rig-core 0.45.0

An opinionated library for building LLM powered applications.
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

//! Embeddable tool descriptions and serialized tool context.
//!
//! ```
//! use rig_core::embeddings::ToolSchema;
//!
//! let schema = ToolSchema {
//!     name: "search".into(),
//!     embedding_docs: vec!["Search documents".into()],
//!     ..Default::default()
//! };
//! assert_eq!(schema.embedding_docs.len(), 1);
//! ```

use crate::Embed;
use serde::Serialize;

use super::embed::EmbedError;

/// Tool name, serialized context, and text descriptions for embedding-based retrieval.
#[derive(Clone, Serialize, Default, Eq, PartialEq)]
pub struct ToolSchema {
    pub name: String,
    pub context: serde_json::Value,
    pub embedding_docs: Vec<String>,
}

impl Embed for ToolSchema {
    fn embed(&self, embedder: &mut super::embed::TextEmbedder) -> Result<(), EmbedError> {
        for doc in &self.embedding_docs {
            embedder.embed(doc.clone());
        }
        Ok(())
    }
}