Struct RealtimeSession 

pub struct RealtimeSession {

    pub id: String,
    pub modalities: Option<Vec<String>>,
    pub model: String,
    pub instructions: Option<String>,
    pub voice: Option<VoiceIdsShared>,
    pub input_audio_format: Option<String>,
    pub output_audio_format: Option<String>,
    pub input_audio_transcription: Option<RealtimeSessionInputAudioTranscription>,
    pub turn_detection: Option<RealtimeSessionTurnDetection>,
    pub input_audio_noise_reduction: Option<RealtimeSessionInputAudioNoiseReduction>,
    pub tools: Option<Vec<Tool>>,
    pub tool_choice: Option<String>,
    pub temperature: Option<f64>,
    pub max_response_output_tokens: Option<Value>,
}

Represents the configuration of an active Realtime session.

Used By

• RealtimeServerEventSessionCreated
• RealtimeServerEventSessionUpdated

Fields

id: String

Unique identifier for the session.

modalities: Option<Vec<String>>

The set of modalities the model can respond with.

model: String

The Realtime model used for this session.

instructions: Option<String>

The default system instructions for the session.

voice: Option<VoiceIdsShared>

The voice the model uses to respond.

input_audio_format: Option<String>

The format of input audio.

output_audio_format: Option<String>

The format of output audio.

input_audio_transcription: Option<RealtimeSessionInputAudioTranscription>

Configuration for input audio transcription.

turn_detection: Option<RealtimeSessionTurnDetection>

Configuration for turn detection.

input_audio_noise_reduction: Option<RealtimeSessionInputAudioNoiseReduction>

Configuration for input audio noise reduction.

tools: Option<Vec<Tool>>

Tools (functions) available to the model.

tool_choice: Option<String>

How the model chooses tools.

temperature: Option<f64>

Sampling temperature for the model.

max_response_output_tokens: Option<Value>

Maximum number of output tokens for a single assistant response.

Trait Implementations

impl Clone for RealtimeSession

fn clone(&self) -> RealtimeSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeSession

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeSession

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RealtimeSession

fn eq(&self, other: &RealtimeSession) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RealtimeSession

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RealtimeSession