翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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
-
レコメンデーションをフィルタリングするときに使用する値。フィルター式の各プレースホルダーパラメータについて、(大文字と小文字が一致した状態で) パラメータ名をキーとして指定し、フィルター値を対応する値として指定します。1 つのパラメータの複数の値をコンマで区切ります。
INCLUDE要素を使用してアイテムを含めるフィルター式について、式で定義されているすべてのパラメータの値を指定する必要があります。EXCLUDE要素を使用してアイテムを除外する式を含むフィルターについては、filter-valuesを省略できます。この場合、Amazon Personalize は、レコメンデーションをフィルタリングするために式のその部分を使用しません。詳細については、「レコメンデーションのフィルタリング」を参照してください。
型: 文字列間のマッピング
マップエントリ: アイテムの最大数は 25 です。
キーの長さの制限: 最大長は 50 です。
キーパターン:
[A-Za-z0-9_]+値の長さの制限: 最大長は 1000 です。
必須: いいえ
- inputList
-
ランク付けするアイテムのリスト (
itemIdによる)。アイテムがトレーニングデータセットに含まれていなかった場合、そのアイテムは再ランク付けされたリストの最後に追加されます。レコメンデーションにメタデータを含める場合、最大数は 50 です。それ以外の場合、最大数は 500 です。タイプ：文字列の配列
長さの制限：最大長は 256 です。
必須: はい
- metadataColumns
-
キャンペーンを作成または更新したときにレコメンデーションのメタデータを有効にした場合は、アイテムデータセットのメタデータ列を指定して、パーソナライズしたランキングに含めるようにします。マップキーは
ITEMSで、値はアイテムデータセットの列名のリストです。指定できる列の最大数は 10 です。キャンペーンのメタデータを有効にする方法については、「Enabling metadata in recommendations for a campaign」を参照してください。
タイプ: 文字列マップの配列への文字列
マップエントリ: アイテムの最大数は 1 です。
キーの長さの制限: 最大長は 256 です。
配列メンバー: 最大数は 99 アイテムです。
長さの制限: 最大長は 1,024 です。
必須: いいえ
- 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
-
レコメンデーションの ID。
型: 文字列
エラー
- InvalidInputException
-
フィールドまたはパラメータに有効な値を指定します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
指定されたリソースは存在しません。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
