Skip to main content

mojentic/realtime/
config.rs

1//! Configuration for the realtime voice subsystem.
2
3use crate::llm::tools::LlmTool;
4use std::collections::HashMap;
5
6pub type RealtimeVoice = String;
7
8#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
9#[serde(rename_all = "lowercase")]
10pub enum RealtimeModality {
11    Audio,
12    Text,
13}
14
15#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
16#[serde(rename_all = "snake_case")]
17pub enum RealtimeAudioFormat {
18    Pcm16,
19    G711Ulaw,
20    G711Alaw,
21}
22
23#[derive(Debug, Clone, Copy, PartialEq, Eq)]
24pub enum InterruptOutputPolicy {
25    Drop,
26    Submit,
27    SubmitCompletedOnly,
28}
29
30#[derive(Debug, Clone)]
31pub enum RealtimeToolChoice {
32    Auto,
33    None,
34    Required,
35    Function(String),
36}
37
38#[derive(Debug, Clone, Default)]
39pub struct ServerVadConfig {
40    pub threshold: Option<f32>,
41    pub prefix_padding_ms: Option<u32>,
42    pub silence_duration_ms: Option<u32>,
43    pub create_response: Option<bool>,
44    pub interrupt_response: Option<bool>,
45    pub idle_timeout_ms: Option<u32>,
46}
47
48#[derive(Debug, Clone, Default)]
49pub struct SemanticVadConfig {
50    pub eagerness: Option<String>,
51    pub create_response: Option<bool>,
52    pub interrupt_response: Option<bool>,
53}
54
55#[derive(Debug, Clone)]
56pub enum TurnDetectionMode {
57    ServerVad,
58    SemanticVad,
59    None,
60    ServerVadCustom(ServerVadConfig),
61    SemanticVadCustom(SemanticVadConfig),
62}
63
64#[derive(Default)]
65pub struct RealtimeVoiceConfig {
66    pub instructions: Option<String>,
67    pub voice: Option<RealtimeVoice>,
68    pub modalities: Option<Vec<RealtimeModality>>,
69    pub input_audio_format: Option<RealtimeAudioFormat>,
70    pub output_audio_format: Option<RealtimeAudioFormat>,
71    pub turn_detection: Option<TurnDetectionMode>,
72    pub input_audio_transcription: Option<InputAudioTranscriptionConfig>,
73    pub disable_input_audio_transcription: bool,
74    pub tools: Option<Vec<Box<dyn LlmTool>>>,
75    pub tool_choice: Option<RealtimeToolChoice>,
76    pub temperature: Option<f32>,
77    pub max_response_output_tokens: Option<u32>,
78    pub on_interrupt: Option<InterruptOutputPolicy>,
79    pub provider_extras: Option<HashMap<String, serde_json::Value>>,
80}
81
82// Manual `Clone` impl: `Box<dyn LlmTool>` isn't `Clone`, so we route tool
83// cloning through `LlmTool::clone_box`. Keep this in sync with the
84// `RealtimeVoiceConfig` fields above.
85impl Clone for RealtimeVoiceConfig {
86    fn clone(&self) -> Self {
87        Self {
88            instructions: self.instructions.clone(),
89            voice: self.voice.clone(),
90            modalities: self.modalities.clone(),
91            input_audio_format: self.input_audio_format,
92            output_audio_format: self.output_audio_format,
93            turn_detection: self.turn_detection.clone(),
94            input_audio_transcription: self.input_audio_transcription.clone(),
95            disable_input_audio_transcription: self.disable_input_audio_transcription,
96            tools: self.tools.as_ref().map(|ts| ts.iter().map(|t| t.clone_box()).collect()),
97            tool_choice: self.tool_choice.clone(),
98            temperature: self.temperature,
99            max_response_output_tokens: self.max_response_output_tokens,
100            on_interrupt: self.on_interrupt,
101            provider_extras: self.provider_extras.clone(),
102        }
103    }
104}
105
106#[derive(Debug, Clone)]
107pub struct InputAudioTranscriptionConfig {
108    pub model: String,
109}
110
111impl Default for InputAudioTranscriptionConfig {
112    fn default() -> Self {
113        Self {
114            model: "whisper-1".to_string(),
115        }
116    }
117}
118
119pub struct Defaults {
120    pub modalities: Vec<RealtimeModality>,
121    pub input_audio_format: RealtimeAudioFormat,
122    pub output_audio_format: RealtimeAudioFormat,
123    pub tool_choice: RealtimeToolChoice,
124    pub on_interrupt: InterruptOutputPolicy,
125}
126
127pub fn defaults() -> Defaults {
128    Defaults {
129        modalities: vec![RealtimeModality::Audio, RealtimeModality::Text],
130        input_audio_format: RealtimeAudioFormat::Pcm16,
131        output_audio_format: RealtimeAudioFormat::Pcm16,
132        tool_choice: RealtimeToolChoice::Auto,
133        on_interrupt: InterruptOutputPolicy::Drop,
134    }
135}