Struct RealtimeHandle 

pub struct RealtimeHandle { /* private fields */ }

Sends events into a realtime session and closes it.

Handles are cheap to clone and remain valid until the session ends.

Implementations

impl RealtimeHandle

pub async fn send(&self, event: RealtimeClientEvent) -> Result<(), Error>

Sends a client event.

Errors

Fails when the model cannot serialize the event or the session is closed.

pub async fn send_raw(&self, raw: JsonValue) -> Result<(), Error>

Sends a raw provider message.

Errors

Fails when the session is closed.

pub async fn send_text(&self, text: impl Into<String>) -> Result<(), Error>

Sends a user text message and requests a response.

Errors

See RealtimeHandle::send.

pub async fn add_tool_output( &self, call_id: &str, output: &JsonValue, ) -> Result<(), Error>

Submits the output of a tool call. A follow-up response is requested once every tool call of the response has an output.

Errors

See RealtimeHandle::send.

pub async fn request_response(&self) -> Result<(), Error>

Requests a response with the default options.

Errors

See RealtimeHandle::send.

pub fn close(&self)

Asks the connection task to close the connection.

pub fn is_closed(&self) -> bool

Returns true once the connection task has finished.

Trait Implementations

impl Clone for RealtimeHandle

fn clone(&self) -> RealtimeHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeHandle

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

Formats the value using the given formatter.