View a markdown version of this page

GetActionRecommendations - Amazon Personalize

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.

GetActionRecommendations

Renvoie une liste des actions recommandées, classées par ordre décroissant par score de prédiction. Utilisez l'GetActionRecommendationsAPI si vous avez une campagne personnalisée qui déploie une version de solution entraînée à l'aide d'une recette PERSONALIZED_ACTIONS.

Pour plus d'informations sur les recettes PERSONALIZED_ACTIONS, consultez les recettes PERSONALIZED_ACTIONS. https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html Pour plus d'informations sur l'obtention de recommandations d'action, voir Obtenir des recommandations d'action.

Syntaxe de la demande

POST /action-recommendations HTTP/1.1 Content-type: application/json { "campaignArn": "string", "filterArn": "string", "filterValues": { "string" : "string" }, "numResults": number, "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 d'action. Cette campagne doit déployer une version de solution entraînée à l'aide d'une recette PERSONALIZED_ACTIONS.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

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 actions, 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 actions, 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 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

numResults

Le nombre de résultats à renvoyer. La valeur par défaut est 5. Le maximum est de 100.

Type : Integer

Plage valide : Valeur minimum de 0.

Obligatoire : non

userId

L'ID utilisateur de l'utilisateur pour lequel fournir des recommandations d'action.

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 { "actionList": [ { "actionId": "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.

actionList

Liste de recommandations d'action triées par ordre décroissant par score de prédiction. Il peut y avoir un maximum de 100 actions dans la liste. Pour plus d'informations sur les scores d'action, consultez Comment fonctionne la notation des recommandations d'action.

Type : tableau d’objets PredictedAction

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 :