

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.

# Amazon Personalize Runtime
<a name="API_Operations_Amazon_Personalize_Runtime"></a>

Les actions suivantes sont prises en charge par Amazon Personalize Runtime :
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

# GetActionRecommendations
<a name="API_RS_GetActionRecommendations"></a>

Renvoie une liste d'actions recommandées, triée par ordre décroissant par score de prédiction. Utilisez l'`GetActionRecommendations`API si vous avez une campagne personnalisée qui déploie une version de solution entraînée par une recette PERSONALIZED\$1ACTIONS. 

[Pour plus d'informations sur les recettes PERSONALIZED\$1ACTIONS, voir recettes PERSONALIZED\$1ACTIONS.](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](https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html).

## Syntaxe de la demande
<a name="API_RS_GetActionRecommendations_RequestSyntax"></a>

```
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
<a name="API_RS_GetActionRecommendations_RequestParameters"></a>

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

## Corps de la demande
<a name="API_RS_GetActionRecommendations_RequestBody"></a>

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

 ** [campaignArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-campaignArn"></a>
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 avec une recette PERSONALIZED\$1ACTIONS.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatoire : non

 ** [filterArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterArn"></a>
L'ARN du filtre à appliquer aux recommandations renvoyées. Pour de plus amples informations, veuillez consulter [Filtrage des recommandations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Lorsque vous utilisez ce paramètre, assurez-vous que la ressource de filtre est bien`ACTIVE`.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatoire : non

 ** [filterValues](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterValues"></a>
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 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 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 [Recommandations de filtrage et segments d'utilisateurs](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
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 1000.  
Obligatoire : non

 ** [numResults](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-numResults"></a>
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](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-userId"></a>
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
<a name="API_RS_GetActionRecommendations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionList": [ 
      { 
         "actionId": "string",
         "score": number
      }
   ],
   "recommendationId": "string"
}
```

## Eléments de réponse
<a name="API_RS_GetActionRecommendations_ResponseElements"></a>

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](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-actionList"></a>
Liste de recommandations d'action triées par ordre décroissant par score de prédiction. La liste peut contenir un maximum de 100 actions. Pour plus d'informations sur les scores d'action, voir [Fonctionnement de la notation des recommandations d'action](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html).  
Type : tableau d’objets [PredictedAction](API_RS_PredictedAction.md)

 ** [recommendationId](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-recommendationId"></a>
ID de la recommandation.  
Type : Chaîne

## Erreurs
<a name="API_RS_GetActionRecommendations_Errors"></a>

 ** 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

## Voir aussi
<a name="API_RS_GetActionRecommendations_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetActionRecommendations) 

# GetPersonalizedRanking
<a name="API_RS_GetPersonalizedRanking"></a>

Réorganise une liste d'éléments recommandés pour un utilisateur donné. Le premier élément de la liste est considéré comme l'élément le plus susceptible d'intéresser l'utilisateur.

**Note**  
La solution utilisée pour la campagne doit avoir été créée à l'aide d'une recette de type PERSONALIZED\$1RANKING.

## Syntaxe de la demande
<a name="API_RS_GetPersonalizedRanking_RequestSyntax"></a>

```
POST /personalize-ranking HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "inputList": [ "string" ],
   "metadataColumns": { 
      "string" : [ "string" ]
   },
   "userId": "string"
}
```

## Paramètres de demande URI
<a name="API_RS_GetPersonalizedRanking_RequestParameters"></a>

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

## Corps de la demande
<a name="API_RS_GetPersonalizedRanking_RequestBody"></a>

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

 ** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-campaignArn"></a>
Le nom de ressource Amazon (ARN) de la campagne à utiliser pour générer le classement personnalisé.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatoire : oui

 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
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 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 1000.  
Obligatoire : non

 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a>
Le nom de ressource Amazon (ARN) d'un filtre que vous avez créé pour inclure des éléments ou exclure des éléments des recommandations pour un utilisateur donné. Pour de plus amples informations, veuillez consulter [Filtrage des recommandations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatoire : non

 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterValues"></a>
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 le`filter-values`. Dans ce cas, Amazon Personalize n'utilise pas cette partie de l'expression pour filtrer les recommandations.  
Pour de plus amples informations, veuillez consulter [Filtrage des recommandations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
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 1000.  
Obligatoire : non

 ** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-inputList"></a>
Une liste d'éléments (par`itemId`) à classer. Si un élément n'a pas été inclus dans le jeu de données d'entraînement, il est ajouté à la fin de la liste reclassée. Si vous incluez des métadonnées dans les recommandations, le maximum est de 50. Sinon, le maximum est de 500.  
Type : tableau de chaînes  
Contraintes de longueur : longueur maximale de 256.  
Obligatoire : oui

 ** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-metadataColumns"></a>
Si vous avez activé les métadonnées dans les recommandations lorsque vous avez créé ou mis à jour la campagne, spécifiez les colonnes de métadonnées de votre jeu de données Items à inclure dans le classement personnalisé. La clé de la carte `ITEMS` et la valeur sont 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](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).   
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

 ** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-userId"></a>
L'utilisateur pour lequel vous souhaitez que la campagne fournisse un classement personnalisé.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Obligatoire : oui

## Syntaxe de la réponse
<a name="API_RS_GetPersonalizedRanking_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

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

## Eléments de réponse
<a name="API_RS_GetPersonalizedRanking_ResponseElements"></a>

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.

 ** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-personalizedRanking"></a>
Liste des éléments les plus susceptibles d'intéresser l'utilisateur. Le maximum est de 500.  
Type : tableau d’objets [PredictedItem](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-recommendationId"></a>
ID de la recommandation.  
Type : Chaîne

## Erreurs
<a name="API_RS_GetPersonalizedRanking_Errors"></a>

 ** 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

## Voir aussi
<a name="API_RS_GetPersonalizedRanking_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 

# GetRecommendations
<a name="API_RS_GetRecommendations"></a>

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\$1PERSONALIZATION - `userId` obligatoire, non utilisé `itemId`
+ RELATED\$1ITEMS - `itemId` obligatoire, non utilisé `userId`

**Note**  
Les campagnes soutenues par une solution créée à l'aide d'une recette de type PERSONALIZED\$1RANKING utilisent l'API. [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)

 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](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). 

## Syntaxe de la demande
<a name="API_RS_GetRecommendations_RequestSyntax"></a>

```
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
<a name="API_RS_GetRecommendations_RequestParameters"></a>

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

## Corps de la demande
<a name="API_RS_GetRecommendations_RequestBody"></a>

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

 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
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](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-context"></a>
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 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](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterArn"></a>
L'ARN du filtre à appliquer aux recommandations renvoyées. Pour de plus amples informations, veuillez consulter [Filtrage des recommandations](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Lorsque vous utilisez ce paramètre, assurez-vous que la ressource de filtre est`ACTIVE`.  
Type : Chaîne  
Contraintes de longueur : longueur maximale de 256.  
Modèle : `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obligatoire : non

 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterValues"></a>
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 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 [Recommandations de filtrage et segments d'utilisateurs](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
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](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-itemId"></a>
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](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-metadataColumns"></a>
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](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata). 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](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).   
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](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-numResults"></a>
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 : Integer  
Plage valide : Valeur minimum de 0.  
Obligatoire : non

 ** [promotions](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-promotions"></a>
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](API_RS_Promotion.md)  
Membres du tableau : nombre maximum de 1 élément.  
Obligatoire : non

 ** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-recommenderArn"></a>
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](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-userId"></a>
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
<a name="API_RS_GetRecommendations_ResponseSyntax"></a>

```
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
<a name="API_RS_GetRecommendations_ResponseElements"></a>

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](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-itemList"></a>
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](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-recommendationId"></a>
ID de la recommandation.  
Type : Chaîne

## Erreurs
<a name="API_RS_GetRecommendations_Errors"></a>

 ** 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

## Voir aussi
<a name="API_RS_GetRecommendations_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations) 