Skip to main content

RealtimeConfig

Struct RealtimeConfig 

Source
pub struct RealtimeConfig {
Show 15 fields pub model: Option<String>, pub instruction: Option<String>, pub voice: Option<String>, pub modalities: Option<Vec<String>>, pub input_audio_format: Option<AudioEncoding>, pub output_audio_format: Option<AudioEncoding>, pub turn_detection: Option<VadConfig>, pub tools: Option<Vec<ToolDefinition>>, pub tool_choice: Option<String>, pub input_audio_transcription: Option<TranscriptionConfig>, pub temperature: Option<f32>, pub max_response_output_tokens: Option<u32>, pub cached_content: Option<String>, pub interruption_detection: Option<InterruptionDetection>, pub extra: Option<Value>,
}
Expand description

Configuration for a realtime session.

Fields§

§model: Option<String>

Model to use (provider-specific).

§instruction: Option<String>

System instruction for the agent.

§voice: Option<String>

Voice to use for audio output.

§modalities: Option<Vec<String>>

Output modalities: [“text”], [“audio”], or [“text”, “audio”].

§input_audio_format: Option<AudioEncoding>

Input audio format.

§output_audio_format: Option<AudioEncoding>

Output audio format.

§turn_detection: Option<VadConfig>

VAD configuration.

§tools: Option<Vec<ToolDefinition>>

Available tools/functions.

§tool_choice: Option<String>

Tool selection mode: “auto”, “none”, “required”.

§input_audio_transcription: Option<TranscriptionConfig>

Whether to include input audio transcription.

§temperature: Option<f32>

Temperature for response generation.

§max_response_output_tokens: Option<u32>

Maximum output tokens.

§cached_content: Option<String>

Cached content resource name (e.g. cachedContents/1234).

§interruption_detection: Option<InterruptionDetection>

Interruption detection mode for voice sessions.

Controls whether the session automatically detects user speech to cancel agent audio output, or relies on explicit API calls. Defaults to Manual when None.

§extra: Option<Value>

Provider-specific options.

Implementations§

Source§

impl RealtimeConfig

Source

pub fn new() -> Self

Create a new empty configuration.

Source

pub fn builder() -> RealtimeConfigBuilder

Create a builder for RealtimeConfig.

Source

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

Set the model.

Source

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

Set the system instruction.

Source

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

Set the voice.

Source

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

Set output modalities.

Source

pub fn with_text_and_audio(self) -> Self

Enable text and audio output.

Source

pub fn with_audio_only(self) -> Self

Enable audio-only output.

Source

pub fn with_vad(self, vad: VadConfig) -> Self

Set VAD configuration.

Source

pub fn with_server_vad(self) -> Self

Enable server-side VAD with default settings.

Source

pub fn without_vad(self) -> Self

Disable VAD (manual turn management).

Source

pub fn with_tool(self, tool: ToolDefinition) -> Self

Add a tool definition.

Source

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

Set multiple tools.

Source

pub fn with_transcription(self) -> Self

Enable input audio transcription.

Source

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

Set temperature.

Source

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

Set cached content resource.

Source

pub fn with_interruption_detection(self, mode: InterruptionDetection) -> Self

Set the interruption detection mode.

See InterruptionDetection for details on each variant.

Source

pub fn with_automatic_interruption(self) -> Self

Enable automatic interruption detection.

The session will detect user speech onset and cancel the current agent audio output automatically.

Trait Implementations§

Source§

impl Clone for RealtimeConfig

Source§

fn clone(&self) -> RealtimeConfig

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 RealtimeConfig

Source§

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

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

impl Default for RealtimeConfig

Source§

fn default() -> RealtimeConfig

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

impl<'de> Deserialize<'de> for RealtimeConfig

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 From<RealtimeConfig> for SessionUpdateConfig

Source§

fn from(config: RealtimeConfig) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for RealtimeConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for RealtimeConfig

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
Source§

impl StructuralPartialEq for RealtimeConfig

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> 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<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>,