Struct RealtimeSessionBuilder 

pub struct RealtimeSessionBuilder { /* private fields */ }

Configuration of a realtime session before it connects.

Implementations

impl RealtimeSessionBuilder

pub fn client_secret(self, secret: ClientSecret) -> Self

Uses an existing client secret instead of creating one through the model.

pub fn expires_after_seconds(self, seconds: u64) -> Self

Requested lifetime of the client secret created on connect.

pub fn config(self, config: RealtimeSessionConfig) -> Self

Sets the initial session configuration. Tool definitions derived from tools are appended to config.tools on connect.

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

Sets the system instructions of the session.

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

Sets the voice used for audio output.

pub fn tools(self, tools: ToolSet) -> Self

Local tools. Function and dynamic tools are advertised to the model; executable ones run inside the session and their outputs are sent back automatically. Tools without an executor are advertised only; the application answers them with RealtimeHandle::add_tool_output.

pub fn tools_context(self, context: JsonValue) -> Self

Context passed to dynamic tool descriptions and executions.

pub fn cancellation(self, cancellation: CancellationToken) -> Self

Cancellation token; cancelling it closes the session.

pub fn event_buffer(self, capacity: usize) -> Self

Capacity of the server event buffer (default 256). Reading from the connection pauses while the buffer is full.

pub async fn connect(self) -> Result<RealtimeSession, Error>

Opens the connection and sends the initial session-update.

Errors

Fails when the client secret cannot be created, the WebSocket handshake fails, a tool context is invalid or the initial event cannot be serialized.

Trait Implementations

impl Debug for RealtimeSessionBuilder

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

Formats the value using the given formatter.

impl IntoFuture for RealtimeSessionBuilder

type Output = Result<RealtimeSession, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <RealtimeSessionBuilder as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.