Enum ServerEvent 

pub enum ServerEvent {
    SessionCreated {
        event_id: String,
        session: Value,
    },
    SessionUpdated {
        event_id: String,
        session: Value,
    },
    Error {
        event_id: String,
        error: ErrorInfo,
    },
    SpeechStarted {
        event_id: String,
        audio_start_ms: u64,
    },
    SpeechStopped {
        event_id: String,
        audio_end_ms: u64,
    },
    AudioCommitted {
        event_id: String,
        item_id: String,
    },
    AudioCleared {
        event_id: String,
    },
    ItemCreated {
        event_id: String,
        item: Value,
    },
    ResponseCreated {
        event_id: String,
        response: Value,
    },
    ResponseDone {
        event_id: String,
        response: Value,
    },
    OutputItemAdded {
        event_id: String,
        response_id: String,
        output_index: u32,
        item: Value,
    },
    OutputItemDone {
        event_id: String,
        response_id: String,
        output_index: u32,
        item: Value,
    },
    AudioDelta {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        content_index: u32,
        delta: Vec<u8>,
    },
    AudioDone {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        content_index: u32,
    },
    TextDelta {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        content_index: u32,
        delta: String,
    },
    TextDone {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        content_index: u32,
        text: String,
    },
    TranscriptDelta {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        content_index: u32,
        delta: String,
    },
    TranscriptDone {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        content_index: u32,
        transcript: String,
    },
    FunctionCallDelta {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        call_id: String,
        delta: String,
    },
    FunctionCallDone {
        event_id: String,
        response_id: String,
        item_id: String,
        output_index: u32,
        call_id: String,
        name: String,
        arguments: String,
    },
    RateLimitsUpdated {
        event_id: String,
        rate_limits: Vec<RateLimit>,
    },
    Unknown,
}

Available on crate feature realtime only.

Events received from the realtime server.

This is a unified event type that abstracts over provider-specific formats. Audio data is stored as raw bytes (Vec<u8>) — decoded from base64 at the transport boundary so consumers never need to deal with encoding.

Variants

SessionCreated

Session was created/connected.

Fields

event_id: String

Unique event ID.

session: Value

Session details.

SessionUpdated

Session configuration was updated.

Fields

event_id: String

Unique event ID.

session: Value

Updated session details.

Error

Error occurred.

Fields

event_id: String

Unique event ID.

error: ErrorInfo

Error details.

SpeechStarted

User speech started (VAD detected).

Fields

event_id: String

Unique event ID.

audio_start_ms: u64

Audio start time in milliseconds.

SpeechStopped

User speech ended (VAD detected).

Fields

event_id: String

Unique event ID.

audio_end_ms: u64

Audio end time in milliseconds.

AudioCommitted

Audio input buffer was committed.

Fields

event_id: String

Unique event ID.

item_id: String

ID of the created item.

AudioCleared

Audio input buffer was cleared.

Fields

event_id: String

Unique event ID.

ItemCreated

Conversation item was created.

Fields

event_id: String

Unique event ID.

item: Value

The created item.

ResponseCreated

Response generation started.

Fields

event_id: String

Unique event ID.

response: Value

Response details.

ResponseDone

Response generation completed.

Fields

event_id: String

Unique event ID.

response: Value

Final response details.

OutputItemAdded

Response output item added.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

output_index: u32

Output index.

item: Value

The output item.

OutputItemDone

Response output item completed.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

output_index: u32

Output index.

item: Value

The completed item.

AudioDelta

Audio delta (chunk of output audio as raw bytes).

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

content_index: u32

Content index.

delta: Vec<u8>

Audio data (raw bytes, serialized as base64 on the wire).

AudioDone

Audio output completed.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

content_index: u32

Content index.

TextDelta

Text delta (chunk of output text).

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

content_index: u32

Content index.

delta: String

Text content.

TextDone

Text output completed.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

content_index: u32

Content index.

text: String

Complete text.

TranscriptDelta

Audio transcript delta.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

content_index: u32

Content index.

delta: String

Transcript delta.

TranscriptDone

Audio transcript completed.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

content_index: u32

Content index.

transcript: String

Complete transcript.

FunctionCallDelta

Function call arguments delta.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

call_id: String

Call ID.

delta: String

Arguments delta.

FunctionCallDone

Function call completed.

Fields

event_id: String

Unique event ID.

response_id: String

Response ID.

item_id: String

Item ID.

output_index: u32

Output index.

call_id: String

Call ID.

name: String

Function name.

arguments: String

Complete arguments.

RateLimitsUpdated

Rate limit information.

Fields

event_id: String

Unique event ID.

rate_limits: Vec<RateLimit>

Rate limit details.

Unknown

Unknown event type (for forward compatibility).

Trait Implementations

impl Clone for ServerEvent

fn clone(&self) -> ServerEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerEvent

fn deserialize<__D>( __deserializer: __D, ) -> Result<ServerEvent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServerEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.