本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
GetRecommendations
返回推荐项目列表。对于广告系列，广告系列的亚马逊资源名称 (ARN) 是必填项，所需的用户和物品输入取决于用于创建支持该活动的解决方案的配方类型，如下所示：
-
用户_个性化-
userId必填项，itemId未使用 -
RELATED_ITEMS-
itemId必填项，userId未使用
注意
由使用 PERSONALIZED_RANKING 类型的配方创建的解决方案支持的广告系列使用GetPersonalizedRanking API。
对于推荐人，推荐人的 ARN 是必填项，所需的项目和用户输入取决于支持推荐人的用例（基于域的配方）。有关用例要求的信息，请参阅选择推荐用例。
请求语法
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"
}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。
必需：否
- promotions
-
适用于推荐请求的促销活动。促销定义了适用于推荐商品的可配置子集的其他业务规则。
类型：Promotion 对象数组
数组成员：最多 1 项。
必需：否
- recommenderArn
-
用于获取推荐的 Amazon Resource Name (ARN)。如果您创建了带有域用例推荐器的域数据集组，请提供推荐器 ARN。
类型：字符串
长度限制：最大长度为 256。
模式：
arn:([a-z\d-]+):personalize:.*:.*:.+必需：否
- userId
-
为其提供建议的用户 ID。
USER_PERSONALIZATION食谱类型为必填项。类型：字符串
长度限制：最大长度为 256。
必需：否
响应语法
HTTP/1.1 200
Content-type: application/json
{
"itemList": [
{
"itemId": "string",
"promotionName": "string",
"score": number
}
],
"recommendationId": "string"
}响应元素
如果此操作成功，则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- itemList
-
按预测分数降序排序的推荐列表。列表中最多可以有 500 个项目。
类型：PredictedItem 对象数组
- recommendationId
-
推荐的 ID。
类型：字符串
错误
- InvalidInputException
-
为字段或参数提供有效值。
HTTP 状态代码：400
- ResourceNotFoundException
-
指定的资源不存在。
HTTP 状态代码：404
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：