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

Class OutputConfig

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.OutputConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

@Generated("software.amazon.awssdk:codegen")
public final class OutputConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

Output configuration for a model response in a call to Converse or ConverseStream.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OutputConfig.Builder

Method Summary

Modifier and Type	Method	Description
static OutputConfig.Builder	builder()
final String	effort()	The effort level for the model to use when generating a response.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends OutputConfig.Builder>	serializableBuilderClass()
final OutputFormat	textFormat()	Structured output parameters to control the model's text response.
OutputConfig.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

textFormat

public final OutputFormat textFormat()

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

Returns:

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

effort

public final 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.

Returns:

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.

toBuilder

public OutputConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OutputConfig.Builder,OutputConfig>

builder

public static OutputConfig.Builder builder()

serializableBuilderClass

public static Class<? extends OutputConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo