Skip to main content

RealtimeServerMessage

xai_rust::models::voice

Enum RealtimeServerMessage

pub enum RealtimeServerMessage {
Show 14 variants    SessionCreated {
        session: SessionConfig,
    },
    SessionUpdated {
        session: SessionConfig,
    },
    ConversationItemCreated {
        item: ConversationItem,
    },
    InputAudioBufferCommitted {
        item_id: String,
    },
    InputAudioBufferCleared {},
    InputAudioBufferSpeechStarted {
        audio_start_ms: u32,
    },
    InputAudioBufferSpeechStopped {
        audio_end_ms: u32,
    },
    ResponseCreated {
        response: RealtimeResponse,
    },
    ResponseAudioDelta {
        response_id: String,
        item_id: String,
        delta: String,
    },
    ResponseAudioTranscriptDelta {
        response_id: String,
        item_id: String,
        delta: String,
    },
    ResponseTextDelta {
        response_id: String,
        item_id: String,
        delta: String,
    },
    ResponseDone {
        response: RealtimeResponse,
    },
    Error {
        error: RealtimeError,
    },
    RateLimitsUpdated {
        rate_limits: Vec<RateLimit>,
    },
}

Expand description

Server message from realtime WebSocket.

Variants§

SessionCreated

Session created.

Fields

§session: SessionConfig

The session configuration.

SessionUpdated

Session updated.

Fields

§session: SessionConfig

The updated session configuration.

ConversationItemCreated

Conversation item created.

Fields

§item: ConversationItem

The created item.

InputAudioBufferCommitted

Input audio buffer committed.

Fields

§item_id: String

The item ID.

InputAudioBufferCleared

Input audio buffer cleared.

InputAudioBufferSpeechStarted

Input audio buffer speech started.

Fields

§audio_start_ms: u32

Audio start time in milliseconds.

InputAudioBufferSpeechStopped

Input audio buffer speech stopped.

Fields

§audio_end_ms: u32

Audio end time in milliseconds.

ResponseCreated

Response created.

Fields

§response: RealtimeResponse

The response.

ResponseAudioDelta

Response audio delta.

Fields

§response_id: String

Response ID.

§item_id: String

Item ID.

§delta: String

Base64-encoded audio delta.

ResponseAudioTranscriptDelta

Response audio transcript delta.

Fields

§response_id: String

Response ID.

§item_id: String

Item ID.

§delta: String

Transcript delta.

ResponseTextDelta

Response text delta.

Fields

§response_id: String

Response ID.

§item_id: String

Item ID.

§delta: String

Text delta.

ResponseDone

Response done.

Fields

§response: RealtimeResponse

The completed response.

Error

Error occurred.

Fields

§error: RealtimeError

Error details.

RateLimitsUpdated

Rate limits updated.

Fields

§rate_limits: Vec<RateLimit>

Rate limit information.

Trait Implementations§

impl Clone for RealtimeServerMessage

fn clone(&self) -> RealtimeServerMessage

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

impl Debug for RealtimeServerMessage

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for RealtimeServerMessage

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 RealtimeServerMessage

impl RefUnwindSafe for RealtimeServerMessage

impl Send for RealtimeServerMessage

impl Sync for RealtimeServerMessage

impl Unpin for RealtimeServerMessage

impl UnsafeUnpin for RealtimeServerMessage

impl UnwindSafe for RealtimeServerMessage

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

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