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

Class ToolChoice

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ToolChoice

All Implemented Interfaces:

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

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

Determines which tools the model should request in a call to Converse or ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ToolChoice.Builder
static class	ToolChoice.Type

Method Summary

Modifier and Type	Method	Description
AnyToolChoice	any()	The model must request at least one tool (no text is generated).
AutoToolChoice	auto()	(Default).
static ToolChoice.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static ToolChoice	fromAny(Consumer<AnyToolChoice.Builder> any)	Create an instance of this class with any() initialized to the given value.
static ToolChoice	fromAny(AnyToolChoice any)	Create an instance of this class with any() initialized to the given value.
static ToolChoice	fromAuto(Consumer<AutoToolChoice.Builder> auto)	Create an instance of this class with auto() initialized to the given value.
static ToolChoice	fromAuto(AutoToolChoice auto)	Create an instance of this class with auto() initialized to the given value.
static ToolChoice	fromTool(Consumer<SpecificToolChoice.Builder> tool)	Create an instance of this class with tool() initialized to the given value.
static ToolChoice	fromTool(SpecificToolChoice tool)	Create an instance of this class with tool() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ToolChoice.Builder>	serializableBuilderClass()
ToolChoice.Builder	toBuilder()
SpecificToolChoice	tool()	The Model must request the specified tool.
String	toString()	Returns a string representation of this object.
ToolChoice.Type	type()	Retrieve an enum value representing which member of this object is populated.

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 Detail

auto

public final AutoToolChoice auto()

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Returns:

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

any

public final AnyToolChoice any()

The model must request at least one tool (no text is generated).

Returns:

The model must request at least one tool (no text is generated).

tool

public final SpecificToolChoice tool()

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

Returns:

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

toBuilder

public ToolChoice.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ToolChoice.Builder,ToolChoice>

builder

public static ToolChoice.Builder builder()

serializableBuilderClass

public static Class<? extends ToolChoice.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)

fromAuto

public static ToolChoice fromAuto(AutoToolChoice auto)

Create an instance of this class with auto() initialized to the given value.

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Parameters:

auto - (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

fromAuto

public static ToolChoice fromAuto(Consumer<AutoToolChoice.Builder> auto)

Create an instance of this class with auto() initialized to the given value.

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Parameters:

auto - (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

fromAny

public static ToolChoice fromAny(AnyToolChoice any)

Create an instance of this class with any() initialized to the given value.

The model must request at least one tool (no text is generated).

Parameters:

any - The model must request at least one tool (no text is generated).

fromAny

public static ToolChoice fromAny(Consumer<AnyToolChoice.Builder> any)

Create an instance of this class with any() initialized to the given value.

The model must request at least one tool (no text is generated).

Parameters:

any - The model must request at least one tool (no text is generated).

fromTool

public static ToolChoice fromTool(SpecificToolChoice tool)

Create an instance of this class with tool() initialized to the given value.

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

Parameters:

tool - The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

fromTool

public static ToolChoice fromTool(Consumer<SpecificToolChoice.Builder> tool)

Create an instance of this class with tool() initialized to the given value.

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

Parameters:

tool - The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

type

public ToolChoice.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ToolChoice.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ToolChoice.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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