GetRecommendations - Amazon Personalize

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

GetRecommendations

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

  • PERSONALIZACIÓN DEL USUARIO:userId obligatorio,itemId no utilizado

  • ARTÍCULOS RELACIONADOS:itemId obligatorio,userId no utilizado

nota

Las campañas que están respaldadas por una solución creada con una receta del tipo PERSONALIZED_RANKING utilizan laGetPersonalizedRanking API.

Para los recomendadores, se requiere el ARN del recomendante y el elemento requerido y la entrada del usuario dependen del caso de uso (receta basada en el dominio) que respalde al recomendador. Para obtener información sobre los requisitos de los casos de uso, consulte Cómo elegir los casos de uso de los recomendadores.

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", "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 deben utilizar para recibir recomendaciones. Los metadatos contextuales incluyen cualquier información de interacción que pueda ser relevante para 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

El ARN del filtro que se aplicará a las recomendaciones devueltas. Para obtener más información, consulte Filtering Recommendations (Filtrar recomendaciones).

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

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

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

Obligatorio: no

filterValues

Los valores que se deben 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 (en el caso que coincida) como clave y los valores del filtro como el valor correspondiente. Separe los valores múltiples de un parámetro con una coma.

Para las expresiones de filtro que utilizan unINCLUDE elemento 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 unEXCLUDE elemento para excluir elementos, puedes omitir lafilter-values. En este caso, Amazon Personalize no utiliza esa parte de la expresión para filtrar las 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 identificador del artículo para el que se proporcionarán recomendaciones.

Necesario para el tipo deRELATED_ITEMS receta.

Tipo: cadena

Limitaciones de longitud: longitud máxima de 256.

Obligatorio: no

numResults

Número de resultados a devolver. El valor predeterminado es 25. El máximo es 500.

Tipo: entero

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

Obligatorio: no

promotions

Las promociones que se aplicarán a la solicitud de recomendación. Una promoción define reglas comerciales adicionales que se aplican a un subconjunto configurable de artículos 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 un ARN de recomendación 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 seudónimo para el que se proporcionarán recomendaciones.

Necesario para el tipo deUSER_PERSONALIZATION receta.

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

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