You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PersonalizeRuntime::Types::GetPersonalizedRankingRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetPersonalizedRankingRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  campaign_arn: "Arn", # required
  input_list: ["ItemID"], # required
  user_id: "UserID", # required
  context: {
    "AttributeName" => "AttributeValue",
  },
  filter_arn: "Arn",
  filter_values: {
    "FilterAttributeName" => "FilterAttributeValue",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_arn ⇒ String

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

#context ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    The contextual metadata to use when getting recommendations.

#filter_arn ⇒ String

The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.

#filter_values ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    The values to use when filtering recommendations.

#input_list ⇒ Array<String>

A list of items (by itemId) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list. The maximum is 500.

Returns:

  • (Array<String>) —

    A list of items (by itemId) to rank.

#user_id ⇒ String

The user for which you want the campaign to provide a personalized ranking.

Returns:

  • (String) —

    The user for which you want the campaign to provide a personalized ranking.