lc_rag/
lib.rs

1// lc-rag/src/lib.rs
2//! RAG (Retrieval-Augmented Generation) module for LangChainRust.
3//!
4//! Provides document loaders, text splitters, retrievers, BM25 search,
5//! hybrid retrieval, GraphRAG, HyDE, multi-query, reranking, and
6//! a full RAG pipeline builder.
7
8pub mod adapter;
9pub mod bm25;
10pub mod chunked_hybrid;
11pub mod graph_rag;
12pub mod hybrid;
13pub mod hyde;
14pub mod loaders;
15pub mod multi_query;
16pub mod pipeline;
17pub mod reranking;
18pub mod retriever;
19pub mod semantic_splitter;
20pub mod splitter;
21mod structured;
22pub mod unified_hybrid;
23
24pub use adapter::RagRunnable;
25pub use pipeline::{RAGPipeline, RAGPipelineBuilder, RAGQueryResult};
26
27pub use loaders::{
28    CSVLoader, DocumentLoader, DocxLoader, HTMLLoader, JSONLoader, LoaderError, MarkdownLoader,
29    PDFLoader, SitemapLoader, TextLoader, WebScraperLoader,
30};
31pub use retriever::{Retriever, RetrieverError, RetrieverTrait, SimilarityRetriever};
32pub use semantic_splitter::SemanticSplitter;
33pub use splitter::{RecursiveCharacterSplitter, TextSplitter};
34
35pub use bm25::{
36    AutoMergingConfig, BM25Index, BM25Params, BM25Retriever, ChunkedBM25Retriever,
37    ChunkedSearchResult, Tokenizer,
38};
39
40#[allow(deprecated)]
41pub use chunked_hybrid::ChunkedHybridRetriever;
42#[allow(deprecated)]
43pub use hybrid::{
44    filter_by_score, reciprocal_rank_fusion, HybridRetriever, RetrievalSource, RetrievedDocument,
45};
46pub use unified_hybrid::{HybridIndexConfig, HybridSearchResult, UnifiedHybridIndex};
47
48pub use multi_query::{
49    MultiQueryConfig, MultiQueryError, MultiQueryRetriever, StaticQueryGenerator,
50};
51
52pub use hyde::{HyDEConfig, HyDEError, HyDERetriever};
53
54pub use reranking::{
55    BM25Reranker, KeywordReranker, Reranker, RerankingConfig, RerankingError, RerankingExecutor,
56};
57
58pub use graph_rag::{
59    Community as GraphCommunity, Entity as GraphEntity, GraphStore, Relation as GraphRelation,
60};
61pub use graph_rag::{GraphRAG, GraphRAGConfig, GraphRAGError, GraphRAGResult, QueryMode};
62
63// Re-export key types from dependency crates for convenience
64pub use lc_embeddings::{
65    cosine_similarity, EmbeddingError, Embeddings, MockEmbeddings, OpenAIEmbeddings,
66};
67pub use lc_vector_stores::{
68    ChunkDocument, ChunkedDocumentStore, ChunkedDocumentStoreTrait, ChunkedVectorStore,
69    DocumentStore, InMemoryDocumentStore,
70};
71pub use lc_vector_stores::{
72    Document, InMemoryVectorStore, SearchResult, VectorStore, VectorStoreError,
73};
lc_rag/lib.rs

lc_rag/
lib.rs
