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
/*
* OpenAI API
*
* The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
*
* The version of the OpenAPI document: 2.3.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// CustomToolParam : A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct CustomToolParam {
/// The type of the custom tool. Always `custom`.
#[serde(rename = "type")]
pub r#type: Type,
/// The name of the custom tool, used to identify it in tool calls.
#[serde(rename = "name")]
pub name: String,
/// Optional description of the custom tool, used to provide more context.
#[serde(rename = "description", skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
#[serde(rename = "format", skip_serializing_if = "Option::is_none")]
pub format: Option<Box<models::CustomToolParamFormat>>,
/// Whether this tool should be deferred and discovered via tool search.
#[serde(rename = "defer_loading", skip_serializing_if = "Option::is_none")]
pub defer_loading: Option<bool>,
}
impl CustomToolParam {
/// A custom tool that processes input using a specified format. Learn more about [custom tools](/docs/guides/function-calling#custom-tools)
pub fn new(r#type: Type, name: String) -> CustomToolParam {
CustomToolParam {
r#type,
name,
description: None,
format: None,
defer_loading: None,
}
}
}
/// The type of the custom tool. Always `custom`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
#[serde(rename = "custom")]
Custom,
}
impl Default for Type {
fn default() -> Type {
Self::Custom
}
}
impl std::fmt::Display for CustomToolParam {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match serde_json::to_string(self) {
Ok(s) => write!(f, "{}", s),
Err(_) => Err(std::fmt::Error),
}
}
}