PersistentAgentStreamEvent Class

Package:

com.azure.ai.agents.persistent.models

Maven Artifact:

com.azure:azure-ai-agents-persistent:1.0.0-beta.2

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.ai.agents.persistent.models.PersistentAgentStreamEvent

public final class PersistentAgentStreamEvent
extends ExpandableStringEnum<PersistentAgentStreamEvent>

Each event in a server-sent events stream has an `event` and `data` property: ``` event: thread.created data: {"id": "thread_123", "object": "thread", ...} ``` We emit events whenever a new object is created, transitions to a new state, or is being streamed in parts (deltas). For example, we emit `thread.run.created` when a new run is created, `thread.run.completed` when a run completes, and so on. When an Agent chooses to create a message during a run, we emit a `thread.message.created event`, a `thread.message.in_progress` event, many `thread.message.delta` events, and finally a `thread.message.completed` event. We may add additional events over time, so we recommend handling unknown events gracefully in your code.

Field Summary

Modifier and Type	Field and Description
static final PersistentAgentStreamEvent	DONE Event sent when the stream is done.
static final PersistentAgentStreamEvent	ERROR Event sent when an error occurs, such as an internal server error or a timeout.
static final PersistentAgentStreamEvent	THREAD_CREATED Event sent when a new thread is created.
static final PersistentAgentStreamEvent	THREAD_MESSAGE_COMPLETED Event sent when a message is completed.
static final PersistentAgentStreamEvent	THREAD_MESSAGE_CREATED Event sent when a new message is created.
static final PersistentAgentStreamEvent	THREAD_MESSAGE_DELTA Event sent when a message is being streamed.
static final PersistentAgentStreamEvent	THREAD_MESSAGE_INCOMPLETE Event sent before a message is completed.
static final PersistentAgentStreamEvent	THREAD_MESSAGE_IN_PROGRESS Event sent when a message moves to `in_progress` status.
static final PersistentAgentStreamEvent	THREAD_RUN_CANCELLED Event sent when a run is cancelled.
static final PersistentAgentStreamEvent	THREAD_RUN_CANCELLING Event sent when a run moves to `cancelling` status.
static final PersistentAgentStreamEvent	THREAD_RUN_COMPLETED Event sent when a run is completed.
static final PersistentAgentStreamEvent	THREAD_RUN_CREATED Event sent when a new run is created.
static final PersistentAgentStreamEvent	THREAD_RUN_EXPIRED Event sent when a run is expired.
static final PersistentAgentStreamEvent	THREAD_RUN_FAILED Event sent when a run fails.
static final PersistentAgentStreamEvent	THREAD_RUN_INCOMPLETE Event sent when a run ends incomplete.
static final PersistentAgentStreamEvent	THREAD_RUN_IN_PROGRESS Event sent when a run moves to `in_progress` status.
static final PersistentAgentStreamEvent	THREAD_RUN_QUEUED Event sent when a run moves to `queued` status.
static final PersistentAgentStreamEvent	THREAD_RUN_REQUIRES_ACTION Event sent when a run moves to `requires_action` status.
static final PersistentAgentStreamEvent	THREAD_RUN_STEP_CANCELLED Event sent when a run step is cancelled.
static final PersistentAgentStreamEvent	THREAD_RUN_STEP_COMPLETED Event sent when a run step is completed.
static final PersistentAgentStreamEvent	THREAD_RUN_STEP_CREATED Event sent when a new thread run step is created.
static final PersistentAgentStreamEvent	THREAD_RUN_STEP_DELTA Event sent when a run step is being streamed.
static final PersistentAgentStreamEvent	THREAD_RUN_STEP_EXPIRED Event sent when a run step is expired.
static final PersistentAgentStreamEvent	THREAD_RUN_STEP_FAILED Event sent when a run step fails.
static final PersistentAgentStreamEvent	THREAD_RUN_STEP_IN_PROGRESS Event sent when a run step moves to `in_progress` status.

Constructor Summary

Constructor	Description
PersistentAgentStreamEvent()	Deprecated Use the fromString(String name) factory method. Creates a new instance of PersistentAgentStreamEvent value.

Method Summary

Modifier and Type	Method and Description
static PersistentAgentStreamEvent	fromString(String name) Creates or finds a PersistentAgentStreamEvent from its string representation.
static Collection<PersistentAgentStreamEvent>	values() Gets known PersistentAgentStreamEvent values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

DONE

public static final PersistentAgentStreamEvent DONE

Event sent when the stream is done.

ERROR

public static final PersistentAgentStreamEvent ERROR

Event sent when an error occurs, such as an internal server error or a timeout.

THREAD_CREATED

public static final PersistentAgentStreamEvent THREAD_CREATED

Event sent when a new thread is created. The data of this event is of type AgentThread.

THREAD_MESSAGE_COMPLETED

public static final PersistentAgentStreamEvent THREAD_MESSAGE_COMPLETED

Event sent when a message is completed. The data of this event is of type ThreadMessage.

THREAD_MESSAGE_CREATED

public static final PersistentAgentStreamEvent THREAD_MESSAGE_CREATED

Event sent when a new message is created. The data of this event is of type ThreadMessage.

THREAD_MESSAGE_DELTA

public static final PersistentAgentStreamEvent THREAD_MESSAGE_DELTA

Event sent when a message is being streamed. The data of this event is of type MessageDeltaChunk.

THREAD_MESSAGE_INCOMPLETE

public static final PersistentAgentStreamEvent THREAD_MESSAGE_INCOMPLETE

Event sent before a message is completed. The data of this event is of type ThreadMessage.

THREAD_MESSAGE_IN_PROGRESS

public static final PersistentAgentStreamEvent THREAD_MESSAGE_IN_PROGRESS

Event sent when a message moves to `in_progress` status. The data of this event is of type ThreadMessage.

THREAD_RUN_CANCELLED

public static final PersistentAgentStreamEvent THREAD_RUN_CANCELLED

Event sent when a run is cancelled. The data of this event is of type ThreadRun.

THREAD_RUN_CANCELLING

public static final PersistentAgentStreamEvent THREAD_RUN_CANCELLING

Event sent when a run moves to `cancelling` status. The data of this event is of type ThreadRun.

THREAD_RUN_COMPLETED

public static final PersistentAgentStreamEvent THREAD_RUN_COMPLETED

Event sent when a run is completed. The data of this event is of type ThreadRun.

THREAD_RUN_CREATED

public static final PersistentAgentStreamEvent THREAD_RUN_CREATED

Event sent when a new run is created. The data of this event is of type ThreadRun.

THREAD_RUN_EXPIRED

public static final PersistentAgentStreamEvent THREAD_RUN_EXPIRED

Event sent when a run is expired. The data of this event is of type ThreadRun.

THREAD_RUN_FAILED

public static final PersistentAgentStreamEvent THREAD_RUN_FAILED

Event sent when a run fails. The data of this event is of type ThreadRun.

THREAD_RUN_INCOMPLETE

public static final PersistentAgentStreamEvent THREAD_RUN_INCOMPLETE

Event sent when a run ends incomplete. The data of this event is of type ThreadRun.

THREAD_RUN_IN_PROGRESS

public static final PersistentAgentStreamEvent THREAD_RUN_IN_PROGRESS

Event sent when a run moves to `in_progress` status. The data of this event is of type ThreadRun.

THREAD_RUN_QUEUED

public static final PersistentAgentStreamEvent THREAD_RUN_QUEUED

Event sent when a run moves to `queued` status. The data of this event is of type ThreadRun.

THREAD_RUN_REQUIRES_ACTION

public static final PersistentAgentStreamEvent THREAD_RUN_REQUIRES_ACTION

Event sent when a run moves to `requires_action` status. The data of this event is of type ThreadRun.

THREAD_RUN_STEP_CANCELLED

public static final PersistentAgentStreamEvent THREAD_RUN_STEP_CANCELLED

Event sent when a run step is cancelled. The data of this event is of type RunStep.

THREAD_RUN_STEP_COMPLETED

public static final PersistentAgentStreamEvent THREAD_RUN_STEP_COMPLETED

Event sent when a run step is completed. The data of this event is of type RunStep.

THREAD_RUN_STEP_CREATED

public static final PersistentAgentStreamEvent THREAD_RUN_STEP_CREATED

Event sent when a new thread run step is created. The data of this event is of type RunStep.

THREAD_RUN_STEP_DELTA

public static final PersistentAgentStreamEvent THREAD_RUN_STEP_DELTA

Event sent when a run step is being streamed. The data of this event is of type RunStepDeltaChunk.

THREAD_RUN_STEP_EXPIRED

public static final PersistentAgentStreamEvent THREAD_RUN_STEP_EXPIRED

Event sent when a run step is expired. The data of this event is of type RunStep.

THREAD_RUN_STEP_FAILED

public static final PersistentAgentStreamEvent THREAD_RUN_STEP_FAILED

Event sent when a run step fails. The data of this event is of type RunStep.

THREAD_RUN_STEP_IN_PROGRESS

public static final PersistentAgentStreamEvent THREAD_RUN_STEP_IN_PROGRESS

Event sent when a run step moves to `in_progress` status. The data of this event is of type RunStep.

Constructor Details

PersistentAgentStreamEvent

@Deprecated
public PersistentAgentStreamEvent()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of PersistentAgentStreamEvent value.

Method Details

fromString

public static PersistentAgentStreamEvent fromString(String name)

Creates or finds a PersistentAgentStreamEvent from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding PersistentAgentStreamEvent.

values

public static Collection<PersistentAgentStreamEvent> values()

Gets known PersistentAgentStreamEvent values.

Returns:

known PersistentAgentStreamEvent values.