Interface OutputConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OutputConfig.Builder,OutputConfig>, SdkBuilder<OutputConfig.Builder,OutputConfig>, SdkPojo

Enclosing class:

OutputConfig

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

Method Summary

Modifier and Type	Method	Description
OutputConfig.Builder	effort(String effort)	The effort level for the model to use when generating a response.
default OutputConfig.Builder	textFormat(Consumer<OutputFormat.Builder> textFormat)	Structured output parameters to control the model's text response.
OutputConfig.Builder	textFormat(OutputFormat textFormat)	Structured output parameters to control the model's text response.

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

textFormat

OutputConfig.Builder textFormat(OutputFormat textFormat)

Structured output parameters to control the model's text response.

Parameters:

textFormat - Structured output parameters to control the model's text response.

Returns:

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

textFormat

default OutputConfig.Builder textFormat(Consumer<OutputFormat.Builder> textFormat)

Structured output parameters to control the model's text response.

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

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

Parameters:

textFormat - a consumer that will call methods on OutputFormat.Builder

Returns:

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

See Also:

• textFormat(OutputFormat)

effort

OutputConfig.Builder effort(String effort)

The effort level for the model to use when generating a response. Higher effort levels allow the model to spend more time reasoning before responding. Supported values are low, medium, high, xhigh, and max.

When extended thinking is disabled, the effort level is capped at high. Use effort high or below, or enable thinking to use higher effort levels.

Parameters:

effort - The effort level for the model to use when generating a response. Higher effort levels allow the model to spend more time reasoning before responding. Supported values are low, medium, high, xhigh, and max.

When extended thinking is disabled, the effort level is capped at high. Use effort high or below, or enable thinking to use higher effort levels.

Returns:

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