Skip to main content

mojentic/realtime/
events.rs

1//! Vendor-neutral event union for the realtime subsystem.
2
3use serde_json::Value;
4use std::collections::HashMap;
5
6#[derive(Debug, Clone, Default)]
7pub struct TokenUsage {
8    pub prompt_tokens: Option<u32>,
9    pub completion_tokens: Option<u32>,
10    pub total_tokens: Option<u32>,
11    pub extras: Option<HashMap<String, Value>>,
12}
13
14#[derive(Debug, Clone)]
15pub struct RealtimeItem {
16    pub id: String,
17    pub item_type: String,
18    pub role: Option<String>,
19    pub text: Option<String>,
20    pub transcript: Option<String>,
21    pub name: Option<String>,
22    pub args: Option<HashMap<String, Value>>,
23    pub output: Option<Value>,
24    pub call_id: Option<String>,
25}
26
27/// Vendor-neutral event types emitted by [`crate::realtime::RealtimeSession`].
28#[derive(Debug, Clone)]
29pub enum RealtimeEvent {
30    // Session lifecycle
31    SessionOpened {
32        session_id: String,
33    },
34    SessionUpdated {
35        config: HashMap<String, Value>,
36    },
37    SessionClosed {
38        reason: SessionCloseReason,
39    },
40
41    // User speech
42    UserSpeechStarted {
43        at_ms: u64,
44    },
45    UserSpeechStopped {
46        at_ms: u64,
47    },
48    UserTranscriptDelta {
49        item_id: String,
50        delta: String,
51    },
52    UserTranscript {
53        item_id: String,
54        text: String,
55    },
56
57    // Assistant output
58    AssistantTurnStarted {
59        turn_id: String,
60    },
61    AssistantTextDelta {
62        turn_id: String,
63        delta: String,
64    },
65    AssistantText {
66        turn_id: String,
67        text: String,
68    },
69    AssistantTranscriptDelta {
70        turn_id: String,
71        delta: String,
72    },
73    AssistantTranscript {
74        turn_id: String,
75        text: String,
76    },
77    AssistantAudioDelta {
78        turn_id: String,
79        pcm: Vec<i16>,
80    },
81    AssistantTurnCompleted {
82        turn_id: String,
83        usage: Option<TokenUsage>,
84    },
85
86    // Tool calls
87    ToolCallStarted {
88        turn_id: String,
89        call_id: String,
90        name: String,
91    },
92    ToolCallArgsDelta {
93        call_id: String,
94        delta: String,
95    },
96    ToolCallDispatched {
97        call_id: String,
98        name: String,
99        args: HashMap<String, Value>,
100    },
101    ToolCallCompleted {
102        call_id: String,
103        name: String,
104        result: Value,
105    },
106    ToolCallFailed {
107        call_id: String,
108        name: String,
109        error: String,
110    },
111    ToolBatchSubmitted {
112        turn_id: String,
113        call_ids: Vec<String>,
114    },
115
116    // Control
117    Interrupted {
118        turn_id: String,
119        reason: InterruptReason,
120    },
121    RateLimited {
122        reset_ms: u64,
123        details: HashMap<String, Value>,
124    },
125    Error {
126        error: String,
127        recoverable: bool,
128    },
129}
130
131#[derive(Debug, Clone, Copy, PartialEq, Eq)]
132pub enum SessionCloseReason {
133    Client,
134    Server,
135    Error,
136}
137
138#[derive(Debug, Clone, Copy, PartialEq, Eq)]
139pub enum InterruptReason {
140    BargeIn,
141    Manual,
142    Error,
143}