Enum ClientEvent 

pub enum ClientEvent {
    SessionUpdate {
        event_id: Option<String>,
        session: SessionConfig,
    },
    InputAudioBufferAppend {
        audio: String,
        client_timestamp: Option<i64>,
    },
    InputAudioBufferAppendVideoFrame {
        video_frame: String,
        client_timestamp: Option<i64>,
    },
    InputAudioBufferCommit {
        client_timestamp: Option<i64>,
    },
    InputAudioBufferClear,
    ConversationItemCreate {
        event_id: Option<String>,
        item: RealtimeConversationItem,
    },
    ConversationItemDelete {
        event_id: Option<String>,
        client_timestamp: Option<i64>,
        item_id: String,
    },
    ConversationItemRetrieve {
        event_id: Option<String>,
        client_timestamp: Option<i64>,
        item_id: String,
    },
    ResponseCreate {
        client_timestamp: Option<i64>,
    },
    ResponseCancel {
        client_timestamp: Option<i64>,
    },
}

Available on crate feature realtime only.

A client event, tagged by type to match the official event names.

Variants

SessionUpdate

session.update — set the session defaults (formats, VAD, tools, …).

Fields

event_id: Option<String>

Optional client-side event id for correlation.

session: SessionConfig

New session configuration to apply.

InputAudioBufferAppend

input_audio_buffer.append — upload base64 WAV audio.

Fields

audio: String

Base64-encoded audio payload.

client_timestamp: Option<i64>

Optional client-side timestamp (ms).

InputAudioBufferAppendVideoFrame

input_audio_buffer.append_video_frame — upload a base64 JPEG frame.

Fields

video_frame: String

Base64-encoded JPEG video frame.

client_timestamp: Option<i64>

Optional client-side timestamp (ms).

InputAudioBufferCommit

input_audio_buffer.commit — commit buffered audio for inference.

Fields

client_timestamp: Option<i64>

Optional client-side timestamp (ms).

InputAudioBufferClear

input_audio_buffer.clear — clear the buffer.

ConversationItemCreate

conversation.item.create — inject a text message or function-call output into the conversation history.

Fields

event_id: Option<String>

Optional client-side event id for correlation.

item: RealtimeConversationItem

The conversation item to insert.

ConversationItemDelete

conversation.item.delete — remove an item from conversation history.

Fields

event_id: Option<String>

Optional client-side event id for correlation.

client_timestamp: Option<i64>

Optional client-side timestamp (ms).

item_id: String

Id of the item to remove.

ConversationItemRetrieve

conversation.item.retrieve — request one conversation-history item.

Fields

event_id: Option<String>

Optional client-side event id for correlation.

client_timestamp: Option<i64>

Optional client-side timestamp (ms).

item_id: String

Id of the item to retrieve.

ResponseCreate

response.create — trigger model inference.

Fields

client_timestamp: Option<i64>

Optional client-side timestamp (ms).

ResponseCancel

response.cancel — cancel the in-flight response (interruption).

Fields

client_timestamp: Option<i64>

Optional client-side timestamp (ms).

Trait Implementations

impl Clone for ClientEvent

fn clone(&self) -> ClientEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientEvent

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

Formats the value using the given formatter.

impl Serialize for ClientEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.