Interface StartBatchEvaluationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<StartBatchEvaluationRequest.Builder,StartBatchEvaluationRequest>, SdkBuilder<StartBatchEvaluationRequest.Builder,StartBatchEvaluationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartBatchEvaluationRequest

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

Method Summary

Modifier and Type	Method	Description
StartBatchEvaluationRequest.Builder	batchEvaluationName(String batchEvaluationName)	The name of the batch evaluation.
StartBatchEvaluationRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
default StartBatchEvaluationRequest.Builder	dataSourceConfig(Consumer<DataSourceConfig.Builder> dataSourceConfig)	The data source configuration that specifies where to pull agent session traces from for evaluation.
StartBatchEvaluationRequest.Builder	dataSourceConfig(DataSourceConfig dataSourceConfig)	The data source configuration that specifies where to pull agent session traces from for evaluation.
StartBatchEvaluationRequest.Builder	description(String description)	The description of the batch evaluation.
default StartBatchEvaluationRequest.Builder	evaluationMetadata(Consumer<EvaluationMetadata.Builder> evaluationMetadata)	Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.
StartBatchEvaluationRequest.Builder	evaluationMetadata(EvaluationMetadata evaluationMetadata)	Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.
StartBatchEvaluationRequest.Builder	evaluators(Collection<Evaluator> evaluators)	The list of evaluators to apply during the batch evaluation.
StartBatchEvaluationRequest.Builder	evaluators(Consumer<Evaluator.Builder>... evaluators)	The list of evaluators to apply during the batch evaluation.
StartBatchEvaluationRequest.Builder	evaluators(Evaluator... evaluators)	The list of evaluators to apply during the batch evaluation.
StartBatchEvaluationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartBatchEvaluationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest.Builder

build

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

batchEvaluationName

StartBatchEvaluationRequest.Builder batchEvaluationName(String batchEvaluationName)

The name of the batch evaluation. Must be unique within your account.

Parameters:

batchEvaluationName - The name of the batch evaluation. Must be unique within your account.

Returns:

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

evaluators

StartBatchEvaluationRequest.Builder evaluators(Collection<Evaluator> evaluators)

The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

Parameters:

evaluators - The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

Returns:

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

evaluators

StartBatchEvaluationRequest.Builder evaluators(Evaluator... evaluators)

The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

Parameters:

evaluators - The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

Returns:

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

evaluators

StartBatchEvaluationRequest.Builder evaluators(Consumer<Evaluator.Builder>... evaluators)

The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

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

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

Parameters:

evaluators - a consumer that will call methods on Evaluator.Builder

Returns:

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

See Also:

• evaluators(java.util.Collection<Evaluator>)

dataSourceConfig

StartBatchEvaluationRequest.Builder dataSourceConfig(DataSourceConfig dataSourceConfig)

The data source configuration that specifies where to pull agent session traces from for evaluation.

Parameters:

dataSourceConfig - The data source configuration that specifies where to pull agent session traces from for evaluation.

Returns:

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

dataSourceConfig

default StartBatchEvaluationRequest.Builder dataSourceConfig(Consumer<DataSourceConfig.Builder> dataSourceConfig)

The data source configuration that specifies where to pull agent session traces from for evaluation.

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

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

Parameters:

dataSourceConfig - a consumer that will call methods on DataSourceConfig.Builder

Returns:

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

See Also:

• dataSourceConfig(DataSourceConfig)

clientToken

StartBatchEvaluationRequest.Builder clientToken(String clientToken)

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

Parameters:

clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

Returns:

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

evaluationMetadata

StartBatchEvaluationRequest.Builder evaluationMetadata(EvaluationMetadata evaluationMetadata)

Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.

Parameters:

evaluationMetadata - Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.

Returns:

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

evaluationMetadata

default StartBatchEvaluationRequest.Builder evaluationMetadata(Consumer<EvaluationMetadata.Builder> evaluationMetadata)

Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.

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

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

Parameters:

evaluationMetadata - a consumer that will call methods on EvaluationMetadata.Builder

Returns:

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

See Also:

• evaluationMetadata(EvaluationMetadata)

description

StartBatchEvaluationRequest.Builder description(String description)

The description of the batch evaluation.

Parameters:

description - The description of the batch evaluation.

Returns:

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

overrideConfiguration

StartBatchEvaluationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartBatchEvaluationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.