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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-personalize/types.rb

Overview

The configuration details of a campaign.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #sync_with_latest_solution_version ⇒ Boolean

  Whether the campaign automatically updates to use the latest solution version (trained model) of a solution.

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

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

Returns:

• (Boolean)

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

class CampaignConfig < Struct.new(
  :item_exploration_config,
  :enable_metadata_with_recommendations,
  :sync_with_latest_solution_version)
  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.

[1]: docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html

Returns:

• (Hash<String,String>)

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

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

#sync_with_latest_solution_version ⇒ Boolean

Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify ‘True`, you must specify the ARN of your solution for the `SolutionVersionArn` parameter. It must be in `SolutionArn/$LATEST` format. The default is `False` and you must manually update the campaign to deploy the latest solution version.

For more information about automatic campaign updates, see [Enabling automatic campaign updates].

[1]: docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update

Returns:

• (Boolean)

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

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