Interface ToolCompensatedEvent

All Superinterfaces:

AiServiceEvent

All Known Implementing Classes:

DefaultToolCompensatedEvent

@Experimental
public interface ToolCompensatedEvent
extends AiServiceEvent

Invoked after a successfully-executed tool is compensated (rolled back) - for example when another tool in the same round failed, or when the invocation was cancelled. It carries the tool that was rolled back, its original (successful) result, and the CompensationReason. Like ToolExecutedEvent, it can be invoked multiple times within a single AI Service invocation.

Since:

1.20.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ToolCompensatedEvent.ToolCompensatedEventBuilder

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Method Summary

Modifier and Type	Method	Description
static ToolCompensatedEvent.ToolCompensatedEventBuilder	builder()	Creates a new builder instance for constructing a ToolCompensatedEvent.
default Class<ToolCompensatedEvent>	eventClass()	Retrieves the class type of the event, representing the specific category of the AI Service invocation event.
CompensationReason	reason()	Returns why the tool was compensated.
ToolExecutionRequest	request()	Gets the ToolExecutionRequest of the tool that was compensated.
List<Content>	resultContents()	Returns the contents of the compensated tool's original (successful) result.
String	resultText()	Returns the original (successful) result of the compensated tool as a plain text string.
default ToolCompensatedEvent.ToolCompensatedEventBuilder	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 of the tool that was compensated.

resultText

String resultText()

Returns the original (successful) result of the compensated tool as a plain text string.

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 compensated tool's original (successful) result.

Returns:

the list of Content elements, never null.

Since:

1.20.0

reason

CompensationReason reason()

Returns why the tool was compensated.

builder

static ToolCompensatedEvent.ToolCompensatedEventBuilder builder()

Creates a new builder instance for constructing a ToolCompensatedEvent.

eventClass

default Class<ToolCompensatedEvent> 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 ToolCompensatedEvent.ToolCompensatedEventBuilder 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