Interface ToolExecutedEvent

All Superinterfaces:

AiServiceEvent

All Known Implementing Classes:

DefaultToolExecutedEvent

public interface ToolExecutedEvent
extends AiServiceEvent

Invoked after the tool is executed. It is important to note that this can be invoked multiple times within a single AI Service invocation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ToolExecutedEvent.ToolExecutedEventBuilder

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Method Summary

Modifier and Type	Method	Description
static ToolExecutedEvent.ToolExecutedEventBuilder	builder()	Creates a new builder instance for constructing a ToolExecutedEvent.
default Class<ToolExecutedEvent>	eventClass()	Retrieves the class type of the event, representing the specific category of the AI Service invocation event.
default boolean	isError()	Returns whether the tool execution failed, for example because the tool threw an exception and the error was sent to the LLM.
ToolExecutionRequest	request()	Gets the ToolExecutionRequest that initiated the tool execution.
List<Content>	resultContents()	Returns the contents of the tool execution result.
String	resultText()	Returns the tool execution result as a plain text string.
default ToolExecutedEvent.ToolExecutedEventBuilder	toBuilder()	Creates a new builder instance initialized with the properties of this AiServiceEvent.

Methods inherited from interface AiServiceEvent

invocationContext

Method Details

request

ToolExecutionRequest request()

Gets the ToolExecutionRequest that initiated the tool execution.

resultText

String resultText()

Returns the tool execution result as a plain text string. This is a convenience method for when the result is known to be a single TextContent.

Returns:

the text of the single TextContent element.

Throws:

IllegalStateException - if the result contains non-text or multiple content elements. Use resultContents() instead.

resultContents

@Experimental
List<Content> resultContents()

Returns the contents of the tool execution result.

Returns:

the list of Content elements, never null.

Since:

1.13.0

isError

@Experimental
default boolean isError()

Returns whether the tool execution failed, for example because the tool threw an exception and the error was sent to the LLM. It is also true when the tool error failed the AI Service invocation (for example with ToolExecutionErrorHandler.failInvocation()): then the result is the error text, which was not sent to the LLM, and an AiServiceErrorEvent follows. AI Services created with AiServices always report it. Integrations that create their own events should report it too: code that reads events reflectively, for example a JSON serializer that serializes this event or an AiServiceInvocationSummaryEvent containing it, fails with UnsupportedOperationException when it is not reported.

Returns:

true if the tool execution failed, false if it succeeded

Throws:

UnsupportedOperationException - if the integration that created this event does not report it

Since:

1.23.0

builder

static ToolExecutedEvent.ToolExecutedEventBuilder builder()

Creates a new builder instance for constructing a ToolExecutedEvent.

eventClass

default Class<ToolExecutedEvent> eventClass()

Description copied from interface: AiServiceEvent

Retrieves the class type of the event, representing the specific category of the AI Service invocation event.

Specified by:

eventClass in interface AiServiceEvent

toBuilder

default ToolExecutedEvent.ToolExecutedEventBuilder toBuilder()

Description copied from interface: AiServiceEvent

Creates a new builder instance initialized with the properties of this AiServiceEvent. This allows modification of the existing properties and reconstruction of the event.

Specified by:

toBuilder in interface AiServiceEvent