Interface ConverseResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockRuntimeResponse.Builder, Buildable, CopyableBuilder<ConverseResponse.Builder,ConverseResponse>, SdkBuilder<ConverseResponse.Builder,ConverseResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ConverseResponse

public static interface ConverseResponse.Builder
extends BedrockRuntimeResponse.Builder, SdkPojo, CopyableBuilder<ConverseResponse.Builder,ConverseResponse>

Method Summary

Modifier and Type	Method	Description
ConverseResponse.Builder	additionalModelResponseFields(Document additionalModelResponseFields)	Additional fields in the response that are unique to the model.
default ConverseResponse.Builder	metrics(Consumer<ConverseMetrics.Builder> metrics)	Metrics for the call to Converse.
ConverseResponse.Builder	metrics(ConverseMetrics metrics)	Metrics for the call to Converse.
default ConverseResponse.Builder	output(Consumer<ConverseOutput.Builder> output)	The result from the call to Converse.
ConverseResponse.Builder	output(ConverseOutput output)	The result from the call to Converse.
ConverseResponse.Builder	stopReason(String stopReason)	The reason why the model stopped generating output.
ConverseResponse.Builder	stopReason(StopReason stopReason)	The reason why the model stopped generating output.
default ConverseResponse.Builder	trace(Consumer<ConverseTrace.Builder> trace)	A trace object that contains information about the Guardrail behavior.
ConverseResponse.Builder	trace(ConverseTrace trace)	A trace object that contains information about the Guardrail behavior.
default ConverseResponse.Builder	usage(Consumer<TokenUsage.Builder> usage)	The total number of tokens used in the call to Converse.
ConverseResponse.Builder	usage(TokenUsage usage)	The total number of tokens used in the call to Converse.

Methods inherited from interface software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeResponse.Builder

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

output

ConverseResponse.Builder output(ConverseOutput output)

The result from the call to Converse.

Parameters:

output - The result from the call to Converse.

Returns:

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

output

default ConverseResponse.Builder output(Consumer<ConverseOutput.Builder> output)

The result from the call to Converse.

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

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

Parameters:

output - a consumer that will call methods on ConverseOutput.Builder

Returns:

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

See Also:

• output(ConverseOutput)

stopReason

ConverseResponse.Builder stopReason(String stopReason)

The reason why the model stopped generating output.

Parameters:

stopReason - The reason why the model stopped generating output.

Returns:

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

See Also:

• StopReason
• StopReason

stopReason

ConverseResponse.Builder stopReason(StopReason stopReason)

The reason why the model stopped generating output.

Parameters:

stopReason - The reason why the model stopped generating output.

Returns:

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

See Also:

• StopReason
• StopReason

usage

ConverseResponse.Builder usage(TokenUsage usage)

The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

Parameters:

usage - The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

Returns:

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

usage

default ConverseResponse.Builder usage(Consumer<TokenUsage.Builder> usage)

The total number of tokens used in the call to Converse. The total includes the tokens input to the model and the tokens generated by the model.

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

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

Parameters:

usage - a consumer that will call methods on TokenUsage.Builder

Returns:

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

See Also:

• usage(TokenUsage)

metrics

ConverseResponse.Builder metrics(ConverseMetrics metrics)

Metrics for the call to Converse.

Parameters:

metrics - Metrics for the call to Converse.

Returns:

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

metrics

default ConverseResponse.Builder metrics(Consumer<ConverseMetrics.Builder> metrics)

Metrics for the call to Converse.

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

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

Parameters:

metrics - a consumer that will call methods on ConverseMetrics.Builder

Returns:

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

See Also:

• metrics(ConverseMetrics)

additionalModelResponseFields

ConverseResponse.Builder additionalModelResponseFields(Document additionalModelResponseFields)

Additional fields in the response that are unique to the model.

Parameters:

additionalModelResponseFields - Additional fields in the response that are unique to the model.

Returns:

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

trace

ConverseResponse.Builder trace(ConverseTrace trace)

A trace object that contains information about the Guardrail behavior.

Parameters:

trace - A trace object that contains information about the Guardrail behavior.

Returns:

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

trace

default ConverseResponse.Builder trace(Consumer<ConverseTrace.Builder> trace)

A trace object that contains information about the Guardrail behavior.

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

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

Parameters:

trace - a consumer that will call methods on ConverseTrace.Builder

Returns:

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

See Also:

• trace(ConverseTrace)