Skip to main content

SessionConfig

Struct SessionConfig 

Source
pub struct SessionConfig {
    pub modalities: Option<Vec<Modality>>,
    pub instructions: Option<String>,
    pub voice: Option<Voice>,
    pub input_audio_format: Option<AudioFormat>,
    pub output_audio_format: Option<AudioFormat>,
    pub input_audio_transcription: Option<InputAudioTranscription>,
    pub input_audio_noise_reduction: Option<InputAudioNoiseReduction>,
    pub turn_detection: Option<TurnDetection>,
    pub tools: Option<Vec<RealtimeTool>>,
    pub tool_choice: Option<ToolChoice>,
    pub temperature: Option<f32>,
    pub max_response_output_tokens: Option<MaxTokens>,
}
Expand description

Session configuration sent in session.update events.

Fields§

§modalities: Option<Vec<Modality>>

Supported modalities for this session.

§instructions: Option<String>

System instructions for the model.

§voice: Option<Voice>

Voice for audio output.

§input_audio_format: Option<AudioFormat>

Format for input audio.

§output_audio_format: Option<AudioFormat>

Format for output audio.

§input_audio_transcription: Option<InputAudioTranscription>

Configuration for input audio transcription.

§input_audio_noise_reduction: Option<InputAudioNoiseReduction>

Noise reduction configuration.

§turn_detection: Option<TurnDetection>

Turn detection configuration.

§tools: Option<Vec<RealtimeTool>>

Available tools for function calling.

§tool_choice: Option<ToolChoice>

How to select tools.

§temperature: Option<f32>

Sampling temperature (0.6 to 1.2).

§max_response_output_tokens: Option<MaxTokens>

Maximum tokens in a response.

Implementations§

Source§

impl SessionConfig

Source

pub fn new() -> Self

Create a new empty session configuration.

Source

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

Set the modalities.

Source

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

Set the instructions.

Source

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

Set the voice.

Source

pub fn with_input_audio_format(self, format: AudioFormat) -> Self

Set the input audio format.

Source

pub fn with_output_audio_format(self, format: AudioFormat) -> Self

Set the output audio format.

Source

pub fn with_transcription(self, config: InputAudioTranscription) -> Self

Set the transcription configuration.

Source

pub fn with_turn_detection(self, config: TurnDetection) -> Self

Set the turn detection configuration.

Source

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

Set the available tools.

Accepts Tool from the common module and converts to RealtimeTool.

Source

pub fn with_realtime_tools(self, tools: Vec<RealtimeTool>) -> Self

Set the available realtime tools directly.

Source

pub fn with_tool_choice(self, choice: ToolChoice) -> Self

Set the tool choice.

Source

pub fn with_temperature(self, temp: f32) -> Self

Set the temperature.

Source

pub fn with_max_tokens(self, max: MaxTokens) -> Self

Set the maximum response tokens.

Trait Implementations§

Source§

impl Clone for SessionConfig

Source§

fn clone(&self) -> SessionConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SessionConfig

Source§

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

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

impl Default for SessionConfig

Source§

fn default() -> SessionConfig

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

impl<'de> Deserialize<'de> for SessionConfig

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 SessionConfig

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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