Enum ClientMessage 

pub enum ClientMessage {
    StartSession {
        pre_prompt: Option<String>,
        language: Option<String>,
        pipeline_mode: Option<String>,
        ai_speaks_first: Option<bool>,
        allow_harm_category: Option<bool>,
        tools: Option<Vec<Tool>>,
    },
    EndSession,
    AudioStart,
    AudioChunk {
        data: String,
    },
    AudioEnd,
    SystemMessage {
        payload: SystemMessagePayload,
    },
    ToolResponse {
        payload: ToolResponsePayload,
    },
    UpdateUserId {
        user_id: String,
    },
    Interrupt,
    Ping,
}

Client message types (sent from client to server)

Variants

StartSession

Start a new session

Fields

pre_prompt: Option<String>

language: Option<String>

pipeline_mode: Option<String>

ai_speaks_first: Option<bool>

allow_harm_category: Option<bool>

tools: Option<Vec<Tool>>

EndSession

End the current session

AudioStart

Start audio streaming session

AudioChunk

Send audio chunk

Fields

data: String

Base64 encoded PCM16 audio data

AudioEnd

End audio streaming session

SystemMessage

Send a system message to the AI during a live session

Fields

payload: SystemMessagePayload

System message payload

ToolResponse

Send tool response (function execution result) back to AI

Fields

payload: ToolResponsePayload

Tool response payload

UpdateUserId

Update user ID (guest-to-user migration)

Fields

user_id: String

The authenticated user’s unique identifier

Interrupt

Explicit interrupt (stop AI response)

Ping

Ping for keep-alive

Implementations

impl ClientMessage

pub fn start_session( pre_prompt: Option<String>, language: Option<String>, pipeline_mode: Option<String>, ai_speaks_first: Option<bool>, allow_harm_category: Option<bool>, tools: Option<Vec<Tool>>, ) -> Self

Create a start session message

pub fn end_session() -> Self

Create an end session message

pub fn audio_start() -> Self

Create an audio start message

pub fn audio_chunk(data: impl Into<String>) -> Self

Create an audio chunk message

pub fn audio_end() -> Self

Create an audio end message

pub fn ping() -> Self

Create a ping message

pub fn system_message(text: impl Into<String>) -> Self

Create a system message (AI responds immediately)

pub fn system_message_with_options( text: impl Into<String>, trigger_response: bool, ) -> Self

Create a system message with explicit trigger_response option

pub fn tool_response(id: impl Into<String>, response: Value) -> Self

Create a tool response message (function execution result)

pub fn update_user_id(user_id: impl Into<String>) -> Self

Create an update user ID message (guest-to-user migration)

pub fn interrupt() -> Self

Create an interrupt message (explicit stop)

pub fn to_json(&self) -> Result<String, Error>

Serialize to JSON string

Trait Implementations

impl Clone for ClientMessage

fn clone(&self) -> ClientMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientMessage

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

Formats the value using the given formatter.

impl Serialize for ClientMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.