Expand description
§graphrag
Meta-crate that re-exports graphrag_core for library users and provides
the graphrag binary (backed by graphrag_cli).
§Installation
cargo install graphragThis installs the graphrag binary which is the full-featured TUI and CLI
for GraphRAG operations.
§Library usage
[dependencies]
graphrag = "0.1"All types from graphrag-core are re-exported:
use graphrag::GraphRAG;Modules§
- async_
graphrag - Async GraphRAG implementation Async GraphRAG System
- async_
processing - Async processing pipelines Async processing utilities for GraphRAG operations
- builder
- Builder pattern implementations GraphRAG builder module
- caching
- Caching utilities for LLM responses High-performance LLM response caching system
- config
- Configuration management and loading
- core
- Core traits and types Core data structures and abstractions for GraphRAG
- critic
- RAG answer evaluation and criticism
- embeddings
- Embedding generation and providers Embedding generation for GraphRAG
- entity
- Entity extraction and management
- evaluation
- Evaluation framework for query results and pipeline validation Evaluation framework for GraphRAG system
- generation
- Text generation and LLM interactions (async feature only)
- graph
- Graph data structures and algorithms
- incremental
- Incremental graph updates Incremental Graph Updates
- inference
- Inference module for model predictions Implicit relationship inference system
- lightrag
- LightRAG dual-level retrieval optimization LightRAG: Simple and Fast Retrieval-Augmented Generation
- monitoring
- Monitoring, benchmarking, and performance tracking Monitoring and benchmarking utilities for GraphRAG
- nlp
- Natural language processing utilities Advanced NLP Module
- ollama
- Ollama LLM integration Ollama LLM integration
- optimization
- Graph optimization (weight optimization, DW-GRPO) Graph optimization module
- parallel
- Parallel processing utilities for GraphRAG
- persistence
- Persistence layer for knowledge graphs (workspace management always available) Persistence layer for GraphRAG knowledge graphs
- pipeline
- Data processing pipelines Pipeline Module
- pipeline_
executor - Composable pipeline executor for build-graph operations Composable pipeline executor for GraphRAG operations
- prelude
- Prelude module containing the most commonly used types
- query
- Query processing and execution
- reranking
- Reranking utilities for improving search result quality Reranking module for improving retrieval accuracy
- retrieval
- Retrieval strategies and implementations
- rograg
- ROGRAG (Robustly Optimized GraphRAG) implementation ROGRAG (Robustly Optimized GraphRAG) module - Reasoning on Graphs for RAG
- storage
- Storage backends and persistence Storage layer for GraphRAG
- summarization
- Text summarization capabilities
- text
- Text processing and chunking
- vector
- Vector operations and embeddings
Macros§
- config_
error - Helper macros for creating specific error types
- generation_
error - Creates a generation error with a message
- retrieval_
error - Creates a retrieval error with a message
- storage_
error - Creates a storage error with a message
Structs§
- ChunkId
- Unique identifier for text chunks
- Confidence
Cross Encoder - Confidence-based cross-encoder implementation (Restored Fallback)
- Config
- Configuration for the GraphRAG system
- Cross
Encoder Config - Configuration for cross-encoder reranking
- Document
- A document in the system
- Document
Id - Unique identifier for documents
- Dual
Level Keywords - Dual-level keywords for retrieval
- Dual
Level Retriever - LightRAG-style dual-level retriever
- Dual
Retrieval Config - Configuration for dual-level retrieval
- Dual
Retrieval Results - Dual-level retrieval results
- Entity
- An entity extracted from text
- Entity
Id - Unique identifier for entities
- Entity
Mention - A mention of an entity in text
- Error
Suggestion - Structured suggestion for error recovery
- Fact
- Fact triple for knowledge graph
- GraphRAG
- Main GraphRAG system
- GraphRAG
Builder - Builder for GraphRAG instances
- Hierarchical
Communities - Hierarchical community detection results
- HippoRAG
Config - Configuration for HippoRAG PPR retrieval
- HippoRAG
Retriever - HippoRAG retrieval system using Personalized PageRank
- Keyword
Extractor - Keyword extractor for dual-level retrieval
- Keyword
Extractor Config - Configuration for keyword extraction
- Knowledge
Graph - Knowledge graph containing entities and their relationships
- Leiden
Community Detector - Leiden community detection algorithm
- Leiden
Config - Configuration for Leiden algorithm
- Memory
Storage - In-memory storage implementation for development and testing
- Page
Rank Config - Configuration for PageRank algorithm
- Page
Rank Retrieval System - High-performance PageRank-based retrieval system implementing fast-GraphRAG approach
- Personalized
Page Rank - Personalized PageRank implementation with optimizations for graph retrieval
- Ranked
Result - Result of cross-encoder reranking with confidence score
- Relationship
- Relationship between entities
- Reranking
Stats - Statistics about reranking performance
- Scored
Result - A result with multiple scoring signals
- Text
Chunk - A chunk of text from a document
Enums§
- Error
Severity - Error severity levels for logging and monitoring
- GraphRAG
Error - Main error type for the GraphRAG system
- Merge
Strategy - Strategy for merging high and low level results
Traits§
- Cross
Encoder - Cross-encoder trait for reranking retrieved results
- Embedder
- Text embedding abstraction for converting text to vector representations
- Entity
Extractor - Entity extraction abstraction for identifying entities in text
- Error
Context - Trait for adding context to errors
- Graph
Store - Graph operations abstraction for knowledge graph management
- Language
Model - Large Language Model abstraction for text generation
- Retriever
- Text retrieval abstraction for finding relevant content
- Semantic
Searcher - Semantic search interface that combines embedder and vector store
- Storage
- Core storage abstraction for persisting and retrieving entities, documents, and graph data
- Vector
Store - Vector similarity search abstraction for finding similar embeddings
Type Aliases§
- Result
- Convenient Result type alias