Class DefaultToolExecutedEvent

java.lang.Object

dev.langchain4j.observability.event.AbstractAiServiceEvent

dev.langchain4j.observability.event.DefaultToolExecutedEvent

All Implemented Interfaces:

AiServiceEvent, ToolExecutedEvent

public class DefaultToolExecutedEvent
extends AbstractAiServiceEvent
implements ToolExecutedEvent

Default implementation of ToolExecutedEvent.

Nested Class Summary

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Nested classes/interfaces inherited from interface ToolExecutedEvent

ToolExecutedEvent.ToolExecutedEventBuilder

Constructor Summary

Constructors

Constructor	Description
DefaultToolExecutedEvent(ToolExecutedEvent.ToolExecutedEventBuilder builder)

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class AbstractAiServiceEvent

invocationContext

Methods inherited from class Object

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

Methods inherited from interface AiServiceEvent

invocationContext

Methods inherited from interface ToolExecutedEvent

eventClass, toBuilder

Constructor Details

DefaultToolExecutedEvent

public DefaultToolExecutedEvent(ToolExecutedEvent.ToolExecutedEventBuilder builder)

Method Details

request

public ToolExecutionRequest request()

Description copied from interface: ToolExecutedEvent

Gets the ToolExecutionRequest that initiated the tool execution.

Specified by:

request in interface ToolExecutedEvent

resultText

public String resultText()

Description copied from interface: ToolExecutedEvent

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.

Specified by:

resultText in interface ToolExecutedEvent

Returns:

the text of the single TextContent element.

resultContents

@Experimental
public List<Content> resultContents()

Description copied from interface: ToolExecutedEvent

Returns the contents of the tool execution result.

Specified by:

resultContents in interface ToolExecutedEvent

Returns:

the list of Content elements, never null.

isError

@Experimental
public boolean isError()

Description copied from interface: ToolExecutedEvent

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.

Specified by:

isError in interface ToolExecutedEvent

Returns:

true if the tool execution failed, false if it succeeded