Uses of Class
dev.langchain4j.agent.tool.ToolExecutionRequest

Packages that use ToolExecutionRequest

Package	Description
dev.langchain4j.agent.tool
dev.langchain4j.agentic.agent
dev.langchain4j.data.message
dev.langchain4j.internal
dev.langchain4j.mcp
dev.langchain4j.mcp.client
dev.langchain4j.model.chat.response
dev.langchain4j.model.google.genai
dev.langchain4j.model.googleai
dev.langchain4j.model.mistralai.internal.mapper
dev.langchain4j.observability.api.event
dev.langchain4j.observability.event
dev.langchain4j.service
dev.langchain4j.service.tool
dev.langchain4j.service.tool.search

Uses of ToolExecutionRequest in dev.langchain4j.agent.tool

Methods in dev.langchain4j.agent.tool that return ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionRequest	ToolExecutionRequest.Builder.build()	Returns a ToolExecutionRequest built from the parameters previously set.

Uses of ToolExecutionRequest in dev.langchain4j.agentic.agent

Method parameters in dev.langchain4j.agentic.agent with type arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
B	AgentBuilder.hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage> hallucinatedToolNameStrategy)	Sets the strategy for handling tool calls when the model hallucinates a non-existent tool name.

Uses of ToolExecutionRequest in dev.langchain4j.data.message

Methods in dev.langchain4j.data.message that return types with arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
List<ToolExecutionRequest>	AiMessage.toolExecutionRequests()	Get the tool execution requests of the message.

Methods in dev.langchain4j.data.message with parameters of type ToolExecutionRequest

Modifier and Type	Method	Description
static AiMessage	AiMessage.aiMessage(ToolExecutionRequest... toolExecutionRequests)	Create a new AiMessage with the given tool execution requests.
static AiMessage	AiMessage.from(ToolExecutionRequest... toolExecutionRequests)	Create a new AiMessage with the given tool execution requests.
static ToolExecutionResultMessage	ToolExecutionResultMessage.from(ToolExecutionRequest request, String toolExecutionResult)	Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.
static ToolExecutionResultMessage	ToolExecutionResultMessage.toolExecutionResultMessage(ToolExecutionRequest request, String toolExecutionResult)	Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.

Method parameters in dev.langchain4j.data.message with type arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
static AiMessage	AiMessage.aiMessage(String text, List<ToolExecutionRequest> toolExecutionRequests)	Create a new AiMessage with the given text and tool execution requests.
static AiMessage	AiMessage.aiMessage(List<ToolExecutionRequest> toolExecutionRequests)	Create a new AiMessage with the given tool execution requests.
static AiMessage	AiMessage.from(String text, List<ToolExecutionRequest> toolExecutionRequests)	Create a new AiMessage with the given text and tool execution requests.
static AiMessage	AiMessage.from(List<ToolExecutionRequest> toolExecutionRequests)	Create a new AiMessage with the given tool execution requests.
AiMessage.Builder	AiMessage.Builder.toolExecutionRequests(List<ToolExecutionRequest> toolExecutionRequests)

Constructor parameters in dev.langchain4j.data.message with type arguments of type ToolExecutionRequest

Modifier	Constructor	Description
	AiMessage(String text, List<ToolExecutionRequest> toolExecutionRequests)	Create a new AiMessage with the given text and tool execution requests.
	AiMessage(List<ToolExecutionRequest> toolExecutionRequests)	Create a new AiMessage with the given tool execution requests.

Uses of ToolExecutionRequest in dev.langchain4j.internal

Methods in dev.langchain4j.internal that return types with arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
List<ToolExecutionRequest>	ToolCallBuilder.allRequests()

Uses of ToolExecutionRequest in dev.langchain4j.mcp

Methods in dev.langchain4j.mcp with parameters of type ToolExecutionRequest

Modifier and Type	Method	Description
String	McpToolExecutor.execute(ToolExecutionRequest executionRequest, Object memoryId)
CompletableFuture<ToolExecutionResult>	McpToolExecutor.executeAsync(ToolExecutionRequest executionRequest, InvocationContext invocationContext)	Non-blocking counterpart of ToolExecutor.executeWithContext(ToolExecutionRequest, InvocationContext), invoked by the asynchronous AI Service tool loop (AI Service methods returning CompletableFuture or CompletionStage), which composes the returned future instead of waiting on a thread.
ToolExecutionResult	McpToolExecutor.executeWithContext(ToolExecutionRequest executionRequest, InvocationContext invocationContext)

Uses of ToolExecutionRequest in dev.langchain4j.mcp.client

Methods in dev.langchain4j.mcp.client with parameters of type ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionResult	DefaultMcpClient.executeTool(ToolExecutionRequest executionRequest)
ToolExecutionResult	DefaultMcpClient.executeTool(ToolExecutionRequest executionRequest, InvocationContext invocationContext)
ToolExecutionResult	McpClient.executeTool(ToolExecutionRequest executionRequest)	Executes a tool on the MCP server and returns the result.
ToolExecutionResult	McpClient.executeTool(ToolExecutionRequest executionRequest, InvocationContext invocationContext)	Executes a tool on the MCP server and returns the result.
CompletableFuture<ToolExecutionResult>	DefaultMcpClient.executeToolAsync(ToolExecutionRequest executionRequest, InvocationContext invocationContext)	Non-blocking counterpart of McpClient.executeTool(ToolExecutionRequest, InvocationContext): executes a tool on the MCP server without holding a thread while the result is in flight.
default CompletableFuture<ToolExecutionResult>	McpClient.executeToolAsync(ToolExecutionRequest executionRequest, InvocationContext invocationContext)	Non-blocking counterpart of McpClient.executeTool(ToolExecutionRequest, InvocationContext): executes a tool on the MCP server without holding a thread while the result is in flight.

Uses of ToolExecutionRequest in dev.langchain4j.model.chat.response

Methods in dev.langchain4j.model.chat.response that return ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionRequest	CompleteToolCall.toolExecutionRequest()	A fully constructed ToolExecutionRequest that is ready for execution.

Constructors in dev.langchain4j.model.chat.response with parameters of type ToolExecutionRequest

Modifier	Constructor	Description
	CompleteToolCall(int index, ToolExecutionRequest toolExecutionRequest)

Uses of ToolExecutionRequest in dev.langchain4j.model.google.genai

Method parameters in dev.langchain4j.model.google.genai with type arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
int	GoogleGenAiTokenCountEstimator.estimateTokenCountInToolExecutionRequests(Iterable<ToolExecutionRequest> toolExecutionRequests)

Uses of ToolExecutionRequest in dev.langchain4j.model.googleai

Method parameters in dev.langchain4j.model.googleai with type arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
int	GoogleAiGeminiTokenCountEstimator.estimateTokenCountInToolExecutionRequests(Iterable<ToolExecutionRequest> toolExecutionRequests)

Uses of ToolExecutionRequest in dev.langchain4j.model.mistralai.internal.mapper

Methods in dev.langchain4j.model.mistralai.internal.mapper that return ToolExecutionRequest

Modifier and Type	Method	Description
static ToolExecutionRequest	MistralAiMapper.toToolExecutionRequest(MistralAiToolCall mistralAiToolCall)

Methods in dev.langchain4j.model.mistralai.internal.mapper that return types with arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
static List<ToolExecutionRequest>	MistralAiMapper.toToolExecutionRequests(List<MistralAiToolCall> mistralAiToolCalls)

Uses of ToolExecutionRequest in dev.langchain4j.observability.api.event

Methods in dev.langchain4j.observability.api.event that return ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionRequest	ToolCompensatedEvent.request()	Gets the ToolExecutionRequest of the tool that was compensated.
ToolExecutionRequest	ToolCompensatedEvent.ToolCompensatedEventBuilder.request()
ToolExecutionRequest	ToolExecutedEvent.request()	Gets the ToolExecutionRequest that initiated the tool execution.
ToolExecutionRequest	ToolExecutedEvent.ToolExecutedEventBuilder.request()

Methods in dev.langchain4j.observability.api.event with parameters of type ToolExecutionRequest

Modifier and Type	Method	Description
ToolCompensatedEvent.ToolCompensatedEventBuilder	ToolCompensatedEvent.ToolCompensatedEventBuilder.request(ToolExecutionRequest request)	Sets the compensated tool's request.
ToolExecutedEvent.ToolExecutedEventBuilder	ToolExecutedEvent.ToolExecutedEventBuilder.request(ToolExecutionRequest request)	Sets the tool execution request.

Uses of ToolExecutionRequest in dev.langchain4j.observability.event

Methods in dev.langchain4j.observability.event that return ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionRequest	DefaultToolCompensatedEvent.request()
ToolExecutionRequest	DefaultToolExecutedEvent.request()

Uses of ToolExecutionRequest in dev.langchain4j.service

Method parameters in dev.langchain4j.service with type arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
AiServices<T>	AiServices.hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage> hallucinatedToolNameStrategy)	Configures the strategy to be used when the LLM hallucinates a tool name (i.e., attempts to call a nonexistent tool).

Uses of ToolExecutionRequest in dev.langchain4j.service.tool

Classes in dev.langchain4j.service.tool that implement interfaces with type arguments of type ToolExecutionRequest

Modifier and Type	Class	Description
enum	HallucinatedToolNameStrategy

Methods in dev.langchain4j.service.tool that return ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionRequest	BeforeToolExecution.request()	Returns the tool execution request that is about to be executed.
ToolExecutionRequest	ToolExecution.request()	Returns the request of the tool execution.
ToolExecutionRequest	ToolErrorContext.toolExecutionRequest()

Methods in dev.langchain4j.service.tool that return types with arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
Map<ToolExecutionRequest, ToolExecutionResult>	ToolService.CombinedToolResults.results()	Returns the value of the results record component.

Methods in dev.langchain4j.service.tool with parameters of type ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionResultMessage	HallucinatedToolNameStrategy.apply(ToolExecutionRequest toolExecutionRequest)
ToolExecutionResult	ToolService.applyToolHallucinationStrategy(ToolExecutionRequest toolRequest)
String	DefaultToolExecutor.execute(ToolExecutionRequest request, Object memoryId)
String	ToolExecutor.execute(ToolExecutionRequest request, Object memoryId)	Executes a tool request.
CompletableFuture<ToolExecutionResult>	DefaultToolExecutor.executeAsync(ToolExecutionRequest request, InvocationContext context)	Non-blocking counterpart of ToolExecutor.executeWithContext(ToolExecutionRequest, InvocationContext), invoked by the asynchronous AI Service tool loop (AI Service methods returning CompletableFuture or CompletionStage), which composes the returned future instead of waiting on a thread.
default CompletableFuture<ToolExecutionResult>	ToolExecutor.executeAsync(ToolExecutionRequest request, InvocationContext context)	Non-blocking counterpart of ToolExecutor.executeWithContext(ToolExecutionRequest, InvocationContext), invoked by the asynchronous AI Service tool loop (AI Service methods returning CompletableFuture or CompletionStage), which composes the returned future instead of waiting on a thread.
ToolExecutionResult	ToolService.executeTool(InvocationContext invocationContext, Map<String, ToolExecutor> toolExecutors, ToolExecutionRequest toolRequest, Consumer<BeforeToolExecution> externalBeforeToolExecution, Consumer<ToolExecution> externalAfterToolExecution)
ToolExecutionResult	DefaultToolExecutor.executeWithContext(ToolExecutionRequest request, InvocationContext context)
default ToolExecutionResult	ToolExecutor.executeWithContext(ToolExecutionRequest request, InvocationContext context)	Executes a tool request.
static ToolExecutionResult	ToolService.executeWithErrorHandling(ToolExecutionRequest toolRequest, ToolExecutor toolExecutor, InvocationContext invocationContext, ToolArgumentsErrorHandler argumentsErrorHandler, ToolExecutionErrorHandler executionErrorHandler)
BeforeToolExecution.Builder	BeforeToolExecution.Builder.request(ToolExecutionRequest request)
ToolExecution.Builder	ToolExecution.Builder.request(ToolExecutionRequest request)
CompletableFuture<ToolExecutionResult>	ToolService.startTool(ToolExecutionRequest toolRequest, Map<String, ToolExecutor> toolExecutors, InvocationContext invocationContext, Consumer<BeforeToolExecution> externalBeforeToolExecution, Consumer<ToolExecution> externalAfterToolExecution, Executor executor)	Initiates a single tool execution on the given executor, returning a future of its result.
ToolErrorContext.Builder	ToolErrorContext.Builder.toolExecutionRequest(ToolExecutionRequest toolExecutionRequest)

Method parameters in dev.langchain4j.service.tool with type arguments of type ToolExecutionRequest

Modifier and Type	Method	Description
String	ToolService.collectCompensableRound(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolService.CompensableToolExecution> compensableExecutions, InvocationContext invocationContext)	Records one completed round's successful compensable tool executions into the shared accumulator and returns the first errored tool's name (or null).
String	ToolService.collectCompensableRound(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolService.CompensableToolExecution> compensableExecutions, InvocationContext invocationContext)	Records one completed round's successful compensable tool executions into the shared accumulator and returns the first errored tool's name (or null).
static CompletableFuture<ToolService.CombinedToolResults>	ToolService.combineToolResultsCollectingErrors(Map<ToolExecutionRequest, CompletableFuture<ToolExecutionResult>> futures)	Combines a set of in-flight (possibly already-started) tool executions into a single future of their results, keyed and ordered by request.
void	ToolService.compensateIfNeeded(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecutionResultMessage> resultMessages, List<ToolService.CompensableToolExecution> compensableExecutions, boolean anyToolErrored, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, AiServiceListenerRegistrar listenerRegistrar)	Synchronous tool compensation, used by the synchronous / TokenStream modes.
void	ToolService.compensateIfNeeded(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecutionResultMessage> resultMessages, List<ToolService.CompensableToolExecution> compensableExecutions, boolean anyToolErrored, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, AiServiceListenerRegistrar listenerRegistrar)	Synchronous tool compensation, used by the synchronous / TokenStream modes.
CompletableFuture<Void>	ToolService.compensateIfNeededAsync(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecutionResultMessage> resultMessages, List<ToolService.CompensableToolExecution> compensableExecutions, boolean anyToolErrored, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, CompensationReason reason, AiServiceListenerRegistrar listenerRegistrar, BiConsumer<ToolExecution, CompensationReason> streamEmitter)	Non-blocking counterpart of ToolService.compensateIfNeeded(List, Map, List, List, boolean, ChatMemory, List, InvocationContext, AiServiceListenerRegistrar), used by the CompletableFuture and reactive modes.
CompletableFuture<Void>	ToolService.compensateIfNeededAsync(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecutionResultMessage> resultMessages, List<ToolService.CompensableToolExecution> compensableExecutions, boolean anyToolErrored, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, CompensationReason reason, AiServiceListenerRegistrar listenerRegistrar, BiConsumer<ToolExecution, CompensationReason> streamEmitter)	Non-blocking counterpart of ToolService.compensateIfNeeded(List, Map, List, List, boolean, ChatMemory, List, InvocationContext, AiServiceListenerRegistrar), used by the CompletableFuture and reactive modes.
CompletableFuture<Void>	ToolService.compensateIfNeededAsync(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecutionResultMessage> resultMessages, List<ToolService.CompensableToolExecution> compensableExecutions, boolean anyToolErrored, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, CompensationReason reason, AiServiceListenerRegistrar listenerRegistrar, BiConsumer<ToolExecution, CompensationReason> streamEmitter, boolean alreadyCollected, String preCollectedFailedToolName)	As ToolService.compensateIfNeededAsync(List, Map, List, List, boolean, ChatMemory, List, InvocationContext, CompensationReason, AiServiceListenerRegistrar, BiConsumer), but when alreadyCollected is true this round's compensable tools have already been recorded into compensableExecutions (via ToolService.collectCompensableRound(List, Map, List, InvocationContext)) and preCollectedFailedToolName carries the collect's result; the collection step is then skipped.
CompletableFuture<Void>	ToolService.compensateIfNeededAsync(List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecutionResultMessage> resultMessages, List<ToolService.CompensableToolExecution> compensableExecutions, boolean anyToolErrored, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, CompensationReason reason, AiServiceListenerRegistrar listenerRegistrar, BiConsumer<ToolExecution, CompensationReason> streamEmitter, boolean alreadyCollected, String preCollectedFailedToolName)	As ToolService.compensateIfNeededAsync(List, Map, List, List, boolean, ChatMemory, List, InvocationContext, CompensationReason, AiServiceListenerRegistrar, BiConsumer), but when alreadyCollected is true this round's compensable tools have already been recorded into compensableExecutions (via ToolService.collectCompensableRound(List, Map, List, InvocationContext)) and preCollectedFailedToolName carries the collect's result; the collection step is then skipped.
CompletableFuture<Void>	ToolService.compensateOnCancellationAsync(List<ToolExecutionRequest> currentRoundRequests, Map<ToolExecutionRequest, ToolExecutionResult> currentRoundResults, List<ToolService.CompensableToolExecution> compensableExecutions, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, AiServiceListenerRegistrar listenerRegistrar, BiConsumer<ToolExecution, CompensationReason> streamEmitter)	Rolls back, on cancellation, every compensable tool that had already executed successfully - across all rounds - implementing the "drain the round, then roll back" contract for the asynchronous and reactive modes.
CompletableFuture<Void>	ToolService.compensateOnCancellationAsync(List<ToolExecutionRequest> currentRoundRequests, Map<ToolExecutionRequest, ToolExecutionResult> currentRoundResults, List<ToolService.CompensableToolExecution> compensableExecutions, ChatMemory chatMemory, List<ChatMessage> messages, InvocationContext invocationContext, AiServiceListenerRegistrar listenerRegistrar, BiConsumer<ToolExecution, CompensationReason> streamEmitter)	Rolls back, on cancellation, every compensable tool that had already executed successfully - across all rounds - implementing the "drain the round, then roll back" contract for the asynchronous and reactive modes.
void	ToolService.hallucinatedToolNameStrategy(Function<ToolExecutionRequest, ToolExecutionResultMessage> toolHallucinationStrategy)
ToolService.NextChatRequest	ToolService.prepareNextChatRequest(AiServiceContext context, Object memoryId, List<ChatMessage> messages, InvocationContext invocationContext, ToolServiceContext toolServiceContext, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, ChatRequestParameters parameters)	Builds the next round's ChatRequest, shared by every AI Service mode: given the already-resolved messages to send (see ToolService.resolveMessagesForNextRequest(List, AiServiceContext, InvocationContext)), it refreshes dynamic tool providers, folds in any tools found by tool search, overrides the tool specifications on the carried-forward parameters, applies the chat-request transformer, and fires the AiServiceRequestIssuedEvent.
ToolService.ToolResultsOutcome	ToolService.processToolResults(AiServiceContext context, List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecution> toolExecutions, InvocationContext invocationContext, ToolServiceContext toolServiceContext)	Per-round bookkeeping shared by every AI Service mode (sync, CompletableFuture, TokenStream, reactive Flow.Publisher): for each executed tool it records a ToolExecution, fires the ToolExecutedEvent, collects the tool-result message (in request order), and accumulates anyToolErrored + the per-tool ReturnBehaviors.
ToolService.ToolResultsOutcome	ToolService.processToolResults(AiServiceContext context, List<ToolExecutionRequest> toolExecutionRequests, Map<ToolExecutionRequest, ToolExecutionResult> toolResults, List<ToolExecution> toolExecutions, InvocationContext invocationContext, ToolServiceContext toolServiceContext)	Per-round bookkeeping shared by every AI Service mode (sync, CompletableFuture, TokenStream, reactive Flow.Publisher): for each executed tool it records a ToolExecution, fires the ToolExecutedEvent, collects the tool-result message (in request order), and accumulates anyToolErrored + the per-tool ReturnBehaviors.

Constructors in dev.langchain4j.service.tool with parameters of type ToolExecutionRequest

Modifier	Constructor	Description
	DefaultToolExecutor(Object object, ToolExecutionRequest toolExecutionRequest)

Constructor parameters in dev.langchain4j.service.tool with type arguments of type ToolExecutionRequest

Modifier	Constructor	Description
	CombinedToolResults(Map<ToolExecutionRequest, ToolExecutionResult> results, Throwable firstError)	Creates an instance of a CombinedToolResults record class.

Uses of ToolExecutionRequest in dev.langchain4j.service.tool.search

Methods in dev.langchain4j.service.tool.search that return ToolExecutionRequest

Modifier and Type	Method	Description
ToolExecutionRequest	ToolSearchRequest.toolExecutionRequest()	Returns the tool call containing the search query.

Methods in dev.langchain4j.service.tool.search with parameters of type ToolExecutionRequest

Modifier and Type	Method	Description
ToolSearchRequest.Builder	ToolSearchRequest.Builder.toolExecutionRequest(ToolExecutionRequest toolExecutionRequest)