Interface ToolChoice.Builder

All Superinterfaces:

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

Enclosing class:

ToolChoice

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

Method Summary

Modifier and Type	Method	Description
default ToolChoice.Builder	any(Consumer<AnyToolChoice.Builder> any)	The model must request at least one tool (no text is generated).
ToolChoice.Builder	any(AnyToolChoice any)	The model must request at least one tool (no text is generated).
default ToolChoice.Builder	auto(Consumer<AutoToolChoice.Builder> auto)	(Default).
ToolChoice.Builder	auto(AutoToolChoice auto)	(Default).
default ToolChoice.Builder	tool(Consumer<SpecificToolChoice.Builder> tool)	The Model must request the specified tool.
ToolChoice.Builder	tool(SpecificToolChoice tool)	The Model must request the specified tool.

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

auto

ToolChoice.Builder auto(AutoToolChoice auto)

(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.

Returns:

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

auto

default ToolChoice.Builder auto(Consumer<AutoToolChoice.Builder> auto)

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

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

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

Parameters:

auto - a consumer that will call methods on AutoToolChoice.Builder

Returns:

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

See Also:

• auto(AutoToolChoice)

any

ToolChoice.Builder any(AnyToolChoice any)

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).

Returns:

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

any

default ToolChoice.Builder any(Consumer<AnyToolChoice.Builder> any)

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

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

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

Parameters:

any - a consumer that will call methods on AnyToolChoice.Builder

Returns:

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

See Also:

• any(AnyToolChoice)

tool

ToolChoice.Builder tool(SpecificToolChoice tool)

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.

Returns:

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

tool

default ToolChoice.Builder tool(Consumer<SpecificToolChoice.Builder> tool)

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

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

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

Parameters:

tool - a consumer that will call methods on SpecificToolChoice.Builder

Returns:

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

See Also:

• tool(SpecificToolChoice)