Skip to main content

Module prelude

Module prelude 

Source
Expand description

Prelude module containing the most commonly used types

Import everything you need with a single line:

use graphrag_core::prelude::*;

This includes:

  • GraphRAG - The main orchestrator
  • Config - Configuration management
  • GraphRAGBuilder - Fluent configuration builder
  • Core types: Document, Entity, Relationship, TextChunk
  • Error handling: Result, GraphRAGError

Re-exportsยง

pub use crate::GraphRAG;
pub use crate::builder::GraphRAGBuilder;
pub use crate::builder::TypedBuilder;
pub use crate::config::Config;
pub use crate::core::GraphRAGError;
pub use crate::core::Result;
pub use crate::core::ChunkId;
pub use crate::core::Document;
pub use crate::core::DocumentId;
pub use crate::core::Entity;
pub use crate::core::EntityId;
pub use crate::core::EntityMention;
pub use crate::core::KnowledgeGraph;
pub use crate::core::Relationship;
pub use crate::core::TextChunk;
pub use crate::retrieval::SearchResult;
pub use crate::retrieval::ExplainedAnswer;
pub use crate::retrieval::ReasoningStep;
pub use crate::retrieval::SourceReference;
pub use crate::retrieval::SourceType;
pub use crate::pipeline_executor::PipelineExecutor;
pub use crate::pipeline_executor::PipelineReport;
pub use crate::config::setconfig::SetConfig;