Skip to main content

ServerEvent

openai_tools::realtime::events::server

Enum ServerEvent 

Source 
pub enum ServerEvent {

Show 32 variants    SessionCreated(SessionCreatedEvent),
    SessionUpdated(SessionUpdatedEvent),
    ConversationCreated(ConversationCreatedEvent),
    ConversationItemCreated(ConversationItemCreatedEvent),
    ConversationItemRetrieved(ConversationItemRetrievedEvent),
    ConversationItemDeleted(ConversationItemDeletedEvent),
    ConversationItemTruncated(ConversationItemTruncatedEvent),
    InputAudioTranscriptionCompleted(InputAudioTranscriptionCompletedEvent),
    InputAudioTranscriptionFailed(InputAudioTranscriptionFailedEvent),
    InputAudioBufferCommitted(InputAudioBufferCommittedEvent),
    InputAudioBufferCleared(InputAudioBufferClearedEvent),
    InputAudioBufferSpeechStarted(SpeechStartedEvent),
    InputAudioBufferSpeechStopped(SpeechStoppedEvent),
    OutputAudioBufferStarted(OutputAudioBufferEvent),
    OutputAudioBufferStopped(OutputAudioBufferStoppedEvent),
    OutputAudioBufferCleared(OutputAudioBufferEvent),
    ResponseCreated(ResponseCreatedEvent),
    ResponseDone(ResponseDoneEvent),
    ResponseOutputItemAdded(ResponseOutputItemEvent),
    ResponseOutputItemDone(ResponseOutputItemEvent),
    ResponseContentPartAdded(ResponseContentPartEvent),
    ResponseContentPartDone(ResponseContentPartEvent),
    ResponseTextDelta(ResponseTextDeltaEvent),
    ResponseTextDone(ResponseTextDoneEvent),
    ResponseAudioDelta(ResponseAudioDeltaEvent),
    ResponseAudioDone(ResponseAudioDoneEvent),
    ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent),
    ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent),
    ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent),
    ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent),
    RateLimitsUpdated(RateLimitsUpdatedEvent),
    Error(ErrorEvent),

}
Expand description

Server events received from the OpenAI Realtime API.

Variants§

§

SessionCreated(SessionCreatedEvent)

Session was created (first event after connection).

§

SessionUpdated(SessionUpdatedEvent)

Session configuration was updated.

§

ConversationCreated(ConversationCreatedEvent)

Conversation was created.

§

ConversationItemCreated(ConversationItemCreatedEvent)

Conversation item was created.

§

ConversationItemRetrieved(ConversationItemRetrievedEvent)

Conversation item was retrieved.

§

ConversationItemDeleted(ConversationItemDeletedEvent)

Conversation item was deleted.

§

ConversationItemTruncated(ConversationItemTruncatedEvent)

Conversation item was truncated.

§

InputAudioTranscriptionCompleted(InputAudioTranscriptionCompletedEvent)

Input audio transcription completed.

§

InputAudioTranscriptionFailed(InputAudioTranscriptionFailedEvent)

Input audio transcription failed.

§

InputAudioBufferCommitted(InputAudioBufferCommittedEvent)

Input audio buffer was committed.

§

InputAudioBufferCleared(InputAudioBufferClearedEvent)

Input audio buffer was cleared.

§

InputAudioBufferSpeechStarted(SpeechStartedEvent)

Speech started in input audio.

§

InputAudioBufferSpeechStopped(SpeechStoppedEvent)

Speech stopped in input audio.

§

OutputAudioBufferStarted(OutputAudioBufferEvent)

Output audio buffer playback started.

§

OutputAudioBufferStopped(OutputAudioBufferStoppedEvent)

Output audio buffer playback stopped.

§

OutputAudioBufferCleared(OutputAudioBufferEvent)

Output audio buffer was cleared.

§

ResponseCreated(ResponseCreatedEvent)

Response was created.

§

ResponseDone(ResponseDoneEvent)

Response generation completed.

§

ResponseOutputItemAdded(ResponseOutputItemEvent)

Output item was added to response.

§

ResponseOutputItemDone(ResponseOutputItemEvent)

Output item completed.

§

ResponseContentPartAdded(ResponseContentPartEvent)

Content part was added.

§

ResponseContentPartDone(ResponseContentPartEvent)

Content part completed.

§

ResponseTextDelta(ResponseTextDeltaEvent)

Text delta received.

§

ResponseTextDone(ResponseTextDoneEvent)

Text output completed.

§

ResponseAudioDelta(ResponseAudioDeltaEvent)

Audio delta received.

§

ResponseAudioDone(ResponseAudioDoneEvent)

Audio output completed.

§

ResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent)

Audio transcript delta received.

§

ResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent)

Audio transcript completed.

§

ResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent)

Function call arguments delta.

§

ResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent)

Function call arguments completed.

§

RateLimitsUpdated(RateLimitsUpdatedEvent)

Rate limits updated.

§

Error(ErrorEvent)

Error occurred.

Implementations§

Source§

impl ServerEvent

Source

pub fn is_error(&self) -> bool

Check if this is an error event.

Source

pub fn event_id(&self) -> Option<&str>

Get the event ID if available.

Trait Implementations§

Source§

impl Clone for ServerEvent

Source§

fn clone(&self) -> ServerEvent

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

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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<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