Interface CreateAdvancedPromptOptimizationJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateAdvancedPromptOptimizationJobRequest

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

Method Summary

Modifier and Type	Method	Description
CreateAdvancedPromptOptimizationJobRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateAdvancedPromptOptimizationJobRequest.Builder	encryptionKeyArn(String encryptionKeyArn)	The Amazon Resource Name (ARN) of the KMS key used for encrypting the output data.
default CreateAdvancedPromptOptimizationJobRequest.Builder	inputConfig(Consumer<AdvancedPromptOptimizationInputConfig.Builder> inputConfig)	Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.
CreateAdvancedPromptOptimizationJobRequest.Builder	inputConfig(AdvancedPromptOptimizationInputConfig inputConfig)	Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.
CreateAdvancedPromptOptimizationJobRequest.Builder	jobDescription(String jobDescription)	A description of the advanced prompt optimization job.
CreateAdvancedPromptOptimizationJobRequest.Builder	jobName(String jobName)	A name for the advanced prompt optimization job.
CreateAdvancedPromptOptimizationJobRequest.Builder	modelConfigurations(Collection<ModelConfiguration> modelConfigurations)	A list of model configurations specifying the target models for prompt optimization.
CreateAdvancedPromptOptimizationJobRequest.Builder	modelConfigurations(Consumer<ModelConfiguration.Builder>... modelConfigurations)	A list of model configurations specifying the target models for prompt optimization.
CreateAdvancedPromptOptimizationJobRequest.Builder	modelConfigurations(ModelConfiguration... modelConfigurations)	A list of model configurations specifying the target models for prompt optimization.
default CreateAdvancedPromptOptimizationJobRequest.Builder	outputConfig(Consumer<AdvancedPromptOptimizationOutputConfig.Builder> outputConfig)	Specifies the S3 location where optimization results will be stored.
CreateAdvancedPromptOptimizationJobRequest.Builder	outputConfig(AdvancedPromptOptimizationOutputConfig outputConfig)	Specifies the S3 location where optimization results will be stored.
CreateAdvancedPromptOptimizationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAdvancedPromptOptimizationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateAdvancedPromptOptimizationJobRequest.Builder	tags(Collection<Tag> tags)	Tags to associate with the advanced prompt optimization job.
CreateAdvancedPromptOptimizationJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Tags to associate with the advanced prompt optimization job.
CreateAdvancedPromptOptimizationJobRequest.Builder	tags(Tag... tags)	Tags to associate with the advanced prompt optimization job.

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

CreateAdvancedPromptOptimizationJobRequest.Builder jobName(String jobName)

A name for the advanced prompt optimization job.

Parameters:

jobName - A name for the advanced prompt optimization job.

Returns:

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

jobDescription

CreateAdvancedPromptOptimizationJobRequest.Builder jobDescription(String jobDescription)

A description of the advanced prompt optimization job.

Parameters:

jobDescription - A description of the advanced prompt optimization job.

Returns:

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

clientToken

CreateAdvancedPromptOptimizationJobRequest.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, Amazon Bedrock 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, Amazon Bedrock ignores the request but does not return an error.

Returns:

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

inputConfig

CreateAdvancedPromptOptimizationJobRequest.Builder inputConfig(AdvancedPromptOptimizationInputConfig inputConfig)

Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.

Parameters:

inputConfig - Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.

Returns:

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

inputConfig

default CreateAdvancedPromptOptimizationJobRequest.Builder inputConfig(Consumer<AdvancedPromptOptimizationInputConfig.Builder> inputConfig)

Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.

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

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

Parameters:

inputConfig - a consumer that will call methods on AdvancedPromptOptimizationInputConfig.Builder

Returns:

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

See Also:

• inputConfig(AdvancedPromptOptimizationInputConfig)

outputConfig

CreateAdvancedPromptOptimizationJobRequest.Builder outputConfig(AdvancedPromptOptimizationOutputConfig outputConfig)

Specifies the S3 location where optimization results will be stored.

Parameters:

outputConfig - Specifies the S3 location where optimization results will be stored.

Returns:

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

outputConfig

default CreateAdvancedPromptOptimizationJobRequest.Builder outputConfig(Consumer<AdvancedPromptOptimizationOutputConfig.Builder> outputConfig)

Specifies the S3 location where optimization results will be stored.

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

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

Parameters:

outputConfig - a consumer that will call methods on AdvancedPromptOptimizationOutputConfig.Builder

Returns:

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

See Also:

• outputConfig(AdvancedPromptOptimizationOutputConfig)

encryptionKeyArn

CreateAdvancedPromptOptimizationJobRequest.Builder encryptionKeyArn(String encryptionKeyArn)

The Amazon Resource Name (ARN) of the KMS key used for encrypting the output data. If not specified, the output is encrypted with an Amazon-owned KMS key.

Parameters:

encryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key used for encrypting the output data. If not specified, the output is encrypted with an Amazon-owned KMS key.

Returns:

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

tags

CreateAdvancedPromptOptimizationJobRequest.Builder tags(Collection<Tag> tags)

Tags to associate with the advanced prompt optimization job.

Parameters:

tags - Tags to associate with the advanced prompt optimization job.

Returns:

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

tags

CreateAdvancedPromptOptimizationJobRequest.Builder tags(Tag... tags)

Tags to associate with the advanced prompt optimization job.

Parameters:

tags - Tags to associate with the advanced prompt optimization job.

Returns:

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

tags

CreateAdvancedPromptOptimizationJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

Tags to associate with the advanced prompt optimization 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 tags(List<Tag>).

Parameters:

tags - 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:

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

modelConfigurations

CreateAdvancedPromptOptimizationJobRequest.Builder modelConfigurations(Collection<ModelConfiguration> modelConfigurations)

A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.

Parameters:

modelConfigurations - A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.

Returns:

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

modelConfigurations

CreateAdvancedPromptOptimizationJobRequest.Builder modelConfigurations(ModelConfiguration... modelConfigurations)

A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.

Parameters:

modelConfigurations - A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.

Returns:

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

modelConfigurations

CreateAdvancedPromptOptimizationJobRequest.Builder modelConfigurations(Consumer<ModelConfiguration.Builder>... modelConfigurations)

A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.

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

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

Parameters:

modelConfigurations - a consumer that will call methods on ModelConfiguration.Builder

Returns:

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

See Also:

• modelConfigurations(java.util.Collection<ModelConfiguration>)

overrideConfiguration

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

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