Enum Class CompensationReason

java.lang.Object

java.lang.Enum<CompensationReason>

dev.langchain4j.observability.api.event.CompensationReason

All Implemented Interfaces:

Serializable, Comparable<CompensationReason>, Constable

@Experimental
public enum CompensationReason
extends Enum<CompensationReason>

Why a successfully-executed tool was compensated (rolled back). Carried by ToolCompensatedEvent.

Since:

1.20.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INVOCATION_CANCELLED	The AI Service invocation was cancelled, so this tool - which had executed successfully - was rolled back.
TOOL_EXECUTION_FAILED	Another tool in the same tool-calling round failed, so this tool - which had executed successfully - was rolled back to keep the round consistent.

Method Summary

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

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOOL_EXECUTION_FAILED

public static final CompensationReason TOOL_EXECUTION_FAILED

Another tool in the same tool-calling round failed, so this tool - which had executed successfully - was rolled back to keep the round consistent.

INVOCATION_CANCELLED

public static final CompensationReason INVOCATION_CANCELLED

The AI Service invocation was cancelled, so this tool - which had executed successfully - was rolled back.

Method Details

values

public static CompensationReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CompensationReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null