Skip to main content

ResponseStreamEvent

Enum ResponseStreamEvent 

Source
pub enum ResponseStreamEvent {
Show 21 variants Created { id: String, model: String, status: String, created_at: i64, request_context: Option<ResponseRequestContext>, }, InProgress { id: String, model: String, status: String, created_at: i64, request_context: Option<ResponseRequestContext>, }, OutputItemAdded { output_index: u32, item_id: String, item_type: String, role: Option<String>, call_id: Option<String>, name: Option<String>, }, ContentPartAdded { item_id: String, output_index: u32, content_index: u32, part_type: String, }, OutputTextDelta { item_id: String, output_index: u32, content_index: u32, delta: String, }, OutputTextDone { item_id: String, output_index: u32, content_index: u32, text: String, }, ContentPartDone { item_id: String, output_index: u32, content_index: u32, part_type: String, text: String, }, OutputItemDone { output_index: u32, item_id: String, item_type: String, role: Option<String>, call_id: Option<String>, name: Option<String>, arguments: Option<String>, text: Option<String>, refusal: Option<String>, summary: Option<Vec<ReasoningSummaryPart>>, }, ReasoningAdded { output_index: u32, item_id: String, }, ReasoningDelta { item_id: String, output_index: u32, content_index: u32, delta: String, }, ReasoningTextDone { item_id: String, output_index: u32, content_index: u32, text: String, }, ReasoningSummaryTextDelta { item_id: String, output_index: u32, content_index: u32, delta: String, }, ReasoningSummaryTextDone { item_id: String, output_index: u32, content_index: u32, text: String, }, FunctionCallArgumentsDelta { output_index: u32, item_id: String, call_id: Option<String>, delta: String, }, FunctionCallArgumentsDone { output_index: u32, item_id: String, call_id: String, arguments: String, }, Completed { response: Box<ResponseObject>, }, Error { id: Option<String>, error_type: String, message: String, code: Option<String>, }, Failed { id: String, model: String, status: String, created_at: i64, }, Incomplete { id: String, model: String, status: String, created_at: i64, reason: Option<String>, }, RefusalDelta { item_id: String, output_index: u32, content_index: u32, delta: String, }, RefusalDone { item_id: String, output_index: u32, content_index: u32, refusal: String, },
}
Expand description

SSE event types for Responses API streaming.

Variants§

§

Created

Initial response created event.

Fields

§model: String
§status: String
§created_at: i64
§

InProgress

Response is in progress.

Fields

§model: String
§status: String
§created_at: i64
§

OutputItemAdded

Output item was added.

Fields

§output_index: u32
§item_id: String
§item_type: String
§call_id: Option<String>
§

ContentPartAdded

Content part was added.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§part_type: String
§

OutputTextDelta

Output text delta (content chunk).

Fields

§item_id: String
§output_index: u32
§content_index: u32
§delta: String
§

OutputTextDone

Output text done.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§text: String
§

ContentPartDone

Content part done.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§part_type: String
§text: String
§

OutputItemDone

Output item done.

Fields

§output_index: u32
§item_id: String
§item_type: String
§call_id: Option<String>
§arguments: Option<String>
§refusal: Option<String>
§

ReasoningAdded

Reasoning output item added.

Fields

§output_index: u32
§item_id: String
§

ReasoningDelta

Reasoning text delta.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§delta: String
§

ReasoningTextDone

Reasoning text done.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§text: String
§

ReasoningSummaryTextDelta

Reasoning summary text delta.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§delta: String
§

ReasoningSummaryTextDone

Reasoning summary text done.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§text: String
§

FunctionCallArgumentsDelta

Function call arguments delta.

Fields

§output_index: u32
§item_id: String
§call_id: Option<String>
§delta: String
§

FunctionCallArgumentsDone

Function call arguments done.

Fields

§output_index: u32
§item_id: String
§call_id: String
§arguments: String
§

Completed

Response completed with final object.

Fields

§

Error

Response error event.

Fields

§error_type: String
§message: String
§

Failed

Response failed event.

Fields

§model: String
§status: String
§created_at: i64
§

Incomplete

Response incomplete event.

Fields

§model: String
§status: String
§created_at: i64
§reason: Option<String>
§

RefusalDelta

Refusal content delta.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§delta: String
§

RefusalDone

Refusal content done.

Fields

§item_id: String
§output_index: u32
§content_index: u32
§refusal: String

Trait Implementations§

Source§

impl Clone for ResponseStreamEvent

Source§

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
Source§

impl Debug for ResponseStreamEvent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more