GetRecommendations - Amazon Personalize
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

GetRecommendations

Renvoie une liste d'éléments recommandés. Pour les campagnes, le nom de ressource Amazon (ARN) de la campagne est obligatoire et les informations relatives à l'utilisateur et à l'article requises dépendent du type de recette utilisé pour créer la solution qui soutient la campagne, comme suit :

  • USER_PERSONALIZATION - userId obligatoire, non utilisé itemId

  • RELATED_ITEMS - itemId obligatoire, non utilisé userId

Note

Les campagnes soutenues par une solution créée à l'aide d'une recette de type PERSONALIZED_RANKING utilisent l'API. GetPersonalizedRanking

Pour les recommandeurs, l'ARN du recommandeur est obligatoire et l'élément requis et les entrées utilisateur dépendent du cas d'utilisation (recette basée sur le domaine) qui sous-tend le recommandeur. Pour plus d'informations sur les exigences relatives aux cas d'utilisation, voir Choisir des cas d'utilisation recommandés.

Syntaxe de la demande

POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "itemId": "string",
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "numResults": number,
   "promotions": [ 
      { 
         "filterArn": "string",
         "filterValues": { 
            "string" : "string" 
         },
         "name": "string",
         "percentPromotedItems": number
      }
   ],
   "recommenderArn": "string",
   "userId": "string"
}

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

campaignArn

Le nom de ressource Amazon (ARN) de la campagne à utiliser pour obtenir des recommandations.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatoire : non

context

Les métadonnées contextuelles à utiliser lors de l'obtention de recommandations. Les métadonnées contextuelles incluent toutes les informations d'interaction susceptibles d'être pertinentes lors de l'obtention des recommandations d'un utilisateur, telles que l'emplacement actuel de l'utilisateur ou le type d'appareil.

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre maximum de 150 éléments.

Contraintes relatives à la longueur des clés : longueur maximale de 150.

Modèle de clé :[A-Za-z\d_]+

Contraintes de longueur de valeur : longueur maximale de 1 000.

Obligatoire : non

filterArn

L'ARN du filtre à appliquer aux recommandations renvoyées. Pour de plus amples informations, veuillez consulter Filtrage des recommandations.

Lorsque vous utilisez ce paramètre, assurez-vous que la ressource de filtre est bienACTIVE.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatoire : non

filterValues

Les valeurs à utiliser lors du filtrage des recommandations. Pour chaque paramètre d'espace réservé de votre expression de filtre, indiquez le nom du paramètre (le cas échéant) sous forme de clé et la ou les valeurs du filtre comme valeur correspondante. Séparez les valeurs multiples d'un paramètre par une virgule.

Pour les expressions de filtre qui utilisent un INCLUDE élément pour inclure des éléments, vous devez fournir des valeurs pour tous les paramètres définis dans l'expression. Pour les filtres contenant des expressions qui utilisent un EXCLUDE élément pour exclure des éléments, vous pouvez omettre lefilter-values. Dans ce cas, Amazon Personalize n'utilise pas cette partie de l'expression pour filtrer les recommandations.

Pour plus d'informations, consultez la section Recommandations de filtrage et segments d'utilisateurs.

Type : mappage chaîne/chaîne

Entrées cartographiques : nombre maximum de 25 éléments.

Contraintes relatives à la longueur des clés : longueur maximale de 50.

Modèle de clé :[A-Za-z0-9_]+

Contraintes de longueur de valeur : longueur maximale de 1 000.

Obligatoire : non

itemId

L'ID de l'article pour lequel fournir des recommandations.

Obligatoire pour le type de RELATED_ITEMS recette.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Obligatoire : non

metadataColumns

Si vous avez activé les métadonnées dans les recommandations lorsque vous avez créé ou mis à jour la campagne ou le recommandateur, spécifiez les colonnes de métadonnées de votre jeu de données d'articles à inclure dans les recommandations d'articles. La clé de la carte ITEMS et la valeur sont une liste de noms de colonnes provenant de votre jeu de données Items. Le nombre maximum de colonnes que vous pouvez fournir est de 10.

Pour plus d'informations sur l'activation des métadonnées pour une campagne, consultez la section Activation des métadonnées dans les recommandations relatives à une campagne. Pour plus d'informations sur l'activation des métadonnées pour un recommandeur, consultez la section Activation des métadonnées dans les recommandations pour un recommandeur.

TYpe : mappage de chaîne à tableau de chaînes

Entrées cartographiques : nombre maximum d'un élément.

Contraintes relatives à la longueur des clés : longueur maximale de 256.

Membres du tableau : nombre maximum de 99 éléments.

Contraintes de longueur : longueur maximale de 150.

Obligatoire : non

numResults

Le nombre de résultats à renvoyer. La valeur par défaut est 25. Si vous incluez des métadonnées dans les recommandations, le maximum est de 50. Dans le cas contraire, le maximum est de 500.

Type : entier

Plage valide : Valeur minimum de 0.

Obligatoire : non

promotions

Les promotions à appliquer à la demande de recommandation. Une promotion définit des règles commerciales supplémentaires qui s'appliquent à un sous-ensemble configurable d'articles recommandés.

Type : tableau d’objets Promotion

Membres du tableau : nombre maximum de 1 élément.

Obligatoire : non

recommenderArn

Le nom de ressource Amazon (ARN) du recommandeur à utiliser pour obtenir des recommandations. Fournissez un ARN de recommandation si vous avez créé un groupe de jeux de données de domaine avec un recommandateur pour un cas d'utilisation de domaine.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatoire : non

userId

L'ID utilisateur pour lequel fournir des recommandations.

Obligatoire pour le type de USER_PERSONALIZATION recette.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "itemList": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "reason": [ "string" ],
         "score": number
      }
   ],
   "recommendationId": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

itemList

Liste de recommandations triées par ordre décroissant par score de prédiction. La liste peut contenir un maximum de 500 éléments.

Type : tableau d’objets PredictedItem

recommendationId

L'ID de la recommandation.

Type : chaîne

Erreurs

InvalidInputException

Entrez une valeur valide pour le champ ou le paramètre.

Code d’état HTTP : 400

ResourceNotFoundException

La ressource spécifiée n'existe pas.

Code d’état HTTP : 404

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :