ResponseStreamEvent

api_openai::components::responses

Enum ResponseStreamEvent 

Source 
#[non_exhaustive]
pub enum ResponseStreamEvent {

Show 24 variants    ResponseContentPartAdded(ResponseContentPartAddedEvent),
    ResponseContentPartDone(ResponseContentPartDoneEvent),
    ResponseCreated(ResponseCreatedEvent),
    ResponseErrorEvent(ResponseErrorEvent),
    ResponseFailed(ResponseFailedEvent),
    ResponseFileSearchCallCompleted(ResponseFileSearchCallCompletedEvent),
    ResponseFileSearchCallInProgress(ResponseFileSearchCallInProgressEvent),
    ResponseFileSearchCallSearching(ResponseFileSearchCallSearchingEvent),
    ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent),
    ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent),
    ResponseIncomplete(ResponseIncompleteEvent),
    ResponseInAnalysis(ResponseInProgressEvent),
    ResponseInProgress(ResponseInProgressEvent),
    ResponseOutputItemAdded(ResponseOutputItemAddedEvent),
    ResponseOutputItemDone(ResponseOutputItemDoneEvent),
    ResponseRefusalDone(ResponseRefusalDoneEvent),
    ResponseRefusalDelta(ResponseRefusalDeltaEvent),
    ResponseTextAnnotationDelta(ResponseTextAnnotationDeltaEvent),
    ResponseTextDelta(ResponseTextDeltaEvent),
    ResponseTextDone(ResponseTextDoneEvent),
    ResponseWebSearchCallCompleted(ResponseWebSearchCallCompletedEvent),
    ResponseWebSearchCallInProgress(ResponseWebSearchCallInProgressEvent),
    ResponseWebSearchCallSearching(ResponseWebSearchCallSearchingEvent),
    ResponseCompleted(ResponseCompletedEvent),

}
Expand description

Represents an event emitted when streaming a Response. Corresponds to the ResponseStreamEvent schema in the OpenAPI spec.

§Used By

  • api::responses::Responses::create_stream

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

ResponseContentPartAdded(ResponseContentPartAddedEvent)

Emitted when a new content part is added.

§

ResponseContentPartDone(ResponseContentPartDoneEvent)

Emitted when a content part is done.

§

ResponseCreated(ResponseCreatedEvent)

Emitted when a response is created.

§

ResponseErrorEvent(ResponseErrorEvent)

Emitted when an error occurs.

§

ResponseFailed(ResponseFailedEvent)

Emitted when a response fails.

§

ResponseFileSearchCallCompleted(ResponseFileSearchCallCompletedEvent)

Emitted when a file search call is completed (results found).

§

ResponseFileSearchCallInProgress(ResponseFileSearchCallInProgressEvent)

Emitted when a file search call is initiated.

§

ResponseFileSearchCallSearching(ResponseFileSearchCallSearchingEvent)

Emitted when a file search is currently searching.

§

ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent)

Emitted when function-call arguments are finalized.

§

ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent)

Emitted when there is a partial function-call arguments delta.

§

ResponseIncomplete(ResponseIncompleteEvent)

Emitted when a response finishes as incomplete.

§

ResponseInAnalysis(ResponseInProgressEvent)

Emitted when the response is in analysis.

§

ResponseInProgress(ResponseInProgressEvent)

Emitted when the response is in progress.

§

ResponseOutputItemAdded(ResponseOutputItemAddedEvent)

Emitted when a new output item is added.

§

ResponseOutputItemDone(ResponseOutputItemDoneEvent)

Emitted when an output item is marked done.

§

ResponseRefusalDone(ResponseRefusalDoneEvent)

Emitted when refusal text is finalized.

§

ResponseRefusalDelta(ResponseRefusalDeltaEvent)

Emitted when there is a partial refusal text.

§

ResponseTextAnnotationDelta(ResponseTextAnnotationDeltaEvent)

Emitted when text annotation is added.

§

ResponseTextDelta(ResponseTextDeltaEvent)

Emitted when there is an additional text delta.

§

ResponseTextDone(ResponseTextDoneEvent)

Emitted when text content is finalized.

§

ResponseWebSearchCallCompleted(ResponseWebSearchCallCompletedEvent)

Emitted when a web search call is completed.

§

ResponseWebSearchCallInProgress(ResponseWebSearchCallInProgressEvent)

Emitted when a web search call is initiated.

§

ResponseWebSearchCallSearching(ResponseWebSearchCallSearchingEvent)

Emitted when a web search call is executing.

§

ResponseCompleted(ResponseCompletedEvent)

Emitted when the model response is complete.

Trait Implementations§

Source§

impl Clone for ResponseStreamEvent

Source§

fn clone(&self) -> ResponseStreamEvent

Returns a duplicate of the value. Read more
1.0.0 · 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
Source§

impl<'de> Deserialize<'de> for ResponseStreamEvent

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ResponseStreamEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ResponseStreamEvent

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ResponseStreamEvent

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<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> CloneDyn for T
where T: Clone,

Source§

fn __clone_dyn(&self, _: DontCallMe) -> *mut ()

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<C, E> EntryToVal<C> for E
where C: Collection<Entry = E>,

Source§

type Val = <C as Collection>::Val

The type of values stored in the collection. This might be distinct from Entry in complex collections. For example, in a HashMap, while Entry might be a ( key, value ) tuple, Val might only be the value part.
Source§

fn entry_to_val(self) -> <E as EntryToVal<C>>::Val

Converts an entry into a value representation specific to the type of collection. This conversion is crucial for handling operations on entries, especially when they need to be treated or accessed as individual values, such as retrieving the value part from a key-value pair in a hash map.
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> IntoResult<T> for T

Source§

type Err = Infallible

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<C, Val> ValToEntry<C> for Val
where C: CollectionValToEntry<Val>,

Source§

fn val_to_entry(self) -> <C as CollectionValToEntry<Val>>::Entry

Invokes the val_to_entry function of the CollectionValToEntry trait to convert the value to an entry.

Source§

type Entry = <C as CollectionValToEntry<Val>>::Entry

Represents the type of entry that corresponds to the value within the collection. Type Entry is defined by the Collection trait.
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
Source§

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