Enum ProviderStreamEvent 

pub enum ProviderStreamEvent {
    Text(String),
    ToolCallStart {
        id: String,
        name: String,
    },
    ToolCallChunk {
        id: String,
        arguments: String,
    },
    Done {
        finish_reason: Option<String>,
        usage: Option<Usage>,
    },
}

A low-level event decoded from a provider’s server-sent event stream.

This is the raw shape yielded by RequestBuilder::stream. Providers differ in how they chunk tool calls, so tool arguments arrive as a ProviderStreamEvent::ToolCallStart followed by any number of ProviderStreamEvent::ToolCallChunks that must be concatenated. For a pre-assembled view, use RequestBuilder::generate_stream_events.

Variants

Text(String)

A fragment of assistant text to append to the output so far.

ToolCallStart

A tool call has begun; its arguments follow in later chunks.

Fields

id: String

Provider-assigned call identifier.

name: String

Name of the tool the model wants to run.

ToolCallChunk

A fragment of the JSON argument string for a tool call.

Fields

id: String

Identifier of the call these arguments belong to.

arguments: String

Partial JSON text to append to previously received fragments.

Done

Generation finished.

Depending on the provider, the finish reason and usage may arrive in separate Done events.

Fields

finish_reason: Option<String>

Why generation stopped, e.g. "stop" or "tool_use".

usage: Option<Usage>

Token usage, when the provider reports it.

Trait Implementations

impl Clone for ProviderStreamEvent

fn clone(&self) -> ProviderStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderStreamEvent

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

Formats the value using the given formatter.