Package dyntabs.ai.event

Enum Class EasyAIEvent.Phase

java.lang.Object

java.lang.Enum<EasyAIEvent.Phase>

dyntabs.ai.event.EasyAIEvent.Phase

All Implemented Interfaces:

Serializable, Comparable<EasyAIEvent.Phase>, Constable

Enclosing class:

EasyAIEvent

public static enum EasyAIEvent.Phase
extends Enum<EasyAIEvent.Phase>

Which moment in an operation's lifecycle an event marks.

Analogy: the stages of a delivery — "dispatched" (STARTED), "out for delivery" (PROGRESS), "attempting delivery" (STEP_STARTED), "delivered" (STEP/RESULT), "redelivery" (RETRY), "completed" (FINISHED), "failed" (ERROR).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	The operation failed.
FINISHED	The operation finished successfully.
PROGRESS	Incremental progress within a longer operation (e.g.
RESULT	A meaningful intermediate or final result was produced.
RETRY	A failed attempt is being retried (e.g. malformed JSON during extraction).
STARTED	The operation has begun.
STEP	A discrete unit of work just completed (e.g. a tool returned).
STEP_STARTED	A discrete unit of work is about to run (e.g. a tool call is being dispatched).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STARTED

public static final EasyAIEvent.Phase STARTED

The operation has begun. Usually paired with EasyAIEvent.Status.RUNNING.

STEP_STARTED

public static final EasyAIEvent.Phase STEP_STARTED

A discrete unit of work is about to run (e.g. a tool call is being dispatched). Lets a UI show a spinning "running" row before the result arrives.

STEP

public static final EasyAIEvent.Phase STEP

A discrete unit of work just completed (e.g. a tool returned).

PROGRESS

public static final EasyAIEvent.Phase PROGRESS

Incremental progress within a longer operation (e.g. "document 7 of 200").

RESULT

public static final EasyAIEvent.Phase RESULT

A meaningful intermediate or final result was produced.

RETRY

public static final EasyAIEvent.Phase RETRY

A failed attempt is being retried (e.g. malformed JSON during extraction).

FINISHED

public static final EasyAIEvent.Phase FINISHED

The operation finished successfully.

ERROR

public static final EasyAIEvent.Phase ERROR

The operation failed. Usually paired with EasyAIEvent.Status.ERROR.

Method Details

values

public static EasyAIEvent.Phase[] 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 EasyAIEvent.Phase 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