Interface: IKnowledgeGraph

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:306

Interface for the Knowledge Graph system

Methods

clear()

clear(): Promise<void>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:446

Clear all knowledge

Returns

Promise<void>

---

decayMemories()

decayMemories(decayFactor?): Promise<number>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:436

Decay old memories (reduce importance over time)

Parameters

decayFactor?

number

Returns

Promise<number>

---

deleteEntity()

deleteEntity(id): Promise<boolean>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:334

Delete an entity and its relations

Parameters

id

string

Returns

Promise<boolean>

---

deleteMemories()?

optional deleteMemories(filter): Promise<number>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:390

Delete the episodic records that copy memory traces (MemoryCopyFilter). MemoryStore.store records each trace here with its full text, so a deleted trace takes its record with it. Optional: a graph without it keeps its records, and CognitiveMemoryManager.deleteScope reports it as not reached.

Parameters

filter

MemoryCopyFilter

Returns

Promise<number>

The number of records deleted.

---

deleteRelation()

deleteRelation(id): Promise<boolean>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:351

Delete a relation

Parameters

id

string

Returns

Promise<boolean>

---

extractFromText()

extractFromText(text, options?): Promise<{ entities: KnowledgeEntity[]; relations: KnowledgeRelation[]; }>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:421

Extract entities and relations from text

Parameters

text

string

options?

entityTypes?

EntityType[]

extractRelations?

boolean

Returns

Promise<{ entities: KnowledgeEntity[]; relations: KnowledgeRelation[]; }>

---

findPath()

findPath(sourceId, targetId, maxDepth?): Promise<object[] | null>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:402

Find shortest path between two entities

Parameters

sourceId

string

targetId

string

maxDepth?

number

Returns

Promise<object[] | null>

---

getEntity()

getEntity(id): Promise<KnowledgeEntity | undefined>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:324

Get entity by ID

Parameters

id

string

Returns

Promise<KnowledgeEntity | undefined>

---

getMemory()

getMemory(id): Promise<EpisodicMemory | undefined>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:365

Get memory by ID

Parameters

id

string

Returns

Promise<EpisodicMemory | undefined>

---

getNeighborhood()

getNeighborhood(entityId, depth?): Promise<{ entities: KnowledgeEntity[]; relations: KnowledgeRelation[]; }>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:407

Get neighborhood of an entity

Parameters

entityId

string

depth?

number

Returns

Promise<{ entities: KnowledgeEntity[]; relations: KnowledgeRelation[]; }>

---

getRelations()

getRelations(entityId, options?): Promise<KnowledgeRelation[]>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:346

Get relations for an entity

Parameters

entityId

string

options?

direction?

"outgoing" | "incoming" | "both"

types?

RelationType[]

Returns

Promise<KnowledgeRelation[]>

---

getStats()

getStats(): Promise<KnowledgeGraphStats>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:441

Get knowledge graph statistics

Returns

Promise<KnowledgeGraphStats>

---

initialize()

initialize(): Promise<void>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:312

Initialize the knowledge graph

Returns

Promise<void>

---

mergeEntities()

mergeEntities(entityIds, primaryId): Promise<KnowledgeEntity>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:431

Merge duplicate entities

Parameters

entityIds

string[]

primaryId

string

Returns

Promise<KnowledgeEntity>

---

queryEntities()

queryEntities(options?): Promise<KnowledgeEntity[]>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:329

Query entities

Parameters

options?

KnowledgeQueryOptions

Returns

Promise<KnowledgeEntity[]>

---

queryMemories()

queryMemories(options?): Promise<EpisodicMemory[]>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:370

Query episodic memories

Parameters

options?

limit?

number

minImportance?

number

participants?

string[]

timeRange?

{ from?: string; to?: string; }

timeRange.from?

string

timeRange.to?

string

types?

("discovery" | "success" | "error" | "conversation" | "task" | "interaction")[]

Returns

Promise<EpisodicMemory[]>

---

recallMemories()

recallMemories(query, topK?): Promise<EpisodicMemory[]>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:381

Recall relevant memories (updates access count)

Parameters

query

string

topK?

number

Returns

Promise<EpisodicMemory[]>

---

recordMemory()

recordMemory(memory): Promise<EpisodicMemory>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:360

Record an episodic memory. A record whose context names a memory trace (memoryTraceId, as MemoryStore.store writes it) is the trace's copy; the in-memory, SQL and Neo4j graphs keep one copy per trace, so recording the trace again replaces it.

Parameters

memory

Omit<EpisodicMemory, "id" | "createdAt" | "accessCount" | "lastAccessedAt">

Returns

Promise<EpisodicMemory>

---

semanticSearch()

semanticSearch(options): Promise<SemanticSearchResult[]>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:414

Semantic search across entities and memories

Parameters

options

SemanticSearchOptions

Returns

Promise<SemanticSearchResult[]>

---

traverse()

traverse(startEntityId, options?): Promise<TraversalResult>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:397

Traverse the graph from a starting entity

Parameters

startEntityId

string

options?

TraversalOptions

Returns

Promise<TraversalResult>

---

upsertEntity()

upsertEntity(entity): Promise<KnowledgeEntity>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:319

Add or update an entity

Parameters

entity

Omit<KnowledgeEntity, "id" | "updatedAt" | "createdAt"> & object

Returns

Promise<KnowledgeEntity>

---

upsertRelation()

upsertRelation(relation): Promise<KnowledgeRelation>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/IKnowledgeGraph.ts:341

Add or update a relation

Parameters

relation

Omit<KnowledgeRelation, "id" | "createdAt"> & object

Returns

Promise<KnowledgeRelation>