Interface AutomatedEvaluationConfig.Builder

All Superinterfaces:

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

Enclosing class:

AutomatedEvaluationConfig

@Mutable
@NotThreadSafe
public static interface AutomatedEvaluationConfig.Builder
extends SdkPojo, CopyableBuilder<AutomatedEvaluationConfig.Builder,AutomatedEvaluationConfig>

Method Summary

Modifier and Type	Method	Description
default AutomatedEvaluationConfig.Builder	customMetricConfig(Consumer<AutomatedEvaluationCustomMetricConfig.Builder> customMetricConfig)	Defines the configuration of custom metrics to be used in an evaluation job.
AutomatedEvaluationConfig.Builder	customMetricConfig(AutomatedEvaluationCustomMetricConfig customMetricConfig)	Defines the configuration of custom metrics to be used in an evaluation job.
AutomatedEvaluationConfig.Builder	datasetMetricConfigs(Collection<EvaluationDatasetMetricConfig> datasetMetricConfigs)	Configuration details of the prompt datasets and metrics you want to use for your evaluation job.
AutomatedEvaluationConfig.Builder	datasetMetricConfigs(Consumer<EvaluationDatasetMetricConfig.Builder>... datasetMetricConfigs)	Configuration details of the prompt datasets and metrics you want to use for your evaluation job.
AutomatedEvaluationConfig.Builder	datasetMetricConfigs(EvaluationDatasetMetricConfig... datasetMetricConfigs)	Configuration details of the prompt datasets and metrics you want to use for your evaluation job.
default AutomatedEvaluationConfig.Builder	evaluatorModelConfig(Consumer<EvaluatorModelConfig.Builder> evaluatorModelConfig)	Contains the evaluator model configuration details.
AutomatedEvaluationConfig.Builder	evaluatorModelConfig(EvaluatorModelConfig evaluatorModelConfig)	Contains the evaluator model configuration details.

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, sdkFieldNameToField, sdkFields

Method Details

datasetMetricConfigs

AutomatedEvaluationConfig.Builder datasetMetricConfigs(Collection<EvaluationDatasetMetricConfig> datasetMetricConfigs)

Configuration details of the prompt datasets and metrics you want to use for your evaluation job.

Parameters:

datasetMetricConfigs - Configuration details of the prompt datasets and metrics you want to use for your evaluation job.

Returns:

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

datasetMetricConfigs

AutomatedEvaluationConfig.Builder datasetMetricConfigs(EvaluationDatasetMetricConfig... datasetMetricConfigs)

Configuration details of the prompt datasets and metrics you want to use for your evaluation job.

Parameters:

datasetMetricConfigs - Configuration details of the prompt datasets and metrics you want to use for your evaluation job.

Returns:

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

datasetMetricConfigs

AutomatedEvaluationConfig.Builder datasetMetricConfigs(Consumer<EvaluationDatasetMetricConfig.Builder>... datasetMetricConfigs)

Configuration details of the prompt datasets and metrics you want to use for your evaluation job.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to datasetMetricConfigs(List<EvaluationDatasetMetricConfig>).

Parameters:

datasetMetricConfigs - a consumer that will call methods on EvaluationDatasetMetricConfig.Builder

Returns:

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

See Also:

• datasetMetricConfigs(java.util.Collection<EvaluationDatasetMetricConfig>)

evaluatorModelConfig

AutomatedEvaluationConfig.Builder evaluatorModelConfig(EvaluatorModelConfig evaluatorModelConfig)

Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

Parameters:

evaluatorModelConfig - Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

Returns:

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

evaluatorModelConfig

default AutomatedEvaluationConfig.Builder evaluatorModelConfig(Consumer<EvaluatorModelConfig.Builder> evaluatorModelConfig)

Contains the evaluator model configuration details. EvaluatorModelConfig is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.

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

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

Parameters:

evaluatorModelConfig - a consumer that will call methods on EvaluatorModelConfig.Builder

Returns:

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

See Also:

• evaluatorModelConfig(EvaluatorModelConfig)

customMetricConfig

AutomatedEvaluationConfig.Builder customMetricConfig(AutomatedEvaluationCustomMetricConfig customMetricConfig)

Defines the configuration of custom metrics to be used in an evaluation job.

Parameters:

customMetricConfig - Defines the configuration of custom metrics to be used in an evaluation job.

Returns:

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

customMetricConfig

default AutomatedEvaluationConfig.Builder customMetricConfig(Consumer<AutomatedEvaluationCustomMetricConfig.Builder> customMetricConfig)

Defines the configuration of custom metrics to be used in an evaluation job.

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

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

Parameters:

customMetricConfig - a consumer that will call methods on AutomatedEvaluationCustomMetricConfig.Builder

Returns:

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

See Also:

• customMetricConfig(AutomatedEvaluationCustomMetricConfig)