Interface ToolConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ToolConfiguration

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

Method Summary

Modifier and Type	Method	Description
default ToolConfiguration.Builder	annotations(Consumer<Annotation.Builder> annotations)	Annotations for the tool configuration.
ToolConfiguration.Builder	annotations(Annotation annotations)	Annotations for the tool configuration.
ToolConfiguration.Builder	description(String description)	The description of the tool configuration.
ToolConfiguration.Builder	inputSchema(Document inputSchema)	The input schema for the tool configuration.
default ToolConfiguration.Builder	instruction(Consumer<ToolInstruction.Builder> instruction)	Instructions for using the tool.
ToolConfiguration.Builder	instruction(ToolInstruction instruction)	Instructions for using the tool.
ToolConfiguration.Builder	outputFilters(Collection<ToolOutputFilter> outputFilters)	Output filters applies to the tool result.
ToolConfiguration.Builder	outputFilters(Consumer<ToolOutputFilter.Builder>... outputFilters)	Output filters applies to the tool result.
ToolConfiguration.Builder	outputFilters(ToolOutputFilter... outputFilters)	Output filters applies to the tool result.
ToolConfiguration.Builder	outputSchema(Document outputSchema)	The output schema for the tool configuration.
ToolConfiguration.Builder	overrideInputValues(Collection<ToolOverrideInputValue> overrideInputValues)	Override input values for the tool configuration.
ToolConfiguration.Builder	overrideInputValues(Consumer<ToolOverrideInputValue.Builder>... overrideInputValues)	Override input values for the tool configuration.
ToolConfiguration.Builder	overrideInputValues(ToolOverrideInputValue... overrideInputValues)	Override input values for the tool configuration.
ToolConfiguration.Builder	title(String title)	The title of the tool configuration.
ToolConfiguration.Builder	toolId(String toolId)	The identifier of the tool, for example toolName from Model Context Provider server.
ToolConfiguration.Builder	toolName(String toolName)	The name of the tool.
ToolConfiguration.Builder	toolType(String toolType)	The type of the tool.
ToolConfiguration.Builder	toolType(ToolType toolType)	The type of the tool.
default ToolConfiguration.Builder	userInteractionConfiguration(Consumer<UserInteractionConfiguration.Builder> userInteractionConfiguration)	Configuration for user interaction with the tool.
ToolConfiguration.Builder	userInteractionConfiguration(UserInteractionConfiguration userInteractionConfiguration)	Configuration for user interaction with the 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

toolName

ToolConfiguration.Builder toolName(String toolName)

The name of the tool.

Parameters:

toolName - The name of the tool.

Returns:

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

toolType

ToolConfiguration.Builder toolType(String toolType)

The type of the tool.

Parameters:

toolType - The type of the tool.

Returns:

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

See Also:

• ToolType
• ToolType

toolType

ToolConfiguration.Builder toolType(ToolType toolType)

The type of the tool.

Parameters:

toolType - The type of the tool.

Returns:

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

See Also:

• ToolType
• ToolType

title

ToolConfiguration.Builder title(String title)

The title of the tool configuration.

Parameters:

title - The title of the tool configuration.

Returns:

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

toolId

ToolConfiguration.Builder toolId(String toolId)

The identifier of the tool, for example toolName from Model Context Provider server.

Parameters:

toolId - The identifier of the tool, for example toolName from Model Context Provider server.

Returns:

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

description

ToolConfiguration.Builder description(String description)

The description of the tool configuration.

Parameters:

description - The description of the tool configuration.

Returns:

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

instruction

ToolConfiguration.Builder instruction(ToolInstruction instruction)

Instructions for using the tool.

Parameters:

instruction - Instructions for using the tool.

Returns:

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

instruction

default ToolConfiguration.Builder instruction(Consumer<ToolInstruction.Builder> instruction)

Instructions for using the tool.

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

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

Parameters:

instruction - a consumer that will call methods on ToolInstruction.Builder

Returns:

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

See Also:

• instruction(ToolInstruction)

overrideInputValues

ToolConfiguration.Builder overrideInputValues(Collection<ToolOverrideInputValue> overrideInputValues)

Override input values for the tool configuration.

Parameters:

overrideInputValues - Override input values for the tool configuration.

Returns:

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

overrideInputValues

ToolConfiguration.Builder overrideInputValues(ToolOverrideInputValue... overrideInputValues)

Override input values for the tool configuration.

Parameters:

overrideInputValues - Override input values for the tool configuration.

Returns:

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

overrideInputValues

ToolConfiguration.Builder overrideInputValues(Consumer<ToolOverrideInputValue.Builder>... overrideInputValues)

Override input values for the tool configuration.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideInputValues(List<ToolOverrideInputValue>).

Parameters:

overrideInputValues - a consumer that will call methods on ToolOverrideInputValue.Builder

Returns:

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

See Also:

• overrideInputValues(java.util.Collection<ToolOverrideInputValue>)

outputFilters

ToolConfiguration.Builder outputFilters(Collection<ToolOutputFilter> outputFilters)

Output filters applies to the tool result.

Parameters:

outputFilters - Output filters applies to the tool result.

Returns:

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

outputFilters

ToolConfiguration.Builder outputFilters(ToolOutputFilter... outputFilters)

Output filters applies to the tool result.

Parameters:

outputFilters - Output filters applies to the tool result.

Returns:

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

outputFilters

ToolConfiguration.Builder outputFilters(Consumer<ToolOutputFilter.Builder>... outputFilters)

Output filters applies to the tool result.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputFilters(List<ToolOutputFilter>).

Parameters:

outputFilters - a consumer that will call methods on ToolOutputFilter.Builder

Returns:

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

See Also:

• outputFilters(java.util.Collection<ToolOutputFilter>)

inputSchema

ToolConfiguration.Builder inputSchema(Document inputSchema)

The input schema for the tool configuration.

Parameters:

inputSchema - The input schema for the tool configuration.

Returns:

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

outputSchema

ToolConfiguration.Builder outputSchema(Document outputSchema)

The output schema for the tool configuration.

Parameters:

outputSchema - The output schema for the tool configuration.

Returns:

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

annotations

ToolConfiguration.Builder annotations(Annotation annotations)

Annotations for the tool configuration.

Parameters:

annotations - Annotations for the tool configuration.

Returns:

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

annotations

default ToolConfiguration.Builder annotations(Consumer<Annotation.Builder> annotations)

Annotations for the tool configuration.

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

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

Parameters:

annotations - a consumer that will call methods on Annotation.Builder

Returns:

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

See Also:

• annotations(Annotation)

userInteractionConfiguration

ToolConfiguration.Builder userInteractionConfiguration(UserInteractionConfiguration userInteractionConfiguration)

Configuration for user interaction with the tool.

Parameters:

userInteractionConfiguration - Configuration for user interaction with the tool.

Returns:

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

userInteractionConfiguration

default ToolConfiguration.Builder userInteractionConfiguration(Consumer<UserInteractionConfiguration.Builder> userInteractionConfiguration)

Configuration for user interaction with the tool.

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

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

Parameters:

userInteractionConfiguration - a consumer that will call methods on UserInteractionConfiguration.Builder

Returns:

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

See Also:

• userInteractionConfiguration(UserInteractionConfiguration)