Struct GraphRAGBuilder 

pub struct GraphRAGBuilder { /* private fields */ }

Builder for GraphRAG instances

Provides a fluent API for configuring GraphRAG with various options.

Implementations

impl GraphRAGBuilder

pub fn new() -> Self

Create a new builder with default configuration

Example

use graphrag_core::builder::GraphRAGBuilder;

let builder = GraphRAGBuilder::new();

pub fn with_output_dir(self, dir: &str) -> Self

Set the output directory for storing graphs and data

Example

let builder = GraphRAGBuilder::new()
    .with_output_dir("./my_workspace");

pub fn with_chunk_size(self, size: usize) -> Self

Set the chunk size for text processing

Example

let builder = GraphRAGBuilder::new()
    .with_chunk_size(512);

pub fn with_chunk_overlap(self, overlap: usize) -> Self

Set the chunk overlap for text processing

Example

let builder = GraphRAGBuilder::new()
    .with_chunk_overlap(50);

pub fn with_embedding_dimension(self, dimension: usize) -> Self

Set the embedding dimension

Example

let builder = GraphRAGBuilder::new()
    .with_embedding_dimension(384);

pub fn with_embedding_model(self, model: &str) -> Self

Set the embedding model name

Example

let builder = GraphRAGBuilder::new()
    .with_embedding_model("nomic-embed-text:latest");

pub fn with_embedding_backend(self, backend: &str) -> Self

Set the embedding backend (“candle”, “fastembed”, “api”, “hash”)

Example

let builder = GraphRAGBuilder::new()
    .with_embedding_backend("candle");

pub fn with_ollama_host(self, host: &str) -> Self

Set the Ollama host

Example

let builder = GraphRAGBuilder::new()
    .with_ollama_host("localhost");

pub fn with_ollama_port(self, port: u16) -> Self

Set the Ollama port

Example

let builder = GraphRAGBuilder::new()
    .with_ollama_port(11434);

pub fn with_ollama_enabled(self, enabled: bool) -> Self

Enable Ollama integration

Example

let builder = GraphRAGBuilder::new()
    .with_ollama_enabled(true);

pub fn with_chat_model(self, model: &str) -> Self

Set the Ollama chat/generation model

Example

let builder = GraphRAGBuilder::new()
    .with_chat_model("llama3.2:latest");

pub fn with_ollama_embedding_model(self, model: &str) -> Self

Set the Ollama embedding model

Example

let builder = GraphRAGBuilder::new()
    .with_ollama_embedding_model("nomic-embed-text:latest");

pub fn with_top_k(self, k: usize) -> Self

Set the top-k results for retrieval

Example

let builder = GraphRAGBuilder::new()
    .with_top_k(10);

pub fn with_similarity_threshold(self, threshold: f32) -> Self

Set the similarity threshold for retrieval

Example

let builder = GraphRAGBuilder::new()
    .with_similarity_threshold(0.7);

pub fn with_approach(self, approach: &str) -> Self

Set the pipeline approach (“semantic”, “algorithmic”, or “hybrid”)

Example

let builder = GraphRAGBuilder::new()
    .with_approach("hybrid");

pub fn with_parallel_processing(self, enabled: bool) -> Self

Enable or disable parallel processing

Example

let builder = GraphRAGBuilder::new()
    .with_parallel_processing(true);

pub fn with_num_threads(self, num_threads: usize) -> Self

Set the number of parallel threads

Example

let builder = GraphRAGBuilder::new()
    .with_num_threads(4);

pub fn with_auto_save(self, enabled: bool, interval_seconds: u64) -> Self

Enable or disable auto-save functionality

Example

let builder = GraphRAGBuilder::new()
    .with_auto_save(true, 300); // Save every 5 minutes

pub fn with_auto_save_workspace(self, name: &str) -> Self

Set the auto-save workspace name

Example

let builder = GraphRAGBuilder::new()
    .with_auto_save_workspace("my_project");

pub fn with_local_defaults(self) -> Self

Configure for local zero-config setup using Ollama

Sets up:

• Ollama enabled with localhost:11434
• Default models (nomic-embed-text for embeddings, llama3.2 for chat)
• Candle backend for local embeddings

Example

let builder = GraphRAGBuilder::new()
    .with_local_defaults();

pub fn build(self) -> Result<GraphRAG>

Build the GraphRAG instance with the configured settings

Errors

Returns an error if the GraphRAG initialization fails

Example

let graphrag = GraphRAGBuilder::new()
    .with_output_dir("./workspace")
    .build()?;

pub fn config(&self) -> &Config

Get a reference to the current configuration

Useful for inspecting the configuration before building

pub fn config_mut(&mut self) -> &mut Config

Get a mutable reference to the current configuration

Allows direct manipulation of the config for advanced use cases

Trait Implementations

impl Clone for GraphRAGBuilder

fn clone(&self) -> GraphRAGBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphRAGBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GraphRAGBuilder

fn default() -> Self

Returns the “default value” for a type.