Package io.agentscope.core.agui.event

Interface AguiEvent

All Known Implementing Classes:

AguiEvent.Custom, AguiEvent.Raw, AguiEvent.ReasoningEnd, AguiEvent.ReasoningMessageChunk, AguiEvent.ReasoningMessageContent, AguiEvent.ReasoningMessageEnd, AguiEvent.ReasoningMessageStart, AguiEvent.ReasoningStart, AguiEvent.RunFinished, AguiEvent.RunStarted, AguiEvent.StateDelta, AguiEvent.StateSnapshot, AguiEvent.TextMessageContent, AguiEvent.TextMessageEnd, AguiEvent.TextMessageStart, AguiEvent.ToolCallArgs, AguiEvent.ToolCallEnd, AguiEvent.ToolCallResult, AguiEvent.ToolCallStart

public sealed interface AguiEvent
permits AguiEvent.RunStarted, AguiEvent.RunFinished, AguiEvent.TextMessageStart, AguiEvent.TextMessageContent, AguiEvent.TextMessageEnd, AguiEvent.ToolCallStart, AguiEvent.ToolCallArgs, AguiEvent.ToolCallEnd, AguiEvent.ToolCallResult, AguiEvent.StateSnapshot, AguiEvent.StateDelta, AguiEvent.Raw, AguiEvent.Custom, AguiEvent.ReasoningStart, AguiEvent.ReasoningMessageStart, AguiEvent.ReasoningMessageContent, AguiEvent.ReasoningMessageEnd, AguiEvent.ReasoningMessageChunk, AguiEvent.ReasoningEnd

Sealed interface for all AG-UI protocol events.

All events in the AG-UI protocol implement this interface and provide common properties like event type, thread ID, and run ID. Using sealed interface with records provides a cleaner, more concise implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	AguiEvent.Custom	The Custom event provides an extension mechanism for implementing features not covered by the standard event types.
static final record	AguiEvent.JsonPatchOperation	Represents a JSON Patch operation (RFC 6902).
static final record	AguiEvent.Raw	Event containing raw/custom data.
static final record	AguiEvent.ReasoningEnd	Event indicating the end of a reasoning/thinking phase.
static final record	AguiEvent.ReasoningMessageChunk	A convenience event to auto start/close reasoning messages.
static final record	AguiEvent.ReasoningMessageContent	Event containing a chunk of content in a streaming reasoning message.
static final record	AguiEvent.ReasoningMessageEnd	Event signaling the end of a reasoning message.
static final record	AguiEvent.ReasoningMessageStart	Event signaling the start of a reasoning message.
static final record	AguiEvent.ReasoningStart	Event indicating the start of a reasoning/thinking phase.
static final record	AguiEvent.RunFinished	Event indicating that an agent run has finished.
static final record	AguiEvent.RunStarted	Event indicating that an agent run has started.
static final record	AguiEvent.StateDelta	Event containing an incremental state delta.
static final record	AguiEvent.StateSnapshot	Event containing a full state snapshot.
static final record	AguiEvent.TextMessageContent	Event containing incremental text content for a message.
static final record	AguiEvent.TextMessageEnd	Event indicating the end of a text message.
static final record	AguiEvent.TextMessageStart	Event indicating the start of a text message.
static final record	AguiEvent.ToolCallArgs	Event containing streaming arguments for a tool call.
static final record	AguiEvent.ToolCallEnd	Event indicating the end of a tool call.
static final record	AguiEvent.ToolCallResult	Event containing the result of a tool call.
static final record	AguiEvent.ToolCallStart	Event indicating the start of a tool call.

Method Summary

Modifier and Type	Method	Description
String	getRunId()	Get the run ID associated with this event.
String	getThreadId()	Get the thread ID associated with this event.
AguiEventType	getType()	Get the event type.

Method Details

getType

AguiEventType getType()

Get the event type.

Returns:

The event type

getThreadId

String getThreadId()

Get the thread ID associated with this event.

Returns:

The thread ID

getRunId

String getRunId()

Get the run ID associated with this event.

Returns:

The run ID