Codex Handbook
codex-api/src/endpoint/realtime_websocket/protocol_v2.rs 210 lines
use crate::endpoint::realtime_websocket::protocol_common::parse_error_event;use crate::endpoint::realtime_websocket::protocol_common::parse_realtime_payload;use crate::endpoint::realtime_websocket::protocol_common::parse_session_updated_event;use crate::endpoint::realtime_websocket::protocol_common::parse_transcript_delta_event;use crate::endpoint::realtime_websocket::protocol_common::parse_transcript_done_event;use codex_protocol::protocol::RealtimeAudioFrame;use codex_protocol::protocol::RealtimeEvent;use codex_protocol::protocol::RealtimeHandoffRequested;use codex_protocol::protocol::RealtimeInputAudioSpeechStarted;use codex_protocol::protocol::RealtimeNoopRequested;use codex_protocol::protocol::RealtimeResponseCancelled;use codex_protocol::protocol::RealtimeResponseCreated;use codex_protocol::protocol::RealtimeResponseDone;use serde_json::Map as JsonMap;use serde_json::Value;use tracing::debug;const BACKGROUND_AGENT_TOOL_NAME: &str = "background_agent";const SILENCE_TOOL_NAME: &str = "remain_silent";const DEFAULT_AUDIO_SAMPLE_RATE: u32 = 24_000;const DEFAULT_AUDIO_CHANNELS: u16 = 1;const TOOL_ARGUMENT_KEYS: [&str; 5] = ["input_transcript", "input", "text", "prompt", "query"];pub(super) fn parse_realtime_event_v2(payload: &str) -> Option<RealtimeEvent> {    let (parsed, message_type) = parse_realtime_payload(payload, "realtime v2")?;    match message_type.as_str() {        "session.updated" => parse_session_updated_event(&parsed),        "response.output_audio.delta" | "response.audio.delta" => {            parse_output_audio_delta_event(&parsed)        }        "conversation.item.input_audio_transcription.delta" => {            parse_transcript_delta_event(&parsed, "delta").map(RealtimeEvent::InputTranscriptDelta)        }        "conversation.item.input_audio_transcription.completed" => {            parse_transcript_done_event(&parsed, "transcript")                .map(RealtimeEvent::InputTranscriptDone)        }        "response.output_text.delta" | "response.output_audio_transcript.delta" => {            parse_transcript_delta_event(&parsed, "delta").map(RealtimeEvent::OutputTranscriptDelta)        }        "response.output_text.done" => {            parse_transcript_done_event(&parsed, "text").map(RealtimeEvent::OutputTranscriptDone)        }        "response.output_audio_transcript.done" => {            parse_transcript_done_event(&parsed, "transcript")                .map(RealtimeEvent::OutputTranscriptDone)        }        "input_audio_buffer.speech_started" => Some(RealtimeEvent::InputAudioSpeechStarted(            RealtimeInputAudioSpeechStarted {                item_id: parsed                    .get("item_id")                    .and_then(Value::as_str)                    .map(str::to_string),            },        )),        "conversation.item.added" | "conversation.item.created" => parsed            .get("item")            .cloned()            .map(RealtimeEvent::ConversationItemAdded),        "conversation.item.done" => parse_conversation_item_done_event(&parsed),        "response.created" => Some(RealtimeEvent::ResponseCreated(RealtimeResponseCreated {            response_id: parse_response_event_response_id(&parsed),        })),        "response.cancelled" => Some(RealtimeEvent::ResponseCancelled(            RealtimeResponseCancelled {                response_id: parse_response_event_response_id(&parsed),            },        )),        "response.done" => Some(RealtimeEvent::ResponseDone(RealtimeResponseDone {            response_id: parse_response_event_response_id(&parsed),        })),        "error" => parse_error_event(&parsed),        _ => {            debug!("received unsupported realtime v2 event type: {message_type}, data: {payload}");            None        }    }}fn parse_response_event_response_id(parsed: &Value) -> Option<String> {    parsed        .get("response")        .and_then(Value::as_object)        .and_then(|response| response.get("id"))        .and_then(Value::as_str)        .map(str::to_string)        .or_else(|| {            parsed                .get("response_id")                .and_then(Value::as_str)                .map(str::to_string)        })}fn parse_output_audio_delta_event(parsed: &Value) -> Option<RealtimeEvent> {    let data = parsed        .get("delta")        .and_then(Value::as_str)        .map(str::to_string)?;    let sample_rate = parsed        .get("sample_rate")        .and_then(Value::as_u64)        .and_then(|value| u32::try_from(value).ok())        .unwrap_or(DEFAULT_AUDIO_SAMPLE_RATE);    let num_channels = parsed        .get("channels")        .or_else(|| parsed.get("num_channels"))        .and_then(Value::as_u64)        .and_then(|value| u16::try_from(value).ok())        .unwrap_or(DEFAULT_AUDIO_CHANNELS);    Some(RealtimeEvent::AudioOut(RealtimeAudioFrame {        data,        sample_rate,        num_channels,        samples_per_channel: parsed            .get("samples_per_channel")            .and_then(Value::as_u64)            .and_then(|value| u32::try_from(value).ok()),        item_id: parsed            .get("item_id")            .and_then(Value::as_str)            .map(str::to_string),    }))}fn parse_conversation_item_done_event(parsed: &Value) -> Option<RealtimeEvent> {    let item = parsed.get("item")?.as_object()?;    if let Some(handoff) = parse_handoff_requested_event(item) {        return Some(handoff);    }    if let Some(noop) = parse_noop_requested_event(item) {        return Some(noop);    }    item.get("id")        .and_then(Value::as_str)        .map(str::to_string)        .map(|item_id| RealtimeEvent::ConversationItemDone { item_id })}fn parse_handoff_requested_event(item: &JsonMap<String, Value>) -> Option<RealtimeEvent> {    let item_type = item.get("type").and_then(Value::as_str);    let item_name = item.get("name").and_then(Value::as_str);    if item_type != Some("function_call") || item_name != Some(BACKGROUND_AGENT_TOOL_NAME) {        return None;    }    let call_id = item        .get("call_id")        .and_then(Value::as_str)        .or_else(|| item.get("id").and_then(Value::as_str))?;    let item_id = item        .get("id")        .and_then(Value::as_str)        .unwrap_or(call_id)        .to_string();    let arguments = item.get("arguments").and_then(Value::as_str).unwrap_or("");    Some(RealtimeEvent::HandoffRequested(RealtimeHandoffRequested {        handoff_id: call_id.to_string(),        item_id,        input_transcript: extract_input_transcript(arguments),        active_transcript: Vec::new(),    }))}fn parse_noop_requested_event(item: &JsonMap<String, Value>) -> Option<RealtimeEvent> {    let item_type = item.get("type").and_then(Value::as_str);    let item_name = item.get("name").and_then(Value::as_str);    if item_type != Some("function_call") || item_name != Some(SILENCE_TOOL_NAME) {        return None;    }    let call_id = item        .get("call_id")        .and_then(Value::as_str)        .or_else(|| item.get("id").and_then(Value::as_str))?;    let item_id = item        .get("id")        .and_then(Value::as_str)        .unwrap_or(call_id)        .to_string();    Some(RealtimeEvent::NoopRequested(RealtimeNoopRequested {        call_id: call_id.to_string(),        item_id,    }))}fn extract_input_transcript(arguments: &str) -> String {    if arguments.is_empty() {        return String::new();    }    if let Ok(arguments_json) = serde_json::from_str::<Value>(arguments)        && let Some(arguments_object) = arguments_json.as_object()    {        for key in TOOL_ARGUMENT_KEYS {            if let Some(value) = arguments_object.get(key).and_then(Value::as_str) {                let trimmed = value.trim();                if !trimmed.is_empty() {                    return trimmed.to_string();                }            }        }    }    arguments.to_string()}