Package software.amazon.awssdk.services.personalize.model

Interface CampaignConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CampaignConfig.Builder,CampaignConfig>, SdkBuilder<CampaignConfig.Builder,CampaignConfig>, SdkPojo
Enclosing class:
CampaignConfig
public static interface CampaignConfig.Builder extends SdkPojo, CopyableBuilder<CampaignConfig.Builder,CampaignConfig>

  • Method Details

    • itemExplorationConfig

      CampaignConfig.Builder itemExplorationConfig(Map<String,String> itemExplorationConfig)

      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.

      Parameters:
      itemExplorationConfig - 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:
      Returns a reference to this object so that method calls can be chained together.

    • enableMetadataWithRecommendations

      CampaignConfig.Builder enableMetadataWithRecommendations(Boolean enableMetadataWithRecommendations)

      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.

      Parameters:
      enableMetadataWithRecommendations - 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:
      Returns a reference to this object so that method calls can be chained together.

    • syncWithLatestSolutionVersion

      CampaignConfig.Builder syncWithLatestSolutionVersion(Boolean syncWithLatestSolutionVersion)

      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.

      Parameters:
      syncWithLatestSolutionVersion - 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:
      Returns a reference to this object so that method calls can be chained together.