Skip to main content

ServerEvent

openai_tools::realtime::events::server

Enum ServerEvent

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§

impl ServerEvent

pub fn is_error(&self) -> bool

Check if this is an error event.

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

Get the event ID if available.

Trait Implementations§

impl Clone for ServerEvent

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

impl Debug for ServerEvent

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

Formats the value using the given formatter. Read more

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

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§

impl Freeze for ServerEvent

impl RefUnwindSafe for ServerEvent

impl Send for ServerEvent

impl Sync for ServerEvent

impl Unpin for ServerEvent

impl UnsafeUnpin for ServerEvent

impl UnwindSafe for ServerEvent

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more