Interface CreateEvaluationJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockRequest.Builder, Buildable, CopyableBuilder<CreateEvaluationJobRequest.Builder,CreateEvaluationJobRequest>, SdkBuilder<CreateEvaluationJobRequest.Builder,CreateEvaluationJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateEvaluationJobRequest

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

Method Summary

Modifier and Type	Method	Description
CreateEvaluationJobRequest.Builder	applicationType(String applicationType)	Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
CreateEvaluationJobRequest.Builder	applicationType(ApplicationType applicationType)	Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
CreateEvaluationJobRequest.Builder	clientRequestToken(String clientRequestToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateEvaluationJobRequest.Builder	customerEncryptionKeyId(String customerEncryptionKeyId)	Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.
default CreateEvaluationJobRequest.Builder	evaluationConfig(Consumer<EvaluationConfig.Builder> evaluationConfig)	Contains the configuration details of either an automated or human-based evaluation job.
CreateEvaluationJobRequest.Builder	evaluationConfig(EvaluationConfig evaluationConfig)	Contains the configuration details of either an automated or human-based evaluation job.
default CreateEvaluationJobRequest.Builder	inferenceConfig(Consumer<EvaluationInferenceConfig.Builder> inferenceConfig)	Contains the configuration details of the inference model for the evaluation job.
CreateEvaluationJobRequest.Builder	inferenceConfig(EvaluationInferenceConfig inferenceConfig)	Contains the configuration details of the inference model for the evaluation job.
CreateEvaluationJobRequest.Builder	jobDescription(String jobDescription)	A description of the evaluation job.
CreateEvaluationJobRequest.Builder	jobName(String jobName)	A name for the evaluation job.
CreateEvaluationJobRequest.Builder	jobTags(Collection<Tag> jobTags)	Tags to attach to the model evaluation job.
CreateEvaluationJobRequest.Builder	jobTags(Consumer<Tag.Builder>... jobTags)	Tags to attach to the model evaluation job.
CreateEvaluationJobRequest.Builder	jobTags(Tag... jobTags)	Tags to attach to the model evaluation job.
default CreateEvaluationJobRequest.Builder	outputDataConfig(Consumer<EvaluationOutputDataConfig.Builder> outputDataConfig)	Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.
CreateEvaluationJobRequest.Builder	outputDataConfig(EvaluationOutputDataConfig outputDataConfig)	Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.
CreateEvaluationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateEvaluationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateEvaluationJobRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrock.model.BedrockRequest.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

jobName

CreateEvaluationJobRequest.Builder jobName(String jobName)

A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

Parameters:

jobName - A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

Returns:

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

jobDescription

CreateEvaluationJobRequest.Builder jobDescription(String jobDescription)

A description of the evaluation job.

Parameters:

jobDescription - A description of the evaluation job.

Returns:

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

clientRequestToken

CreateEvaluationJobRequest.Builder clientRequestToken(String clientRequestToken)

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

Parameters:

clientRequestToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

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

roleArn

CreateEvaluationJobRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

Returns:

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

customerEncryptionKeyId

CreateEvaluationJobRequest.Builder customerEncryptionKeyId(String customerEncryptionKeyId)

Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

Parameters:

customerEncryptionKeyId - Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

Returns:

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

jobTags

CreateEvaluationJobRequest.Builder jobTags(Collection<Tag> jobTags)

Tags to attach to the model evaluation job.

Parameters:

jobTags - Tags to attach to the model evaluation job.

Returns:

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

jobTags

CreateEvaluationJobRequest.Builder jobTags(Tag... jobTags)

Tags to attach to the model evaluation job.

Parameters:

jobTags - Tags to attach to the model evaluation job.

Returns:

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

jobTags

CreateEvaluationJobRequest.Builder jobTags(Consumer<Tag.Builder>... jobTags)

Tags to attach to the model evaluation job.

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

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

Parameters:

jobTags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• jobTags(java.util.Collection<Tag>)

applicationType

CreateEvaluationJobRequest.Builder applicationType(String applicationType)

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Parameters:

applicationType - Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Returns:

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

See Also:

• ApplicationType
• ApplicationType

applicationType

CreateEvaluationJobRequest.Builder applicationType(ApplicationType applicationType)

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Parameters:

applicationType - Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Returns:

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

See Also:

• ApplicationType
• ApplicationType

evaluationConfig

CreateEvaluationJobRequest.Builder evaluationConfig(EvaluationConfig evaluationConfig)

Contains the configuration details of either an automated or human-based evaluation job.

Parameters:

evaluationConfig - Contains the configuration details of either an automated or human-based evaluation job.

Returns:

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

evaluationConfig

default CreateEvaluationJobRequest.Builder evaluationConfig(Consumer<EvaluationConfig.Builder> evaluationConfig)

Contains the configuration details of either an automated or human-based evaluation job.

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

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

Parameters:

evaluationConfig - a consumer that will call methods on EvaluationConfig.Builder

Returns:

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

See Also:

• evaluationConfig(EvaluationConfig)

inferenceConfig

CreateEvaluationJobRequest.Builder inferenceConfig(EvaluationInferenceConfig inferenceConfig)

Contains the configuration details of the inference model for the evaluation job.

For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

Parameters:

inferenceConfig - Contains the configuration details of the inference model for the evaluation job.

For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

Returns:

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

inferenceConfig

default CreateEvaluationJobRequest.Builder inferenceConfig(Consumer<EvaluationInferenceConfig.Builder> inferenceConfig)

Contains the configuration details of the inference model for the evaluation job.

For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

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

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

Parameters:

inferenceConfig - a consumer that will call methods on EvaluationInferenceConfig.Builder

Returns:

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

See Also:

• inferenceConfig(EvaluationInferenceConfig)

outputDataConfig

CreateEvaluationJobRequest.Builder outputDataConfig(EvaluationOutputDataConfig outputDataConfig)

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

Parameters:

outputDataConfig - Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

Returns:

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

outputDataConfig

default CreateEvaluationJobRequest.Builder outputDataConfig(Consumer<EvaluationOutputDataConfig.Builder> outputDataConfig)

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

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

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

Parameters:

outputDataConfig - a consumer that will call methods on EvaluationOutputDataConfig.Builder

Returns:

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

See Also:

• outputDataConfig(EvaluationOutputDataConfig)

overrideConfiguration

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

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