Enum ClientEvent 

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

Client events sent to the OpenAI Realtime API server.

Variants

SessionUpdate

Update the session configuration.

Fields

event_id: Option<String>

Optional client-generated event ID.

session: SessionConfig

Session configuration to update.

InputAudioBufferAppend

Append audio data to the input buffer.

Fields

event_id: Option<String>

Optional client-generated event ID.

audio: String

Base64-encoded audio data.

InputAudioBufferClear

Clear the input audio buffer.

Fields

event_id: Option<String>

Optional client-generated event ID.

InputAudioBufferCommit

Commit the input audio buffer.

Fields

event_id: Option<String>

Optional client-generated event ID.

OutputAudioBufferClear

Clear the output audio buffer (WebRTC only).

Fields

event_id: Option<String>

Optional client-generated event ID.

ConversationItemCreate

Create a new conversation item.

Fields

event_id: Option<String>

Optional client-generated event ID.

previous_item_id: Option<String>

ID of the item to insert after (omit to append).

item: ConversationItem

The conversation item to create.

ConversationItemDelete

Delete a conversation item.

Fields

event_id: Option<String>

Optional client-generated event ID.

item_id: String

ID of the item to delete.

ConversationItemRetrieve

Retrieve a conversation item.

Fields

event_id: Option<String>

Optional client-generated event ID.

item_id: String

ID of the item to retrieve.

ConversationItemTruncate

Truncate a conversation item’s audio.

Fields

event_id: Option<String>

Optional client-generated event ID.

item_id: String

ID of the item to truncate.

content_index: u32

Index of the content part to truncate.

audio_end_ms: u32

Audio end position in milliseconds.

ResponseCreate

Create a new response.

Fields

event_id: Option<String>

Optional client-generated event ID.

response: Option<ResponseCreateConfig>

Response configuration.

ResponseCancel

Cancel the current response.

Fields

event_id: Option<String>

Optional client-generated event ID.

Implementations

impl ClientEvent

pub fn session_update(config: SessionConfig) -> Self

Create a session update event.

pub fn append_audio(audio_base64: impl Into<String>) -> Self

Create an input audio buffer append event.

pub fn clear_audio() -> Self

Create an input audio buffer clear event.

pub fn commit_audio() -> Self

Create an input audio buffer commit event.

pub fn create_item(item: ConversationItem) -> Self

Create a conversation item create event.

pub fn create_item_after( item: ConversationItem, previous_item_id: impl Into<String>, ) -> Self

Create a conversation item create event with a specific position.

pub fn delete_item(item_id: impl Into<String>) -> Self

Create a conversation item delete event.

pub fn create_response(config: Option<ResponseCreateConfig>) -> Self

Create a response create event.

pub fn cancel_response() -> Self

Create a response cancel event.

pub fn with_event_id(self, id: impl Into<String>) -> Self

Set a custom event ID.

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.