Struct LiveClient 

pub struct LiveClient { /* private fields */ }

Builder for a primary or forked Live WebSocket session.

Implementations

impl LiveClient

pub fn new() -> Self

Creates a client using OPENAI_API_KEY.

pub fn with_api_key(api_key: impl Into<String>) -> Self

Creates a client using an explicit OpenAI API key.

pub fn with_auth(auth: AuthProvider) -> Self

Creates a client with an authentication provider.

The Live API currently supports only AuthProvider::OpenAI. Passing Azure authentication is allowed here so that configuration can be shared, but connect and fork reject it.

pub fn model(&mut self, model: LiveModel) -> &mut Self

Selects the frontend Live model.

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

Sets immutable frontend instructions.

pub fn voice(&mut self, voice: LiveVoice) -> &mut Self

Selects the output voice.

pub fn audio_format(&mut self, format: LiveAudioFormat) -> &mut Self

Selects the common input/output audio format.

pub fn delegation(&mut self, delegation: Delegation) -> &mut Self

Selects the delegation strategy.

pub fn store(&mut self, store: bool) -> &mut Self

Enables or disables storage for later forks.

pub fn input(&mut self, input: Vec<Value>) -> &mut Self

Supplies initial Responses-style input items.

pub async fn connect(&self) -> Result<LiveSession>

Starts a new primary Live WebSocket session.

pub async fn fork(&self, session_id: &str) -> Result<LiveSession>

Forks a stored Live session, applying only explicitly configured fields.

Trait Implementations

impl Clone for LiveClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LiveClient

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

Formats the value using the given formatter.

impl Default for LiveClient

fn default() -> Self

Returns the “default value” for a type.