Skip to main content

ResponseStreamEvent

openai_types::responses::streaming

Enum ResponseStreamEvent

#[non_exhaustive]pub enum ResponseStreamEvent {
Show 18 variants    ResponseCreated {
        response: Response,
    },
    ResponseInProgress {
        response: Response,
    },
    ResponseCompleted(ResponseCompletedEvent),
    ResponseFailed(ResponseFailedEvent),
    ResponseIncomplete(ResponseIncompleteEvent),
    ResponseOutputItemAdded(ResponseOutputItemAddedEvent),
    OutputItemDone {
        output_index: i64,
        item: ResponseOutputItem,
    },
    ContentPartAdded {
        output_index: i64,
        content_index: i64,
        part: Value,
    },
    ContentPartDone {
        output_index: i64,
        content_index: i64,
        part: Value,
    },
    ResponseOutputTextDelta(ResponseTextDeltaEvent),
    OutputTextDone {
        output_index: i64,
        content_index: i64,
        text: String,
    },
    ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent),
    ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent),
    ResponseReasoningTextDelta(ResponseReasoningTextDeltaEvent),
    ResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDeltaEvent),
    ReasoningSummaryTextDone {
        output_index: i64,
        summary_index: Option<i64>,
        text: String,
    },
    ResponseError(ResponseErrorEvent),
    Other(Value),
}

Expand description

A streaming event from the Responses API.

Uses #[serde(tag = "type")] for typed deserialization. Unknown event types fall through to the Other variant to ensure forward compatibility.

Variants (Non-exhaustive)§

This enum is marked as 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

Response created.

Fields

§response: Response

The created response.

ResponseInProgress

Response in progress.

Fields

§response: Response

The in-progress response.

ResponseCompleted(ResponseCompletedEvent)

Response completed.

ResponseFailed(ResponseFailedEvent)

Response failed.

ResponseIncomplete(ResponseIncompleteEvent)

Response incomplete.

ResponseOutputItemAdded(ResponseOutputItemAddedEvent)

New output item added.

OutputItemDone

Output item done.

Fields

§output_index: i64

Index of the output item.

§item: ResponseOutputItem

The completed output item.

ContentPartAdded

Content part added.

Fields

§output_index: i64

Index of the output item.

§content_index: i64

Index of the content part.

§part: Value

The content part.

ContentPartDone

Content part done.

Fields

§output_index: i64

Index of the output item.

§content_index: i64

Index of the content part.

§part: Value

The content part.

ResponseOutputTextDelta(ResponseTextDeltaEvent)

Text output delta.

OutputTextDone

Text output done.

Fields

§output_index: i64

Index of the output item.

§content_index: i64

Index of the content part.

§text: String

The complete text.

ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent)

Function call arguments delta.

ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent)

Function call arguments done.

ResponseReasoningTextDelta(ResponseReasoningTextDeltaEvent)

Reasoning text delta.

ResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDeltaEvent)

Reasoning summary text delta.

ReasoningSummaryTextDone

Reasoning summary text done.

Fields

§output_index: i64

Index of the output item.

§summary_index: Option<i64>

Index of the summary part.

§text: String

The complete summary text.

ResponseError(ResponseErrorEvent)

Error event.

Other(Value)

Unknown event type. Contains the raw JSON data for forward compatibility.

Implementations§

impl ResponseStreamEvent

pub fn event_type(&self) -> &str

Get the event type string.

Trait Implementations§

impl Clone for ResponseStreamEvent

fn clone(&self) -> ResponseStreamEvent

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ResponseStreamEvent

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

Formats the value using the given formatter. Read more

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. Read more

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. Read more

Auto Trait Implementations§

impl Freeze for ResponseStreamEvent

impl RefUnwindSafe for ResponseStreamEvent

impl Send for ResponseStreamEvent

impl Sync for ResponseStreamEvent

impl Unpin for ResponseStreamEvent

impl UnsafeUnpin for ResponseStreamEvent

impl UnwindSafe for ResponseStreamEvent

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.