翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetActionRecommendations
予測スコアで降順にソートされたレコメンデーションアクションのリストを返します。PERSONALIZED_ACTIONS レシピでトレーニングされたソリューションバージョンをデプロイするカスタムキャンペーンがある場合は、GetActionRecommendations
API を使用してください。
PERSONALIZED_ACTIONS レシピの詳細については、「PERSONALIZED_ACTIONS recipes」を参照してください。アクションレコメンデーションの取得については、「Getting action recommendations」を参照してください。
リクエストの構文
POST /action-recommendations HTTP/1.1
Content-type: application/json
{
"campaignArn": "string
",
"filterArn": "string
",
"filterValues": {
"string
" : "string
"
},
"numResults": number
,
"userId": "string
"
}
URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- campaignArn
-
アクションレコメンデーションの取得に使用するキャンペーンの Amazon リソースネーム (ARN)。このキャンペーンでは、PERSONALIZED_ACTIONS レシピでトレーニングされたソリューションバージョンをデプロイする必要があります。
型: 文字列
長さの制限:最大長は 256 です。
パターン:
arn:([a-z\d-]+):personalize:.*:.*:.+
必須: いいえ
- filterArn
-
返されたレコメンデーションに適用するフィルターの ARN。詳細については、「レコメンデーションのフィルタリング」を参照してください。
このパラメータを使用するときは、フィルターのリソースが
ACTIVE
であることを確認してください。型: 文字列
長さの制限:最大長は 256 です。
パターン:
arn:([a-z\d-]+):personalize:.*:.*:.+
必須: いいえ
- filterValues
-
レコメンデーションをフィルタリングするときに使用する値。フィルター式の各プレースホルダーパラメータについて、(大文字と小文字が一致した状態で) パラメータ名をキーとして指定し、フィルター値を対応する値として指定します。1 つのパラメータの複数の値をコンマで区切ります。
INCLUDE
要素を使用してアクションを含めるフィルター式について、式で定義されているすべてのパラメータの値を指定する必要があります。EXCLUDE
要素を使用してアクションを除外する式を含むフィルターについては、filter-values
を省略できます。この場合、Amazon Personalize は、式のその部分を使用してレコメンデーションをフィルタリングしません。詳細については、「レコメンデーションとユーザーセグメントのフィルタリング」を参照してください。
型: 文字列間のマッピング
マップエントリ: アイテムの最大数は 25 です。
キーの長さの制限: 最大長は 50 です。
キーパターン:
[A-Za-z0-9_]+
値の長さの制限: 最大長は 1000 です。
必須: いいえ
- numResults
-
返される結果の数。デフォルトは 5 です。最大は 100 です。
タイプ: 整数
値の範囲: 最小値 は 0 です。
必須: いいえ
- userId
-
アクションレコメンデーションを提供するユーザーのユーザー ID。
型: 文字列
長さの制限:最大長は 256 です。
必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"actionList": [
{
"actionId": "string",
"score": number
}
],
"recommendationId": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- actionList
-
予測スコアで降順にソートされたアクションレコメンデーションのリスト。リストには最大 100 個のアクションを含めることができます。アクションスコアの詳細については、「How action recommendation scoring works」を参照してください。
型: PredictedAction オブジェクトの配列
- recommendationId
-
レコメンデーションの ID。
型: 文字列
エラー
- InvalidInputException
-
フィールドまたはパラメータに有効な値を指定します。
HTTP ステータスコード:400
- ResourceNotFoundException
-
指定されたリソースは存在しません。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDK でこの API を使用する方法の詳細については、以下を参照してください。