lc_rag/
lib.rs

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

lc_rag/
lib.rs
