class Aws::PersonalizeRuntime::Types::GetRecommendationsRequest
@note When making an API call, you may pass GetRecommendationsRequest
data as a hash: { campaign_arn: "Arn", # required item_id: "ItemID", user_id: "UserID", num_results: 1, context: { "AttributeName" => "AttributeValue", }, filter_arn: "Arn", filter_values: { "FilterAttributeName" => "FilterAttributeValue", }, }
@!attribute [rw] campaign_arn
The Amazon Resource Name (ARN) of the campaign to use for getting recommendations. @return [String]
@!attribute [rw] item_id
The item ID to provide recommendations for. Required for `RELATED_ITEMS` recipe type. @return [String]
@!attribute [rw] user_id
The user ID to provide recommendations for. Required for `USER_PERSONALIZATION` recipe type. @return [String]
@!attribute [rw] num_results
The number of results to return. The default is 25. The maximum is 500. @return [Integer]
@!attribute [rw] 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. @return [Hash<String,String>]
@!attribute [rw] filter_arn
The ARN of the filter to apply to the returned recommendations. For more information, see [Filtering Recommendations][1]. When using this parameter, be sure the filter resource is `ACTIVE`. [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html @return [String]
@!attribute [rw] filter_values
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][1]. [1]: https://docs.aws.amazon.com/personalize/latest/dg/filter.html @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
Constants
- SENSITIVE