Class: KnowledgeGraph

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:50

In-memory Knowledge Graph implementation

Implements

• IKnowledgeGraph

Constructors

Constructor

new KnowledgeGraph(config?): KnowledgeGraph

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:66

Parameters

config?

KnowledgeGraphConfig = {}

Returns

KnowledgeGraph

Methods

clear()

clear(): Promise<void>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:776

Clear all knowledge

Returns

Promise<void>

Implementation of

IKnowledgeGraph.clear

---

decayMemories()

decayMemories(decayFactor?): Promise<number>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:716

Decay old memories (reduce importance over time)

Parameters

decayFactor?

number

Returns

Promise<number>

Implementation of

IKnowledgeGraph.decayMemories

---

deleteEntity()

deleteEntity(id): Promise<boolean>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:175

Delete an entity and its relations

Parameters

id

string

Returns

Promise<boolean>

Implementation of

IKnowledgeGraph.deleteEntity

---

deleteMemories()

deleteMemories(filter): Promise<number>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:404

Delete the episodic records that copy the filter's traces or scopes: a trace's copy by its key, a scope's copies by the scope their stored context names. The relations that name a deleted record go with it, as an entity's do (deleteEntity): a host can relate a record, since upsertRelation takes any node id.

Parameters

filter

MemoryCopyFilter

Returns

Promise<number>

Implementation of

IKnowledgeGraph.deleteMemories

---

deleteRelation()

deleteRelation(id): Promise<boolean>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:267

Delete a relation

Parameters

id

string

Returns

Promise<boolean>

Implementation of

IKnowledgeGraph.deleteRelation

---

extractFromText()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:628

Extract entities and relations from text

Parameters

text

string

options?

entityTypes?

EntityType[]

extractRelations?

boolean

Returns

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

Implementation of

IKnowledgeGraph.extractFromText

---

findPath()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:491

Find shortest path between two entities

Parameters

sourceId

string

targetId

string

maxDepth?

number = 5

Returns

Promise<object[] | null>

Implementation of

IKnowledgeGraph.findPath

---

getEntity()

getEntity(id): Promise<KnowledgeEntity | undefined>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:125

Get entity by ID

Parameters

id

string

Returns

Promise<KnowledgeEntity | undefined>

Implementation of

IKnowledgeGraph.getEntity

---

getMemory()

getMemory(id): Promise<EpisodicMemory | undefined>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:316

Get memory by ID

Parameters

id

string

Returns

Promise<EpisodicMemory | undefined>

Implementation of

IKnowledgeGraph.getMemory

---

getNeighborhood()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:540

Get neighborhood of an entity

Parameters

entityId

string

depth?

number = 1

Returns

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

Implementation of

IKnowledgeGraph.getNeighborhood

---

getRelations()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:236

Get relations for an entity

Parameters

entityId

string

options?

direction?

"outgoing" | "incoming" | "both"

types?

RelationType[]

Returns

Promise<KnowledgeRelation[]>

Implementation of

IKnowledgeGraph.getRelations

---

getStats()

getStats(): Promise<KnowledgeGraphStats>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:742

Get knowledge graph statistics

Returns

Promise<KnowledgeGraphStats>

Implementation of

IKnowledgeGraph.getStats

---

initialize()

initialize(): Promise<void>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:73

Initialize the knowledge graph

Returns

Promise<void>

Implementation of

IKnowledgeGraph.initialize

---

mergeEntities()

mergeEntities(entityIds, primaryId): Promise<KnowledgeEntity>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:682

Merge duplicate entities

Parameters

entityIds

string[]

primaryId

string

Returns

Promise<KnowledgeEntity>

Implementation of

IKnowledgeGraph.mergeEntities

---

queryEntities()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:129

Query entities

Parameters

options?

KnowledgeQueryOptions

Returns

Promise<KnowledgeEntity[]>

Implementation of

IKnowledgeGraph.queryEntities

---

queryMemories()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:326

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[]>

Implementation of

IKnowledgeGraph.queryMemories

---

recallMemories()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:368

Recall relevant memories (updates access count)

Parameters

query

string

topK?

number = 5

Returns

Promise<EpisodicMemory[]>

Implementation of

IKnowledgeGraph.recallMemories

---

recordMemory()

recordMemory(memoryInput): Promise<EpisodicMemory>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:283

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

memoryInput

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

Returns

Promise<EpisodicMemory>

Implementation of

IKnowledgeGraph.recordMemory

---

semanticSearch()

semanticSearch(options): Promise<SemanticSearchResult[]>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:556

Semantic search across entities and memories

Parameters

options

SemanticSearchOptions

Returns

Promise<SemanticSearchResult[]>

Implementation of

IKnowledgeGraph.semanticSearch

---

traverse()

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

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:428

Traverse the graph from a starting entity

Parameters

startEntityId

string

options?

TraversalOptions

Returns

Promise<TraversalResult>

Implementation of

IKnowledgeGraph.traverse

---

upsertEntity()

upsertEntity(entityInput): Promise<KnowledgeEntity>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:81

Add or update an entity

Parameters

entityInput

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

Returns

Promise<KnowledgeEntity>

Implementation of

IKnowledgeGraph.upsertEntity

---

upsertRelation()

upsertRelation(relationInput): Promise<KnowledgeRelation>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:203

Add or update a relation

Parameters

relationInput

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

Returns

Promise<KnowledgeRelation>

Implementation of

IKnowledgeGraph.upsertRelation