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
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

//! Text extraction for embedding builders, including implementations for common types.
//!
//! ```
//! use rig_core::embeddings::to_texts;
//!
//! assert_eq!(to_texts("document")?, vec!["document"]);
//! # Ok::<(), rig_core::embeddings::EmbedError>(())
//! ```

/// Failure extracting text for embedding.
#[derive(Debug, thiserror::Error)]
#[error("{0}")]
pub struct EmbedError(#[from] Box<dyn std::error::Error + Send + Sync>);

impl EmbedError {
    pub fn new<E: std::error::Error + Send + Sync + 'static>(error: E) -> Self {
        EmbedError(Box::new(error))
    }
}

/// Extracts text fragments for vector embedding in append order.
/// Implementations report extraction failures through [`EmbedError`].
///
/// ```
/// use rig_core::{Embed, embeddings::{EmbedError, TextEmbedder, to_texts}};
///
/// struct Definitions(String);
/// impl Embed for Definitions {
///     fn embed(&self, out: &mut TextEmbedder) -> Result<(), EmbedError> {
///         for definition in self.0.split(',') {
///             out.embed(definition.trim().to_owned());
///         }
///         Ok(())
///     }
/// }
/// assert_eq!(to_texts(Definitions("fruit, company".into()))?, vec!["fruit", "company"]);
/// # Ok::<(), EmbedError>(())
/// ```
pub trait Embed {
    /// Append all text fragments that should be embedded for this value.
    fn embed(&self, embedder: &mut TextEmbedder) -> Result<(), EmbedError>;
}

/// Accumulates string values that need to be embedded.
/// Used by the [Embed] trait.
#[derive(Default)]
pub struct TextEmbedder {
    pub(crate) texts: Vec<String>,
}

impl TextEmbedder {
    /// Appends a text fragment without filtering or deduplication.
    pub fn embed(&mut self, text: String) {
        self.texts.push(text);
    }
}

/// Extracts text fragments in append order, propagating extraction errors.
pub fn to_texts(item: impl Embed) -> Result<Vec<String>, EmbedError> {
    let mut embedder = TextEmbedder::default();
    item.embed(&mut embedder)?;
    Ok(embedder.texts)
}

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

/// Embeds each type as its `Display` text.
macro_rules! embed_as_text {
    ($($type:ty),*) => {$(
        impl Embed for $type {
            fn embed(&self, embedder: &mut TextEmbedder) -> Result<(), EmbedError> {
                embedder.embed(self.to_string());
                Ok(())
            }
        }
    )*};
}

embed_as_text!(&str, i8, i16, i32, i64, i128, f32, f64, bool, char);

impl Embed for serde_json::Value {
    fn embed(&self, embedder: &mut TextEmbedder) -> Result<(), EmbedError> {
        embedder.embed(serde_json::to_string(self).map_err(EmbedError::new)?);
        Ok(())
    }
}

impl<T: Embed> Embed for &T {
    fn embed(&self, embedder: &mut TextEmbedder) -> Result<(), EmbedError> {
        (*self).embed(embedder)
    }
}

impl<T: Embed> Embed for Vec<T> {
    fn embed(&self, embedder: &mut TextEmbedder) -> Result<(), EmbedError> {
        for item in self {
            item.embed(embedder).map_err(EmbedError::new)?;
        }
        Ok(())
    }
}