Enum AgentStreamEvent 

pub enum AgentStreamEvent {
    RunStart {
        run_id: RunId,
        conversation_id: ConversationId,
    },
    NodeStart {
        node: AgentExecutionNode,
        step: usize,
        status: RunStatus,
    },
    NodeComplete {
        node: AgentExecutionNode,
        step: usize,
        status: RunStatus,
    },
    Custom {
        event: AgentEvent,
    },
    ModelRequest {
        step: usize,
    },
    ModelStream {
        step: usize,
        event: ModelResponseStreamEvent,
    },
    ModelResponse {
        step: usize,
        response: ModelResponse,
    },
    Checkpoint {
        node: AgentExecutionNode,
        step: usize,
    },
    Suspended {
        node: AgentExecutionNode,
        reason: String,
    },
    ToolCall {
        step: usize,
        call: ToolCallPart,
    },
    ToolReturn {
        step: usize,
        tool_return: ToolReturnPart,
    },
    OutputRetry {
        retries: usize,
        prompt: String,
    },
    SteeringGuard {
        step: usize,
        prompt: String,
    },
    RunComplete {
        run_id: RunId,
        output: String,
    },
    RunFailed {
        run_id: RunId,
        error_kind: String,
        message: String,
    },
}

Typed event emitted by the agent runtime while a run progresses.

Variants

RunStart

A run started.

Fields

run_id: RunId

Run identifier.

conversation_id: ConversationId

Conversation identifier.

NodeStart

Runtime execution entered a durable node boundary.

Fields

node: AgentExecutionNode

Execution boundary being entered.

step: usize

Completed run step at this boundary.

status: RunStatus

Current run status at this boundary.

NodeComplete

Runtime execution completed a durable node boundary.

Fields

node: AgentExecutionNode

Execution boundary that completed.

step: usize

Completed run step at this boundary.

status: RunStatus

Current run status after this boundary.

Custom

A context sideband event was published during the run.

Fields

event: AgentEvent

Application or capability event.

ModelRequest

A model request was prepared for a loop step.

Fields

step: usize

Completed run step before sending the request.

ModelStream

A model response stream event was received.

Fields

step: usize

Completed run step for the active model request.

event: ModelResponseStreamEvent

Canonical model stream event.

ModelResponse

A model response was received.

Fields

step: usize

Completed run step after receiving the response.

response: ModelResponse

Canonical model response.

Checkpoint

A durable execution checkpoint was persisted or inspected.

Fields

node: AgentExecutionNode

Execution boundary.

step: usize

Completed run step at this boundary.

Suspended

Execution was suspended at a durable checkpoint.

Fields

node: AgentExecutionNode

Execution boundary that requested suspension.

reason: String

Human-readable suspend reason.

ToolCall

A model requested a function tool call.

Fields

step: usize

Current run step.

call: ToolCallPart

Tool call part.

ToolReturn

A function tool returned a result or structured control-flow error.

Fields

step: usize

Current run step.

tool_return: ToolReturnPart

Tool return part.

OutputRetry

Output validation or output function validation requested another model turn.

Fields

retries: usize

Retry count after this retry was scheduled.

prompt: String

Retry prompt sent to the model.

SteeringGuard

Pending user steering requested another model turn before finalization.

Fields

step: usize

Current run step.

prompt: String

Control prompt sent to the model before finalization.

RunComplete

A run completed successfully.

Fields

run_id: RunId

Run identifier.

output: String

Final output text.

RunFailed

A run failed after preserving recoverable context state.

Fields

run_id: RunId

Run identifier.

error_kind: String

Failure kind.

message: String

Human-readable error message.

Implementations

impl AgentStreamEvent

pub fn sideband_event(&self) -> Option<AgentSidebandEvent>

Return a typed sideband event view for known context events carried by Custom.

Trait Implementations

impl Clone for AgentStreamEvent

fn clone(&self) -> AgentStreamEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentStreamEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentStreamEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AgentStreamEvent

impl PartialEq for AgentStreamEvent

fn eq(&self, other: &AgentStreamEvent) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AgentStreamEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AgentStreamEvent