Getting item metadata with recommendations - Amazon Personalize
Including item metadata with recommendations (Amazon CLI)Including item metadata with recommendations (Amazon SDKs)
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Getting item metadata with recommendations

If you configured your campaign or recommender to return metadata for recommended items, you can specify the columns to include in your GetRecommendations API operation. Or you can specify the columns when you test the campaign with the Amazon Personalize console.

For information about enabling metadata for a campaign, see Item metadata in recommendations. For information about enabling metadata for a recommender, see Enabling metadata in recommendations for a domain recommender in Amazon Personalize.

The following code samples show how to specify the metadata columns to include with the Amazon CLI or the Amazon SDKs. To do this with the Amazon Personalize console, you specify the columns when you test your campaign. For more information, see Getting item recommendations (console).

Including item metadata with recommendations (Amazon CLI)

If you enabled metadata in recommendations for your campaign or recommender, you can specify the Items dataset metadata columns to include in the response. The following code sample shows how to specify the metadata columns as part of your request for recommendations.

aws personalize-runtime get-recommendations \
--campaign-arn campaign arn \
--user-id User ID \
--num-results 10 \
--metadata-columns "{\"ITEMS\": ["\"columnNameA"\","\"columnNameB"\"]}"

Including item metadata with recommendations (Amazon SDKs)

If you enabled metadata in recommendations for your campaign or recommender, you can specify the Items dataset metadata columns to include in the response. The following code sample shows how to specify the metadata columns as part of your request for recommendations.

import boto3

personalizeRt = boto3.client('personalize-runtime')

response = personalizeRt.get_recommendations(
  campaignArn = 'Campaign ARN',
  userId = 'User ID',
  numResults = 10
  metadataColumns = {
    "ITEMS": ['columnNameA','columnNameB']
  }
)

print("Recommended items")
for item in response['itemList']:
  print(item['itemId'])
  print(item['metadata'])