Class: Aws::CustomerProfiles::Types::SearchRecommendationsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CustomerProfiles::Types::SearchRecommendationsRequest

Defined in:

gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:key_values, :context]

Instance Attribute Summary

• #candidate_ids ⇒ Array<String>

  A list of item IDs to rank for the user.

• #context ⇒ Hash<String,String>

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

• #diversity ⇒ Types::RecommendationDiversityConfig

  Runtime diversity configuration for this request.

• #domain_name ⇒ String

  The unique name of the domain.

• #key_name ⇒ String

  A searchable identifier of a customer profile.

• #key_values ⇒ Array<String>

  A list of key values.

• #max_recommendations ⇒ Integer

  The maximum number of recommendations to return.

• #metadata ⇒ Types::RecommendationMetadata

  Configuration for metadata to include in recommendation responses.

• #recommender ⇒ Types::Recommender

  The recommender used to generate the recommendations.

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

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :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>)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end

#diversity ⇒ Types::RecommendationDiversityConfig

Runtime diversity configuration for this request. Enables diversity-aware recommendations and optionally supplies values for placeholder-based diversity caps configured on the recommender.

Returns:

• (Types::RecommendationDiversityConfig)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end

#domain_name ⇒ String

The unique name of the domain.

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end

#key_name ⇒ String

A searchable identifier of a customer profile. You can use a predefined key, such as _profileId, _phone, or _email, or a custom-defined key.

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end

#key_values ⇒ Array<String>

A list of key values. Provide one value for each field of the search key.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end

#max_recommendations ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end

#metadata ⇒ Types::RecommendationMetadata

Configuration for metadata to include in recommendation responses.

Returns:

• (Types::RecommendationMetadata)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end

#recommender ⇒ Types::Recommender

The recommender used to generate the recommendations.

Returns:

• (Types::Recommender)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 10182

class SearchRecommendationsRequest < Struct.new(
  :domain_name,
  :key_name,
  :key_values,
  :recommender,
  :candidate_ids,
  :context,
  :diversity,
  :metadata,
  :max_recommendations)
  SENSITIVE = [:key_values, :context]
  include Aws::Structure
end