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

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

Overview

The configuration details of a campaign.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 712

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

Returns:

  • (Hash<String,String>) 


712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 712

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

#ranking_influence ⇒ Hash<String,Float>

A map of ranking influence values for POPULARITY and FRESHNESS. For each key, specify a numerical value between 0.0 and 1.0 that determines how much influence that ranking factor has on the final recommendations. A value closer to 1.0 gives more weight to the factor, while a value closer to 0.0 reduces its influence.

Returns:

  • (Hash<String,Float>) 


712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 712

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

Returns:

  • (Boolean) 


712
713
714
715
716
717
718
719
 
# File 'gems/aws-sdk-personalize/lib/aws-sdk-personalize/types.rb', line 712

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