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

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

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

/// The tool that the model may call.
#[derive(Debug, Default, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct Tool {
    /// The type of the tool. Currently, only function is supported.
    #[serde(rename = "type")]
    pub _type: ToolType,
    /// Function.
    pub function: Function,
}

impl_display_for_serialize!(Tool);

impl Tool {
    pub fn new(function: Function) -> Self {
        Self {
            _type: ToolType::Function,
            function,
        }
    }
}

impl From<Function> for Tool {
    fn from(value: Function) -> Self {
        Self::new(value)
    }
}

/// The type of the tool.
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub enum ToolType {
    /// Function.
    Function,
}

impl Default for ToolType {
    fn default() -> Self {
        ToolType::Function
    }
}

impl Display for ToolType {
    fn fmt(
        &self,
        f: &mut std::fmt::Formatter<'_>,
    ) -> std::fmt::Result {
        match self {
            | ToolType::Function => {
                write!(f, "function")
            },
        }
    }
}

impl_enum_string_serialization!(
    ToolType,
    Function => "function"
);

/// The function tha the model may call by tool.
#[derive(Debug, Default, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct Function {
    /// A description of what the function does, used by the model to choose when and how to call the function.
    pub description: Option<String>,
    /// The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
    pub name: String,
    /// The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.
    ///
    /// Omitting parameters defines a function with an empty parameter list.
    pub parameters: Option<serde_json::Map<String, serde_json::Value>>,
}

impl_display_for_serialize!(Function);