fierros-core 1.0.0

Provider-neutral core primitives for Fierros
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

use crate::Metadata;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Document {
    pub id: String,
    pub text: String,
    pub metadata: Metadata,
}

impl Document {
    pub fn new(id: impl Into<String>, text: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            text: text.into(),
            metadata: Metadata::new(),
        }
    }

    pub fn with_metadata(mut self, metadata: Metadata) -> Self {
        self.metadata = metadata;
        self
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Chunk {
    pub id: String,
    pub document_id: String,
    pub text: String,
    pub metadata: Metadata,
    pub start_char: usize,
    pub end_char: usize,
}

impl Chunk {
    pub fn new(
        id: impl Into<String>,
        document_id: impl Into<String>,
        text: impl Into<String>,
        start_char: usize,
        end_char: usize,
    ) -> Self {
        Self {
            id: id.into(),
            document_id: document_id.into(),
            text: text.into(),
            metadata: Metadata::new(),
            start_char,
            end_char,
        }
    }

    pub fn with_metadata(mut self, metadata: Metadata) -> Self {
        self.metadata = metadata;
        self
    }
}

#[cfg(test)]
mod tests {
    use super::{Chunk, Document};
    use crate::Metadata;

    #[test]
    fn document_constructor_sets_id_and_text() {
        let doc = Document::new("doc-1", "hello");
        assert_eq!(doc.id, "doc-1");
        assert_eq!(doc.text, "hello");
    }

    #[test]
    fn chunk_constructor_sets_offsets() {
        let chunk = Chunk::new("chunk-1", "doc-1", "hello", 0, 5);
        assert_eq!(chunk.document_id, "doc-1");
        assert_eq!(chunk.start_char, 0);
        assert_eq!(chunk.end_char, 5);
    }

    #[test]
    fn document_with_metadata_replaces_default_metadata() {
        let metadata = Metadata::new().with("source", "runbook.md");
        let doc = Document::new("doc-1", "hello").with_metadata(metadata.clone());
        assert_eq!(doc.metadata, metadata);
    }

    #[test]
    fn chunk_with_metadata_replaces_default_metadata() {
        let metadata = Metadata::new().with("score", 0.9);
        let chunk = Chunk::new("chunk-1", "doc-1", "hello", 0, 5).with_metadata(metadata.clone());
        assert_eq!(chunk.metadata, metadata);
    }
}