Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

personalizeruntime_get_recommendations

Returns a list of recommended items


Description

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 API.

Usage

personalizeruntime_get_recommendations(campaignArn, itemId, userId,
  numResults, context, filterArn, filterValues)

Arguments

campaignArn

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

itemId

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

userId

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

numResults

The number of results to return. The default is 25. The maximum is 500.

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.

filterArn

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

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

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.

For more information, see Filtering Recommendations.

Value

A list with the following syntax:

list(
  itemList = list(
    list(
      itemId = "string",
      score = 123.0
    )
  ),
  recommendationId = "string"
)

Request syntax

svc$get_recommendations(
  campaignArn = "string",
  itemId = "string",
  userId = "string",
  numResults = 123,
  context = list(
    "string"
  ),
  filterArn = "string",
  filterValues = list(
    "string"
  )
)

paws.machine.learning

Amazon Web Services Machine Learning Services

v0.1.11
Apache License (>= 2.0)
Authors
David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.