Class: Aws::CustomerProfiles::Types::GetProfileRecommendationsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:context]

Instance Attribute Summary collapse

Instance Attribute Details

#candidate_ids ⇒ Array<String>

A list of item IDs to rank for the user. Use this when you want to re-rank a specific set of items rather than getting recommendations from the full item catalog. Required for personalized-ranking use cases.

Returns:

  • (Array<String>) 


4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#context ⇒ Hash<String,String>

The contextual metadata used to provide dynamic runtime information to tailor recommendations.

Returns:

  • (Hash<String,String>) 


4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of recommendations to return. The default value is 10.

Returns:

  • (Integer) 


4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#metadata_config ⇒ Types::MetadataConfig

Configuration for including item metadata in the recommendation response. Use this to specify which metadata columns to return alongside recommended items.

Returns:



4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#profile_id ⇒ String

The unique identifier of the profile for which to retrieve recommendations.

Returns:

  • (String) 


4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#recommender_filters ⇒ Array<Types::RecommenderFilter>

A list of filters to apply to the returned recommendations. Filters define criteria for including or excluding items from the recommendation results.

Returns:



4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#recommender_name ⇒ String

The unique name of the recommender.

Returns:

  • (String) 


4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end

#recommender_promotional_filters ⇒ Array<Types::RecommenderPromotionalFilter>

A list of promotional filters to apply to the recommendations. Promotional filters allow you to promote specific items within a configurable subset of recommendation results.

Returns:



4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4606

class GetProfileRecommendationsRequest < Struct.new(
  :domain_name,
  :profile_id,
  :recommender_name,
  :context,
  :recommender_filters,
  :recommender_promotional_filters,
  :candidate_ids,
  :max_results,
  :metadata_config)
  SENSITIVE = [:context]
  include Aws::Structure
end