Struct ResponsesStreamEvent 

pub struct ResponsesStreamEvent {
    pub type: 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: each frame is event: <type> + data: <json> where the JSON is self-describing via type, and the stream ends after the terminal response.completed / response.incomplete / response.failed event. This is a flat superset of every event’s fields — type says which ones are meaningful; SDKs MUST ignore event types they don’t recognise (the dialect grows by adding types).

Fields

type: String

“response.created”, “response.output_text.delta”, …

sequence_number: u64

response: Option<ResponsesResponse>

response.created/in_progress/completed/incomplete/failed

output_index: Option<u32>

item_id: Option<String>

content_index: Option<u32>

item: Option<ResponseItem>

response.output_item.added/done

part: Option<ResponseContentPart>

response.content_part.added/done

delta: Option<String>

*.delta events (text / reasoning / arguments)

text: Option<String>

response.output_text.done / reasoning_text.done

arguments: Option<String>

response.function_call_arguments.done

message: Option<String>

“error” event

Implementations

impl ResponsesStreamEvent

pub fn output_index(&self) -> u32

Returns the value of output_index, or the default value if output_index is unset.

pub fn item_id(&self) -> &str

Returns the value of item_id, or the default value if item_id is unset.

pub fn content_index(&self) -> u32

Returns the value of content_index, or the default value if content_index is unset.

pub fn delta(&self) -> &str

Returns the value of delta, or the default value if delta is unset.

pub fn text(&self) -> &str

Returns the value of text, or the default value if text is unset.

pub fn arguments(&self) -> &str

Returns the value of arguments, or the default value if arguments is unset.

pub fn message(&self) -> &str

Returns the value of message, or the default value if message is unset.

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 Default for ResponsesStreamEvent

fn default() -> Self

Returns the “default value” for a type.

impl Message for ResponsesStreamEvent

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ResponsesStreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ResponsesStreamEvent