Struct RealtimeClient 

pub struct RealtimeClient { /* private fields */ }

Builder for creating Realtime API connections.

Example

use openai_tools::realtime::{RealtimeClient, Modality, Voice};
use openai_tools::common::models::RealtimeModel;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = RealtimeClient::new();
    client
        .model(RealtimeModel::Gpt4oRealtimePreview)
        .modalities(vec![Modality::Text, Modality::Audio])
        .voice(Voice::Alloy)
        .instructions("You are a helpful assistant.");

    let mut session = client.connect().await?;
    // Use session...
    session.close().await?;
    Ok(())
}

Implementations

impl RealtimeClient

pub fn new() -> Self

Create a new RealtimeClient for OpenAI API.

Loads the API key from the OPENAI_API_KEY environment variable.

pub fn with_auth(auth: AuthProvider) -> Self

Create a new RealtimeClient with a custom authentication provider.

pub fn azure() -> Result<Self>

Create a new RealtimeClient for Azure OpenAI API.

pub fn detect_provider() -> Result<Self>

Create a new RealtimeClient by auto-detecting the provider.

pub fn with_url<S: Into<String>>(base_url: S, api_key: S) -> Self

Creates a new RealtimeClient with URL-based provider detection.

pub fn from_url<S: Into<String>>(url: S) -> Result<Self>

Creates a new RealtimeClient from URL using environment variables.

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

👎Deprecated since 0.3.0: Use with_auth(AuthProvider::OpenAI(...)) instead

Create a new RealtimeClient with an explicit API key.

pub fn auth(&self) -> &AuthProvider

Returns the authentication provider.

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

Set the model for the Realtime API.

Example

use openai_tools::realtime::RealtimeClient;
use openai_tools::common::models::RealtimeModel;

let mut client = RealtimeClient::new();
client.model(RealtimeModel::Gpt4oRealtimePreview);

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

👎Deprecated since 0.2.0: Use model(RealtimeModel) instead for type safety

Set the model using a string ID (for backward compatibility).

Prefer using [model] with RealtimeModel enum for type safety.

pub fn modalities(&mut self, modalities: Vec<Modality>) -> &mut Self

Set the supported modalities.

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

Set the system instructions.

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

Set the voice for audio output.

pub fn input_audio_format(&mut self, format: AudioFormat) -> &mut Self

Set the input audio format.

pub fn output_audio_format(&mut self, format: AudioFormat) -> &mut Self

Set the output audio format.

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

Enable input audio transcription.

pub fn transcription(&mut self, config: InputAudioTranscription) -> &mut Self

Set input audio transcription configuration.

pub fn server_vad(&mut self, config: ServerVadConfig) -> &mut Self

Set Server VAD turn detection.

pub fn semantic_vad(&mut self, config: SemanticVadConfig) -> &mut Self

Set Semantic VAD turn detection.

pub fn disable_turn_detection(&mut self) -> &mut Self

Disable turn detection (manual mode).

pub fn tools(&mut self, tools: Vec<Tool>) -> &mut Self

Set available tools for function calling.

Accepts Tool from the common module and converts to RealtimeTool.

pub fn realtime_tools(&mut self, tools: Vec<RealtimeTool>) -> &mut Self

Set available realtime tools directly.

pub fn temperature(&mut self, temp: f32) -> &mut Self

Set the sampling temperature.

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

Connect to the Realtime API.

Returns a RealtimeSession for sending and receiving events.

Trait Implementations

impl Clone for RealtimeClient

fn clone(&self) -> RealtimeClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeClient

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

Formats the value using the given formatter.

impl Default for RealtimeClient

fn default() -> Self

Returns the “default value” for a type.