Interface: IGraphRAGEngine
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:192
Methods
clear()
clear():
Promise<void>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:252
Clear all data
Returns
Promise<void>
getCommunities()
getCommunities(
level?):Promise<GraphCommunity[]>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:240
Get community hierarchy
Parameters
level?
number
Returns
Promise<GraphCommunity[]>
getEntities()
getEntities(
options?):Promise<GraphEntity[]>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:234
Get all entities
Parameters
options?
limit?
number
type?
string
Returns
Promise<GraphEntity[]>
getRelationships()
getRelationships(
entityId):Promise<GraphRelationship[]>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:237
Get all relationships for an entity
Parameters
entityId
string
Returns
Promise<GraphRelationship[]>
getStats()
getStats():
Promise<{communityLevels:number;documentsIngested:number;totalCommunities:number;totalEntities:number;totalRelationships:number; }>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:243
Get statistics
Returns
Promise<{ communityLevels: number; documentsIngested: number; totalCommunities: number; totalEntities: number; totalRelationships: number; }>
globalSearch()
globalSearch(
query,options?):Promise<GlobalSearchResult>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:225
Global search: answers broad questions using community summaries. Best for "What are the main themes?" type questions.
Parameters
query
string
options?
Returns
Promise<GlobalSearchResult>
ingestDocuments()
ingestDocuments(
documents):Promise<{communitiesDetected:number;documentsProcessed:number;entitiesExtracted:number;relationshipsExtracted:number; }>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:200
Ingest documents: extract entities/relationships, build graph, detect communities, generate summaries.
Parameters
documents
object[]
Returns
Promise<{ communitiesDetected: number; documentsProcessed: number; entitiesExtracted: number; relationshipsExtracted: number; }>
initialize()
initialize(
config):Promise<void>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:194
Initialize the engine with configuration
Parameters
config
Returns
Promise<void>
localSearch()
localSearch(
query,options?):Promise<LocalSearchResult>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:231
Local search: finds specific entities and their context. Best for "Tell me about X" type questions.
Parameters
query
string
options?
Returns
Promise<LocalSearchResult>
removeDocuments()
removeDocuments(
documentIds):Promise<{communitiesDetected:number;documentsRemoved:number; }>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:216
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<{ communitiesDetected: number; documentsRemoved: number; }>
shutdown()
shutdown():
Promise<void>
Defined in: packages/agentos/src/cognition/memory/retrieval/graph/graphrag/IGraphRAG.ts:255
Shutdown and cleanup
Returns
Promise<void>