Struct RealtimeSession

Source
pub struct RealtimeSession {
Show 14 fields pub id: Option<String>, pub input_audio_format: Option<String>, pub input_audio_noise_reduction: Option<RealtimeSessionInputAudioNoiseReduction>, pub input_audio_transcription: Option<RealtimeSessionInputAudioTranscription>, pub instructions: Option<String>, pub max_response_output_tokens: Option<Value>, pub modalities: Option<Value>, pub model: Option<String>, pub output_audio_format: Option<String>, pub temperature: Option<f32>, pub tool_choice: Option<String>, pub tools: Option<Vec<RealtimeResponseCreateParamsTools>>, pub turn_detection: Option<RealtimeSessionTurnDetection>, pub voice: Option<VoiceIdsShared>,
}

Fields§

§id: Option<String>

Unique identifier for the session that looks like sess_1234567890abcdef.

§input_audio_format: Option<String>

The format of input audio. Options are pcm16, g711_ulaw, or g711_alaw. For pcm16, input audio must be 16-bit PCM at a 24kHz sample rate, single channel (mono), and little-endian byte order.

§input_audio_noise_reduction: Option<RealtimeSessionInputAudioNoiseReduction>§input_audio_transcription: Option<RealtimeSessionInputAudioTranscription>§instructions: Option<String>

The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. "be extremely succinct", "act friendly", "here are examples of good responses") and on audio behavior (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior. Note that the server sets default instructions which will be used if this field is not set and are visible in the session.created event at the start of the session.

§max_response_output_tokens: Option<Value>

Maximum number of output tokens for a single assistant response, inclusive of tool calls. Provide an integer between 1 and 4096 to limit output tokens, or inf for the maximum available tokens for a given model. Defaults to inf.

§modalities: Option<Value>

The set of modalities the model can respond with. To disable audio, set this to ["text"].

§model: Option<String>

The Realtime model used for this session.

§output_audio_format: Option<String>

The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw. For pcm16, output audio is sampled at a rate of 24kHz.

§temperature: Option<f32>

Sampling temperature for the model, limited to [0.6, 1.2]. For audio models a temperature of 0.8 is highly recommended for best performance.

§tool_choice: Option<String>

How the model chooses tools. Options are auto, none, required, or specify a function.

§tools: Option<Vec<RealtimeResponseCreateParamsTools>>

Tools (functions) available to the model.

§turn_detection: Option<RealtimeSessionTurnDetection>§voice: Option<VoiceIdsShared>

The voice the model uses to respond. Voice cannot be changed during the session once the model has responded with audio at least once. Current voice options are alloy, ash, ballad, coral, echo sage, shimmer and verse.

Trait Implementations§

Source§

impl Debug for RealtimeSession

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for RealtimeSession

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,