Class: Aws::PersonalizeRuntime::Types::GetRecommendationsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-personalizeruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:context, :filter_values]

Instance Attribute Summary collapse

Instance Attribute Details

#campaign_arn ⇒ String

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

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#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>) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#filter_arn ⇒ String

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

[1]: docs.aws.amazon.com/personalize/latest/dg/filter.html

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#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 and user segments].

[1]: docs.aws.amazon.com/personalize/latest/dg/filter.html

Returns:

  • (Hash<String,String>) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#item_id ⇒ String

The item ID to provide recommendations for.

Required for ‘RELATED_ITEMS` recipe type.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#metadata_columns ⇒ Hash<String,Array<String>>

If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations. The map key is ‘ITEMS` and the value is a list of column names from your Items dataset. The maximum number of columns you can provide is 10.

For information about enabling metadata for a campaign, see [Enabling metadata in recommendations for a campaign]. For information about enabling metadata for a recommender, see [Enabling metadata in recommendations for a recommender].

[1]: docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata [2]: docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata

Returns:

  • (Hash<String,Array<String>>) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#num_results ⇒ Integer

The number of results to return. The default is 25. If you are including metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.

Returns:

  • (Integer) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#promotions ⇒ Array<Types::Promotion>

The promotions to apply to the recommendation request. A promotion defines additional business rules that apply to a configurable subset of recommended items.

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#recommender_arn ⇒ String

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end

#user_id ⇒ String

The user ID to provide recommendations for.

Required for ‘USER_PERSONALIZATION` recipe type.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/aws-sdk-personalizeruntime/types.rb', line 294

class GetRecommendationsRequest < Struct.new(
  :campaign_arn,
  :item_id,
  :user_id,
  :num_results,
  :context,
  :filter_arn,
  :filter_values,
  :recommender_arn,
  :promotions,
  :metadata_columns)
  SENSITIVE = [:context, :filter_values]
  include Aws::Structure
end