GetRecommendations - Amazon Personalize
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

GetRecommendations

返回推荐项目的列表。对于市场活动,必需提供活动的 Amazon 资源名称 (ARN),所需的用户和项目输入取决于用于创建支持市场活动的解决方案的配方类型:

  • USER_个性化-userId:必需itemId未使用

  • 关联 _ 物品-itemId:必需userId未使用

注意

使用 POSONALIZED 类型的配方创建的解决方案支持的市场活动使用GetPersonalizedRankingAPI。

对于推荐者,推荐者的 ARN 是必需的,所需的项目和用户输入取决于支持推荐者的使用案例(基于域的配方)。有关用例要求的信息,请参阅选择推荐用例.

请求语法

POST /recommendations HTTP/1.1 Content-type: application/json { "campaignArn": "string", "context": { "string" : "string" }, "filterArn": "string", "filterValues": { "string" : "string" }, "itemId": "string", "numResults": number, "recommenderArn": "string", "userId": "string" }

URI 请求参数

该请求不使用任何 URI 参数。

请求正文

请求接受采用 JSON 格式的以下数据。

campaignArn

用于获取推荐的活动的 Amazon 资源名称 (ARN)。

类型: 字符串

长度约束:长度上限为 256。

模式:arn:([a-z\d-]+):personalize:.*:.*:.+

:必需 否

context

获取推荐时要使用的上下文元数据。上下文元数据包括获取用户推荐时可能相关的任何互动信息,例如用户的当前位置或设备类型。

类型: 字符串到字符串映射

地图条目:最多 150 项。

键长度约束:长度上限为 150。

密钥模式:[A-Za-z\d_]+

值长度约束:长度上限为 1000。

:必需 否

filterArn

要应用于返回的推荐的筛选器的 ARN。有关更多信息,请参阅筛选建议

使用此参数时,请确保过滤器资源为ACTIVE.

类型: 字符串

长度约束:长度上限为 256。

模式:arn:([a-z\d-]+):personalize:.*:.*:.+

:必需 否

filterValues

筛选推荐时要使用的值。对于过滤器表达式中的每个占位符参数,请提供参数名称(大小写匹配)作为键,并提供筛选器值作为相应的值。使用逗号分隔一个参数的多个值。

对于使用INCLUDE要包含项目的元素,必须为表达式中定义的所有参数提供值。对于包含使用EXCLUDE要排除项目的元素,可以省略filter-values。在这种情况下,Amazon Personalize 化不会使用表达式的那一部分来筛选推荐。

有关更多信息,请参阅筛选建议

类型: 字符串到字符串映射

地图条目:最多 25 项。

键长度约束:长度上限为 50。

密钥模式:[A-Za-z0-9_]+

值长度约束:长度上限为 1000。

:必需 否

itemId

要为其提供建议的商品编号。

对于 是必需的RELATED_ITEMS配方类型。

类型: 字符串

长度约束:长度上限为 256。

:必需 否

numResults

要返回的结果数量。默认值为 25。最大值为 500。

类型: 整数

有效范围:最小值为 0。

:必需 否

recommenderArn

用于获取推荐的 Amazon 资源名称 (ARN)。如果您创建了带有域用例推荐者的域数据集组,请提供推荐者 ARN。

类型: 字符串

长度约束:长度上限为 256。

模式:arn:([a-z\d-]+):personalize:.*:.*:.+

:必需 否

userId

要为其提供建议的用户 ID。

对于 是必需的USER_PERSONALIZATION配方类型。

类型: 字符串

长度约束:长度上限为 256。

:必需 否

响应语法

HTTP/1.1 200 Content-type: application/json { "itemList": [ { "itemId": "string", "score": number } ], "recommendationId": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

itemList

按预测分数降序排序的推荐列表。列表中最多 500 项。

类型: 数组PredictedItem对象

recommendationId

推荐的 ID。

类型: 字符串

错误

InvalidInputException

为字段或参数提供有效值。

HTTP 状态代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 状态代码:404

另请参阅

有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: