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

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

GetRecommendations

返回推荐项的列表。所需输入取决于用于创建支持市场活动的解决方案的配方类型,如下所示:

  • 相关项目-itemId必填项,userId未使用

  • 用户个性化-itemId可选userId必需

注意

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

请求语法

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

URI 请求参数

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

请求正文

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

CaspaignArn

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

类型: 字符串

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

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

:必需 是

context

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

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

映射条目:最多 150 项。

密钥长度约束条件:长度上限为 150。

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

值长度约束条件:长度上限为 1 000。

:必需 否

过滤器网络

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

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

类型: 字符串

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

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

:必需 否

过滤器值

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

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

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

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

映射条目:最多 25 项。

密钥长度约束条件:长度上限为 50。

键模式:[A-Za-z0-9]+

值长度约束条件:长度上限为 1 000。

:必需 否

itemId

要为其提供建议的项目 ID。

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

类型: 字符串

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

:必需 否

NumResults

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

类型: 整数

有效范围:最小值为 0。

:必需 否

userId

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

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

类型: 字符串

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

:必需 否

响应语法

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

响应元素

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

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

商品列表

按预测得分按升序排序的建议列表。列表中最多可以有 500 个项。

类型: 数组PredictedItemobjects

推荐编号

建议的 ID。

类型: 字符串

Errors

InvalidInputException

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

HTTP 状态代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 状态代码:404