fornix 0.1.1

Knowledge storage, retrieval, and graph infrastructure for cognitive systems
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

//! Retrieval-Augmented Generation: chunking, retrieval strategies,
//! reranking, output filtering, and evaluation.

/// A chunk of source content used as retrieval context.
pub struct RagContext {
    pub id: Option<String>,
    pub content: String,
    pub score: Option<f32>,
    pub retrieval_score: Option<f32>,
    pub source: Option<String>,
}

/// The result of a RAG search pass.
pub struct RagResult {
    pub query: String,
    pub contexts: Vec<RagContext>,
}

/// Interface for chunking source text into retrievable units.
pub trait Chunker: Send + Sync {
    type Error: std::error::Error + Send + Sync + 'static;

    fn chunk(&self, text: &str) -> Result<Vec<String>, Self::Error>;
}

/// Interface for retrieval strategies (vector-only, BM25-only, hybrid,
/// graph, HyDE, parent-child, multi-query, dialectic).
pub trait RagStrategy: Send + Sync {
    type Error: std::error::Error + Send + Sync + 'static;

    fn search(&self, query: &str) -> Result<RagResult, Self::Error>;
    fn search_contexts(&self, query: &str) -> Result<Vec<RagContext>, Self::Error>;
}

/// Interface for result reranking (null, cross-encoder).
pub trait Reranker: Send + Sync {
    type Error: std::error::Error + Send + Sync + 'static;

    fn rerank(
        &self,
        query: &str,
        contexts: Vec<RagContext>,
        top_k: Option<usize>,
    ) -> Result<Vec<RagContext>, Self::Error>;
}

/// Interface for output filters applied after retrieval
/// (PII redaction, entity denylist, citation grounding, hallucination review, etc.).
pub trait OutputFilter: Send + Sync {
    type Error: std::error::Error + Send + Sync + 'static;

    fn name(&self) -> &'static str;
    fn filter(&self, result: RagResult, query: &str) -> Result<RagResult, Self::Error>;
}

/// Interface for RAG evaluation metrics
/// (context precision, recall, faithfulness, answer relevance).
pub trait EvaluationMetric: Send + Sync {
    type Error: std::error::Error + Send + Sync + 'static;

    fn name(&self) -> &'static str;
    fn score(&self, result: &RagResult, reference: &str) -> Result<f32, Self::Error>;
}