Enum ResponseStreamEvent 

#[non_exhaustive]
pub enum ResponseStreamEvent {
    Created {
        response: Response,
        sequence_number: u64,
    },
    InProgress {
        response: Response,
        sequence_number: u64,
    },
    Queued {
        response: Response,
        sequence_number: u64,
    },
    Completed {
        response: Response,
        sequence_number: u64,
    },
    Failed {
        response: Response,
        sequence_number: u64,
    },
    Incomplete {
        response: Response,
        sequence_number: u64,
    },
    OutputItemAdded {
        output_index: u32,
        item: OutputItem,
        sequence_number: u64,
    },
    OutputItemDone {
        output_index: u32,
        item: OutputItem,
        sequence_number: u64,
    },
    ContentPartAdded {
        item_id: String,
        output_index: u32,
        content_index: u32,
        part: Value,
        sequence_number: u64,
    },
    ContentPartDone {
        item_id: String,
        output_index: u32,
        content_index: u32,
        part: Value,
        sequence_number: u64,
    },
    OutputTextDelta {
        item_id: String,
        output_index: u32,
        content_index: u32,
        delta: String,
        sequence_number: u64,
    },
    OutputTextDone {
        item_id: String,
        output_index: u32,
        content_index: u32,
        text: String,
        sequence_number: u64,
    },
    FunctionCallArgumentsDelta {
        item_id: String,
        output_index: u32,
        delta: String,
        sequence_number: u64,
    },
    FunctionCallArgumentsDone {
        item_id: String,
        output_index: u32,
        arguments: String,
        sequence_number: u64,
    },
    Error {
        code: Option<String>,
        message: String,
        param: Option<String>,
        sequence_number: u64,
    },
    Unknown,
}

One event in a Responses API SSE 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.

Created

Fields

response: Response

sequence_number: u64

InProgress

Fields

response: Response

sequence_number: u64

Queued

Fields

response: Response

sequence_number: u64

Completed

Terminal: the response finished successfully.

Fields

response: Response

sequence_number: u64

Failed

Terminal: the response failed. This is Ok(Failed{..}), not a stream error — inspect response.error for details.

Fields

response: Response

sequence_number: u64

Incomplete

Terminal: the response stopped early (e.g. hit max_output_tokens).

Fields

response: Response

sequence_number: u64

OutputItemAdded

Fields

output_index: u32

item: OutputItem

sequence_number: u64

OutputItemDone

Fields

output_index: u32

item: OutputItem

sequence_number: u64

ContentPartAdded

Fields

item_id: String

output_index: u32

content_index: u32

part: Value

sequence_number: u64

ContentPartDone

Fields

item_id: String

output_index: u32

content_index: u32

part: Value

sequence_number: u64

OutputTextDelta

Fields

item_id: String

output_index: u32

content_index: u32

delta: String

sequence_number: u64

OutputTextDone

Fields

item_id: String

output_index: u32

content_index: u32

text: String

sequence_number: u64

FunctionCallArgumentsDelta

Fields

item_id: String

output_index: u32

delta: String

sequence_number: u64

FunctionCallArgumentsDone

Fields

item_id: String

output_index: u32

arguments: String

sequence_number: u64

Error

Fields

code: Option<String>

message: String

param: Option<String>

sequence_number: u64

Unknown

Any event type not modeled above (audio, reasoning-summary, code-interpreter, mcp, image-gen, refusal, annotation, …).

Implementations

impl ResponseStreamEvent

pub fn sequence_number(&self) -> Option<u64>

This event’s position in the stream, for resuming a background response via retrieve_stream(id, starting_after). None only for ResponseStreamEvent::Unknown (payload not captured).

Trait Implementations

impl Clone for ResponseStreamEvent

fn clone(&self) -> ResponseStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.