Package org.springframework.ai.tool.method

Class MethodToolCallback

java.lang.Object

org.springframework.ai.tool.method.MethodToolCallback

All Implemented Interfaces:

ToolCallback

public final class MethodToolCallback
extends Object
implements ToolCallback

A ToolCallback implementation to invoke methods as tools.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MethodToolCallback.Builder

Constructor Summary

Constructors

Constructor	Description
MethodToolCallback(ToolDefinition toolDefinition, ToolMetadata toolMetadata, Method toolMethod, Object toolObject, ToolCallResultConverter toolCallResultConverter)

Method Summary

Modifier and Type	Method	Description
static MethodToolCallback.Builder	builder()
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, ToolContext toolContext)	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()	Metadata providing additional information on how to handle the tool.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MethodToolCallback

public MethodToolCallback(ToolDefinition toolDefinition,
 @Nullable
 ToolMetadata toolMetadata,
 Method toolMethod,
 @Nullable
 Object toolObject,
 @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: 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 toolContext)

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

toString

public String toString()

Overrides:

toString in class Object

builder

public static MethodToolCallback.Builder builder()