Package org.springframework.ai.tool

Interface ToolCallback

All Superinterfaces:

FunctionCallback

All Known Implementing Classes:

FunctionToolCallback, MethodToolCallback

public interface ToolCallback
extends FunctionCallback

Represents a tool whose execution can be triggered by an AI model.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
default String	getDescription()	Deprecated.
default String	getInputTypeSchema()	Deprecated.
default String	getName()	Deprecated.
ToolDefinition	getToolDefinition()	Definition used by the AI model to determine when and how to call the tool.
default ToolMetadata	getToolMetadata()	Metadata providing additional information on how to handle the tool.

Methods inherited from interface org.springframework.ai.model.function.FunctionCallback

call, call

Method Details

getToolDefinition

ToolDefinition getToolDefinition()

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

getToolMetadata

default ToolMetadata getToolMetadata()

Metadata providing additional information on how to handle the tool.

getName

@Deprecated
default String getName()

Deprecated.

Specified by:

getName in interface FunctionCallback

Returns:

Returns the Function name. Unique within the model.

getDescription

@Deprecated
default String getDescription()

Deprecated.

Specified by:

getDescription in interface FunctionCallback

Returns:

Returns the function description. This description is used by the model do decide if the function should be called or not.

getInputTypeSchema

@Deprecated
default String getInputTypeSchema()

Deprecated.

Specified by:

getInputTypeSchema in interface FunctionCallback

Returns:

Returns the JSON schema of the function input type.