GetRecommendations

Devuelve una lista de elementos recomendados. Para las campañas, se requiere el nombre del recurso de Amazon (ARN) de la campaña y la entrada requerida de usuario y elemento depende del tipo de receta utilizado para crear la solución que respalda la campaña, de la siguiente manera:

• USER_PERSONALIZATION: userId obligatorio, itemId no utilizado

• RELATED_ITEMS: itemId obligatorio, userId no utilizado

nota

Las campañas respaldadas por una solución creada con una receta del tipo PERSONALIZED_RANKING utilizan la API GetPersonalizedRanking.

Para los recomendadores, se requiere el ARN del recomendador y la entrada requerida de usuario y elemento dependen del caso de uso (receta basada en el dominio) que respalda al recomendador. Para obtener información sobre los requisitos de los casos de uso, consulte Elección de los casos de uso de un recomendador.

Sintaxis de la solicitud

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 de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

campaignArn

El nombre de recurso de Amazon (ARN) de la campaña que se va a utilizar para obtener recomendaciones.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatorio: no

context

Los metadatos contextuales que se utilizarán para obtener recomendaciones. Los metadatos contextuales incluyen cualquier información de interacción que pueda ser relevante a la hora de obtener las recomendaciones de un usuario, como la ubicación actual del usuario o el tipo de dispositivo.

Tipo: mapa de cadena a cadena

Entradas de mapa: número máximo de 150 elementos.

Limitaciones de longitud de clave: longitud máxima de 150 caracteres.

Patrón de clave: [A-Za-z\d_]+

Limitaciones de longitud de valor: longitud máxima de 1000 caracteres.

Obligatorio: no

filterArn

ARN del filtro que se aplicará a las recomendaciones devueltas. Para obtener más información, consulte Filtrado de recomendaciones.

Cuando utilice este parámetro, asegúrese de que el recurso de filtro sea ACTIVE.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatorio: no

filterValues

Los valores que se van a utilizar al filtrar las recomendaciones. Para cada parámetro de marcador de posición de la expresión de filtro, proporcione el nombre del parámetro (respetando mayúsculas y minúsculas) como clave y los valores del filtro como valor correspondiente. Separe los valores múltiples de un parámetro con una coma.

En el caso de las expresiones de filtro que utilizan un elemento INCLUDE para incluir elementos, debe proporcionar valores para todos los parámetros definidos en la expresión. En el caso de los filtros con expresiones que utilizan un objeto EXCLUDE para excluir elementos, puede omitir la expresión filter-values. En este caso, Amazon Personalize no utiliza esa parte de la expresión para filtrar recomendaciones.

Para obtener más información, consulte Filtrado de recomendaciones y segmentos de usuario.

Tipo: mapa de cadena a cadena

Entradas de mapa: número máximo de 25 elementos.

Limitaciones de longitud de clave: longitud máxima de 50 caracteres.

Patrón de clave: [A-Za-z0-9_]+

Limitaciones de longitud de valor: longitud máxima de 1000 caracteres.

Obligatorio: no

itemId

El ID del elemento para el que se van a ofrecer recomendaciones.

Necesario para el tipo de receta RELATED_ITEMS.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Obligatorio: no

metadataColumns

Si ha habilitado los metadatos en las recomendaciones al crear o actualizar la campaña o el recomendador, especifique las columnas de metadatos del conjunto de datos de elementos que se van a incluir en las recomendaciones de elementos. La clave de asignación es ITEMS y el valor es una lista de nombres de columnas de su conjunto de datos de elementos. El número máximo de columnas que puede proporcionar es 10.

Para obtener información sobre cómo habilitar los metadatos para una campaña, consulte Habilitación de los metadatos en las recomendaciones para una campaña. Para obtener información sobre cómo habilitar los metadatos para un recomendador, consulte Habilitación de los metadatos en las recomendaciones para un recomendador.

Tipo: mapa de cadena a matriz de cadenas

Entradas de mapa: número máximo de 1 elemento.

Limitaciones de longitud de clave: longitud máxima de 256.

Miembros de la matriz: número máximo de 99 elementos.

Limitaciones de longitud: longitud máxima de 150 caracteres.

Obligatorio: no

numResults

El número de resultados que se devolverá. El valor predeterminado es 25. Si incluye metadatos en las recomendaciones, el máximo es 50. De lo contrario, el máximo es 500.

Tipo: número entero

Rango válido: valor mínimo de 0.

Obligatorio: no

promotions

Las promociones que se aplican a la solicitud de recomendación. Una promoción define reglas empresariales adicionales que se aplican a un subconjunto configurable de elementos recomendados.

Tipo: matriz de objetos Promotion

Miembros de la matriz: número máximo de 1 elemento.

Obligatorio: no

recommenderArn

El nombre de recurso de Amazon (ARN) del recomendador que se va a utilizar para obtener recomendaciones. Proporcione el ARN de un recomendador si creó un grupo de conjuntos de datos de dominio con un recomendador para un caso de uso de dominio.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Patrón: arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatorio: no

userId

El ID del usuario para el que se van a proporcionar recomendaciones.

Necesario para el tipo de receta USER_PERSONALIZATION.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Obligatorio: no

Sintaxis de la respuesta

HTTP/1.1 200
Content-type: application/json

{
   "itemList": [ 
      { 
         "itemId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "promotionName": "string",
         "score": number
      }
   ],
   "recommendationId": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

itemList

Lista de recomendaciones ordenadas en orden descendente por puntuación de predicción. Puede haber un máximo de 500 elementos en la lista.

Tipo: matriz de objetos PredictedItem

recommendationId

El identificador de la recomendación.

Tipo: cadena

Errores

InvalidInputException

Proporcione un valor válido para el campo o el parámetro.

Código de estado HTTP: 400

ResourceNotFoundException

El recurso especificado no existe.

Código de estado HTTP: 404

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:

• AWS Command Line Interface

• AWS SDK para .NET

• SDK de AWS para C++

• AWS SDK para Go

• AWS SDK para Java V2

• AWS SDK para JavaScript V3

• AWS SDK para PHP V3

• AWS SDK para Python

• AWS SDK para Ruby V3