graphrt_rag/lib.rs
1//! # graphrt-rag
2//!
3//! Retrieval building blocks for graphrt workflows and the `knowledge-retrieval` node.
4//!
5//! - [`Embedder`], [`VectorStore`], [`Reranker`], [`Retriever`]: pluggable traits.
6//! - [`MemoryStore`]: in-process cosine + BM25 store (optionally file-backed).
7//! - [`SqliteStore`] (feature `sqlite`): the same search over one SQLite file,
8//! with incremental writes and several processes sharing the database.
9//! - [`OpenAiEmbedder`], [`HttpReranker`], [`HttpRetriever`] (feature `http`) and
10//! [`QdrantStore`] (feature `qdrant`).
11//! - [`chunk_text`] and [`Ingestor`] for indexing documents.
12//! - [`KnowledgeBase`]: the service the node uses, built in code or from a
13//! [`KnowledgeConfig`] file.
14//!
15//! ```
16//! use std::sync::Arc;
17//! use graphrt_core::{Registry, Services};
18//! use graphrt_rag::{Document, HashEmbedder, KnowledgeBase, MemoryStore};
19//!
20//! # futures::executor::block_on(async {
21//! let kb = KnowledgeBase::new()
22//! .with_store_dataset("faq", Arc::new(MemoryStore::new()), Arc::new(HashEmbedder::new(256)), None);
23//! kb.ingestor("faq").unwrap().ingest(&Document::new("faq", "returns", "Items can be returned within 30 days.")).await.unwrap();
24//!
25//! let mut registry = Registry::with_builtins();
26//! graphrt_rag::register(&mut registry);
27//! let services = Services::new().with(kb);
28//! # let _ = services;
29//! # });
30//! ```
31
32mod chunker;
33mod error;
34mod filter;
35mod hash;
36#[cfg(feature = "http")]
37mod http;
38mod ingest;
39mod kb;
40mod memory;
41mod node;
42mod pipeline;
43#[cfg(feature = "qdrant")]
44mod qdrant;
45#[cfg(feature = "sqlite")]
46mod sqlite;
47mod types;
48
49#[cfg(feature = "doc")]
50mod doc_extractor;
51pub use chunker::{ChunkerConfig, TextChunk, chunk_text};
52#[cfg(feature = "doc")]
53pub use doc_extractor::DocExtractor;
54pub use error::RagError;
55pub use filter::{Logical, MetadataCondition, MetadataFilter, UnknownOperator};
56pub use hash::HashEmbedder;
57#[cfg(feature = "http")]
58pub use http::{
59 HttpReranker, HttpRerankerConfig, HttpRetriever, HttpRetrieverConfig, HttpSettings, OpenAiEmbedder,
60 OpenAiEmbedderConfig, Secret,
61};
62pub use ingest::{Document, IngestReport, Ingestor};
63pub use kb::{DatasetConfig, DatasetInfo, EnvLookup, KnowledgeBase, KnowledgeConfig};
64pub use memory::{MemoryStore, cosine, dot, tokenize};
65pub use node::{KIND, KnowledgeRetrievalNode, descriptor, register};
66pub use pipeline::{StoreRetriever, finalize, merge_weighted, rerank};
67#[cfg(feature = "qdrant")]
68pub use qdrant::{QdrantConfig, QdrantStore};
69#[cfg(feature = "sqlite")]
70pub use sqlite::SqliteStore;
71pub use types::{
72 Embedder, Extractor, Hit, HybridWeights, KeywordQuery, Metadata, PlainTextExtractor, Reranker, RetrievalRequest,
73 Retriever, StoredChunk, VectorQuery, VectorStore, check_vector, content_hash,
74};