open_ai_rust 1.1.1

Idiomatic Rust SDK for the OpenAI API: chat, responses, embeddings, audio, images, moderations, files, batches, vector stores, fine-tuning. Builder payloads, typed function-call schemas, streaming, per-request retries/timeouts.
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

//! End-to-end test: `#[derive(FunctionCall)]` from
//! `open_ai_rust_fn_call_extension` against the canonical
//! `FunctionCallable` trait path.

#[cfg(test)]
mod tests {
    use open_ai_rust::logoi::input::tool::raw_macro::FunctionCallable;
    use open_ai_rust::logoi::input::tool::{FunctionCall, FunctionParameter, FunctionType};
    use open_ai_rust_fn_call_extension::FunctionCall;

    #[test]
    pub fn can_parse_basic_struct_just_name() {
        #[derive(FunctionCall)]
        struct JustName {}

        let expected = FunctionCall {
            name: "JustName".to_string(),
            description: None,
            parameters: vec![],
        };
        assert_eq!(JustName::fn_schema(), expected);
    }

    #[test]
    pub fn can_parse_simple_struct_primitive_types() {
        #[derive(FunctionCall)]
        #[allow(dead_code)]
        struct CreateNpc {
            name: String,
            male: bool,
            age: i32,
        }

        let expected = FunctionCall {
            name: "CreateNpc".to_string(),
            description: None,
            parameters: vec![
                FunctionParameter {
                    name: "name".to_string(),
                    _type: FunctionType::String,
                    description: None,
                    required: true,
                },
                FunctionParameter {
                    name: "male".to_string(),
                    _type: FunctionType::Boolean,
                    description: None,
                    required: true,
                },
                FunctionParameter {
                    name: "age".to_string(),
                    _type: FunctionType::Number,
                    description: None,
                    required: true,
                },
            ],
        };
        assert_eq!(CreateNpc::fn_schema(), expected);
    }

    #[test]
    pub fn can_parse_struct_with_vec_of_primitive() {
        #[derive(FunctionCall)]
        #[allow(dead_code)]
        struct MakeNotes {
            heading: String,
            notes: Vec<String>,
            difficulty: u8,
        }

        let expected = FunctionCall {
            name: "MakeNotes".to_string(),
            description: None,
            parameters: vec![
                FunctionParameter {
                    name: "heading".to_string(),
                    _type: FunctionType::String,
                    description: None,
                    required: true,
                },
                FunctionParameter {
                    name: "notes".to_string(),
                    _type: FunctionType::Array(Box::new(FunctionType::String)),
                    description: None,
                    required: true,
                },
                FunctionParameter {
                    name: "difficulty".to_string(),
                    _type: FunctionType::Number,
                    description: None,
                    required: true,
                },
            ],
        };
        assert_eq!(MakeNotes::fn_schema(), expected);
    }

    #[test]
    fn nested_struct_schema_unwraps_into_object() {
        #[derive(FunctionCall)]
        #[allow(dead_code)]
        struct OuterStruct {
            inner: InnerStruct,
        }
        #[derive(FunctionCall)]
        #[allow(dead_code)]
        struct InnerStruct {
            value: String,
        }

        let expected = FunctionCall {
            name: "OuterStruct".to_string(),
            description: None,
            parameters: vec![FunctionParameter {
                name: "inner".to_string(),
                _type: FunctionType::Object(vec![FunctionParameter {
                    name: "value".to_string(),
                    _type: FunctionType::String,
                    description: None,
                    required: true,
                }]),
                description: None,
                required: true,
            }],
        };
        assert_eq!(OuterStruct::fn_schema(), expected);
    }

    #[test]
    fn vec_of_user_struct_unwraps_into_array_object() {
        #[derive(FunctionCall)]
        #[allow(dead_code)]
        struct OuterStruct {
            inner: Vec<InnerStruct>,
        }
        #[derive(FunctionCall)]
        #[allow(dead_code)]
        struct InnerStruct {
            value: String,
        }

        let expected = FunctionCall {
            name: "OuterStruct".to_string(),
            description: None,
            parameters: vec![FunctionParameter {
                name: "inner".to_string(),
                _type: FunctionType::Array(Box::new(FunctionType::Object(vec![
                    FunctionParameter {
                        name: "value".to_string(),
                        _type: FunctionType::String,
                        description: None,
                        required: true,
                    },
                ]))),
                description: None,
                required: true,
            }],
        };
        assert_eq!(OuterStruct::fn_schema(), expected);
    }
}