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

Interface RecommenderConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>, SdkBuilder<RecommenderConfig.Builder,RecommenderConfig>, SdkPojo

Enclosing class:

RecommenderConfig

public static interface RecommenderConfig.Builder
extends SdkPojo, CopyableBuilder<RecommenderConfig.Builder,RecommenderConfig>

Method Summary

Modifier and Type	Method	Description
RecommenderConfig.Builder	enableMetadataWithRecommendations(Boolean enableMetadataWithRecommendations)	Whether metadata with recommendations is enabled for the recommender.
RecommenderConfig.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.
RecommenderConfig.Builder	minRecommendationRequestsPerSecond(Integer minRecommendationRequestsPerSecond)	Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support.
default RecommenderConfig.Builder	trainingDataConfig(Consumer<TrainingDataConfig.Builder> trainingDataConfig)	Specifies the training data configuration to use when creating a domain recommender.
RecommenderConfig.Builder	trainingDataConfig(TrainingDataConfig trainingDataConfig)	Specifies the training data configuration to use when creating a domain recommender.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

itemExplorationConfig

RecommenderConfig.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 recommenders generate personalized recommendations for a user (not popular items or similar items).

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 recommenders generate personalized recommendations for a user (not popular items or similar items).

Returns:

Returns a reference to this object so that method calls can be chained together.

minRecommendationRequestsPerSecond

RecommenderConfig.Builder minRecommendationRequestsPerSecond(Integer minRecommendationRequestsPerSecond)

Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

Parameters:

minRecommendationRequestsPerSecond - Specifies the requested minimum provisioned recommendation requests per second that Amazon Personalize will support. A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond (the default). Track your usage using Amazon CloudWatch metrics, and increase the minRecommendationRequestsPerSecond as necessary.

Returns:

Returns a reference to this object so that method calls can be chained together.

trainingDataConfig

RecommenderConfig.Builder trainingDataConfig(TrainingDataConfig trainingDataConfig)

Specifies the training data configuration to use when creating a domain recommender.

Parameters:

trainingDataConfig - Specifies the training data configuration to use when creating a domain recommender.

Returns:

Returns a reference to this object so that method calls can be chained together.

trainingDataConfig

default RecommenderConfig.Builder trainingDataConfig(Consumer<TrainingDataConfig.Builder> trainingDataConfig)

Specifies the training data configuration to use when creating a domain recommender.

This is a convenience method that creates an instance of the TrainingDataConfig.Builder avoiding the need to create one manually via TrainingDataConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to trainingDataConfig(TrainingDataConfig).

Parameters:

trainingDataConfig - a consumer that will call methods on TrainingDataConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

trainingDataConfig(TrainingDataConfig)

enableMetadataWithRecommendations

RecommenderConfig.Builder enableMetadataWithRecommendations(Boolean enableMetadataWithRecommendations)

Whether metadata with recommendations is enabled for the recommender. 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.

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

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.