Enum RealtimeClientEvent 

#[non_exhaustive]
pub enum RealtimeClientEvent {
    SessionUpdate {
        session: RealtimeSessionConfig,
        event_id: Option<String>,
        extra: Extra,
    },
    InputAudioBufferAppend {
        audio: String,
        event_id: Option<String>,
        extra: Extra,
    },
    InputAudioBufferCommit {
        event_id: Option<String>,
        extra: Extra,
    },
    InputAudioBufferClear {
        event_id: Option<String>,
        extra: Extra,
    },
    OutputAudioBufferClear {
        event_id: Option<String>,
        extra: Extra,
    },
    ConversationItemCreate {
        item: RealtimeItem,
        previous_item_id: Option<String>,
        event_id: Option<String>,
        extra: Extra,
    },
    ConversationItemRetrieve {
        item_id: String,
        event_id: Option<String>,
        extra: Extra,
    },
    ConversationItemTruncate {
        item_id: String,
        content_index: u32,
        audio_end_ms: u64,
        event_id: Option<String>,
        extra: Extra,
    },
    ConversationItemDelete {
        item_id: String,
        event_id: Option<String>,
        extra: Extra,
    },
    ResponseCreate {
        response: Option<RealtimeResponseOptions>,
        event_id: Option<String>,
        extra: Extra,
    },
    ResponseCancel {
        response_id: Option<String>,
        event_id: Option<String>,
        extra: Extra,
    },
}

Events the client sends over the realtime WebSocket.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SessionUpdate

Fields

session: RealtimeSessionConfig

event_id: Option<String>

extra: Extra

InputAudioBufferAppend

Fields

audio: String

Base64-encoded audio in the session input format.

event_id: Option<String>

extra: Extra

InputAudioBufferCommit

Fields

event_id: Option<String>

extra: Extra

InputAudioBufferClear

Fields

event_id: Option<String>

extra: Extra

OutputAudioBufferClear

WebRTC only: stop whatever the server is currently playing out.

Fields

event_id: Option<String>

extra: Extra

ConversationItemCreate

Fields

item: RealtimeItem

previous_item_id: Option<String>

event_id: Option<String>

extra: Extra

ConversationItemRetrieve

Fields

item_id: String

event_id: Option<String>

extra: Extra

ConversationItemTruncate

Fields

item_id: String

content_index: u32

audio_end_ms: u64

event_id: Option<String>

extra: Extra

ConversationItemDelete

Fields

item_id: String

event_id: Option<String>

extra: Extra

ResponseCreate

Fields

response: Option<RealtimeResponseOptions>

event_id: Option<String>

extra: Extra

ResponseCancel

Fields

response_id: Option<String>

event_id: Option<String>

extra: Extra

Trait Implementations

impl Clone for RealtimeClientEvent

fn clone(&self) -> RealtimeClientEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RealtimeClientEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeClientEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeClientEvent

fn eq(&self, other: &RealtimeClientEvent) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RealtimeClientEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RealtimeClientEvent