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

GetPersonalizedRanking

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

Sintaxe da Solicitação

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 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 gerar a classificação personalizada.

Tipo: string

Restrições de tamanho: o tamanho máximo é 256.

Padrão: arn:([a-z\d-]+):personalize:.*:.*:.+

Exigido: Sim

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

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.

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

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

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

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.

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

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.

Exigido: Sim

Sintaxe da Resposta

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

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

Uma lista de itens na ordem mais provável de interesse para o usuário. O máximo é 500.

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 um dos SDKs específicos de linguagem AWS, consulte: