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

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

GetRecommendations

Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:

  • RELATED_ITEMS - itemId required, userId not used

  • USER_PERSONALIZATION - itemId optional, userId required

注記

Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the GetPersonalizedRanking API.

リクエストの構文

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

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

URI Request Parameters

The request does not use any URI parameters.

リクエストボディ

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

campaignArn

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

タイプ: 文字列

Length Constraints: 最大長は 256 です。

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

Required: はい

context

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

タイプ: String to string map

Map Entries: Maximum number of 150 items.

Key Length Constraints: Maximum length of 150.

Key Pattern: [A-Za-z\d_]+

Value Length Constraints: Maximum length of 1000.

Required: いいえ

filterArn

The ARN of the filter to apply to the returned recommendations. 詳細については、「レコメンデーションのフィルタリング」を参照してください。

When using this parameter, be sure the filter resource is ACTIVE.

タイプ: 文字列

Length Constraints: 最大長は 256 です。

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

Required: いいえ

filterValues

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

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

タイプ: String to string map

Map Entries: Maximum number of 25 items.

Key Length Constraints: 最大長は 50 です。

Key Pattern: [A-Za-z0-9]+

Value Length Constraints: Maximum length of 1000.

Required: いいえ

itemId

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

タイプ: 文字列

Length Constraints: 最大長は 256 です。

Required: いいえ

numResults

The number of results to return. デフォルトは 25 です。The maximum is 500.

タイプ: 整数

Valid Range: Minimum value of 0.

Required: いいえ

userId

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

タイプ: 文字列

Length Constraints: 最大長は 256 です。

Required: いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

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

レスポンス要素

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

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

itemList

A list of recommendations sorted in ascending order by prediction score. There can be a maximum of 500 items in the list.

タイプ: Array of PredictedItem objects

recommendationId

The ID of the recommendation.

タイプ: 文字列

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

ResourceNotFoundException

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

HTTP Status Code: 404

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

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