Struct RetrievalSystemAdapter 

pub struct RetrievalSystemAdapter { /* private fields */ }

Adapter for RetrievalSystem to implement AsyncRetriever trait

Graph Integration

This adapter wraps the RetrievalSystem which operates on a KnowledgeGraph. For full functionality, the RetrievalSystem needs to be initialized with a populated graph. The current implementation provides the trait interface but actual retrieval requires application-level graph management.

Usage Pattern

use graphrag_core::core::retrieval_adapters::RetrievalSystemAdapter;
use graphrag_core::retrieval::RetrievalSystem;
use graphrag_core::config::Config;

let config = Config::default();
let system = RetrievalSystem::new(&config)?;
let adapter = RetrievalSystemAdapter::new(system);

// Search requires a populated knowledge graph in the retrieval system
// This would typically be managed at the application level

Implementations

impl RetrievalSystemAdapter

pub fn new(system: RetrievalSystem) -> Self

Create a new retrieval system adapter

Note: The RetrievalSystem should be populated with a KnowledgeGraph before search operations will return meaningful results.

pub fn system(&self) -> &RetrievalSystem

Get reference to underlying retrieval system

pub fn system_mut(&mut self) -> &mut RetrievalSystem

Get mutable reference to underlying retrieval system

This allows configuring the retrieval system after creation, such as setting the knowledge graph or updating configurations.

Trait Implementations

impl AsyncRetriever for RetrievalSystemAdapter

type Query = String

The query type this retriever accepts

type Result = RetrievalResult

The result type this retriever returns

type Error = GraphRAGError

The error type returned by retrieval operations

fn search<'life0, 'async_trait>( &'life0 self, _query: Self::Query, _k: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Self::Result>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform a search query

fn search_with_context<'life0, 'life1, 'async_trait>( &'life0 self, query: Self::Query, _context: &'life1 str, k: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Self::Result>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a search with additional context

fn search_batch<'life0, 'async_trait>( &'life0 self, queries: Vec<Self::Query>, k: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Vec<Self::Result>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform multiple search queries concurrently

fn update<'life0, 'async_trait>( &'life0 mut self, _content: Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update the retriever with new content

fn health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Health check for retrieval system

fn update_batch<'life0, 'async_trait>( &'life0 mut self, content_batches: Vec<Vec<String>>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update the retriever with new content in batches

fn refresh_index<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Refresh/rebuild the retrieval index

fn get_stats<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<RetrievalStats>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get retrieval statistics