Package org.springframework.ai.tool.function

Class FunctionToolCallback<I,O>

java.lang.Object

org.springframework.ai.tool.function.FunctionToolCallback<I,O>

All Implemented Interfaces:

FunctionCallback, ToolCallback

public class FunctionToolCallback<I,O>
extends Object
implements ToolCallback

A ToolCallback implementation to invoke functions as tools.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionToolCallback.Builder<I,O>

Nested classes/interfaces inherited from interface org.springframework.ai.model.function.FunctionCallback

FunctionCallback.CommonCallbackInvokingSpec<B extends FunctionCallback.CommonCallbackInvokingSpec<B>>, FunctionCallback.FunctionInvokingSpec<I,O>, FunctionCallback.MethodInvokingSpec, FunctionCallback.SchemaType

Constructor Summary

Constructors

Constructor	Description
FunctionToolCallback(ToolDefinition toolDefinition, ToolMetadata toolMetadata, Type toolInputType, BiFunction<I,ToolContext,O> toolFunction, ToolCallResultConverter toolCallResultConverter)

Method Summary

Modifier and Type	Method	Description
static <I, O> FunctionToolCallback.Builder<I,O>	builder(String name, BiFunction<I,ToolContext,O> function)	Build a FunctionToolCallback from a BiFunction.
static <I> FunctionToolCallback.Builder<I,Void>	builder(String name, Consumer<I> consumer)	Build a FunctionToolCallback from a Consumer.
static <I, O> FunctionToolCallback.Builder<I,O>	builder(String name, Function<I,O> function)	Build a FunctionToolCallback from a Function.
static <O> FunctionToolCallback.Builder<Void,O>	builder(String name, Supplier<O> supplier)	Build a FunctionToolCallback from a Supplier.
String	call(String toolInput)	Called when a model detects and triggers a function call.
String	call(String toolInput, ToolContext toolContext)	Called when a model detects and triggers a function call.
ToolDefinition	getToolDefinition()	Definition used by the AI model to determine when and how to call the tool.
ToolMetadata	getToolMetadata()	Metadata providing additional information on how to handle the tool.

Methods inherited from class java.lang.Object

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

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

getDescription, getInputTypeSchema, getName

Constructor Details

FunctionToolCallback

public FunctionToolCallback(ToolDefinition toolDefinition,
 @Nullable
 ToolMetadata toolMetadata,
 Type toolInputType,
 BiFunction<I,ToolContext,O> toolFunction,
 @Nullable
 ToolCallResultConverter toolCallResultConverter)

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

Description copied from interface: ToolCallback

Metadata providing additional information on how to handle the tool.

Specified by:

getToolMetadata in interface ToolCallback

call

public String call(String toolInput)

Description copied from interface: FunctionCallback

Called when a model detects and triggers a function call. The model is responsible to pass the function arguments in the pre-configured JSON schema format.

Specified by:

call in interface FunctionCallback

Parameters:

toolInput - JSON string with the function arguments to be passed to the function. The arguments are defined as JSON schema usually registered with the model.

Returns:

String containing the function call response.

call

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

Description copied from interface: FunctionCallback

Called when a model detects and triggers a function call. The model is responsible to pass the function arguments in the pre-configured JSON schema format. Additionally, the model can pass a context map to the function if available. The context is used to pass additional user provided state in addition to the arguments provided by the AI model.

Specified by:

call in interface FunctionCallback

Parameters:

toolInput - JSON string with the function arguments to be passed to the function. The arguments are defined as JSON schema usually registered with the model. Arguments are provided by the AI model.

toolContext - Map with the function context. The context is used to pass additional user provided state in addition to the arguments provided by the AI model.

Returns:

String containing the function call response.

builder

public static <I,
O>
FunctionToolCallback.Builder<I,O> builder(String name,
 BiFunction<I,ToolContext,O> function)

Build a FunctionToolCallback from a BiFunction.

builder

public static <I,
O>
FunctionToolCallback.Builder<I,O> builder(String name,
 Function<I,O> function)

Build a FunctionToolCallback from a Function.

builder

public static <O>
FunctionToolCallback.Builder<Void,O> builder(String name,
 Supplier<O> supplier)

Build a FunctionToolCallback from a Supplier.

builder

public static <I>
FunctionToolCallback.Builder<I,Void> builder(String name,
 Consumer<I> consumer)

Build a FunctionToolCallback from a Consumer.