Enum ResponseStreamEvent 

pub enum ResponseStreamEvent {
    AudioDelta {
        delta: String,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    AudioDone {
        sequence_number: u64,
    },
    AudioTranscriptDelta {
        delta: String,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    AudioTranscriptDone {
        sequence_number: u64,
    },
    CodeInterpreterCallCodeDelta {
        delta: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    CodeInterpreterCallCodeDone {
        code: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    CodeInterpreterCallCompleted {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    CodeInterpreterCallInProgress {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    CodeInterpreterCallInterpreting {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    Created {
        response: ResponseBody,
        sequence_number: u64,
    },
    Queued {
        response: ResponseBody,
        sequence_number: u64,
    },
    InProgress {
        response: ResponseBody,
        sequence_number: u64,
    },
    Failed {
        response: ResponseBody,
        sequence_number: u64,
    },
    Incomplete {
        response: ResponseBody,
        sequence_number: u64,
    },
    Completed {
        response: ResponseBody,
        sequence_number: u64,
    },
    OutputItemAdded {
        item: ResponseOutputItem,
        output_index: u64,
        sequence_number: u64,
    },
    OutputItemDone {
        item: ResponseOutputItem,
        output_index: u64,
        sequence_number: u64,
    },
    ContentPartAdded {
        content_index: u64,
        item_id: String,
        output_index: u64,
        part: ResponseStreamContentPart,
        sequence_number: u64,
    },
    ContentPartDone {
        content_index: u64,
        item_id: String,
        output_index: u64,
        part: ResponseStreamContentPart,
        sequence_number: u64,
    },
    OutputTextAnnotationAdded {
        annotation: Value,
        annotation_index: u64,
        content_index: u64,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    OutputTextDelta {
        content_index: u64,
        delta: String,
        item_id: String,
        logprobs: Option<Vec<ResponseStreamTokenLogprob>>,
        output_index: u64,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    OutputTextDone {
        content_index: u64,
        item_id: String,
        logprobs: Option<Vec<ResponseStreamTokenLogprob>>,
        output_index: u64,
        sequence_number: u64,
        text: String,
    },
    RefusalDelta {
        content_index: u64,
        delta: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    RefusalDone {
        content_index: u64,
        item_id: String,
        output_index: u64,
        refusal: String,
        sequence_number: u64,
    },
    ReasoningTextDelta {
        content_index: u64,
        delta: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    ReasoningTextDone {
        content_index: u64,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        text: String,
    },
    ReasoningSummaryPartAdded {
        item_id: String,
        output_index: u64,
        part: ResponseSummaryTextContent,
        sequence_number: u64,
        summary_index: u64,
    },
    ReasoningSummaryPartDone {
        item_id: String,
        output_index: u64,
        part: ResponseSummaryTextContent,
        sequence_number: u64,
        summary_index: u64,
    },
    ReasoningSummaryTextDelta {
        delta: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        summary_index: u64,
        obfuscation: Option<String>,
    },
    ReasoningSummaryTextDone {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        summary_index: u64,
        text: String,
    },
    FunctionCallArgumentsDelta {
        delta: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    FunctionCallArgumentsDone {
        arguments: String,
        item_id: String,
        name: Option<String>,
        output_index: u64,
        sequence_number: u64,
    },
    FileSearchCallInProgress {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    FileSearchCallSearching {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    FileSearchCallCompleted {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    WebSearchCallInProgress {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    WebSearchCallSearching {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    WebSearchCallCompleted {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    ImageGenerationCallInProgress {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    ImageGenerationCallGenerating {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    ImageGenerationCallPartialImage {
        item_id: String,
        output_index: u64,
        partial_image_b64: String,
        partial_image_index: u64,
        sequence_number: u64,
    },
    ImageGenerationCallCompleted {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    McpCallArgumentsDelta {
        delta: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    McpCallArgumentsDone {
        arguments: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    McpCallInProgress {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    McpCallCompleted {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    McpCallFailed {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    McpListToolsInProgress {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    McpListToolsCompleted {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    McpListToolsFailed {
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    CustomToolCallInputDelta {
        delta: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
        obfuscation: Option<String>,
    },
    CustomToolCallInputDone {
        input: String,
        item_id: String,
        output_index: u64,
        sequence_number: u64,
    },
    Error {
        error: ResponseStreamErrorPayload,
        sequence_number: u64,
    },
    Keepalive {
        sequence_number: u64,
    },
}

Stream event union documented by Responses API.

Each SSE data: line (except [DONE]) deserializes to one of these variants, discriminated by the type field in JSON.

Variants

AudioDelta

Fields

delta: String

sequence_number: u64

obfuscation: Option<String>

AudioDone

Fields

sequence_number: u64

AudioTranscriptDelta

Fields

delta: String

sequence_number: u64

obfuscation: Option<String>

AudioTranscriptDone

Fields

sequence_number: u64

CodeInterpreterCallCodeDelta

Fields

delta: String

item_id: String

output_index: u64

sequence_number: u64

obfuscation: Option<String>

CodeInterpreterCallCodeDone

Fields

code: String

item_id: String

output_index: u64

sequence_number: u64

CodeInterpreterCallCompleted

Fields

item_id: String

output_index: u64

sequence_number: u64

CodeInterpreterCallInProgress

Fields

item_id: String

output_index: u64

sequence_number: u64

CodeInterpreterCallInterpreting

Fields

item_id: String

output_index: u64

sequence_number: u64

Created

Fields

response: ResponseBody

sequence_number: u64

Queued

Fields

response: ResponseBody

sequence_number: u64

InProgress

Fields

response: ResponseBody

sequence_number: u64

Failed

Fields

response: ResponseBody

sequence_number: u64

Incomplete

Fields

response: ResponseBody

sequence_number: u64

Completed

Fields

response: ResponseBody

sequence_number: u64

OutputItemAdded

Fields

item: ResponseOutputItem

output_index: u64

sequence_number: u64

OutputItemDone

Fields

item: ResponseOutputItem

output_index: u64

sequence_number: u64

ContentPartAdded

Fields

content_index: u64

item_id: String

output_index: u64

part: ResponseStreamContentPart

sequence_number: u64

ContentPartDone

Fields

content_index: u64

item_id: String

output_index: u64

part: ResponseStreamContentPart

sequence_number: u64

OutputTextAnnotationAdded

Fields

annotation: Value

annotation_index: u64

content_index: u64

item_id: String

output_index: u64

sequence_number: u64

OutputTextDelta

Fields

content_index: u64

delta: String

item_id: String

logprobs: Option<Vec<ResponseStreamTokenLogprob>>

output_index: u64

sequence_number: u64

obfuscation: Option<String>

OutputTextDone

Fields

content_index: u64

item_id: String

logprobs: Option<Vec<ResponseStreamTokenLogprob>>

output_index: u64

sequence_number: u64

text: String

RefusalDelta

Fields

content_index: u64

delta: String

item_id: String

output_index: u64

sequence_number: u64

obfuscation: Option<String>

RefusalDone

Fields

content_index: u64

item_id: String

output_index: u64

refusal: String

sequence_number: u64

ReasoningTextDelta

Fields

content_index: u64

delta: String

item_id: String

output_index: u64

sequence_number: u64

obfuscation: Option<String>

ReasoningTextDone

Fields

content_index: u64

item_id: String

output_index: u64

sequence_number: u64

text: String

ReasoningSummaryPartAdded

Fields

item_id: String

output_index: u64

part: ResponseSummaryTextContent

sequence_number: u64

summary_index: u64

ReasoningSummaryPartDone

Fields

item_id: String

output_index: u64

part: ResponseSummaryTextContent

sequence_number: u64

summary_index: u64

ReasoningSummaryTextDelta

Fields

delta: String

item_id: String

output_index: u64

sequence_number: u64

summary_index: u64

obfuscation: Option<String>

ReasoningSummaryTextDone

Fields

item_id: String

output_index: u64

sequence_number: u64

summary_index: u64

text: String

FunctionCallArgumentsDelta

Fields

delta: String

item_id: String

output_index: u64

sequence_number: u64

obfuscation: Option<String>

FunctionCallArgumentsDone

Fields

arguments: String

item_id: String

name: Option<String>

output_index: u64

sequence_number: u64

FileSearchCallInProgress

Fields

item_id: String

output_index: u64

sequence_number: u64

FileSearchCallSearching

Fields

item_id: String

output_index: u64

sequence_number: u64

FileSearchCallCompleted

Fields

item_id: String

output_index: u64

sequence_number: u64

WebSearchCallInProgress

Fields

item_id: String

output_index: u64

sequence_number: u64

WebSearchCallSearching

Fields

item_id: String

output_index: u64

sequence_number: u64

WebSearchCallCompleted

Fields

item_id: String

output_index: u64

sequence_number: u64

ImageGenerationCallInProgress

Fields

item_id: String

output_index: u64

sequence_number: u64

ImageGenerationCallGenerating

Fields

item_id: String

output_index: u64

sequence_number: u64

ImageGenerationCallPartialImage

Fields

item_id: String

output_index: u64

partial_image_b64: String

partial_image_index: u64

sequence_number: u64

ImageGenerationCallCompleted

Fields

item_id: String

output_index: u64

sequence_number: u64

McpCallArgumentsDelta

Fields

delta: String

item_id: String

output_index: u64

sequence_number: u64

obfuscation: Option<String>

McpCallArgumentsDone

Fields

arguments: String

item_id: String

output_index: u64

sequence_number: u64

McpCallInProgress

Fields

item_id: String

output_index: u64

sequence_number: u64

McpCallCompleted

Fields

item_id: String

output_index: u64

sequence_number: u64

McpCallFailed

Fields

item_id: String

output_index: u64

sequence_number: u64

McpListToolsInProgress

Fields

item_id: String

output_index: u64

sequence_number: u64

McpListToolsCompleted

Fields

item_id: String

output_index: u64

sequence_number: u64

McpListToolsFailed

Fields

item_id: String

output_index: u64

sequence_number: u64

CustomToolCallInputDelta

Fields

delta: String

item_id: String

output_index: u64

sequence_number: u64

obfuscation: Option<String>

CustomToolCallInputDone

Fields

input: String

item_id: String

output_index: u64

sequence_number: u64

Error

Fields

error: ResponseStreamErrorPayload

sequence_number: u64

Keepalive

Undocumented SSE frame Codex ships while the upstream is still working (event: keepalive\ndata: {"type":"keepalive","sequence_number":N}). Not part of OpenAI’s public Responses streaming spec but required to keep deserialization from failing mid-stream.

Fields

sequence_number: u64

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.

impl PartialEq for ResponseStreamEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ResponseStreamEvent

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 ResponseStreamEvent