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" ], "userId": "string" }

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下のデータを JSON 形式で受け入れます。

campaignArn

パーソナライズされたランキングを生成するために使用するキャンペーンの Amazon リソースネーム (ARN)。

Type: 文字列

長さの制限: 最大長は 256 です。

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

必須: はい

context

レコメンデーションを取得するときに使用するコンテキストメタデータ。コンテキストメタデータには、ユーザーの現在の場所やデバイスの種類など、ユーザーの推奨情報を取得する際に関連するインタラクション情報が含まれます。

Type: 文字列から文字列へのマッピング

マップエントリ: 最大数は 150 項目です。

キー長コンストレイント: 最大長は 150 です。

キーパターン: [A-Za-z\d_]+

値の長さ拘束: 最大長は 1,000 です。

必須: いいえ

filterArn

特定のユーザーのアイテムを含めるか、またはレコメンデーションからアイテムを除外するために作成したフィルタの Amazon リソースネーム(ARN)。詳細については、「レコメンデーションのフィルタリング」を参照してください。

Type: 文字列

長さの制限: 最大長は 256 です。

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

必須: いいえ

filterValues

レコメンデーションをフィルタリングするときに使用する値。フィルタ式のプレースホルダパラメータごとに、パラメータ名 (大文字と小文字は一致する) をキーとして、フィルタ値を対応する値として指定します。カンマで複数の値を区切ります。

使用するフィルタ式の場合、INCLUDE要素にアイテムを含めるには、式に定義されているすべてのパラメータに値を指定する必要があります。使用する式を持つフィルタの場合EXCLUDE要素を使用して、アイテムを除外するには、filter-valuesこの場合、Amazon Personalize eは表現のその部分を使用して推奨事項をフィルタリングしません。

詳細については、「レコメンデーションのフィルタリング」を参照してください。

Type: 文字列から文字列へのマッピング

マップエントリ: 最大数は 25 項目です。

キー長コンストレイント: 最大長は 50 です。

キーパターン: [A-Za-z0-9]+

値の長さ拘束: 最大長は 1,000 です。

必須: いいえ

inputList

項目のリスト (itemId) をランク付けする。トレーニングデータセットにアイテムが含まれていない場合、アイテムは再ランク付けリストの最後に追加されます。最大値は 500 です。

Type: 文字列の配列

長さの制限: 最大長は 256 です。

必須: はい

userId

キャンペーンでパーソナライズされたランキングを提供したいユーザー。

Type: 文字列

長さの制限: 最大長は 256 です。

必須: はい

レスポンスの構文

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

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

personalizedRanking

ユーザーにとって最も関心の高い順に項目のリスト。最大値は 500 です。

Type: 配列配列 PredictedItem objects

recommendationId

レコメンデーションの ID。

Type: 文字列

Errors

InvalidInputException

フィールドまたはパラメータに有効な値を指定します。

HTTP ステータスコード: 400

ResourceNotFoundException

指定されたリソースは存在しません

HTTP ステータスコード: 404

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、次を参照してください。