RealtimeServerEvent

api_openai::components::exposed::realtime_shared::events::orphan

Enum RealtimeServerEvent 

Source 
pub enum RealtimeServerEvent {

Show 32 variants    ConversationCreated(RealtimeServerEventConversationCreated),
    ConversationItemCreated(RealtimeServerEventConversationItemCreated),
    ConversationItemDeleted(RealtimeServerEventConversationItemDeleted),
    ConversationItemInputAudioTranscriptionCompleted(RealtimeServerEventConversationItemInputAudioTranscriptionCompleted),
    ConversationItemInputAudioTranscriptionDelta(RealtimeServerEventConversationItemInputAudioTranscriptionDelta),
    ConversationItemInputAudioTranscriptionFailed(RealtimeServerEventConversationItemInputAudioTranscriptionFailed),
    ConversationItemRetrieved(RealtimeServerEventConversationItemRetrieved),
    ConversationItemTruncated(RealtimeServerEventConversationItemTruncated),
    Error(RealtimeServerEventError),
    InputAudioBufferCleared(RealtimeServerEventInputAudioBufferCleared),
    InputAudioBufferCommitted(RealtimeServerEventInputAudioBufferCommitted),
    InputAudioBufferSpeechStarted(RealtimeServerEventInputAudioBufferSpeechStarted),
    InputAudioBufferSpeechStopped(RealtimeServerEventInputAudioBufferSpeechStopped),
    RateLimitsUpdated(RealtimeServerEventRateLimitsUpdated),
    ResponseAudioDelta(RealtimeServerEventResponseAudioDelta),
    ResponseAudioDone(RealtimeServerEventResponseAudioDone),
    ResponseAudioTranscriptDelta(RealtimeServerEventResponseAudioTranscriptDelta),
    ResponseAudioTranscriptDone(RealtimeServerEventResponseAudioTranscriptDone),
    ResponseContentPartAdded(RealtimeServerEventResponseContentPartAdded),
    ResponseContentPartDone(RealtimeServerEventResponseContentPartDone),
    ResponseCreated(RealtimeServerEventResponseCreated),
    ResponseDone(RealtimeServerEventResponseDone),
    ResponseFunctionCallArgumentsDelta(RealtimeServerEventResponseFunctionCallArgumentsDelta),
    ResponseFunctionCallArgumentsDone(RealtimeServerEventResponseFunctionCallArgumentsDone),
    ResponseOutputItemAdded(RealtimeServerEventResponseOutputItemAdded),
    ResponseOutputItemDone(RealtimeServerEventResponseOutputItemDone),
    ResponseTextDelta(RealtimeServerEventResponseTextDelta),
    ResponseTextDone(RealtimeServerEventResponseTextDone),
    SessionCreated(RealtimeServerEventSessionCreated),
    SessionUpdated(RealtimeServerEventSessionUpdated),
    TranscriptionSessionCreated(RealtimeServerEventTranscriptionSessionCreated),
    TranscriptionSessionUpdated(RealtimeServerEventTranscriptionSessionUpdated),

}
Expand description

Represents the different types of events sent by the server in a Realtime session.

§Used By

  • Realtime WebSocket client implementations (for deserializing incoming events).

Variants§

§

ConversationCreated(RealtimeServerEventConversationCreated)

Conversation created event.

§

ConversationItemCreated(RealtimeServerEventConversationItemCreated)

Conversation item created event.

§

ConversationItemDeleted(RealtimeServerEventConversationItemDeleted)

Conversation item deleted event.

§

ConversationItemInputAudioTranscriptionCompleted(RealtimeServerEventConversationItemInputAudioTranscriptionCompleted)

Input audio transcription completed event.

§

ConversationItemInputAudioTranscriptionDelta(RealtimeServerEventConversationItemInputAudioTranscriptionDelta)

Input audio transcription delta event.

§

ConversationItemInputAudioTranscriptionFailed(RealtimeServerEventConversationItemInputAudioTranscriptionFailed)

Input audio transcription failed event.

§

ConversationItemRetrieved(RealtimeServerEventConversationItemRetrieved)

Conversation item retrieved event.

§

ConversationItemTruncated(RealtimeServerEventConversationItemTruncated)

Conversation item truncated event.

§

Error(RealtimeServerEventError)

Error event.

§

InputAudioBufferCleared(RealtimeServerEventInputAudioBufferCleared)

Input audio buffer cleared event.

§

InputAudioBufferCommitted(RealtimeServerEventInputAudioBufferCommitted)

Input audio buffer committed event.

§

InputAudioBufferSpeechStarted(RealtimeServerEventInputAudioBufferSpeechStarted)

Input audio buffer speech started event.

§

InputAudioBufferSpeechStopped(RealtimeServerEventInputAudioBufferSpeechStopped)

Input audio buffer speech stopped event.

§

RateLimitsUpdated(RealtimeServerEventRateLimitsUpdated)

Rate limits updated event.

§

ResponseAudioDelta(RealtimeServerEventResponseAudioDelta)

Response audio delta event.

§

ResponseAudioDone(RealtimeServerEventResponseAudioDone)

Response audio done event.

§

ResponseAudioTranscriptDelta(RealtimeServerEventResponseAudioTranscriptDelta)

Response audio transcript delta event.

§

ResponseAudioTranscriptDone(RealtimeServerEventResponseAudioTranscriptDone)

Response audio transcript done event.

§

ResponseContentPartAdded(RealtimeServerEventResponseContentPartAdded)

Response content part added event.

§

ResponseContentPartDone(RealtimeServerEventResponseContentPartDone)

Response content part done event.

§

ResponseCreated(RealtimeServerEventResponseCreated)

Response created event.

§

ResponseDone(RealtimeServerEventResponseDone)

Response done event.

§

ResponseFunctionCallArgumentsDelta(RealtimeServerEventResponseFunctionCallArgumentsDelta)

Response function call arguments delta event.

§

ResponseFunctionCallArgumentsDone(RealtimeServerEventResponseFunctionCallArgumentsDone)

Response function call arguments done event.

§

ResponseOutputItemAdded(RealtimeServerEventResponseOutputItemAdded)

Response output item added event.

§

ResponseOutputItemDone(RealtimeServerEventResponseOutputItemDone)

Response output item done event.

§

ResponseTextDelta(RealtimeServerEventResponseTextDelta)

Response text delta event.

§

ResponseTextDone(RealtimeServerEventResponseTextDone)

Response text done event.

§

SessionCreated(RealtimeServerEventSessionCreated)

Session created event.

§

SessionUpdated(RealtimeServerEventSessionUpdated)

Session updated event.

§

TranscriptionSessionCreated(RealtimeServerEventTranscriptionSessionCreated)

Transcription session created event.

§

TranscriptionSessionUpdated(RealtimeServerEventTranscriptionSessionUpdated)

Transcription session updated event.

Trait Implementations§

Source§

impl Clone for RealtimeServerEvent

Source§

fn clone(&self) -> RealtimeServerEvent

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 RealtimeServerEvent

Source§

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

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

impl<'de> Deserialize<'de> for RealtimeServerEvent

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 RealtimeServerEvent

Source§

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

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>,