Uses of Enum Class
dev.langchain4j.observability.api.event.CompensationReason

Packages that use CompensationReason

Package	Description
dev.langchain4j.observability.api.event
dev.langchain4j.observability.event
dev.langchain4j.service
dev.langchain4j.service.tool

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

Subclasses with type arguments of type CompensationReason in dev.langchain4j.observability.api.event

Modifier and Type	Class	Description
enum	CompensationReason	Why a successfully-executed tool was compensated (rolled back).

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

Modifier and Type	Method	Description
CompensationReason	ToolCompensatedEvent.reason()	Returns why the tool was compensated.
CompensationReason	ToolCompensatedEvent.ToolCompensatedEventBuilder.reason()
static CompensationReason	CompensationReason.valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompensationReason[]	CompensationReason.values()	Returns an array containing the constants of this enum class, in the order they are declared.

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

Modifier and Type	Method	Description
ToolCompensatedEvent.ToolCompensatedEventBuilder	ToolCompensatedEvent.ToolCompensatedEventBuilder.reason(CompensationReason reason)	Sets the reason the tool was compensated.

Uses of CompensationReason in dev.langchain4j.observability.event

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

Modifier and Type	Method	Description
CompensationReason	DefaultToolCompensatedEvent.reason()

Uses of CompensationReason in dev.langchain4j.service

Methods in dev.langchain4j.service that return CompensationReason

Modifier and Type	Method	Description
CompensationReason	AiServiceStreamingEvent.ToolCompensatedEvent.reason()

Constructors in dev.langchain4j.service with parameters of type CompensationReason

Modifier	Constructor	Description
	ToolCompensatedEvent(ToolExecution toolExecution, CompensationReason reason, InvocationContext invocationContext)

Uses of CompensationReason in dev.langchain4j.service.tool

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

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

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

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