Class: Aws::CustomerProfiles::Types::RecommenderConfig

Inherits:

Struct

• Object
• Struct
• Aws::CustomerProfiles::Types::RecommenderConfig

Includes:

Structure

Defined in:

lib/aws-sdk-customerprofiles/types.rb

Overview

Configuration settings that define the behavior and parameters of a recommender.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #diversity_config ⇒ Types::DiversityConfig

  Configuration for diversity-aware recommendations.

• #events_config ⇒ Types::EventsConfig

  Configuration settings for how the recommender processes and uses events.

• #excluded_columns ⇒ Hash<String,Array<String>>

  A map of dataset type to a list of column names to exclude from training.

• #included_columns ⇒ Hash<String,Array<String>>

  A map of dataset type to a list of column names to train on.

• #inference_config ⇒ Types::InferenceConfig

  Configuration settings for how the recommender handles inference requests.

• #training_frequency ⇒ Integer

  How often the recommender should retrain its model with new data.

Instance Attribute Details

#diversity_config ⇒ Types::DiversityConfig

Configuration for diversity-aware recommendations. When set, the recommender applies diversity constraints defined per item column to reduce over-concentration of similar items in the results.

Returns:

• (Types::DiversityConfig)

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

class RecommenderConfig < Struct.new(
  :events_config,
  :training_frequency,
  :inference_config,
  :included_columns,
  :excluded_columns,
  :diversity_config)
  SENSITIVE = []
  include Aws::Structure
end

#events_config ⇒ Types::EventsConfig

Configuration settings for how the recommender processes and uses events.

Returns:

• (Types::EventsConfig)

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

class RecommenderConfig < Struct.new(
  :events_config,
  :training_frequency,
  :inference_config,
  :included_columns,
  :excluded_columns,
  :diversity_config)
  SENSITIVE = []
  include Aws::Structure
end

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

A map of dataset type to a list of column names to exclude from training. The _webAnalytics and _catalogItem keys are supported. The column names must be valid columns defined in the recommender schema. All columns in the schema except the listed columns will be used for training. The following columns are mandatory and cannot be excluded: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with IncludedColumns — both cannot be specified in the same request.

Returns:

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

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

class RecommenderConfig < Struct.new(
  :events_config,
  :training_frequency,
  :inference_config,
  :included_columns,
  :excluded_columns,
  :diversity_config)
  SENSITIVE = []
  include Aws::Structure
end

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

A map of dataset type to a list of column names to train on. The _webAnalytics and _catalogItem keys are supported. The column names must be a subset of the columns defined in the recommender schema. If not specified, all columns in the schema are used for training. The following columns are always included in training and do not need to be specified: Item.Id, EventTimestamp, and EventType for _webAnalytics; Id for _catalogItem. Mutually exclusive with ExcludedColumns — both cannot be specified in the same request.

Returns:

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

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

class RecommenderConfig < Struct.new(
  :events_config,
  :training_frequency,
  :inference_config,
  :included_columns,
  :excluded_columns,
  :diversity_config)
  SENSITIVE = []
  include Aws::Structure
end

#inference_config ⇒ Types::InferenceConfig

Configuration settings for how the recommender handles inference requests.

Returns:

• (Types::InferenceConfig)

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

class RecommenderConfig < Struct.new(
  :events_config,
  :training_frequency,
  :inference_config,
  :included_columns,
  :excluded_columns,
  :diversity_config)
  SENSITIVE = []
  include Aws::Structure
end

#training_frequency ⇒ Integer

How often the recommender should retrain its model with new data. If set to 0, automatic retraining will not be enabled.

Returns:

• (Integer)

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

class RecommenderConfig < Struct.new(
  :events_config,
  :training_frequency,
  :inference_config,
  :included_columns,
  :excluded_columns,
  :diversity_config)
  SENSITIVE = []
  include Aws::Structure
end