Skip to main content

SessionCreateRequest

Struct SessionCreateRequest 

Source
pub struct SessionCreateRequest {
Show 13 fields pub model: Option<String>, pub voice: Option<String>, pub instructions: Option<String>, pub input_audio_format: Option<RealtimeAudioFormat>, pub output_audio_format: Option<RealtimeAudioFormat>, pub modalities: Option<Vec<String>>, pub temperature: Option<f64>, pub max_response_output_tokens: Option<MaxResponseTokens>, pub tools: Option<Vec<RealtimeTool>>, pub tool_choice: Option<String>, pub turn_detection: Option<TurnDetection>, pub input_audio_transcription: Option<InputAudioTranscription>, pub speed: Option<f64>,
}
Expand description

Request body for POST /realtime/sessions.

Fields§

§model: Option<String>

The Realtime model to use.

§voice: Option<String>

The voice the model uses to respond.

§instructions: Option<String>

System instructions for the session.

§input_audio_format: Option<RealtimeAudioFormat>

The format of input audio.

§output_audio_format: Option<RealtimeAudioFormat>

The format of output audio.

§modalities: Option<Vec<String>>

Modalities: [“text”], [“audio”], or [“text”, “audio”].

§temperature: Option<f64>

Sampling temperature (0.6-1.2).

§max_response_output_tokens: Option<MaxResponseTokens>

Maximum output tokens (1-4096 or “inf”).

§tools: Option<Vec<RealtimeTool>>

Tools (functions) available to the model.

§tool_choice: Option<String>

How the model chooses tools.

§turn_detection: Option<TurnDetection>

Turn detection configuration.

§input_audio_transcription: Option<InputAudioTranscription>

Input audio transcription configuration.

§speed: Option<f64>

Speed of spoken response (0.25-1.5).

Implementations§

Source§

impl SessionCreateRequest

Source

pub fn new() -> Self

Source

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

Set the model.

Source

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

Set the voice.

Source

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

Set instructions.

Source

pub fn modalities(self, modalities: Vec<String>) -> Self

Set modalities.

Trait Implementations§

Source§

impl Clone for SessionCreateRequest

Source§

fn clone(&self) -> SessionCreateRequest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SessionCreateRequest

Source§

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

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

impl Default for SessionCreateRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Serialize for SessionCreateRequest

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.