GetRecommendations - Amazon Personalize
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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á.

GetRecommendations

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_PERSONALIZATION - userId obrigatório, não usado itemId

  • RELATED_ITEMS - 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_RANKING usam a API. GetPersonalizedRanking

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.

Sintaxe da Solicitação

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 solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

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

campaignArn

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

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

O ARN do filtro a ser aplicado às recomendações retornadas. Para obter mais informações, consulte Filtrar recomendações.

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

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.

Tipo: mapa de strings 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

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

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. Para obter informações sobre como habilitar metadados para uma recomendador, consulte Enabling metadata in recommendations for a recommender.

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

    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

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

Membros da matriz: número máximo de 1 item.

Obrigatório: não

recommenderArn

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

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

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

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

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

recommendationId

O ID da recomendação.

Tipo: string

Erros

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

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: