Interface ToolSpecification.Builder

All Superinterfaces:

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

Enclosing class:

ToolSpecification

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

Method Summary

Modifier and Type	Method	Description
ToolSpecification.Builder	description(String description)	The description for the tool.
default ToolSpecification.Builder	inputSchema(Consumer<ToolInputSchema.Builder> inputSchema)	The input schema for the tool in JSON format.
ToolSpecification.Builder	inputSchema(ToolInputSchema inputSchema)	The input schema for the tool in JSON format.
ToolSpecification.Builder	name(String name)	The name for the tool.
ToolSpecification.Builder	strict(Boolean strict)	Flag to enable structured output enforcement on a tool usage 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

name

ToolSpecification.Builder name(String name)

The name for the tool.

Parameters:

name - The name for the tool.

Returns:

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

description

ToolSpecification.Builder description(String description)

The description for the tool.

Parameters:

description - The description for the tool.

Returns:

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

inputSchema

ToolSpecification.Builder inputSchema(ToolInputSchema inputSchema)

The input schema for the tool in JSON format.

Parameters:

inputSchema - The input schema for the tool in JSON format.

Returns:

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

inputSchema

default ToolSpecification.Builder inputSchema(Consumer<ToolInputSchema.Builder> inputSchema)

The input schema for the tool in JSON format.

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

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

Parameters:

inputSchema - a consumer that will call methods on ToolInputSchema.Builder

Returns:

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

See Also:

• inputSchema(ToolInputSchema)

strict

ToolSpecification.Builder strict(Boolean strict)

Flag to enable structured output enforcement on a tool usage response.

Parameters:

strict - Flag to enable structured output enforcement on a tool usage response.

Returns:

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