本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
GetRecommendations
傳回建議項目的清單。對於促銷活動，需要促銷活動的 Amazon 資源名稱 (ARN)，並且所需的使用者和項目輸入取決於用於建立支援促銷活動之解決方案的配方類型，如下所示：
-
使用者個人化-
userId必要，itemId未使用 -
相關項目-
itemId必要，未使用userId
注意
由使用「個人化排名」類型的配方建立的解決方案支援的行銷活動會使用 API。GetPersonalizedRanking
對於推薦人來說，建議人員的 ARN 是必要的，並且必要的項目和使用者輸入取決於支援建議程式的使用案例 (以網域為基礎的配方)。如需使用案例需求的相關資訊，請參閱選擇推薦使用案例。
請求語法
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"
}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
-
要提供建議的項目 ID。
RELATED_ITEMS配方類型是必需的。類型：字串
長度限制：長度上限為 256。
必要：否
- metadataColumns
-
如果您在建立或更新促銷活動或推薦人時啟用建議中的中繼資料，請從項目資料集中指定要包含在項目建議中的中繼資料欄。map 索引鍵為，
ITEMS而且值是 Items 資料集中的資料行名稱清單。您可以提供的最大欄數為 10。如需啟用促銷活動中繼資料的詳細資訊，請參閱在促銷活動的建議中啟用中繼資料。如需為推薦人啟用中繼資料的相關資訊，請參閱啟用建議人的建議中的中繼資料。
類型：字串到字串陣列映射
地圖項目：1 個項目的最大數量。
鍵長度限制：最大長度 256。
陣列成員：99 個項目的上限。
長度限制：最大長度為 150。
必要：否
- numResults
-
要傳回的結果數目。預設為 25。如果您要在建議中包含中繼資料，則最大值為 50。否則，最大值為 500。
類型：整數
有效範圍：最小值為 0。
必要：否
- promotions
-
要套用至建議請求的促銷活動。促銷會定義套用至可供配置之建議項目子集的其他企業規則。
類型：Promotion 物件陣列
陣列成員：最多 1 個項目。
必要：否
- 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",
"metadata": {
"string" : "string"
},
"promotionName": "string",
"reason": [ "string" ],
"score": number
}
],
"recommendationId": "string"
}回應元素
如果動作成功，則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- itemList
-
依預測分數以遞減順序排序的建議清單。清單中最多可以有 500 個項目。
類型：PredictedItem 物件陣列
- recommendationId
-
建議的識別碼。
類型：字串
錯誤
- InvalidInputException
-
提供欄位或參數的有效值。
HTTP 狀態碼：400
- ResourceNotFoundException
-
指定的資源不存在。
HTTP 狀態碼：404
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
