Class: Aws::Personalize::Types::CampaignConfig

Inherits:

Struct

Object
Struct
Aws::Personalize::Types::CampaignConfig

show all

Defined in:: gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb

Overview

The configuration details of a campaign.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#enable_metadata_with_recommendations ⇒ Boolean
Whether metadata with recommendations is enabled for the campaign.
#item_exploration_config ⇒ Hash<String,String>
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items.

Instance Attribute Details

#enable_metadata_with_recommendations ⇒ `Boolean`

Whether metadata with recommendations is enabled for the campaign. If enabled, you can specify the columns from your Items dataset in your request for recommendations. Amazon Personalize returns this data for each item in the recommendation response. For information about enabling metadata for a campaign, see Enabling metadata in recommendations for a campaign.

If you enable metadata in recommendations, you will incur additional costs. For more information, see Amazon Personalize pricing.

Returns:

(Boolean)

# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 648

class CampaignConfig < Struct.new(
  :item_exploration_config,
  :enable_metadata_with_recommendations)
  SENSITIVE = []
  include Aws::Structure
end

#item_exploration_config ⇒ `Hash<String,String>`

Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.