gproxy-protocol 2.2.3

GPROXY protocol types and endpoint metadata
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

use serde::{Deserialize, Serialize};

use super::super::common::*;
use super::{ResponseCreateRequest, ResponseStreamEvent};

pub type ResponseWebSocketWireModel =
    OpenAiWireModel<ResponseWebSocketRequest, ResponseStreamEvent>;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(tag = "type")]
#[allow(clippy::large_enum_variant)]
pub enum ResponseWebSocketRequest {
    #[serde(rename = "response.create")]
    ResponseCreate(ResponseCreateWebSocketRequest),
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct ResponseCreateWebSocketRequest {
    #[serde(flatten)]
    pub response: ResponseCreateRequest,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub generate: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_metadata: Option<Metadata>,
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use super::*;
    use crate::protocol::openai::{OpenAiModelId, ResponseInput};

    #[test]
    fn response_create_frame_round_trips_websocket_fields() {
        let value = json!({
            "type": "response.create",
            "model": "gpt-x",
            "input": "hello",
            "stream": true,
            "generate": false,
            "client_metadata": {
                "x-codex-installation-id": "installation-1"
            }
        });

        let parsed: ResponseWebSocketRequest = serde_json::from_value(value).unwrap();
        let ResponseWebSocketRequest::ResponseCreate(frame) = parsed;
        assert_eq!(
            frame.response.model,
            Some(OpenAiModelId::Unknown("gpt-x".to_owned()))
        );
        assert_eq!(
            frame.response.input,
            Some(ResponseInput::Text("hello".to_owned()))
        );
        assert_eq!(frame.response.stream, Some(true));
        assert_eq!(frame.generate, Some(false));
        assert_eq!(
            frame
                .client_metadata
                .as_ref()
                .and_then(|m| m.get("x-codex-installation-id")),
            Some(&"installation-1".to_owned())
        );

        let serialized = serde_json::to_value(ResponseWebSocketRequest::ResponseCreate(frame))
            .expect("serialize websocket response.create");
        assert_eq!(serialized["type"], json!("response.create"));
        assert_eq!(serialized["generate"], json!(false));
    }
}