As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

O runtime do Amazon Personalize oferece suporte às seguintes ações:
+  [GetActionRecommendations](API_RS_GetActionRecommendations.md) 
+  [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) 
+  [GetRecommendations](API_RS_GetRecommendations.md) 

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

Exibe uma lista de ações recomendadas em ordem decrescente por pontuação de previsão. Use a API `GetActionRecommendations` se você tiver uma campanha personalizada que implante uma versão da solução treinada com uma fórmula PERSONALIZED\$1ACTIONS. 

Para obter mais informações sobre fórmulas PERSONALIZED\$1ACTIONS, consulte [PERSONALIZED\$1ACTIONS recipes](https://docs.aws.amazon.com/personalize/latest/dg/nexts-best-action-recipes.html). Para obter mais informações sobre como obter recomendações de ações, consulte [Obter recomendações de ações](https://docs.aws.amazon.com/personalize/latest/dg/get-action-recommendations.html).

## Sintaxe da Solicitação
<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"
}
```

## Parâmetros da solicitação de URI
<a name="API_RS_GetActionRecommendations_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_RS_GetActionRecommendations_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha a ser usada para obter recomendações de ações. Essa campanha deve implantar uma versão da solução treinada com uma fórmula PERSONALIZED\$1ACTIONS.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterArn](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterArn"></a>
O ARN do filtro a ser aplicado às recomendações retornadas. Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Ao usar esse parâmetro, verifique se o recurso de filtro é `ACTIVE`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterValues](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-filterValues"></a>
Os valores a serem usados ao filtrar as recomendações. Para cada parâmetro de espaço reservado em sua expressão de filtro, forneça o nome do parâmetro (em maiúsculas e minúsculas) como uma chave e os valores do filtro como o valor correspondente. Separe vários valores para um parâmetro com uma vírgula.   
Para expressões de filtros que usem um elemento `INCLUDE` para incluir ações, é necessário fornecer valores para todos os parâmetros definidos na expressão. Para filtros com expressões que usem um elemento `EXCLUDE` para excluir ações, é possível omitir os `filter-values`. Nesse caso, o Amazon Personalize não usa essa parte da expressão para filtrar recomendações.  
Para obter mais informações, consulte [Filtrar recomendações e segmentos de usuários](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 25 itens.  
Restrições de tamanhos de chave: tamanho máximo de 50.  
Padrão da chave: `[A-Za-z0-9_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [numResults](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-numResults"></a>
     o número máximo de resultados a serem retornados. O padrão é 5. O máximo é cem.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0.  
Obrigatório: não

 ** [userId](#API_RS_GetActionRecommendations_RequestSyntax) **   <a name="personalize-RS_GetActionRecommendations-request-userId"></a>
O ID do usuário para o qual fornecer recomendações de ações.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

## Sintaxe da resposta
<a name="API_RS_GetActionRecommendations_ResponseSyntax"></a>

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

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

## Elementos de resposta
<a name="API_RS_GetActionRecommendations_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [actionList](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-actionList"></a>
Uma lista de recomendações de ações em ordem decrescente por pontuação de previsão. Pode haver, no máximo, cem ações na lista. Para obter informações sobre pontuações de ações, consulte [How action recommendation scoring works](https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html).  
Tipo: matriz de objetos [PredictedAction](API_RS_PredictedAction.md)

 ** [recommendationId](#API_RS_GetActionRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetActionRecommendations-response-recommendationId"></a>
O ID da recomendação.  
Tipo: string

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

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O recurso especificado não existe.  
Código de status HTTP: 404

## Consulte Também
<a name="API_RS_GetActionRecommendations_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetActionRecommendations) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetActionRecommendations) 

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

Classifica novamente uma lista de itens recomendados para um determinado usuário. O primeiro item na lista é considerado pelo item de maior interesse para o usuário.

**nota**  
A solução por trás da campanha precisa ter sido criada com uma fórmula do tipo PERSONALIZED\$1RANKING.

## Sintaxe da Solicitação
<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"
}
```

## Parâmetros da solicitação de URI
<a name="API_RS_GetPersonalizedRanking_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_RS_GetPersonalizedRanking_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha a ser usada para gerar a classificação personalizada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: Sim

 ** [context](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-context"></a>
Os metadados contextuais a serem usados ao obter recomendações. Os metadados contextuais incluem qualquer informação de interação que possa ser relevante ao obter as recomendações de um usuário, como a localização atual do usuário ou o tipo de dispositivo.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 150 itens.  
Restrições de tamanhos de chave: tamanho máximo de 150.  
Padrão da chave: `[A-Za-z\d_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [filterArn](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterArn"></a>
O nome do recurso da Amazon (ARN) de um filtro que você criou para incluir ou excluir itens das recomendações de um determinado usuário. Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterValues](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-filterValues"></a>
Os valores a serem usados ao filtrar as recomendações. Para cada parâmetro de espaço reservado em sua expressão de filtro, forneça o nome do parâmetro (em maiúsculas e minúsculas) como uma chave e os valores do filtro como o valor correspondente. Separe vários valores para um parâmetro com uma vírgula.   
Para expressões de filtro que usam um elemento `INCLUDE` para incluir itens, você deve fornecer valores para todos os parâmetros definidos na expressão. Para filtros com expressões que usam um `EXCLUDE` elemento para excluir itens, você pode omitir o`filter-values`. Nesse caso, o Amazon Personalize não usa essa parte da expressão para filtrar recomendações.  
Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 25 itens.  
Restrições de tamanhos de chave: tamanho máximo de 50.  
Padrão da chave: `[A-Za-z0-9_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [inputList](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-inputList"></a>
Uma lista de itens (por `itemId`) para classificar. Se um item não foi incluído no conjunto de dados de treinamento, o item será anexado ao final da lista reclassificada. Se você estiver incluindo metadados nas recomendações, o máximo será cinquenta. Caso contrário, o máximo será quinhentos.  
Tipo: matriz de strings  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: Sim

 ** [metadataColumns](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-metadataColumns"></a>
Se você habilitou os metadados nas recomendações ao criar ou atualizar a campanha, especifique as colunas de metadados do conjunto de dados de itens a serem incluídas na classificação personalizada. A chave do mapa é `ITEMS` e o valor é uma lista de nomes de colunas do conjunto de dados de itens. O número máximo de colunas que podem ser fornecidas é dez.  
 Para obter informações sobre como habilitar metadados para uma campanha, consulte [Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata).   
Tipo: string para a matriz do mapa de strings  
Entradas do mapa: número máximo de um item.  
Restrições de tamanho de chave: tamanho máximo de 256.  
Membros da matriz: número máximo de 99 itens.  
Restrições de tamanho: tamanho máximo de 150.  
Obrigatório: não

 ** [userId](#API_RS_GetPersonalizedRanking_RequestSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-request-userId"></a>
O usuário para o qual você deseja que a campanha forneça uma classificação personalizada.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: sim

## Sintaxe da resposta
<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"
}
```

## Elementos de resposta
<a name="API_RS_GetPersonalizedRanking_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [personalizedRanking](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-personalizedRanking"></a>
Uma lista de itens na ordem mais provável de interesse para o usuário. O máximo é 500.  
Tipo: matriz de objetos [PredictedItem](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetPersonalizedRanking_ResponseSyntax) **   <a name="personalize-RS_GetPersonalizedRanking-response-recommendationId"></a>
O ID da recomendação.  
Tipo: string

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

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O recurso especificado não existe.  
Código de status HTTP: 404

## Consulte Também
<a name="API_RS_GetPersonalizedRanking_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetPersonalizedRanking) 

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

Retorna uma lista de itens recomendados. Para campanhas, o nome do recurso da Amazon (ARN) da campanha é obrigatório e a entrada necessária do usuário e do item depende do tipo de fórmula usada para criar a solução de apoio à campanha da seguinte forma:
+ USER\$1PERSONALIZATION - `userId` obrigatório, não usado `itemId`
+ RELATED\$1ITEMS - `itemId` obrigatório, não usado `userId`

**nota**  
Campanhas que são apoiadas por uma solução criada usando uma fórmula do tipo PERSONALIZED\$1RANKING usam a API. [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md)

 Para recomendadores, o ARN do recomendador é obrigatório e o item necessário e a entrada do usuário dependem do caso de uso (fórmula baseada em domínio) que sustenta o recomendador. Para obter informações sobre os requisitos de casos de uso, consulte [Como escolher casos de uso recomendados](https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). 

## Sintaxe da Solicitação
<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"
}
```

## Parâmetros da solicitação de URI
<a name="API_RS_GetRecommendations_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_RS_GetRecommendations_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
O nome do recurso da Amazon (ARN) da campanha a ser usada para obter recomendações.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [context](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-context"></a>
Os metadados contextuais a serem usados ao obter recomendações. Os metadados contextuais incluem qualquer informação de interação que possa ser relevante ao obter as recomendações de um usuário, como a localização atual do usuário ou o tipo de dispositivo.  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 150 itens.  
Restrições de tamanhos de chave: tamanho máximo de 150.  
Padrão da chave: `[A-Za-z\d_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [filterArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterArn"></a>
O ARN do filtro a ser aplicado às recomendações retornadas. Para obter mais informações, consulte [Filtrar recomendações](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Ao usar esse parâmetro, verifique se o recurso de filtro é `ACTIVE`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [filterValues](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-filterValues"></a>
Os valores a serem usados ao filtrar as recomendações. Para cada parâmetro de espaço reservado em sua expressão de filtro, forneça o nome do parâmetro (em maiúsculas e minúsculas) como uma chave e os valores do filtro como o valor correspondente. Separe vários valores para um parâmetro com uma vírgula.   
Para expressões de filtro que usam um elemento `INCLUDE` para incluir itens, você deve fornecer valores para todos os parâmetros definidos na expressão. Para filtros com expressões que usam um `EXCLUDE` elemento para excluir itens, você pode omitir o `filter-values`. Nesse caso, o Amazon Personalize não usa essa parte da expressão para filtrar recomendações.   
Para obter mais informações, consulte [Filtrar recomendações e segmentos de usuários](https://docs.aws.amazon.com/personalize/latest/dg/filter.html).  
Tipo: mapa de string para string  
Entradas do mapa: número máximo de 25 itens.  
Restrições de tamanhos de chave: tamanho máximo de 50.  
Padrão da chave: `[A-Za-z0-9_]+`   
Restrições de tamanho de valor: tamanho máximo de 1.000.  
Obrigatório: não

 ** [itemId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-itemId"></a>
O ID do item para o qual fornecer recomendações.  
Obrigatório para o tipo de fórmula `RELATED_ITEMS`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

 ** [metadataColumns](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-metadataColumns"></a>
Se você habilitou os metadados nas recomendações ao criar ou atualizar a campanha ou o recomendador, especifique as colunas de metadados do conjunto de dados de itens a serem incluídas nas recomendações de itens. A chave do mapa é `ITEMS` e o valor é uma lista de nomes de colunas do conjunto de dados de itens. O número máximo de colunas que podem ser fornecidas é dez.  
 Para obter informações sobre como habilitar metadados para uma campanha, consulte [Enabling metadata in recommendations for a campaign](https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata). Para obter informações sobre como habilitar metadados para uma recomendador, consulte [Enabling metadata in recommendations for a recommender](https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata).   
Tipo: string para a matriz do mapa de strings  
Entradas do mapa: número máximo de um item.  
Restrições de tamanho de chave: tamanho máximo de 256.  
Membros da matriz: número máximo de 99 itens.  
Restrições de tamanho: tamanho máximo de 150.  
Obrigatório: não

 ** [numResults](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-numResults"></a>
     o número máximo de resultados a serem retornados. O padrão é 25. Se você estiver incluindo metadados nas recomendações, o máximo será cinquenta. Caso contrário, o máximo será quinhentos.  
Tipo: inteiro  
Intervalo válido: valor mínimo de 0.  
Obrigatório: não

 ** [promotions](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-promotions"></a>
As promoções a serem aplicadas à solicitação de recomendação. Uma promoção define regras de negócios adicionais que se aplicam a um subconjunto configurável de itens recomendados.  
Tipo: matriz de objetos [Promotion](API_RS_Promotion.md)  
Membros da matriz: número máximo de 1 item.  
Obrigatório: não

 ** [recommenderArn](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-recommenderArn"></a>
O nome do recurso da Amazon (ARN) do recomendador a ser usado para obter recomendações. Forneça um ARN de recomendação se você criou um grupo de conjuntos de dados de domínio com um recomendador para um caso de uso de domínio.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Padrão: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
Obrigatório: não

 ** [userId](#API_RS_GetRecommendations_RequestSyntax) **   <a name="personalize-RS_GetRecommendations-request-userId"></a>
O ID do usuário para o qual fornecer recomendações.  
Obrigatório para o tipo de fórmula `USER_PERSONALIZATION`.  
Tipo: string  
Restrições de tamanho: o tamanho máximo é 256.  
Obrigatório: não

## Sintaxe da resposta
<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"
}
```

## Elementos de resposta
<a name="API_RS_GetRecommendations_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [itemList](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-itemList"></a>
Uma lista de recomendações classificadas em ordem decrescente por pontuação de previsão. Pode haver no máximo 500 itens na lista.  
Tipo: matriz de objetos [PredictedItem](API_RS_PredictedItem.md)

 ** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) **   <a name="personalize-RS_GetRecommendations-response-recommendationId"></a>
O ID da recomendação.  
Tipo: string

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

 ** InvalidInputException **   
Forneça um valor válido para o campo ou parâmetro.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O recurso especificado não existe.  
Código de status HTTP: 404

## Consulte Também
<a name="API_RS_GetRecommendations_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations)