Package software.amazon.awssdk.services.bedrockruntime.model

Interface ConverseRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockRuntimeRequest.Builder, Buildable, CopyableBuilder<ConverseRequest.Builder,ConverseRequest>, SdkBuilder<ConverseRequest.Builder,ConverseRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ConverseRequest

public static interface ConverseRequest.Builder
extends BedrockRuntimeRequest.Builder, SdkPojo, CopyableBuilder<ConverseRequest.Builder,ConverseRequest>

Method Summary

Modifier and Type	Method	Description
ConverseRequest.Builder	additionalModelRequestFields(Document additionalModelRequestFields)	Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field.
ConverseRequest.Builder	additionalModelResponseFieldPaths(String... additionalModelResponseFieldPaths)	Additional model parameters field paths to return in the response.
ConverseRequest.Builder	additionalModelResponseFieldPaths(Collection<String> additionalModelResponseFieldPaths)	Additional model parameters field paths to return in the response.
default ConverseRequest.Builder	guardrailConfig(Consumer<GuardrailConfiguration.Builder> guardrailConfig)	Configuration information for a guardrail that you want to use in the request.
ConverseRequest.Builder	guardrailConfig(GuardrailConfiguration guardrailConfig)	Configuration information for a guardrail that you want to use in the request.
default ConverseRequest.Builder	inferenceConfig(Consumer<InferenceConfiguration.Builder> inferenceConfig)	Inference parameters to pass to the model.
ConverseRequest.Builder	inferenceConfig(InferenceConfiguration inferenceConfig)	Inference parameters to pass to the model.
ConverseRequest.Builder	messages(Collection<Message> messages)	The messages that you want to send to the model.
ConverseRequest.Builder	messages(Consumer<Message.Builder>... messages)	The messages that you want to send to the model.
ConverseRequest.Builder	messages(Message... messages)	The messages that you want to send to the model.
ConverseRequest.Builder	modelId(String modelId)	The identifier for the model that you want to call.
ConverseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ConverseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ConverseRequest.Builder	system(Collection<SystemContentBlock> system)	A system prompt to pass to the model.
ConverseRequest.Builder	system(Consumer<SystemContentBlock.Builder>... system)	A system prompt to pass to the model.
ConverseRequest.Builder	system(SystemContentBlock... system)	A system prompt to pass to the model.
default ConverseRequest.Builder	toolConfig(Consumer<ToolConfiguration.Builder> toolConfig)	Configuration information for the tools that the model can use when generating a response.
ConverseRequest.Builder	toolConfig(ToolConfiguration toolConfig)	Configuration information for the tools that the model can use when generating a response.

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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeRequest.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, sdkFields

Method Detail

modelId

ConverseRequest.Builder modelId(String modelId)

The identifier for the model that you want to call.

The modelId to provide depends on the type of model that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

modelId - The identifier for the model that you want to call.

The modelId to provide depends on the type of model that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

Returns:

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

messages

ConverseRequest.Builder messages(Collection<Message> messages)

The messages that you want to send to the model.

Parameters:

messages - The messages that you want to send to the model.

Returns:

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

messages

ConverseRequest.Builder messages(Message... messages)

The messages that you want to send to the model.

Parameters:

messages - The messages that you want to send to the model.

Returns:

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

messages

ConverseRequest.Builder messages(Consumer<Message.Builder>... messages)

The messages that you want to send to the model.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #messages(List).

Parameters:

messages - a consumer that will call methods on Message.Builder

Returns:

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

See Also:

#messages(java.util.Collection)

system

ConverseRequest.Builder system(Collection<SystemContentBlock> system)

A system prompt to pass to the model.

Parameters:

system - A system prompt to pass to the model.

Returns:

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

system

ConverseRequest.Builder system(SystemContentBlock... system)

A system prompt to pass to the model.

Parameters:

system - A system prompt to pass to the model.

Returns:

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

system

ConverseRequest.Builder system(Consumer<SystemContentBlock.Builder>... system)

A system prompt to pass to the model.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #system(List).

Parameters:

system - a consumer that will call methods on SystemContentBlock.Builder

Returns:

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

See Also:

#system(java.util.Collection)

inferenceConfig

ConverseRequest.Builder inferenceConfig(InferenceConfiguration inferenceConfig)

Inference parameters to pass to the model. Converse supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

Parameters:

inferenceConfig - Inference parameters to pass to the model. Converse supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

Returns:

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

inferenceConfig

default ConverseRequest.Builder inferenceConfig(Consumer<InferenceConfiguration.Builder> inferenceConfig)

Inference parameters to pass to the model. Converse supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

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

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

Parameters:

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

Returns:

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

See Also:

inferenceConfig(InferenceConfiguration)

toolConfig

ConverseRequest.Builder toolConfig(ToolConfiguration toolConfig)

Configuration information for the tools that the model can use when generating a response.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

Parameters:

toolConfig - Configuration information for the tools that the model can use when generating a response.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

Returns:

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

toolConfig

default ConverseRequest.Builder toolConfig(Consumer<ToolConfiguration.Builder> toolConfig)

Configuration information for the tools that the model can use when generating a response.

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

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

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

Parameters:

toolConfig - a consumer that will call methods on ToolConfiguration.Builder

Returns:

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

See Also:

toolConfig(ToolConfiguration)

guardrailConfig

ConverseRequest.Builder guardrailConfig(GuardrailConfiguration guardrailConfig)

Configuration information for a guardrail that you want to use in the request.

Parameters:

guardrailConfig - Configuration information for a guardrail that you want to use in the request.

Returns:

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

guardrailConfig

default ConverseRequest.Builder guardrailConfig(Consumer<GuardrailConfiguration.Builder> guardrailConfig)

Configuration information for a guardrail that you want to use in the request.

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

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

Parameters:

guardrailConfig - a consumer that will call methods on GuardrailConfiguration.Builder

Returns:

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

See Also:

guardrailConfig(GuardrailConfiguration)

additionalModelRequestFields

ConverseRequest.Builder additionalModelRequestFields(Document additionalModelRequestFields)

Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field. For more information, see Model parameters.

Parameters:

additionalModelRequestFields - Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field. For more information, see Model parameters.

Returns:

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

additionalModelResponseFieldPaths

ConverseRequest.Builder additionalModelResponseFieldPaths(Collection<String> additionalModelResponseFieldPaths)

Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

Parameters:

additionalModelResponseFieldPaths - Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

Returns:

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

additionalModelResponseFieldPaths

ConverseRequest.Builder additionalModelResponseFieldPaths(String... additionalModelResponseFieldPaths)

Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

Parameters:

additionalModelResponseFieldPaths - Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse.

Returns:

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

overrideConfiguration

ConverseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder