openai-tools 1.1.0

Tools for 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

use crate::common::{
    function::Function,
    parameters::{Name, ParameterProperty, Parameters},
};
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Default, Deserialize, Serialize)]
pub struct Tool {
    #[serde(rename = "type")]
    pub type_name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub server_label: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub server_url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_approval: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_tools: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub function: Option<Function>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub parameters: Option<Parameters>,
}

impl Tool {
    pub fn mcp(
        server_label: String,
        server_url: String,
        require_approval: String,
        allowed_tools: Vec<String>,
        parameters: Vec<(Name, ParameterProperty)>,
    ) -> Self {
        Self {
            type_name: "mcp".into(),
            name: Some("".into()),
            server_label: Some(server_label),
            server_url: Some(server_url),
            require_approval: Some(require_approval),
            allowed_tools: Some(allowed_tools),
            parameters: Some(Parameters::new(parameters, None)),
            ..Default::default()
        }
    }

    pub fn function<T: AsRef<str>, U: AsRef<str>, V: AsRef<str>>(
        name: T,
        description: U,
        parameters: Vec<(V, ParameterProperty)>,
        strict: bool,
    ) -> Self {
        Self {
            type_name: "function".into(),
            name: Some(name.as_ref().to_string()),
            function: Some(Function::new(name, description, Parameters::new(parameters, None), strict)),
            ..Default::default()
        }
    }
}