GetRecommendations - Amazon Personalize
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

GetRecommendations

推奨項目のリストを返します。キャンペーンでは、キャンペーンの Amazon リソースネーム (ARN) が必要であり、必要なユーザーおよびアイテムの入力は、キャンペーンに展開するソリューションの作成に使用するレシピタイプに応じて異なります。

  • USER_PERSONALIZE-userId必須itemId使用しない

  • RELATED_ITEMS-itemId必須userId使用しない

注記

PERSONALIZED_RANKING タイプのレシピを使用して作成されたソリューションに展開するキャンペーンでは、GetPersonalizedRankingアピ。

レコメンダーの場合、レコメンダーの ARN が必要であり、必要な項目とユーザー入力は、レコメンダーをバッキングするユースケース（ドメインベースのレシピ）によって異なります。ユースケースの要件については、を参照してください。レコメンダーのユースケースの選択。

リクエストの構文

POST /recommendations HTTP/1.1
Content-type: application/json

{
   "campaignArn": "string",
   "context": { 
      "string" : "string" 
   },
   "filterArn": "string",
   "filterValues": { 
      "string" : "string" 
   },
   "itemId": "string",
   "numResults": number,
   "recommenderArn": "string",
   "userId": "string"
}

URI リクエストパラメータ

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

リクエストボディ

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

campaignArn

レコメンデーションを取得するために使用するキャンペーンの Amazon リソースネーム (ARN)。

Type: 文字列

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

パターン: arn:([a-z\d-]+):personalize:.*:.*:.+

: 必須 いいえ

context

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

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

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

キー長の制約: 最大長は 150 です。

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

値の長さの制約: 最大長は 1,000 です。

: 必須 いいえ

filterArn

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

このパラメータを使用する場合は、フィルタリソースがACTIVE。

Type: 文字列

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

パターン: arn:([a-z\d-]+):personalize:.*:.*:.+

: 必須 いいえ

filterValues

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

使用するフィルタ式の場合INCLUDE要素に項目を含めるには、式に定義されているすべてのパラメータに値を指定する必要があります。使用する式を含むフィルタの場合EXCLUDE要素に項目を除外するには、を省略できます。filter-valuesこの場合、Amazon Personalize は、レコメンデーションをフィルタリングするために式のその部分を使用しません。

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

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

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

キー長の制限: 最大長は 50 です。

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

値の長さの制約: 最大長は 1,000 です。

: 必須 いいえ

itemId

レコメンデーションを提供するアイテム ID。

では必須RELATED_ITEMSレシピタイプ。

Type: 文字列

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

: 必須 いいえ

numResults

返される結果の数。デフォルトは 25 です。最大数は 500 です。

Type: 整数

有効範囲: 最小値は 0 です。

: 必須 いいえ

recommenderArn

レコメンデーションを取得するために使用するレコメンダーの Amazon リソースネーム (ARN)。ドメインユースケースのレコメンダーを使用してドメインデータセットグループを作成した場合は、レコメンダー ARN を指定します。

Type: 文字列

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

パターン: arn:([a-z\d-]+):personalize:.*:.*:.+

: 必須 いいえ

userId

レコメンデーションを提供するユーザー ID。

では必須USER_PERSONALIZATIONレシピタイプ。

Type: 文字列

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

: 必須 いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "itemList": [ 
      { 
         "itemId": "string",
         "score": number
      }
   ],
   "recommendationId": "string"
}

レスポンス要素

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

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

itemList

予測スコアの降順でソートされたレコメンデーションのリスト。リストの項目は最大 500 個。

Type: の配列PredictedItemオブジェクト

recommendationId

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

Type: 文字列

エラー

InvalidInputException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 404

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

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