Enum ClientEvent 

pub enum ClientEvent {
    SessionUpdate {
        session: Box<SessionConfig>,
        event_id: Option<String>,
    },
    ConversationItemCreate {
        item: RealtimeConversationItem,
        event_id: Option<String>,
        previous_item_id: Option<String>,
    },
    ConversationItemDelete {
        item_id: String,
        event_id: Option<String>,
    },
    ConversationItemRetrieve {
        item_id: String,
        event_id: Option<String>,
    },
    ConversationItemTruncate {
        audio_end_ms: u32,
        content_index: u32,
        item_id: String,
        event_id: Option<String>,
    },
    InputAudioBufferAppend {
        audio: String,
        event_id: Option<String>,
    },
    InputAudioBufferClear {
        event_id: Option<String>,
    },
    InputAudioBufferCommit {
        event_id: Option<String>,
    },
    OutputAudioBufferClear {
        event_id: Option<String>,
    },
    ResponseCancel {
        event_id: Option<String>,
        response_id: Option<String>,
    },
    ResponseCreate {
        event_id: Option<String>,
        response: Option<Box<RealtimeResponseCreateParams>>,
    },
    Unknown,
}

A client-to-server event in the OpenAI Realtime API.

Sent by the client over WebSocket, WebRTC, or SIP connections. Discriminated by the type field in the JSON wire format.

Large payloads (SessionConfig 624 B, RealtimeResponseCreateParams 384 B) are Box-ed so the enum stays ≈224 bytes instead of ≈648.

Variants

SessionUpdate

Update the session configuration.

Fields

session: Box<SessionConfig>

event_id: Option<String>

ConversationItemCreate

Add a new item to the conversation.

Fields

item: RealtimeConversationItem

event_id: Option<String>

previous_item_id: Option<String>

ConversationItemDelete

Remove an item from the conversation history.

Fields

item_id: String

event_id: Option<String>

ConversationItemRetrieve

Retrieve the server’s representation of a conversation item.

Fields

item_id: String

event_id: Option<String>

ConversationItemTruncate

Truncate a previous assistant message’s audio.

Fields

audio_end_ms: u32

content_index: u32

item_id: String

event_id: Option<String>

InputAudioBufferAppend

Append audio bytes to the input audio buffer.

WARNING: audio contains a base64 audio blob that can be very large. Avoid logging this variant with Debug in production; prefer event_type() for structured logging.

Fields

audio: String

event_id: Option<String>

InputAudioBufferClear

Clear the input audio buffer.

Fields

event_id: Option<String>

InputAudioBufferCommit

Commit the input audio buffer as a user message.

Fields

event_id: Option<String>

OutputAudioBufferClear

Cut off the current audio response.

Fields

event_id: Option<String>

ResponseCancel

Cancel an in-progress response.

Fields

event_id: Option<String>

response_id: Option<String>

ResponseCreate

Trigger model inference to create a response.

Fields

event_id: Option<String>

response: Option<Box<RealtimeResponseCreateParams>>

Unknown

Unrecognized event type. Serde automatically deserializes any unrecognized type value into this variant (no data preserved). For proxy use, forward the raw frame instead of re-serializing.

Implementations

impl ClientEvent

pub fn session_update(event_id: Option<String>, session: SessionConfig) -> Self

Build a session.update event.

pub fn conversation_item_create( event_id: Option<String>, previous_item_id: Option<String>, item: RealtimeConversationItem, ) -> Self

Build a conversation.item.create event.

pub fn conversation_item_delete( event_id: Option<String>, item_id: impl Into<String>, ) -> Self

Build a conversation.item.delete event.

pub fn conversation_item_retrieve( event_id: Option<String>, item_id: impl Into<String>, ) -> Self

Build a conversation.item.retrieve event.

pub fn conversation_item_truncate( event_id: Option<String>, item_id: impl Into<String>, content_index: u32, audio_end_ms: u32, ) -> Self

Build a conversation.item.truncate event.

pub fn input_audio_buffer_append( event_id: Option<String>, audio: impl Into<String>, ) -> Self

Build an input_audio_buffer.append event.

pub fn input_audio_buffer_clear(event_id: Option<String>) -> Self

Build an input_audio_buffer.clear event.

pub fn input_audio_buffer_commit(event_id: Option<String>) -> Self

Build an input_audio_buffer.commit event.

pub fn output_audio_buffer_clear(event_id: Option<String>) -> Self

Build an output_audio_buffer.clear event.

pub fn response_cancel( event_id: Option<String>, response_id: Option<String>, ) -> Self

Build a response.cancel event.

pub fn response_create( event_id: Option<String>, response: Option<RealtimeResponseCreateParams>, ) -> Self

Build a response.create event.

impl ClientEvent

pub fn event_type(&self) -> &str

Returns the event type string (e.g. "session.update").

For unknown events, returns "unknown".

pub fn to_event_type(&self) -> Option<RealtimeClientEvent>

Maps this event to its corresponding RealtimeClientEvent constant.

Returns None for Unknown events.

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<'de> Deserialize<'de> for ClientEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.