gproxy-protocol 4.1.14

GPROXY v4 connection modelling, operation declarations, vendor wire types and pairwise conversion
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206

//! Native Realtime wire DTOs. Source definitions are cited on each object.
//! Verified with Realtime.md and openai-python snapshot
//! e12b81d3bbf644ec7045e152d69bc4b68d69cd48 (2026-09-13).
//! https://github.com/openai/openai-python/tree/e12b81d3bbf644ec7045e152d69bc4b68d69cd48/src/openai/types/realtime
use super::{
    ConversationCreatedEvent, ConversationItem, ConversationItemAdded, ConversationItemCreateEvent,
    ConversationItemCreatedEvent, ConversationItemDeleteEvent, ConversationItemDeletedEvent,
    ConversationItemDone, ConversationItemInputAudioTranscriptionCompletedEvent,
    ConversationItemInputAudioTranscriptionDeltaEvent,
    ConversationItemInputAudioTranscriptionFailedEvent,
    ConversationItemInputAudioTranscriptionSegment, ConversationItemRetrieveEvent,
    ConversationItemTruncateEvent, ConversationItemTruncatedEvent, InputAudioBufferAppendEvent,
    InputAudioBufferClearEvent, InputAudioBufferClearedEvent, InputAudioBufferCommitEvent,
    InputAudioBufferCommittedEvent, InputAudioBufferDtmfEventReceivedEvent,
    InputAudioBufferSpeechStartedEvent, InputAudioBufferSpeechStoppedEvent,
    InputAudioBufferTimeoutTriggered, McpListToolsCompleted, McpListToolsFailed,
    McpListToolsInProgress, OutputAudioBufferClearEvent, RateLimitsUpdatedEvent,
    RealtimeErrorEvent, ResponseAudioDeltaEvent, ResponseAudioDoneEvent,
    ResponseAudioTranscriptDeltaEvent, ResponseAudioTranscriptDoneEvent, ResponseCancelEvent,
    ResponseContentPartAddedEvent, ResponseContentPartDoneEvent, ResponseCreateEvent,
    ResponseCreatedEvent, ResponseDoneEvent, ResponseFunctionCallArgumentsDeltaEvent,
    ResponseFunctionCallArgumentsDoneEvent, ResponseMcpCallArgumentsDelta,
    ResponseMcpCallArgumentsDone, ResponseMcpCallCompleted, ResponseMcpCallFailed,
    ResponseMcpCallInProgress, ResponseOutputItemAddedEvent, ResponseOutputItemDoneEvent,
    ResponseTextDeltaEvent, ResponseTextDoneEvent, SessionCreatedEvent, SessionUpdateEvent,
    SessionUpdatedEvent,
};
use crate::Rest;
use serde::{Deserialize, Serialize};

pub type HandshakeRequest = crate::WireRequest<()>;
pub type HandshakeResponse = crate::WireResponse<()>;

/// Source: `openai/types/realtime/realtime_client_event.py`, `RealtimeClientEvent`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[serde(untagged)]
#[allow(clippy::large_enum_variant)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum RealtimeClientEvent {
    ConversationItemCreateEvent(ConversationItemCreateEvent),
    ConversationItemDeleteEvent(ConversationItemDeleteEvent),
    ConversationItemRetrieveEvent(ConversationItemRetrieveEvent),
    ConversationItemTruncateEvent(ConversationItemTruncateEvent),
    InputAudioBufferAppendEvent(InputAudioBufferAppendEvent),
    InputAudioBufferClearEvent(InputAudioBufferClearEvent),
    OutputAudioBufferClearEvent(OutputAudioBufferClearEvent),
    InputAudioBufferCommitEvent(InputAudioBufferCommitEvent),
    ResponseCancelEvent(ResponseCancelEvent),
    ResponseCreateEvent(ResponseCreateEvent),
    SessionUpdateEvent(SessionUpdateEvent),
}

/// Source: `openai/types/realtime/realtime_server_event.py`, `RealtimeServerEvent`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[serde(untagged)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum RealtimeServerEvent {
    ConversationCreatedEvent(ConversationCreatedEvent),
    ConversationItemCreatedEvent(ConversationItemCreatedEvent),
    ConversationItemDeletedEvent(ConversationItemDeletedEvent),
    ConversationItemInputAudioTranscriptionCompletedEvent(
        ConversationItemInputAudioTranscriptionCompletedEvent,
    ),
    ConversationItemInputAudioTranscriptionDeltaEvent(
        ConversationItemInputAudioTranscriptionDeltaEvent,
    ),
    ConversationItemInputAudioTranscriptionFailedEvent(
        ConversationItemInputAudioTranscriptionFailedEvent,
    ),
    ConversationItemRetrieved(ConversationItemRetrieved),
    ConversationItemTruncatedEvent(ConversationItemTruncatedEvent),
    RealtimeErrorEvent(RealtimeErrorEvent),
    InputAudioBufferClearedEvent(InputAudioBufferClearedEvent),
    InputAudioBufferCommittedEvent(InputAudioBufferCommittedEvent),
    InputAudioBufferDtmfEventReceivedEvent(InputAudioBufferDtmfEventReceivedEvent),
    InputAudioBufferSpeechStartedEvent(InputAudioBufferSpeechStartedEvent),
    InputAudioBufferSpeechStoppedEvent(InputAudioBufferSpeechStoppedEvent),
    RateLimitsUpdatedEvent(RateLimitsUpdatedEvent),
    ResponseAudioDeltaEvent(ResponseAudioDeltaEvent),
    ResponseAudioDoneEvent(ResponseAudioDoneEvent),
    ResponseAudioTranscriptDeltaEvent(ResponseAudioTranscriptDeltaEvent),
    ResponseAudioTranscriptDoneEvent(ResponseAudioTranscriptDoneEvent),
    ResponseContentPartAddedEvent(ResponseContentPartAddedEvent),
    ResponseContentPartDoneEvent(ResponseContentPartDoneEvent),
    ResponseCreatedEvent(ResponseCreatedEvent),
    ResponseDoneEvent(ResponseDoneEvent),
    ResponseFunctionCallArgumentsDeltaEvent(ResponseFunctionCallArgumentsDeltaEvent),
    ResponseFunctionCallArgumentsDoneEvent(ResponseFunctionCallArgumentsDoneEvent),
    ResponseOutputItemAddedEvent(ResponseOutputItemAddedEvent),
    ResponseOutputItemDoneEvent(ResponseOutputItemDoneEvent),
    ResponseTextDeltaEvent(ResponseTextDeltaEvent),
    ResponseTextDoneEvent(ResponseTextDoneEvent),
    SessionCreatedEvent(SessionCreatedEvent),
    SessionUpdatedEvent(SessionUpdatedEvent),
    RealtimeServerEventOutputAudioBufferStarted(RealtimeServerEventOutputAudioBufferStarted),
    RealtimeServerEventOutputAudioBufferStopped(RealtimeServerEventOutputAudioBufferStopped),
    RealtimeServerEventOutputAudioBufferCleared(RealtimeServerEventOutputAudioBufferCleared),
    ConversationItemAdded(ConversationItemAdded),
    ConversationItemDone(ConversationItemDone),
    InputAudioBufferTimeoutTriggered(InputAudioBufferTimeoutTriggered),
    ConversationItemInputAudioTranscriptionSegment(ConversationItemInputAudioTranscriptionSegment),
    McpListToolsInProgress(McpListToolsInProgress),
    McpListToolsCompleted(McpListToolsCompleted),
    McpListToolsFailed(McpListToolsFailed),
    ResponseMcpCallArgumentsDelta(ResponseMcpCallArgumentsDelta),
    ResponseMcpCallArgumentsDone(ResponseMcpCallArgumentsDone),
    ResponseMcpCallInProgress(ResponseMcpCallInProgress),
    ResponseMcpCallCompleted(ResponseMcpCallCompleted),
    ResponseMcpCallFailed(ResponseMcpCallFailed),
}

/// Source: `openai/types/realtime/realtime_server_event.py`, `ConversationItemRetrieved`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, gproxy_protocol_macros::WireBuilder)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ConversationItemRetrieved {
    pub event_id: String,
    pub item: ConversationItem,
    #[serde(rename = "type")]
    pub type_: ConversationItemRetrievedType,
    #[serde(default, flatten, skip_serializing_if = "serde_json::Map::is_empty")]
    pub rest: Rest,
}

/// Source: `openai/types/realtime/realtime_server_event.py`, `OutputAudioBufferStarted`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, gproxy_protocol_macros::WireBuilder)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct RealtimeServerEventOutputAudioBufferStarted {
    pub event_id: String,
    pub response_id: String,
    #[serde(rename = "type")]
    pub type_: RealtimeServerEventOutputAudioBufferStartedType,
    #[serde(default, flatten, skip_serializing_if = "serde_json::Map::is_empty")]
    pub rest: Rest,
}

/// Source: `openai/types/realtime/realtime_server_event.py`, `OutputAudioBufferStopped`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, gproxy_protocol_macros::WireBuilder)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct RealtimeServerEventOutputAudioBufferStopped {
    pub event_id: String,
    pub response_id: String,
    #[serde(rename = "type")]
    pub type_: RealtimeServerEventOutputAudioBufferStoppedType,
    #[serde(default, flatten, skip_serializing_if = "serde_json::Map::is_empty")]
    pub rest: Rest,
}

/// Source: `openai/types/realtime/realtime_server_event.py`, `OutputAudioBufferCleared`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, gproxy_protocol_macros::WireBuilder)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct RealtimeServerEventOutputAudioBufferCleared {
    pub event_id: String,
    pub response_id: String,
    #[serde(rename = "type")]
    pub type_: RealtimeServerEventOutputAudioBufferClearedType,
    #[serde(default, flatten, skip_serializing_if = "serde_json::Map::is_empty")]
    pub rest: Rest,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum ConversationItemRetrievedType {
    #[serde(rename = "conversation.item.retrieved")]
    ConversationItemRetrieved,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum RealtimeServerEventOutputAudioBufferStartedType {
    #[serde(rename = "output_audio_buffer.started")]
    OutputAudioBufferStarted,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum RealtimeServerEventOutputAudioBufferStoppedType {
    #[serde(rename = "output_audio_buffer.stopped")]
    OutputAudioBufferStopped,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
#[derive(gproxy_protocol_macros::DeclaredFields)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub enum RealtimeServerEventOutputAudioBufferClearedType {
    #[serde(rename = "output_audio_buffer.cleared")]
    OutputAudioBufferCleared,
}