Enum ChatEvent 

#[non_exhaustive]
pub enum ChatEvent {
    Delta {
        text: String,
    },
    Finished {
        usage: Option<LlmUsage>,
        model: Option<String>,
        finish_reason: Option<FinishReason>,
        metadata: Map<String, Value>,
    },
    ToolCall {
        id: String,
        name: String,
        arguments: String,
    },
}

An event in a chat completion stream.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Delta

A partial text delta from the stream.

Fields

text: String

The text chunk received.

Finished

The stream has finished.

Fields

usage: Option<LlmUsage>

Usage statistics, if available.

model: Option<String>

The model that generated the response.

finish_reason: Option<FinishReason>

Why the stream finished.

metadata: Map<String, Value>

Provider-specific metadata.

ToolCall

An intermediate tool call emitted during streaming.

Fields

id: String

Tool call identifier.

name: String

Name of the tool to invoke.

arguments: String

JSON arguments for the tool.

Trait Implementations

impl Clone for ChatEvent

fn clone(&self) -> ChatEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatEvent

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

Formats the value using the given formatter.