Package org.springframework.ai.tool.augment

Class AugmentedToolCallback<T extends Record>

java.lang.Object

org.springframework.ai.tool.augment.AugmentedToolCallback<T>

All Implemented Interfaces:

ToolCallback

public class AugmentedToolCallback<T extends Record>
extends Object
implements ToolCallback

This class wraps an existing ToolCallback and modifies its input schema to include additional fields defined in the provided Record type. It also provides a mechanism to handle these extended arguments, either by consuming them via a provided Consumer or by removing them from the input after processing.

Author:

Christian Tzolov

Field Summary

Fields inherited from interface org.springframework.ai.tool.ToolCallback

logger

Constructor Summary

Constructors

Constructor	Description
AugmentedToolCallback(ToolCallback delegate, Class<T> augmentedArgumentsClass, @Nullable Consumer<AugmentedArgumentEvent<T>> augmentedArgumentsConsumer, boolean removeExtraArgumentsAfterProcessing)

Method Summary

Modifier and Type	Method	Description
String	call(String toolInput)	Execute tool with the given input and return the result to send back to the AI model.
String	call(String toolInput, @Nullable ToolContext tooContext)	Execute tool with the given input and context, and return the result to send back to the AI model.
ToolDefinition	getToolDefinition()	Definition used by the AI model to determine when and how to call the tool.
ToolMetadata	getToolMetadata()	The delegate's metadata, so that augmenting the arguments keeps flags such as ToolMetadata.returnDirect() and ToolMetadata.requiresConfirmation().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AugmentedToolCallback

public AugmentedToolCallback(ToolCallback delegate,
 Class<T> augmentedArgumentsClass,
 @Nullable Consumer<AugmentedArgumentEvent<T>> augmentedArgumentsConsumer,
 boolean removeExtraArgumentsAfterProcessing)

Method Details

getToolDefinition

public ToolDefinition getToolDefinition()

Description copied from interface: ToolCallback

Definition used by the AI model to determine when and how to call the tool.

Specified by:

getToolDefinition in interface ToolCallback

getToolMetadata

public ToolMetadata getToolMetadata()

The delegate's metadata, so that augmenting the arguments keeps flags such as ToolMetadata.returnDirect() and ToolMetadata.requiresConfirmation().

Specified by:

getToolMetadata in interface ToolCallback

call

public String call(String toolInput)

Description copied from interface: ToolCallback

Execute tool with the given input and return the result to send back to the AI model.

Specified by:

call in interface ToolCallback

call

public String call(String toolInput,
 @Nullable ToolContext tooContext)

Description copied from interface: ToolCallback

Execute tool with the given input and context, and return the result to send back to the AI model.

Specified by:

call in interface ToolCallback