Enum ResponsesStreamEvent 

#[non_exhaustive]
pub enum ResponsesStreamEvent {
    ResponseCreated {
        sequence_number: u64,
        response: Response,
    },
    ResponseInProgress {
        sequence_number: u64,
        response: Response,
    },
    ResponseOutputItemAdded {
        sequence_number: u64,
        output_index: u64,
        item: OutputItem,
    },
    ResponseOutputItemDone {
        sequence_number: u64,
        output_index: u64,
        item: OutputItem,
    },
    ResponseContentPartAdded {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        content_index: u64,
        part: ContentPart,
    },
    ResponseContentPartDone {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        content_index: u64,
        part: ContentPart,
    },
    ResponseReasoningTextDelta {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        content_index: u64,
        delta: String,
    },
    ResponseReasoningTextDone {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        content_index: u64,
        text: String,
    },
    ResponseOutputTextDelta {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        content_index: u64,
        delta: String,
    },
    ResponseOutputTextDone {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        content_index: u64,
        text: String,
    },
    ResponseFunctionCallArgumentsDelta {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        delta: String,
    },
    ResponseFunctionCallArgumentsDone {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        arguments: String,
    },
    ResponseCustomToolCallInputDelta {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        delta: String,
    },
    ResponseCustomToolCallInputDone {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
        input: String,
    },
    ResponseWebSearchCallInProgress {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
    },
    ResponseWebSearchCallSearching {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
    },
    ResponseWebSearchCallCompleted {
        sequence_number: u64,
        item_id: String,
        output_index: u64,
    },
    ResponseCompleted {
        sequence_number: u64,
        response: Response,
    },
    ResponseIncomplete {
        sequence_number: u64,
        response: Response,
    },
    ResponseFailed {
        sequence_number: u64,
        response: Response,
    },
    Unknown,
}

A semantic server-sent event emitted by the Responses API stream.

Each event carries a sequence_number. The final event is response.completed / response.incomplete / response.failed; there is no data: [DONE] message.

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.

ResponseCreated

The first event; the response has been created with status in_progress.

Fields

sequence_number: u64

response: Response

ResponseInProgress

The response is being generated.

Fields

sequence_number: u64

response: Response

ResponseOutputItemAdded

An output item starts.

Fields

sequence_number: u64

output_index: u64

item: OutputItem

ResponseOutputItemDone

An output item completes.

Fields

sequence_number: u64

output_index: u64

item: OutputItem

ResponseContentPartAdded

A content part within an output item starts.

Fields

sequence_number: u64

item_id: String

output_index: u64

content_index: u64

part: ContentPart

ResponseContentPartDone

A content part within an output item completes.

Fields

sequence_number: u64

item_id: String

output_index: u64

content_index: u64

part: ContentPart

ResponseReasoningTextDelta

Incremental chain-of-thought text.

Fields

sequence_number: u64

item_id: String

output_index: u64

content_index: u64

delta: String

ResponseReasoningTextDone

The full chain-of-thought text.

Fields

sequence_number: u64

item_id: String

output_index: u64

content_index: u64

text: String

ResponseOutputTextDelta

Incremental output text.

Fields

sequence_number: u64

item_id: String

output_index: u64

content_index: u64

delta: String

ResponseOutputTextDone

The full output text.

Fields

sequence_number: u64

item_id: String

output_index: u64

content_index: u64

text: String

ResponseFunctionCallArgumentsDelta

Incremental function call arguments.

Fields

sequence_number: u64

item_id: String

output_index: u64

delta: String

ResponseFunctionCallArgumentsDone

The full function call arguments.

Fields

sequence_number: u64

item_id: String

output_index: u64

arguments: String

ResponseCustomToolCallInputDelta

Incremental custom tool call (apply_patch) input.

Fields

sequence_number: u64

item_id: String

output_index: u64

delta: String

ResponseCustomToolCallInputDone

The full custom tool call (apply_patch) input.

Fields

sequence_number: u64

item_id: String

output_index: u64

input: String

ResponseWebSearchCallInProgress

A server-side web search tool call is starting.

Fields

sequence_number: u64

item_id: String

output_index: u64

ResponseWebSearchCallSearching

A server-side web search tool call is searching.

Fields

sequence_number: u64

item_id: String

output_index: u64

ResponseWebSearchCallCompleted

A server-side web search tool call completed.

Fields

sequence_number: u64

item_id: String

output_index: u64

ResponseCompleted

The final event when the response completes normally, carrying the full response object.

Fields

sequence_number: u64

response: Response

ResponseIncomplete

The final event when the response is truncated, carrying the full response object.

Fields

sequence_number: u64

response: Response

ResponseFailed

The final event when the response fails, carrying the full response object with error details.

Fields

sequence_number: u64

response: Response

Unknown

An unrecognized event type, tolerated during deserialization.

Implementations

impl ResponsesStreamEvent

pub fn is_terminal(&self) -> bool

Whether this event is one of the terminal events (response.completed / response.incomplete / response.failed).

pub fn response(&self) -> Option<&Response>

The full response object carried by created / in-progress / terminal events.

pub fn delta(&self) -> Option<&str>

The incremental delta text carried by *_text.delta / *_arguments.delta events.

Trait Implementations

impl Clone for ResponsesStreamEvent

fn clone(&self) -> ResponsesStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponsesStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponsesStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponsesStreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ResponsesStreamEvent

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 ResponsesStreamEvent