GetPersonalizedRanking - Amazon Personalize

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

GetPersonalizedRanking

重新排列給定使用者的建議項目清單。清單中的第一個項目被視為使用者最有可能感興趣的項目。

注意

您必須已使用類型為 PERSONALIZED_RANKING 的配方,建立支持行銷活動的解決方案。

請求語法

POST /personalize-ranking HTTP/1.1 Content-type: application/json { "campaignArn": "string", "context": { "string" : "string" }, "filterArn": "string", "filterValues": { "string" : "string" }, "inputList": [ "string" ], "metadataColumns": { "string" : [ "string" ] }, "userId": "string" }

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

campaignArn

活動的 Amazon 資源名稱(ARN),用於生成個性化排名。

類型:字串

長度限制:長度上限為 256。

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

必要:是

context

取得建議時要使用的關聯式中繼資料。上下文元數據包括在獲取用戶建議時可能相關的任何互動信息,例如用戶的當前位置或設備類型。

類型:字串到字串映射

地圖項目:最多 150 個項目。

鍵長度限制:最大長度為 150。

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

值長度限制:最大長度為 1000。

必要:否

filterArn

您建立的篩選器的 Amazon 資源名稱 (ARN),以包括項目或從建議中排除特定使用者的項目。如需詳細資訊,請參閱篩選建議

類型:字串

長度限制:長度上限為 256。

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

必要:否

filterValues

篩選建議時要使用的值。對於篩選運算式中的每個預留位置參數,請提供參數名稱 (在相符的情況下) 做為索引鍵,並提供篩選器值做為對應值。使用逗號分隔一個參數的多個值。

對於使用INCLUDE元素包括項目的篩選運算式,您必須為運算式中定義的所有參數提供值。對於具有使用EXCLUDE元素排除項目之運算式的篩選器,您可以省略filter-values。在這種情況下,Amazon Personalize 不會使用該部分運算式來篩選建議。

如需詳細資訊,請參閱篩選建議

類型:字串到字串映射

地圖項目:最多 25 個項目。

鍵長度限制:最大長度為 50。

金鑰模式:[A-Za-z0-9_]+

值長度限制:最大長度為 1000。

必要:否

inputList

項目列表(按itemId)排名。如果某個項目未包含在訓練資料集中,該項目會附加到重新排名清單的結尾。如果您要在建議中包含中繼資料,則最大值為 50。否則,最大值為 500。

類型:字串陣列

長度限制:長度上限為 256。

必要:是

metadataColumns

如果您在建立或更新促銷活動時在建議中啟用中繼資料,請從項目資料集中指定中繼資料欄,以納入個人化排名。map 索引鍵為,ITEMS而且值是 Items 資料集中的資料行名稱清單。您可以提供的最大欄數為 10。

如需啟用促銷活動中繼資料的詳細資訊,請參閱在促銷活動的建議中啟用中繼資料。

類型:字串到字串陣列映射

地圖項目:1 個項目的最大數量。

鍵長度限制:最大長度為 256。

陣列成員:99 個項目的最大數目。

長度限制:最大長度為 150。

必要:否

userId

您希望廣告活動提供個人化排名的使用者。

類型:字串

長度限制:長度上限為 256。

必要:是

回應語法

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

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

personalizedRanking

按用戶最有可能感興趣的順序排列的項目列表。最大值為 500。

類型:PredictedItem 物件陣列

recommendationId

建議的識別碼。

類型:字串

錯誤

InvalidInputException

提供欄位或參數的有效值。

HTTP 狀態碼:400

ResourceNotFoundException

指定的資源不存在。

HTTP 狀態碼:404

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: