oaapi 0.2.0

An unofficial Rust client for the OpenAI API.
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

use serde::{Deserialize, Serialize};
use std::fmt::Display;

use crate::chat::ToolType;
use crate::macros::{
    impl_display_for_serialize, impl_enum_string_serialization,
};

/// The tool choice.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum ToolChoice {
    /// Options.
    Option(TooChoiceOption),
    /// Specified tool.
    Specified(SpecifiedTool),
}

impl Default for ToolChoice {
    fn default() -> Self {
        Self::Option(TooChoiceOption::default())
    }
}

impl_display_for_serialize!(ToolChoice);

/// The tool choice option.
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub enum TooChoiceOption {
    /// none, means the model will not call a function and instead generates a message.
    None,
    /// auto, means the model can pick between generating a message or calling a function.
    Auto,
}

impl Default for TooChoiceOption {
    fn default() -> Self {
        TooChoiceOption::Auto
    }
}

impl Display for TooChoiceOption {
    fn fmt(
        &self,
        f: &mut std::fmt::Formatter<'_>,
    ) -> std::fmt::Result {
        match self {
            | TooChoiceOption::None => {
                write!(f, "none")
            },
            | TooChoiceOption::Auto => {
                write!(f, "auto")
            },
        }
    }
}

impl_enum_string_serialization!(
    TooChoiceOption,
    None => "none",
    Auto => "auto"
);

impl From<TooChoiceOption> for ToolChoice {
    fn from(value: TooChoiceOption) -> Self {
        Self::Option(value)
    }
}

impl From<SpecifiedTool> for ToolChoice {
    fn from(value: SpecifiedTool) -> Self {
        Self::Specified(value)
    }
}

/// The specified tool.
#[derive(Debug, Clone, Eq, PartialEq, Default, Serialize, Deserialize)]
pub struct SpecifiedTool {
    /// The type of the tool. Currently, only function is supported.
    #[serde(rename = "type")]
    pub _type: ToolType,
    /// Specified function.
    pub function: SpecifiedFunction,
}

impl_display_for_serialize!(SpecifiedTool);

/// The specified function.
#[derive(Debug, Clone, Eq, PartialEq, Default, Serialize, Deserialize)]
pub struct SpecifiedFunction {
    /// The name of function.
    pub name: String,
}

impl_display_for_serialize!(SpecifiedFunction);

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn deserialize() {
        assert_eq!(
            serde_json::from_str::<ToolChoice>("\"none\"").unwrap(),
            ToolChoice::Option(TooChoiceOption::None)
        );

        assert_eq!(
            serde_json::from_str::<ToolChoice>("\"auto\"").unwrap(),
            ToolChoice::Option(TooChoiceOption::Auto)
        );

        assert_eq!(
            serde_json::from_str::<ToolChoice>(
                r#"{
                    "type": "function",
                    "function": {
                        "name": "my_function"
                    }
                }"#
            )
            .unwrap(),
            ToolChoice::Specified(SpecifiedTool {
                _type: ToolType::Function,
                function: SpecifiedFunction {
                    name: "my_function".to_string(),
                },
            })
        );
    }

    #[test]
    fn serialize() {
        assert_eq!(
            serde_json::to_string(&ToolChoice::Option(
                TooChoiceOption::None
            ))
            .unwrap(),
            "\"none\""
        );

        assert_eq!(
            serde_json::to_string(&ToolChoice::Option(
                TooChoiceOption::Auto
            ))
            .unwrap(),
            "\"auto\""
        );

        assert_eq!(
            serde_json::to_string(&ToolChoice::Specified(SpecifiedTool {
                _type: ToolType::Function,
                function: SpecifiedFunction {
                    name: "my_function".to_string(),
                },
            }))
            .unwrap(),
            r#"{"type":"function","function":{"name":"my_function"}}"#
        );
    }
}