Class GraphRAGEngine

Implements

IGraphRAGEngine

Index

Constructors

Methods

initialize ingestDocuments removeDocuments globalSearch localSearch getEntities getRelationships getCommunities getStats clear shutdown

Constructors

constructor

new GraphRAGEngine(deps?): GraphRAGEngine
Parameters
- Optional deps: {
      vectorStore?: IVectorStore;
      embeddingManager?: IEmbeddingManager;
      llmProvider?: LLMProvider;
      persistenceAdapter?: PersistenceAdapter;
  }
  - Optional vectorStore?: IVectorStore
  - Optional embeddingManager?: IEmbeddingManager
  - Optional llmProvider?: LLMProvider
  - Optional persistenceAdapter?: PersistenceAdapter
Returns GraphRAGEngine
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:130

Methods

initialize

initialize(config): Promise<void>
Initialize the engine with configuration
Parameters
- config: GraphRAGConfig
Returns Promise<void>
Implementation of IGraphRAGEngine.initialize
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:198

ingestDocuments

ingestDocuments(documents): Promise<{
    entitiesExtracted: number;
    relationshipsExtracted: number;
    communitiesDetected: number;
    documentsProcessed: number;
}>
Ingest documents: extract entities/relationships, build graph, detect communities, generate summaries.
Parameters
- documents: {
      id: string;
      content: string;
      metadata?: Record<string, MetadataValue>;
  }[]
Returns Promise<{
    entitiesExtracted: number;
    relationshipsExtracted: number;
    communitiesDetected: number;
    documentsProcessed: number;
}>
Implementation of IGraphRAGEngine.ingestDocuments
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:264

removeDocuments

removeDocuments(documentIds): Promise<{
documentsRemoved: number;
communitiesDetected: number;
}>
Remove one or more previously-ingested documents from the graph.

This subtracts the document's entity/relationship contributions and recomputes communities. It is used to keep GraphRAG in sync when a source document is deleted or moved out of indexed categories.
Parameters
- documentIds: string[]
Returns Promise<{
documentsRemoved: number;
communitiesDetected: number;
}>
Implementation of IGraphRAGEngine.removeDocuments
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:417

globalSearch

globalSearch(query, options?): Promise<GlobalSearchResult>
Global search: answers broad questions using community summaries. Best for "What are the main themes?" type questions.
Parameters
- query: string
- Optional options: GraphRAGSearchOptions
Returns Promise<GlobalSearchResult>
Implementation of IGraphRAGEngine.globalSearch
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1116

localSearch

localSearch(query, options?): Promise<LocalSearchResult>
Local search: finds specific entities and their context. Best for "Tell me about X" type questions.
Parameters
- query: string
- Optional options: GraphRAGSearchOptions
Returns Promise<LocalSearchResult>
Implementation of IGraphRAGEngine.localSearch
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1287

getEntities

getEntities(options?): Promise<GraphEntity[]>
Get all entities
Parameters
- Optional options: {
  type?: string;
  limit?: number;
  }
  - Optional type?: string
  - Optional limit?: number
Returns Promise<GraphEntity[]>
Implementation of IGraphRAGEngine.getEntities
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1451

getRelationships

getRelationships(entityId): Promise<GraphRelationship[]>
Get all relationships for an entity
Parameters
- entityId: string
Returns Promise<GraphRelationship[]>
Implementation of IGraphRAGEngine.getRelationships
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1460

getCommunities

getCommunities(level?): Promise<GraphCommunity[]>
Get community hierarchy
Parameters
- Optional level: number
Returns Promise<GraphCommunity[]>
Implementation of IGraphRAGEngine.getCommunities
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1467

getStats

getStats(): Promise<{
    totalEntities: number;
    totalRelationships: number;
    totalCommunities: number;
    communityLevels: number;
    documentsIngested: number;
}>
Get statistics

Returns Promise<{
    totalEntities: number;
    totalRelationships: number;
    totalCommunities: number;
    communityLevels: number;
    documentsIngested: number;
}>
Implementation of IGraphRAGEngine.getStats
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1476

clear

clear(): Promise<void>
Clear all data

Returns Promise<void>
Implementation of IGraphRAGEngine.clear
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1494

shutdown

shutdown(): Promise<void>
Shutdown and cleanup

Returns Promise<void>
Implementation of IGraphRAGEngine.shutdown
- Defined in src/memory/retrieval/graph/graphrag/GraphRAGEngine.ts:1517

Class GraphRAGEngine

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional vectorStore?: IVectorStore

Optional embeddingManager?: IEmbeddingManager

Optional llmProvider?: LLMProvider

Optional persistenceAdapter?: PersistenceAdapter

Returns GraphRAGEngine

Methods

initialize

Parameters

Returns Promise<void>

ingestDocuments

Parameters

Returns Promise<{ entitiesExtracted: number; relationshipsExtracted: number; communitiesDetected: number; documentsProcessed: number; }>

removeDocuments

Parameters

Returns Promise<{ documentsRemoved: number; communitiesDetected: number; }>

globalSearch

Parameters

Returns Promise<GlobalSearchResult>

localSearch

Parameters

Returns Promise<LocalSearchResult>

getEntities

Parameters

Optional type?: string

Optional limit?: number

Returns Promise<GraphEntity[]>

getRelationships

Parameters

Returns Promise<GraphRelationship[]>

getCommunities

Parameters

Returns Promise<GraphCommunity[]>

getStats

Returns Promise<{ totalEntities: number; totalRelationships: number; totalCommunities: number; communityLevels: number; documentsIngested: number; }>

clear

Returns Promise<void>

shutdown

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Optional` vectorStore?: IVectorStore

`Optional` embeddingManager?: IEmbeddingManager

`Optional` llmProvider?: LLMProvider

`Optional` persistenceAdapter?: PersistenceAdapter

Returns Promise<{
entitiesExtracted: number;
relationshipsExtracted: number;
communitiesDetected: number;
documentsProcessed: number;
}>

Returns Promise<{
documentsRemoved: number;
communitiesDetected: number;
}>

`Optional` type?: string

`Optional` limit?: number

Returns Promise<{
totalEntities: number;
totalRelationships: number;
totalCommunities: number;
communityLevels: number;
documentsIngested: number;
}>