Interface: IGraphRAGEngine
Defined in: packages/agentos/src/rag/graphrag/IGraphRAG.ts:182
Methods
clear()
clear():
Promise<void>
Defined in: packages/agentos/src/rag/graphrag/IGraphRAG.ts:230
Clear all data
Returns
Promise<void>
getCommunities()
getCommunities(
level?):Promise<GraphCommunity[]>
Defined in: packages/agentos/src/rag/graphrag/IGraphRAG.ts:218
Get community hierarchy
Parameters
level?
number
Returns
Promise<GraphCommunity[]>
getEntities()
getEntities(
options?):Promise<GraphEntity[]>
Defined in: packages/agentos/src/rag/graphrag/IGraphRAG.ts:212
Get all entities
Parameters
options?
limit?
number
type?
string
Returns
Promise<GraphEntity[]>
getRelationships()
getRelationships(
entityId):Promise<GraphRelationship[]>
Defined in: packages/agentos/src/rag/graphrag/IGraphRAG.ts:215
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/rag/graphrag/IGraphRAG.ts:221
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/rag/graphrag/IGraphRAG.ts:203
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/rag/graphrag/IGraphRAG.ts:190
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/rag/graphrag/IGraphRAG.ts:184
Initialize the engine with configuration
Parameters
config
Returns
Promise<void>
localSearch()
localSearch(
query,options?):Promise<LocalSearchResult>
Defined in: packages/agentos/src/rag/graphrag/IGraphRAG.ts:209
Local search: finds specific entities and their context. Best for "Tell me about X" type questions.
Parameters
query
string
options?
Returns
Promise<LocalSearchResult>
shutdown()
shutdown():
Promise<void>
Defined in: packages/agentos/src/rag/graphrag/IGraphRAG.ts:233
Shutdown and cleanup
Returns
Promise<void>