Class DefaultToolExecutor

java.lang.Object

dev.langchain4j.service.tool.DefaultToolExecutor

All Implemented Interfaces:

ToolExecutor

public class DefaultToolExecutor
extends Object
implements ToolExecutor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultToolExecutor.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultToolExecutor(DefaultToolExecutor.Builder builder)
DefaultToolExecutor(Object object, ToolExecutionRequest toolExecutionRequest)
DefaultToolExecutor(Object object, Method method)
DefaultToolExecutor(Object object, Method originalMethod, Method methodToInvoke)	When methods annotated with @Tool are wrapped into proxies (AOP), the parameters of the proxied method do not retain their original names.

Method Summary

Modifier and Type	Method	Description
static DefaultToolExecutor.Builder	builder()
String	execute(ToolExecutionRequest request, Object memoryId)	Executes a tool request.
ToolExecutionResult	executeWithContext(ToolExecutionRequest request, InvocationContext context)	Executes a tool request.
static long	getBoundedLongValue(Object argument, String parameterName, Class<?> parameterType, long minValue, long maxValue)

Methods inherited from class Object

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

Constructor Details

DefaultToolExecutor

public DefaultToolExecutor(DefaultToolExecutor.Builder builder)

DefaultToolExecutor

public DefaultToolExecutor(Object object,
 Method method)

DefaultToolExecutor

public DefaultToolExecutor(Object object,
 ToolExecutionRequest toolExecutionRequest)

DefaultToolExecutor

public DefaultToolExecutor(Object object,
 Method originalMethod,
 Method methodToInvoke)

When methods annotated with @Tool are wrapped into proxies (AOP), the parameters of the proxied method do not retain their original names. Therefore, access to the original method is required to retrieve those names.

Parameters:

object - the object on which the method should be invoked

originalMethod - the original method, used to retrieve parameter names and prepare arguments

methodToInvoke - the method that should actually be invoked

Method Details

executeWithContext

public ToolExecutionResult executeWithContext(ToolExecutionRequest request,
 InvocationContext context)

Description copied from interface: ToolExecutor

Executes a tool request. Override this method if you wish to:

- access the InvocationParameters when passing extra data into the tool
- propagate the tool result object (ToolExecutionResult.result()) into the ToolExecution

Specified by:

executeWithContext in interface ToolExecutor

Parameters:

request - The tool execution request. Contains tool name and arguments.

context - The AI Service invocation context, contains ChatMemory ID (see MemoryId for more details), and InvocationParameters.

Returns:

The result of the tool execution that will be sent to the LLM.

execute

public String execute(ToolExecutionRequest request,
 Object memoryId)

Description copied from interface: ToolExecutor

Executes a tool request.

Specified by:

execute in interface ToolExecutor

Parameters:

request - The tool execution request. Contains tool name and arguments.

memoryId - The ID of the chat memory. .

Returns:

The result of the tool execution that will be sent to the LLM.

getBoundedLongValue

public static long getBoundedLongValue(Object argument,
 String parameterName,
 Class<?> parameterType,
 long minValue,
 long maxValue)

builder

public static DefaultToolExecutor.Builder builder()