langchain_rust/schemas/
tools_openai_like.rs

1use crate::schemas::convert::{OpenAIFromLangchain, TryOpenAiFromLangchain};
2use crate::tools::Tool;
3use async_openai::types::chat::{
4    ChatCompletionNamedToolChoice, ChatCompletionTool, ChatCompletionToolChoiceOption,
5    ChatCompletionTools, FunctionName, FunctionObjectArgs, ToolChoiceOptions,
6};
7use serde::{Deserialize, Serialize};
8use serde_json::Value;
9use std::ops::Deref;
10
11#[derive(Clone, Debug)]
12pub enum FunctionCallBehavior {
13    None,
14    Auto,
15    Named(String),
16}
17
18impl OpenAIFromLangchain<FunctionCallBehavior> for ChatCompletionToolChoiceOption {
19    fn from_langchain(langchain: FunctionCallBehavior) -> Self {
20        match langchain {
21            FunctionCallBehavior::Auto => {
22                ChatCompletionToolChoiceOption::Mode(ToolChoiceOptions::Auto)
23            }
24            FunctionCallBehavior::None => {
25                ChatCompletionToolChoiceOption::Mode(ToolChoiceOptions::None)
26            }
27            FunctionCallBehavior::Named(name) => {
28                ChatCompletionToolChoiceOption::Function(ChatCompletionNamedToolChoice {
29                    function: FunctionName { name },
30                })
31            }
32        }
33    }
34}
35
36#[derive(Clone, Debug)]
37pub struct FunctionDefinition {
38    pub name: String,
39    pub description: String,
40    pub parameters: Value,
41}
42
43impl FunctionDefinition {
44    pub fn new(name: &str, description: &str, parameters: Value) -> Self {
45        FunctionDefinition {
46            name: name.trim().replace(" ", "_"),
47            description: description.to_string(),
48            parameters,
49        }
50    }
51
52    /// Generic function that can be used with both Arc<Tool>, Box<Tool>, and direct references
53    pub fn from_langchain_tool<T>(tool: &T) -> FunctionDefinition
54    where
55        T: Deref<Target = dyn Tool> + ?Sized,
56    {
57        FunctionDefinition {
58            name: tool.name().trim().replace(" ", "_"),
59            description: tool.description(),
60            parameters: tool.parameters(),
61        }
62    }
63}
64
65impl TryOpenAiFromLangchain<FunctionDefinition> for ChatCompletionTool {
66    type Error = async_openai::error::OpenAIError;
67    fn try_from_langchain(langchain: FunctionDefinition) -> Result<Self, Self::Error> {
68        let function = FunctionObjectArgs::default()
69            .name(langchain.name)
70            .description(langchain.description)
71            .parameters(langchain.parameters)
72            .build()?;
73
74        Ok(ChatCompletionTool { function })
75    }
76}
77
78impl TryOpenAiFromLangchain<FunctionDefinition> for ChatCompletionTools {
79    type Error = async_openai::error::OpenAIError;
80    fn try_from_langchain(langchain: FunctionDefinition) -> Result<Self, Self::Error> {
81        ChatCompletionTool::try_from_langchain(langchain).map(ChatCompletionTools::Function)
82    }
83}
84
85#[derive(Serialize, Deserialize, Debug)]
86pub struct FunctionCallResponse {
87    pub id: String,
88    #[serde(rename = "type")]
89    pub type_field: String,
90    pub function: FunctionDetail,
91}
92
93#[derive(Serialize, Deserialize, Debug)]
94pub struct FunctionDetail {
95    pub name: String,
96    ///this should be an string, and this should be passed to the tool, to
97    ///then be deserilised inside the tool, becuase just the tools knows the names of the arguments.
98    pub arguments: String,
99}
100
101impl FunctionCallResponse {
102    pub fn from_str(s: &str) -> Result<Self, serde_json::Error> {
103        serde_json::from_str(s)
104    }
105}
106
107#[cfg(test)]
108mod tests {
109    use super::*;
110    use async_trait::async_trait;
111    use serde_json::json;
112    use std::{error::Error, sync::Arc};
113
114    struct MyTool;
115
116    #[async_trait]
117    impl Tool for MyTool {
118        fn name(&self) -> String {
119            " Web Search ".into()
120        }
121        fn description(&self) -> String {
122            "searches".into()
123        }
124        async fn run(&self, _input: Value) -> Result<String, Box<dyn Error>> {
125            Ok(String::new())
126        }
127    }
128
129    #[test]
130    fn function_definition_normalizes_name() {
131        let f = FunctionDefinition::new(" my cool tool ", "desc", json!({}));
132        assert_eq!(f.name, "my_cool_tool");
133    }
134
135    #[test]
136    fn function_definition_from_tool_uses_default_parameters() {
137        let tool: Arc<dyn Tool> = Arc::new(MyTool);
138        let f = FunctionDefinition::from_langchain_tool(&tool);
139        assert_eq!(f.name, "Web_Search");
140        assert_eq!(f.description, "searches");
141        assert_eq!(f.parameters["required"], json!(["input"]));
142        assert_eq!(
143            f.parameters["properties"]["input"]["description"],
144            "searches"
145        );
146    }
147
148    #[test]
149    fn function_call_response_parses() {
150        let r = FunctionCallResponse::from_str(
151            r#"{"id":"c1","type":"function","function":{"name":"calc","arguments":"{\"a\":1}"}}"#,
152        )
153        .unwrap();
154        assert_eq!(r.id, "c1");
155        assert_eq!(r.type_field, "function");
156        assert_eq!(r.function.name, "calc");
157        assert_eq!(r.function.arguments, "{\"a\":1}");
158        assert!(FunctionCallResponse::from_str("{}").is_err());
159    }
160}
langchain_rust/schemas/tools_openai_like.rs

langchain_rust/schemas/
tools_openai_like.rs
