Skip to main content

Crate lc_rag

Crate lc_rag 

Source
Expand description

RAG (Retrieval-Augmented Generation) module for LangChainRust.

Provides document loaders, text splitters, retrievers, BM25 search, hybrid retrieval, GraphRAG, HyDE, multi-query, reranking, and a full RAG pipeline builder.

Re-exports§

pub use pipeline::RAGPipeline;
pub use pipeline::RAGPipelineBuilder;
pub use pipeline::RAGQueryResult;
pub use loaders::CSVLoader;
pub use loaders::DocumentLoader;
pub use loaders::DocxLoader;
pub use loaders::HTMLLoader;
pub use loaders::JSONLoader;
pub use loaders::LoaderError;
pub use loaders::MarkdownLoader;
pub use loaders::PDFLoader;
pub use loaders::SitemapLoader;
pub use loaders::TextLoader;
pub use loaders::WebScraperLoader;
pub use retriever::Retriever;
pub use retriever::RetrieverError;
pub use retriever::RetrieverTrait;
pub use retriever::SimilarityRetriever;
pub use semantic_splitter::SemanticSplitter;
pub use bm25::AutoMergingConfig;
pub use bm25::BM25Index;
pub use bm25::BM25Params;
pub use bm25::BM25Retriever;
pub use bm25::ChunkedBM25Retriever;
pub use bm25::ChunkedSearchResult;
pub use bm25::Tokenizer;
pub use chunked_hybrid::ChunkedHybridRetriever;
pub use hybrid::reciprocal_rank_fusion;
pub use hybrid::HybridRetriever;
pub use hybrid::RetrievalSource;
pub use hybrid::RetrievedDocument;
pub use unified_hybrid::HybridIndexConfig;
pub use unified_hybrid::HybridSearchResult;
pub use unified_hybrid::UnifiedHybridIndex;
pub use multi_query::MultiQueryConfig;
pub use multi_query::MultiQueryError;
pub use multi_query::MultiQueryRetriever;
pub use multi_query::StaticQueryGenerator;
pub use hyde::HyDEConfig;
pub use hyde::HyDEError;
pub use hyde::HyDERetriever;
pub use reranking::BM25Reranker;
pub use reranking::KeywordReranker;
pub use reranking::Reranker;
pub use reranking::RerankingConfig;
pub use reranking::RerankingError;
pub use reranking::RerankingExecutor;
pub use graph_rag::Community as GraphCommunity;
pub use graph_rag::Entity as GraphEntity;
pub use graph_rag::GraphStore;
pub use graph_rag::Relation as GraphRelation;
pub use graph_rag::GraphRAG;
pub use graph_rag::GraphRAGConfig;
pub use graph_rag::GraphRAGError;
pub use graph_rag::GraphRAGResult;
pub use graph_rag::QueryMode;

Modules§

bm25
BM25 检索模块
chunked_hybrid
Chunked Hybrid Retriever - BM25 + 向量混合检索器
graph_rag
GraphRAG (Knowledge Graph RAG) module.
hybrid
混合检索模块
hyde
HyDE (Hypothetical Document Embedding) Retriever 实现
loaders
文档加载器实现
multi_query
MultiQueryRetriever 实现
pipeline
RAGPipeline & RAGPipelineBuilder — 一行搞定 RAG 管线
reranking
Reranking(重排序)实现
retriever
检索器实现
semantic_splitter
语义分块器
splitter
文本分割器实现
unified_hybrid
Unified Hybrid Index - 统一混合索引

Structs§

ChunkDocument
Chunk document (split document fragment).
ChunkedVectorStore
Chunked Vector Store
Document
Document structure.
InMemoryDocumentStore
内存文档存储
InMemoryVectorStore
内存向量存储
MockEmbeddings
Mock embeddings for testing purposes.
OpenAIEmbeddings
OpenAI Embeddings client
RecursiveCharacterSplitter
Recursive character splitter
SearchResult
Search result.

Enums§

EmbeddingError
Embedding error type
VectorStoreError
Vector store error types.

Traits§

ChunkedDocumentStoreTrait
支持 Parent-Child 结构的文档存储 trait
DocumentStore
文档存储 trait
Embeddings
Embedding model trait
TextSplitter
Text splitter trait
VectorStore
Vector store trait.

Functions§

cosine_similarity
Compute cosine similarity between two vectors.

Type Aliases§

ChunkedDocumentStore