View a markdown version of this page

GetRecommendations - Amazon Personalize
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursVoir 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'articles recommandés. Pour les campagnes, le nom de ressource Amazon (ARN) de la campagne est obligatoire et la saisie des utilisateurs et des articles requise dépend 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 recommandateurs, l'ARN du recommandateur est obligatoire et l'élément requis et les données saisies par l'utilisateur dépendent du cas d'utilisation (recette basée sur le domaine) qui sous-tend le recommandateur. Pour plus d'informations sur les exigences des cas d'utilisation, consultez la section Choix 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 pour obtenir des recommandations. Les métadonnées contextuelles incluent toutes les informations d'interaction susceptibles d'être pertinentes pour obtenir les recommandations d'un utilisateur, telles que la position actuelle de l'utilisateur ou le type d'appareil.

Type : mappage chaîne/chaîne

Entrées sur la carte : nombre maximum de 150 éléments.

Contraintes relatives à la longueur des touches : longueur maximale de 150.

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

Contraintes de longueur de valeur : longueur maximale de 1000.

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 l'estACTIVE.

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é dans votre expression de filtre, indiquez le nom du paramètre (dans les cas correspondants) en tant que clé et la ou les valeurs du filtre en tant que 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 articles, vous pouvez omettre le filter-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 Filtrage des recommandations et des segments d'utilisateurs.

Type : mappage chaîne/chaîne

Entrées sur la carte : nombre maximum de 25 éléments.

Contraintes relatives à la longueur des touches : longueur maximale de 50.

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

Contraintes de longueur de valeur : longueur maximale de 1000.

Obligatoire : non

itemId

L'identifiant 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 lors de la création ou de la mise à jour de la campagne ou de la recommandation, spécifiez les colonnes de métadonnées de votre jeu de données Items à inclure dans les recommandations d'articles. La clé de la carte est, ITEMS et sa valeur est, une liste de noms de colonnes 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 recommandataire, voir Activation des métadonnées dans les recommandations destinées à un recommandateur.

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

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

Contraintes relatives à la longueur des touches : 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. Sinon, le maximum est de 500.

Type : Integer

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 recommandateur à 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 outil de recommandation 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 classées par ordre décroissant par score de prédiction. Il peut y avoir un maximum de 500 éléments dans la liste.

Type : tableau d’objets PredictedItem

recommendationId

L'ID de la recommandation.

Type : Chaîne

Erreurs

InvalidInputException

Fournissez 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

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :