Struct StreamChunk 

pub struct StreamChunk {
    pub content: String,
    pub is_delta: bool,
    pub is_done: bool,
    pub model: String,
    pub role: Option<MessageRole>,
    pub tool_calls_delta: Option<Vec<ToolCallDelta>>,
    pub finish_reason: Option<String>,
    pub usage: Option<Usage>,
    pub metadata: HashMap<String, Value>,
    pub timestamp: Option<DateTime<Utc>>,
}

A single chunk in a streaming response

Fields

content: String

Content delta for this chunk

is_delta: bool

Whether this is a delta (partial) or complete content

is_done: bool

Whether this is the final chunk

model: String

Model name

role: Option<MessageRole>

Role of the message (if applicable)

tool_calls_delta: Option<Vec<ToolCallDelta>>

Tool calls delta (if applicable)

finish_reason: Option<String>

Finish reason (if this is the final chunk)

usage: Option<Usage>

Usage statistics (typically only in final chunk)

metadata: HashMap<String, Value>

Chunk metadata

timestamp: Option<DateTime<Utc>>

Chunk timestamp

Implementations

impl StreamChunk

pub fn new( content: impl Into<String>, model: impl Into<String>, is_delta: bool, is_done: bool, ) -> Self

Create a new stream chunk

pub fn delta(content: impl Into<String>, model: impl Into<String>) -> Self

Create a delta chunk

pub fn done(model: impl Into<String>) -> Self

Create a final chunk

pub fn with_role(self, role: MessageRole) -> Self

Set the role

pub fn with_tool_calls_delta(self, delta: Vec<ToolCallDelta>) -> Self

Set tool calls delta

pub fn with_finish_reason(self, reason: impl Into<String>) -> Self

Set finish reason

pub fn with_usage(self, usage: Usage) -> Self

Set usage statistics

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Add metadata

pub fn has_content(&self) -> bool

Check if this chunk has content

pub fn has_tool_calls(&self) -> bool

Check if this chunk has tool calls

Trait Implementations

impl Clone for StreamChunk

fn clone(&self) -> StreamChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamChunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamChunk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.