Skip to main content

gproxy_protocol/openai/realtime/
session.rs

1use serde::{Deserialize, Serialize};
2use serde_json::Value;
3
4use crate::openai::common::{OpenAiModelId, ResponseToolChoice, Rest};
5use crate::openai::generate_content::responses::ResponseTool;
6
7use super::audio::RealtimeAudio;
8
9#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, gproxy_protocol_macros::WireBuilder)]
10#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
11pub struct RealtimeSession {
12    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
13    pub type_: Option<RealtimeSessionType>,
14    #[serde(skip_serializing_if = "Option::is_none")]
15    pub model: Option<OpenAiModelId>,
16    #[serde(skip_serializing_if = "Option::is_none")]
17    pub output_modalities: Option<Vec<RealtimeOutputModality>>,
18    #[serde(skip_serializing_if = "Option::is_none")]
19    pub instructions: Option<String>,
20    #[serde(skip_serializing_if = "Option::is_none")]
21    pub audio: Option<RealtimeAudio>,
22    #[serde(skip_serializing_if = "Option::is_none")]
23    pub include: Option<Vec<String>>,
24    #[serde(skip_serializing_if = "Option::is_none")]
25    pub tools: Option<Vec<ResponseTool>>,
26    #[serde(skip_serializing_if = "Option::is_none")]
27    pub tool_choice: Option<ResponseToolChoice>,
28    #[serde(skip_serializing_if = "Option::is_none")]
29    pub max_output_tokens: Option<RealtimeMaxTokens>,
30    #[serde(default, flatten)]
31    pub rest: Rest,
32}
33
34pub type RealtimeSessionConfig = RealtimeSession;
35
36#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
37#[serde(untagged)]
38#[cfg_attr(not(feature = "exhaustive"), non_exhaustive)]
39pub enum RealtimeMaxTokens {
40    Count(u64),
41    Infinite(String),
42    Raw(Value),
43}
44
45extensible_string!(RealtimeSessionType, KnownRealtimeSessionType {
46    Realtime => "realtime", Transcription => "transcription",
47});
48extensible_string!(RealtimeOutputModality, KnownRealtimeOutputModality {
49    Text => "text", Audio => "audio",
50});