Struct ResponsesStreamEvent 

pub struct ResponsesStreamEvent {
    pub kind: String,
    pub sequence_number: u64,
    pub response: Option<ResponsesResponse>,
    pub output_index: Option<u32>,
    pub item_id: Option<String>,
    pub content_index: Option<u32>,
    pub item: Option<ResponseItem>,
    pub part: Option<ResponseContentPart>,
    pub delta: Option<String>,
    pub text: Option<String>,
    pub arguments: Option<String>,
    pub message: Option<String>,
}

One streaming SSE event. Unlike chat streaming there is NO data: [DONE] sentinel: the stream ends after the terminal response.completed / response.incomplete / response.failed event. This is a flat superset of every event’s fields — kind says which are meaningful; see the accessor helpers.

Fields

kind: String

The event type, e.g. "response.created", "response.output_text.delta", "error".

sequence_number: u64

response: Option<ResponsesResponse>

Present on response.created / response.in_progress / the terminal events.

output_index: Option<u32>

item_id: Option<String>

content_index: Option<u32>

item: Option<ResponseItem>

Present on response.output_item.added / .done.

part: Option<ResponseContentPart>

Present on response.content_part.added / .done.

delta: Option<String>

Present on *.delta events (text / reasoning / arguments).

text: Option<String>

Present on response.output_text.done / response.reasoning_text.done.

arguments: Option<String>

Present on response.function_call_arguments.done.

message: Option<String>

Present on the "error" event.

Implementations

impl ResponsesStreamEvent

pub fn is_terminal(&self) -> bool

Whether this is a terminal event (response.completed / .incomplete / .failed), after which the stream ends.

pub fn is_error(&self) -> bool

Whether this is the "error" event.

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

The incremental output text of a response.output_text.delta event; None otherwise. Accumulate these for the assembled text.

pub fn terminal_response(&self) -> Option<&ResponsesResponse>

The terminal response snapshot (with the full output and usage), if this is a terminal event carrying one.

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