aboutsummaryrefslogtreecommitdiffstats
path: root/crates/asist-core/src/tools.rs
blob: 1bf151098e7ba918b5fa15bedbd55d720f165629 (plain)
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
//! Tools the model can call.
//!
//! The assistant's extension point. A tool is an object that describes itself
//! in JSON Schema and knows how to run; the registry translates them to the
//! chat API `tools` format and dispatches the calls that come back. Adding a
//! new capability means implementing the trait and registering it, without
//! touching the orchestrator.

use std::collections::BTreeMap;
use std::sync::Arc;
use std::time::Duration;

use serde_json::{json, Value};

use crate::config::ToolsConfig;
use crate::error::{Error, Result};

/// Something the model can ask to be done.
pub trait Tool: Send + Sync {
    /// Identifier the model uses. Lowercase, no spaces.
    fn name(&self) -> &str;

    /// What it is for. The model reads it, so it is written for the model:
    /// concrete and in the conversation language.
    fn description(&self) -> &str;

    /// JSON Schema of the arguments.
    fn parameters(&self) -> Value;

    /// Runs and returns the text handed to the model as the result.
    fn call(&self, args: &Value) -> Result<String>;

    /// `true` if the tool changes something outside the process. The
    /// orchestrator announces it aloud before running it.
    fn is_side_effecting(&self) -> bool {
        false
    }

    /// Sentence spoken right when it starts running.
    ///
    /// It exists for the sake of the conversation, not decoration: a search takes
    /// about 2.5 s, the camera almost 3, and the two model passes come on top.
    /// Six seconds of total silence read as the assistant having hung. A tool
    /// that answers instantly returns `None`, where the acknowledgement would
    /// annoy more than help.
    fn acknowledgement(&self) -> Option<&str> {
        None
    }
}

/// A call as the model requests it.
#[derive(Debug, Clone)]
pub struct ToolCall {
    pub id: String,
    pub name: String,
    /// JSON arguments, not validated yet.
    pub arguments: String,
}

/// Result of running it.
#[derive(Debug, Clone)]
pub struct ToolOutcome {
    pub id: String,
    pub name: String,
    pub ok: bool,
    pub output: String,
    pub took: Duration,
}

#[derive(Default, Clone)]
pub struct ToolRegistry {
    tools: BTreeMap<String, Arc<dyn Tool>>,
}

impl ToolRegistry {
    pub fn new() -> Self {
        Self::default()
    }

    /// Builds the tool set the configuration asks for.
    pub fn from_config(config: &ToolsConfig) -> Self {
        let mut registry = Self::new();
        if !config.enabled {
            return registry;
        }
        registry.register(Arc::new(builtin::Clock));
        if config.shell {
            registry.register(Arc::new(builtin::Shell::new(config)));
        }
        registry
    }

    pub fn register(&mut self, tool: Arc<dyn Tool>) {
        self.tools.insert(tool.name().to_string(), tool);
    }

    pub fn is_empty(&self) -> bool {
        self.tools.is_empty()
    }

    pub fn names(&self) -> Vec<&str> {
        self.tools.keys().map(String::as_str).collect()
    }

    pub fn get(&self, name: &str) -> Option<&Arc<dyn Tool>> {
        self.tools.get(name)
    }

    /// Description in the OpenAI chat API `tools` format, which is what
    /// llama-server speaks.
    pub fn schema(&self) -> Value {
        Value::Array(
            self.tools
                .values()
                .map(|tool| {
                    json!({
                        "type": "function",
                        "function": {
                            "name": tool.name(),
                            "description": tool.description(),
                            "parameters": tool.parameters(),
                        }
                    })
                })
                .collect(),
        )
    }

    /// Runs a call. It never propagates the error upwards: a tool failure is
    /// handed back to the model as text so it can explain it or retry, instead
    /// of bringing the turn down.
    pub fn dispatch(&self, call: &ToolCall) -> ToolOutcome {
        let started = std::time::Instant::now();
        let result = match self.tools.get(&call.name) {
            None => Err(Error::Tool {
                tool: call.name.clone(),
                message: format!(
                    "no existe esa herramienta; disponibles: {}",
                    self.names().join(", ")
                ),
            }),
            Some(tool) => serde_json::from_str::<Value>(&call.arguments)
                .or_else(|_| {
                    // Small models sometimes send an empty string instead of «{}»
                    // when the function takes no arguments.
                    if call.arguments.trim().is_empty() {
                        Ok(json!({}))
                    } else {
                        Err(Error::Tool {
                            tool: call.name.clone(),
                            message: format!("argumentos JSON inválidos: {}", call.arguments),
                        })
                    }
                })
                .and_then(|args| tool.call(&args)),
        };

        let took = started.elapsed();
        match result {
            Ok(output) => ToolOutcome {
                id: call.id.clone(),
                name: call.name.clone(),
                ok: true,
                output,
                took,
            },
            Err(err) => ToolOutcome {
                id: call.id.clone(),
                name: call.name.clone(),
                ok: false,
                output: format!("error: {err}"),
                took,
            },
        }
    }
}

pub mod builtin {
    use super::*;
    use std::path::Path;
    use std::process::Command;

    /// Local date and time. It exists because the model does not know them and
    /// confidently makes them up, and it doubles as a minimal tool example.
    pub struct Clock;

    impl Tool for Clock {
        fn name(&self) -> &str {
            "hora_actual"
        }

        fn description(&self) -> &str {
            "Devuelve la fecha y la hora locales del sistema. Úsala siempre que \
             te pregunten qué hora o qué día es, en vez de suponerlo."
        }

        fn parameters(&self) -> Value {
            json!({ "type": "object", "properties": {}, "required": [] })
        }

        fn call(&self, _args: &Value) -> Result<String> {
            // `date` avoids pulling in a whole calendar dependency for a single
            // call, and it honours the system time zone. It is asked for numeric
            // fields and the names are filled in here: `%A` and `%B` come out in
            // the locale language, which on this machine is English, and the
            // assistant would end up saying «Sunday 6 de September».
            let out = Command::new("date")
                .arg("+%w %-d %-m %Y %H:%M")
                .output()
                .map_err(|e| Error::Tool {
                    tool: "hora_actual".into(),
                    message: e.to_string(),
                })?;
            let raw = String::from_utf8_lossy(&out.stdout);
            format_spanish_date(raw.trim()).ok_or_else(|| Error::Tool {
                tool: "hora_actual".into(),
                message: format!("«date» devolvió algo inesperado: {raw:?}"),
            })
        }
    }

    pub(super) const WEEKDAYS: [&str; 7] = [
        "domingo",
        "lunes",
        "martes",
        "miércoles",
        "jueves",
        "viernes",
        "sábado",
    ];
    const MONTHS: [&str; 12] = [
        "enero",
        "febrero",
        "marzo",
        "abril",
        "mayo",
        "junio",
        "julio",
        "agosto",
        "septiembre",
        "octubre",
        "noviembre",
        "diciembre",
    ];

    /// Builds «domingo 6 de septiembre de 2026, 19:13» from
    /// «0 6 9 2026 19:13».
    pub(super) fn format_spanish_date(raw: &str) -> Option<String> {
        let mut fields = raw.split_whitespace();
        let weekday: usize = fields.next()?.parse().ok()?;
        let day: u32 = fields.next()?.parse().ok()?;
        let