Class ToolService

java.lang.Object

dev.langchain4j.service.tool.ToolService

public class ToolService
extends Object

Constructor Summary

Constructors

Constructor	Description
ToolService()

Method Summary

Modifier and Type	Method	Description
void	afterToolExecution(Consumer<ToolExecution> afterToolExecution)
ToolExecutionResult	applyToolHallucinationStrategy(ToolExecutionRequest toolRequest)
ToolArgumentsErrorHandler	argumentsErrorHandler()
void	argumentsErrorHandler(ToolArgumentsErrorHandler handler)
void	beforeToolExecution(Consumer<BeforeToolExecution> beforeToolExecution)
ToolServiceContext	createContext(InvocationContext invocationContext, UserMessage userMessage, List<ChatMessage> messages)
ToolServiceResult	executeInferenceAndToolsLoop(AiServiceContext context, Object memoryId, ChatResponse chatResponse, ChatRequestParameters parameters, List<ChatMessage> messages, ChatMemory chatMemory, InvocationContext invocationContext, ToolServiceContext toolServiceContext, boolean isReturnTypeResult)
ToolExecutionResult	executeTool(InvocationContext invocationContext, Map<String, ToolExecutor> toolExecutors, ToolExecutionRequest toolRequest, Consumer<BeforeToolExecution> externalBeforeToolExecution, Consumer<ToolExecution> externalAfterToolExecution)
void	executeToolsConcurrently()
void	executeToolsConcurrently(Executor executor)
static ToolExecutionResult	executeWithErrorHandling(ToolExecutionRequest toolRequest, ToolExecutor toolExecutor, InvocationContext invocationContext, ToolArgumentsErrorHandler argumentsErrorHandler, ToolExecutionErrorHandler executionErrorHandler)
ToolExecutionErrorHandler	executionErrorHandler()
void	executionErrorHandler(ToolExecutionErrorHandler handler)
Executor	executor()
static List<AiServiceTool>	findTools(Object objectWithTools)	Scans the given object for @Tool-annotated methods and returns a list of AiServiceTools.
void	hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage> toolHallucinationStrategy)
boolean	isImmediateTool(String toolName)
int	maxSequentialToolsInvocations()
void	maxSequentialToolsInvocations(int maxSequentialToolsInvocations)
static ToolServiceContext	refreshDynamicProviders(ToolServiceContext toolServiceContext, List<ChatMessage> messages, InvocationContext invocationContext)	Re-evaluates dynamic tool providers and returns an updated ToolServiceContext with any newly provided tool specifications and executors.
Map<String, ToolExecutor>	toolExecutors()
ToolProvider	toolProvider()	Deprecated. use toolProviders() instead
void	toolProvider(ToolProvider toolProvider)
Set<ToolProvider>	toolProviders()
void	toolProviders(Collection<ToolProvider> toolProviders)
void	tools(Collection<Object> objectsWithTools)
void	tools(Map<ToolSpecification, ToolExecutor> tools)
void	tools(Map<ToolSpecification, ToolExecutor> tools, Set<String> immediateReturnToolNames)
void	toolSearchStrategy(ToolSearchStrategy toolSearchStrategy)
List<ToolSpecification>	toolSpecifications()

Methods inherited from class Object

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

Constructor Details

ToolService

public ToolService()

Method Details

hallucinatedToolNameStrategy

public void hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage> toolHallucinationStrategy)

toolProvider

public void toolProvider(ToolProvider toolProvider)

toolProviders

public void toolProviders(Collection<ToolProvider> toolProviders)

Since:

1.12.0

tools

public void tools(Map<ToolSpecification, ToolExecutor> tools)

tools

public void tools(Map<ToolSpecification, ToolExecutor> tools,
 Set<String> immediateReturnToolNames)

tools

public void tools(Collection<Object> objectsWithTools)

findTools

public static List<AiServiceTool> findTools(Object objectWithTools)

Scans the given object for @Tool-annotated methods and returns a list of AiServiceTools.

Parameters:

objectWithTools - an object containing @Tool-annotated methods

Returns:

list of resolved tools

Throws:

IllegalConfigurationException - if the object has no @Tool-annotated methods

Since:

1.13.0

executeToolsConcurrently

public void executeToolsConcurrently()

Since:

1.4.0

executeToolsConcurrently

public void executeToolsConcurrently(Executor executor)

Since:

1.4.0

maxSequentialToolsInvocations

public void maxSequentialToolsInvocations(int maxSequentialToolsInvocations)

maxSequentialToolsInvocations

public int maxSequentialToolsInvocations()

beforeToolExecution

public void beforeToolExecution(Consumer<BeforeToolExecution> beforeToolExecution)

Since:

1.11.0

afterToolExecution

public void afterToolExecution(Consumer<ToolExecution> afterToolExecution)

Since:

1.11.0

argumentsErrorHandler

public void argumentsErrorHandler(ToolArgumentsErrorHandler handler)

Since:

1.4.0

argumentsErrorHandler

public ToolArgumentsErrorHandler argumentsErrorHandler()

Since:

1.4.0

executionErrorHandler

public void executionErrorHandler(ToolExecutionErrorHandler handler)

Since:

1.4.0

executionErrorHandler

public ToolExecutionErrorHandler executionErrorHandler()

Since:

1.4.0

toolSearchStrategy

public void toolSearchStrategy(ToolSearchStrategy toolSearchStrategy)

Since:

1.12.0

createContext

public ToolServiceContext createContext(InvocationContext invocationContext,
 UserMessage userMessage,
 List<ChatMessage> messages)

executeInferenceAndToolsLoop

public ToolServiceResult executeInferenceAndToolsLoop(AiServiceContext context,
 Object memoryId,
 ChatResponse chatResponse,
 ChatRequestParameters parameters,
 List<ChatMessage> messages,
 ChatMemory chatMemory,
 InvocationContext invocationContext,
 ToolServiceContext toolServiceContext,
 boolean isReturnTypeResult)

refreshDynamicProviders

public static ToolServiceContext refreshDynamicProviders(ToolServiceContext toolServiceContext,
 List<ChatMessage> messages,
 InvocationContext invocationContext)

Re-evaluates dynamic tool providers and returns an updated ToolServiceContext with any newly provided tool specifications and executors.

Non-dynamic providers are not re-called — their tools remain unchanged. Tools returned by dynamic providers are only added, never removed: once a tool is present in the context, it stays for the remainder of the AI service invocation.

Since:

1.13.0

executeTool

public ToolExecutionResult executeTool(InvocationContext invocationContext,
 Map<String, ToolExecutor> toolExecutors,
 ToolExecutionRequest toolRequest,
 Consumer<BeforeToolExecution> externalBeforeToolExecution,
 Consumer<ToolExecution> externalAfterToolExecution)

executeWithErrorHandling

public static ToolExecutionResult executeWithErrorHandling(ToolExecutionRequest toolRequest,
 ToolExecutor toolExecutor,
 InvocationContext invocationContext,
 ToolArgumentsErrorHandler argumentsErrorHandler,
 ToolExecutionErrorHandler executionErrorHandler)

applyToolHallucinationStrategy

public ToolExecutionResult applyToolHallucinationStrategy(ToolExecutionRequest toolRequest)

toolSpecifications

public List<ToolSpecification> toolSpecifications()

toolExecutors

public Map<String, ToolExecutor> toolExecutors()

executor

public Executor executor()

Since:

1.4.0

toolProviders

public Set<ToolProvider> toolProviders()

Since:

1.12.0

toolProvider

@Deprecated(since="1.12.0")
public ToolProvider toolProvider()

Deprecated.

use toolProviders() instead

isImmediateTool

public boolean isImmediateTool(String toolName)