async_openai_alt::types::realtime

Enum ServerEvent

Source 
pub enum ServerEvent {

Show 28 variants    Error(ErrorEvent),
    SessionCreated(SessionCreatedEvent),
    SessionUpdated(SessionUpdatedEvent),
    ConversationCreated(ConversationCreatedEvent),
    InputAudioBufferCommited(InputAudioBufferCommitedEvent),
    InputAudioBufferCleared(InputAudioBufferClearedEvent),
    InputAudioBufferSpeechStarted(InputAudioBufferSpeechStartedEvent),
    InputAudioBufferSpeechStopped(InputAudioBufferSpeechStoppedEvent),
    ConversationItemCreated(ConversationItemCreatedEvent),
    ConversationItemInputAudioTranscriptionCompleted(ConversationItemInputAudioTranscriptionCompletedEvent),
    ConversationItemInputAudioTranscriptionFailed(ConversationItemInputAudioTranscriptionFailedEvent),
    ConversationItemTruncated(ConversationItemTruncatedEvent),
    ConversationItemDeleted(ConversationItemDeletedEvent),
    ResponseCreated(ResponseCreatedEvent),
    ResponseDone(ResponseDoneEvent),
    ResponseOutputItemAdded(ResponseOutputItemAddedEvent),
    ResponseOutputItemDone(ResponseOutputItemDoneEvent),
    ResponseContentPartAdded(ResponseContentPartAddedEvent),
    ResponseContentPartDone(ResponseContentPartDoneEvent),
    ResponseTextDelta(ResponseTextDeltaEvent),
    ResponseTextDone(ResponseTextDoneEvent),
    ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent),
    ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent),
    ResponseAudioDelta(ResponseAudioDeltaEvent),
    ResponseAudioDone(ResponseAudioDoneEvent),
    ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent),
    ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent),
    RateLimitsUpdated(RateLimitsUpdatedEvent),

}
Available on crate feature realtime only.
Expand description

These are events emitted from the OpenAI Realtime WebSocket server to the client.

Variants§

§

Error(ErrorEvent)

Returned when an error occurs.

§

SessionCreated(SessionCreatedEvent)

Returned when a session is created. Emitted automatically when a new connection is established.

§

SessionUpdated(SessionUpdatedEvent)

Returned when a session is updated.

§

ConversationCreated(ConversationCreatedEvent)

Returned when a conversation is created. Emitted right after session creation.

§

InputAudioBufferCommited(InputAudioBufferCommitedEvent)

Returned when an input audio buffer is committed, either by the client or automatically in server VAD mode.

§

InputAudioBufferCleared(InputAudioBufferClearedEvent)

Returned when the input audio buffer is cleared by the client.

§

InputAudioBufferSpeechStarted(InputAudioBufferSpeechStartedEvent)

Returned in server turn detection mode when speech is detected.

§

InputAudioBufferSpeechStopped(InputAudioBufferSpeechStoppedEvent)

Returned in server turn detection mode when speech stops.

§

ConversationItemCreated(ConversationItemCreatedEvent)

Returned when a conversation item is created.

§

ConversationItemInputAudioTranscriptionCompleted(ConversationItemInputAudioTranscriptionCompletedEvent)

Returned when input audio transcription is enabled and a transcription succeeds.

§

ConversationItemInputAudioTranscriptionFailed(ConversationItemInputAudioTranscriptionFailedEvent)

Returned when input audio transcription is configured, and a transcription request for a user message failed.

§

ConversationItemTruncated(ConversationItemTruncatedEvent)

Returned when an earlier assistant audio message item is truncated by the client.

§

ConversationItemDeleted(ConversationItemDeletedEvent)

Returned when an item in the conversation is deleted.

§

ResponseCreated(ResponseCreatedEvent)

Returned when a new Response is created. The first event of response creation, where the response is in an initial state of “in_progress”.

§

ResponseDone(ResponseDoneEvent)

Returned when a Response is done streaming. Always emitted, no matter the final state.

§

ResponseOutputItemAdded(ResponseOutputItemAddedEvent)

Returned when a new Item is created during response generation.

§

ResponseOutputItemDone(ResponseOutputItemDoneEvent)

Returned when an Item is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

§

ResponseContentPartAdded(ResponseContentPartAddedEvent)

Returned when a new content part is added to an assistant message item during response generation.

§

ResponseContentPartDone(ResponseContentPartDoneEvent)

Returned when a content part is done streaming in an assistant message item. Also emitted when a Response is interrupted, incomplete, or cancelled.

§

ResponseTextDelta(ResponseTextDeltaEvent)

Returned when the text value of a “text” content part is updated.

§

ResponseTextDone(ResponseTextDoneEvent)

Returned when the text value of a “text” content part is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

§

ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent)

Returned when the model-generated transcription of audio output is updated.

§

ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent)

Returned when the model-generated transcription of audio output is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

§

ResponseAudioDelta(ResponseAudioDeltaEvent)

Returned when the model-generated audio is updated.

§

ResponseAudioDone(ResponseAudioDoneEvent)

Returned when the model-generated audio is done. Also emitted when a Response is interrupted, incomplete, or cancelled.

§

ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent)

Returned when the model-generated function call arguments are updated.

§

ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent)

Returned when the model-generated function call arguments are done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

§

RateLimitsUpdated(RateLimitsUpdatedEvent)

Emitted after every “response.done” event to indicate the updated rate limits.

Trait Implementations§

Source§

impl Clone for ServerEvent

Source§

fn clone(&self) -> ServerEvent

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 ServerEvent

Source§

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

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

impl<'de> Deserialize<'de> for ServerEvent

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 Serialize for ServerEvent

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

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<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<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<U, <U as TryFrom<T>>::Error>> + 'async_trait>>
where T: 'async_trait,

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,