ic-llm 1.1.0

A library for making requests to the LLM canister on the Internet Computer
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
use candid::CandidType;
use serde::{Deserialize, Serialize};

#[derive(CandidType, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
pub enum Tool {
    #[serde(rename = "function")]
    Function(Function),
}

#[derive(CandidType, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
pub struct Parameters {
    #[serde(rename = "type")]
    pub type_: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<Vec<Property>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<Vec<String>>,
}

#[derive(CandidType, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
pub struct Function {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub parameters: Option<Parameters>,
}

#[derive(CandidType, Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
pub struct Property {
    #[serde(rename = "type")]
    pub type_: String,
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(rename = "enum", skip_serializing_if = "Option::is_none")]
    pub enum_: Option<Vec<String>>,
}

/// Enum representing the types a parameter can have.
#[derive(Clone, Debug)]
pub enum ParameterType {
    String,
    Boolean,
    Number,
    // Can be extended with more types as needed
}

impl ParameterType {
    fn as_str(&self) -> &'static str {
        match self {
            ParameterType::String => "string",
            ParameterType::Boolean => "boolean",
            ParameterType::Number => "number",
        }
    }
}

/// Builder for creating a parameter for a function tool.
#[derive(Clone, Debug)]
pub struct ParameterBuilder {
    name: String,
    type_: ParameterType,
    description: Option<String>,
    required: bool,
    enum_values: Option<Vec<String>>,
}

impl ParameterBuilder {
    /// Create a new parameter builder with a name and type.
    pub fn new<S: Into<String>>(name: S, type_: ParameterType) -> Self {
        Self {
            name: name.into(),
            type_,
            description: None,
            required: false,
            enum_values: None,
        }
    }

    /// Add a description to the parameter.
    pub fn with_description<S: Into<String>>(mut self, description: S) -> Self {
        self.description = Some(description.into());
        self
    }

    /// Mark the parameter as required.
    pub fn is_required(mut self) -> Self {
        self.required = true;
        self
    }

    /// Add allowed enum values for the parameter.
    pub fn with_enum_values<S: Into<String>, I: IntoIterator<Item = S>>(
        mut self,
        values: I,
    ) -> Self {
        self.enum_values = Some(values.into_iter().map(|s| s.into()).collect());
        self
    }

    /// Convert the builder to a Property.
    fn to_property(&self) -> Property {
        Property {
            type_: self.type_.as_str().to_string(),
            name: self.name.clone(),
            description: self.description.clone(),
            enum_: self.enum_values.clone(),
        }
    }
}

/// Builder for creating a function tool.
pub struct ToolBuilder {
    function: Function,
    parameters: Vec<ParameterBuilder>,
}

impl ToolBuilder {
    /// Creates a new tool builder with a function name.
    pub fn new<S: Into<String>>(name: S) -> Self {
        Self {
            function: Function {
                name: name.into(),
                description: None,
                parameters: None,
            },
            parameters: Vec::new(),
        }
    }

    /// Adds a description to the function.
    pub fn with_description<S: Into<String>>(mut self, description: S) -> Self {
        self.function.description = Some(description.into());
        self
    }

    /// Adds a parameter to the function.
    pub fn with_parameter(mut self, parameter: ParameterBuilder) -> Self {
        self.parameters.push(parameter);
        self
    }

    /// Builds the final Tool.
    pub fn build(self) -> Tool {
        let mut function = self.function;

        if !self.parameters.is_empty() {
            let properties = self
                .parameters
                .iter()
                .map(|p| p.to_property())
                .collect::<Vec<_>>();
            let required = self
                .parameters
                .iter()
                .filter(|p| p.required)
                .map(|p| p.name.clone())
                .collect::<Vec<_>>();

            function.parameters = Some(Parameters {
                type_: "object".to_string(),
                properties: Some(properties),
                required: if required.is_empty() {
                    None
                } else {
                    Some(required)
                },
            });
        }

        Tool::Function(function)
    }
}

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

    #[test]
    fn create_simple_tool() {
        let tool = ToolBuilder::new("test_tool").build();

        let expected = Tool::Function(Function {
            name: "test_tool".to_string(),
            description: None,
            parameters: None,
        });

        assert_eq!(tool, expected);
    }

    #[test]
    fn tool_with_description() {
        let tool = ToolBuilder::new("test_tool")
            .with_description("This is a test tool")
            .build();

        let expected = Tool::Function(Function {
            name: "test_tool".to_string(),
            description: Some("This is a test tool".to_string()),
            parameters: None,
        });

        assert_eq!(tool, expected);
    }

    #[test]
    fn tool_with_single_parameter() {
        let tool = ToolBuilder::new("test_tool")
            .with_parameter(
                ParameterBuilder::new("param1", ParameterType::String)
                    .with_description("Test parameter")
                    .is_required(),
            )
            .build();

        let expected = Tool::Function(Function {
            name: "test_tool".to_string(),
            description: None,
            parameters: Some(Parameters {
                type_: "object".to_string(),
                properties: Some(vec![Property {
                    name: "param1".to_string(),
                    type_: "string".to_string(),
                    description: Some("Test parameter".to_string()),
                    enum_: None,
                }]),
                required: Some(vec!["param1".to_string()]),
            }),
        });

        assert_eq!(tool, expected);
    }

    #[test]
    fn tool_with_multiple_parameters() {
        let tool = ToolBuilder::new("weather_tool")
            .with_description("Get weather information")
            .with_parameter(
                ParameterBuilder::new("location", ParameterType::String)
                    .with_description("City name")
                    .is_required(),
            )
            .with_parameter(
                ParameterBuilder::new("units", ParameterType::String)
                    .with_description("Temperature units"),
            )
            .with_parameter(
                ParameterBuilder::new("forecast", ParameterType::Boolean)
                    .with_description("Include forecast"),
            )
            .build();

        let expected = Tool::Function(Function {
            name: "weather_tool".to_string(),
            description: Some("Get weather information".to_string()),
            parameters: Some(Parameters {
                type_: "object".to_string(),
                properties: Some(vec![
                    Property {
                        name: "location".to_string(),
                        type_: "string".to_string(),
                        description: Some("City name".to_string()),
                        enum_: None,
                    },
                    Property {
                        name: "units".to_string(),
                        type_: "string".to_string(),
                        description: Some("Temperature units".to_string()),
                        enum_: None,
                    },
                    Property {
                        name: "forecast".to_string(),
                        type_: "boolean".to_string(),
                        description: Some("Include forecast".to_string()),
                        enum_: None,
                    },
                ]),
                required: Some(vec!["location".to_string()]),
            }),
        });

        assert_eq!(tool, expected);
    }

    #[test]
    fn optional_parameter() {
        let tool = ToolBuilder::new("test_tool")
            .with_parameter(
                ParameterBuilder::new("optional_param", ParameterType::String)
                    .with_description("This parameter is optional"), // Not calling is_required()
            )
            .build();

        let expected = Tool::Function(Function {
            name: "test_tool".to_string(),
            description: None,
            parameters: Some(Parameters {
                type_: "object".to_string(),
                properties: Some(vec![Property {
                    name: "optional_param".to_string(),
                    type_: "string".to_string(),
                    description: Some("This parameter is optional".to_string()),
                    enum_: None,
                }]),
                required: None,
            }),
        });

        assert_eq!(tool, expected);
    }

    #[test]
    fn parameter_type_conversion() {
        assert_eq!(ParameterType::String.as_str(), "string");
        assert_eq!(ParameterType::Boolean.as_str(), "boolean");
        assert_eq!(ParameterType::Number.as_str(), "number");
    }

    #[test]
    fn weather_tool_example() {
        // Test the example from the documentation
        let weather_tool = ToolBuilder::new("get_current_weather")
            .with_description("Get current weather for a location.")
            .with_parameter(
                ParameterBuilder::new("location", ParameterType::String)
                    .with_description("The location to get the weather for (e.g. Cairo, Egypt)")
                    .is_required(),
            )
            .build();

        let expected = Tool::Function(Function {
            name: "get_current_weather".to_string(),
            description: Some("Get current weather for a location.".to_string()),
            parameters: Some(Parameters {
                type_: "object".to_string(),
                properties: Some(vec![Property {
                    name: "location".to_string(),
                    type_: "string".to_string(),
                    description: Some(
                        "The location to get the weather for (e.g. Cairo, Egypt)".to_string(),
                    ),
                    enum_: None,
                }]),
                required: Some(vec!["location".to_string()]),
            }),
        });

        assert_eq!(weather_tool, expected);
    }

    #[test]
    fn number_parameter() {
        let tool = ToolBuilder::new("calculator")
            .with_description("Perform mathematical calculations")
            .with_parameter(
                ParameterBuilder::new("value", ParameterType::Number)
                    .with_description("The numeric value to use in calculation")
                    .is_required(),
            )
            .build();

        let expected = Tool::Function(Function {
            name: "calculator".to_string(),
            description: Some("Perform mathematical calculations".to_string()),
            parameters: Some(Parameters {
                type_: "object".to_string(),
                properties: Some(vec![Property {
                    name: "value".to_string(),
                    type_: "number".to_string(),
                    description: Some("The numeric value to use in calculation".to_string()),
                    enum_: None,
                }]),
                required: Some(vec!["value".to_string()]),
            }),
        });

        assert_eq!(tool, expected);
    }

    #[test]
    fn enum_parameter() {
        let tool = ToolBuilder::new("unit_converter")
            .with_description("Convert between different units")
            .with_parameter(
                ParameterBuilder::new("value", ParameterType::Number)
                    .with_description("The value to convert")
                    .is_required(),
            )
            .with_parameter(
                ParameterBuilder::new("unit", ParameterType::String)
                    .with_description("The unit to convert to")
                    .with_enum_values(["meters", "feet", "kilometers", "miles"])
                    .is_required(),
            )
            .build();

        let expected = Tool::Function(Function {
            name: "unit_converter".to_string(),
            description: Some("Convert between different units".to_string()),
            parameters: Some(Parameters {
                type_: "object".to_string(),
                properties: Some(vec![
                    Property {
                        name: "value".to_string(),
                        type_: "number".to_string(),
                        description: Some("The value to convert".to_string()),
                        enum_: None,
                    },
                    Property {
                        name: "unit".to_string(),
                        type_: "string".to_string(),
                        description: Some("The unit to convert to".to_string()),
                        enum_: Some(vec![
                            "meters".to_string(),
                            "feet".to_string(),
                            "kilometers".to_string(),
                            "miles".to_string(),
                        ]),
                    },
                ]),
                required: Some(vec!["value".to_string(), "unit".to_string()]),
            }),
        });

        assert_eq!(tool, expected);
    }
}