ResponseEvent

async_openai::types::responses

Enum ResponseEvent 

Source 
#[non_exhaustive]
pub enum ResponseEvent {

Show 48 variants    ResponseCreated(ResponseCreated),
    ResponseInProgress(ResponseInProgress),
    ResponseCompleted(ResponseCompleted),
    ResponseFailed(ResponseFailed),
    ResponseIncomplete(ResponseIncomplete),
    ResponseQueued(ResponseQueued),
    ResponseOutputItemAdded(ResponseOutputItemAdded),
    ResponseContentPartAdded(ResponseContentPartAdded),
    ResponseOutputTextDelta(ResponseOutputTextDelta),
    ResponseOutputTextDone(ResponseOutputTextDone),
    ResponseRefusalDelta(ResponseRefusalDelta),
    ResponseRefusalDone(ResponseRefusalDone),
    ResponseContentPartDone(ResponseContentPartDone),
    ResponseOutputItemDone(ResponseOutputItemDone),
    ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDelta),
    ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDone),
    ResponseFileSearchCallInProgress(ResponseFileSearchCallInProgress),
    ResponseFileSearchCallSearching(ResponseFileSearchCallSearching),
    ResponseFileSearchCallCompleted(ResponseFileSearchCallCompleted),
    ResponseWebSearchCallInProgress(ResponseWebSearchCallInProgress),
    ResponseWebSearchCallSearching(ResponseWebSearchCallSearching),
    ResponseWebSearchCallCompleted(ResponseWebSearchCallCompleted),
    ResponseReasoningSummaryPartAdded(ResponseReasoningSummaryPartAdded),
    ResponseReasoningSummaryPartDone(ResponseReasoningSummaryPartDone),
    ResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDelta),
    ResponseReasoningSummaryTextDone(ResponseReasoningSummaryTextDone),
    ResponseReasoningSummaryDelta(ResponseReasoningSummaryDelta),
    ResponseReasoningSummaryDone(ResponseReasoningSummaryDone),
    ResponseImageGenerationCallInProgress(ResponseImageGenerationCallInProgress),
    ResponseImageGenerationCallGenerating(ResponseImageGenerationCallGenerating),
    ResponseImageGenerationCallPartialImage(ResponseImageGenerationCallPartialImage),
    ResponseImageGenerationCallCompleted(ResponseImageGenerationCallCompleted),
    ResponseMcpCallArgumentsDelta(ResponseMcpCallArgumentsDelta),
    ResponseMcpCallArgumentsDone(ResponseMcpCallArgumentsDone),
    ResponseMcpCallCompleted(ResponseMcpCallCompleted),
    ResponseMcpCallFailed(ResponseMcpCallFailed),
    ResponseMcpCallInProgress(ResponseMcpCallInProgress),
    ResponseMcpListToolsCompleted(ResponseMcpListToolsCompleted),
    ResponseMcpListToolsFailed(ResponseMcpListToolsFailed),
    ResponseMcpListToolsInProgress(ResponseMcpListToolsInProgress),
    ResponseCodeInterpreterCallInProgress(ResponseCodeInterpreterCallInProgress),
    ResponseCodeInterpreterCallInterpreting(ResponseCodeInterpreterCallInterpreting),
    ResponseCodeInterpreterCallCompleted(ResponseCodeInterpreterCallCompleted),
    ResponseCodeInterpreterCallCodeDelta(ResponseCodeInterpreterCallCodeDelta),
    ResponseCodeInterpreterCallCodeDone(ResponseCodeInterpreterCallCodeDone),
    ResponseOutputTextAnnotationAdded(ResponseOutputTextAnnotationAdded),
    ResponseError(ResponseError),
    Unknown(Value),

}
Expand description

Event types for streaming responses from the Responses API

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(ResponseCreated)

Response creation started

§

ResponseInProgress(ResponseInProgress)

Processing in progress

§

ResponseCompleted(ResponseCompleted)

Response completed (different from done)

§

ResponseFailed(ResponseFailed)

Response failed

§

ResponseIncomplete(ResponseIncomplete)

Response incomplete

§

ResponseQueued(ResponseQueued)

Response queued

§

ResponseOutputItemAdded(ResponseOutputItemAdded)

Output item added

§

ResponseContentPartAdded(ResponseContentPartAdded)

Content part added

§

ResponseOutputTextDelta(ResponseOutputTextDelta)

Text delta update

§

ResponseOutputTextDone(ResponseOutputTextDone)

Text output completed

§

ResponseRefusalDelta(ResponseRefusalDelta)

Refusal delta update

§

ResponseRefusalDone(ResponseRefusalDone)

Refusal completed

§

ResponseContentPartDone(ResponseContentPartDone)

Content part completed

§

ResponseOutputItemDone(ResponseOutputItemDone)

Output item completed

§

ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDelta)

Function call arguments delta

§

ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDone)

Function call arguments completed

§

ResponseFileSearchCallInProgress(ResponseFileSearchCallInProgress)

File search call in progress

§

ResponseFileSearchCallSearching(ResponseFileSearchCallSearching)

File search call searching

§

ResponseFileSearchCallCompleted(ResponseFileSearchCallCompleted)

File search call completed

§

ResponseWebSearchCallInProgress(ResponseWebSearchCallInProgress)

Web search call in progress

§

ResponseWebSearchCallSearching(ResponseWebSearchCallSearching)

Web search call searching

§

ResponseWebSearchCallCompleted(ResponseWebSearchCallCompleted)

Web search call completed

§

ResponseReasoningSummaryPartAdded(ResponseReasoningSummaryPartAdded)

Reasoning summary part added

§

ResponseReasoningSummaryPartDone(ResponseReasoningSummaryPartDone)

Reasoning summary part done

§

ResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDelta)

Reasoning summary text delta

§

ResponseReasoningSummaryTextDone(ResponseReasoningSummaryTextDone)

Reasoning summary text done

§

ResponseReasoningSummaryDelta(ResponseReasoningSummaryDelta)

Reasoning summary delta

§

ResponseReasoningSummaryDone(ResponseReasoningSummaryDone)

Reasoning summary done

§

ResponseImageGenerationCallInProgress(ResponseImageGenerationCallInProgress)

Image generation call in progress

§

ResponseImageGenerationCallGenerating(ResponseImageGenerationCallGenerating)

Image generation call generating

§

ResponseImageGenerationCallPartialImage(ResponseImageGenerationCallPartialImage)

Image generation call partial image

§

ResponseImageGenerationCallCompleted(ResponseImageGenerationCallCompleted)

Image generation call completed

§

ResponseMcpCallArgumentsDelta(ResponseMcpCallArgumentsDelta)

MCP call arguments delta

§

ResponseMcpCallArgumentsDone(ResponseMcpCallArgumentsDone)

MCP call arguments done

§

ResponseMcpCallCompleted(ResponseMcpCallCompleted)

MCP call completed

§

ResponseMcpCallFailed(ResponseMcpCallFailed)

MCP call failed

§

ResponseMcpCallInProgress(ResponseMcpCallInProgress)

MCP call in progress

§

ResponseMcpListToolsCompleted(ResponseMcpListToolsCompleted)

MCP list tools completed

§

ResponseMcpListToolsFailed(ResponseMcpListToolsFailed)

MCP list tools failed

§

ResponseMcpListToolsInProgress(ResponseMcpListToolsInProgress)

MCP list tools in progress

§

ResponseCodeInterpreterCallInProgress(ResponseCodeInterpreterCallInProgress)

Code interpreter call in progress

§

ResponseCodeInterpreterCallInterpreting(ResponseCodeInterpreterCallInterpreting)

Code interpreter call interpreting

§

ResponseCodeInterpreterCallCompleted(ResponseCodeInterpreterCallCompleted)

Code interpreter call completed

§

ResponseCodeInterpreterCallCodeDelta(ResponseCodeInterpreterCallCodeDelta)

Code interpreter call code delta

§

ResponseCodeInterpreterCallCodeDone(ResponseCodeInterpreterCallCodeDone)

Code interpreter call code done

§

ResponseOutputTextAnnotationAdded(ResponseOutputTextAnnotationAdded)

Output text annotation added

§

ResponseError(ResponseError)

Error occurred

§

Unknown(Value)

Unknown event type

Trait Implementations§

Source§

impl Clone for ResponseEvent

Source§

fn clone(&self) -> ResponseEvent

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 ResponseEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ResponseEvent

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 ResponseEvent

Source§

fn eq(&self, other: &ResponseEvent) -> 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 ResponseEvent

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 ResponseEvent

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

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,