Skip to main content

Class: Neo4jKnowledgeGraph

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/Neo4jKnowledgeGraph.ts:91

Interface for the Knowledge Graph system

Implements​

Constructors​

Constructor​

new Neo4jKnowledgeGraph(config): Neo4jKnowledgeGraph

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/Neo4jKnowledgeGraph.ts:102

Parameters​

config​

Neo4jKnowledgeGraphConfig

Returns​

Neo4jKnowledgeGraph

Methods​

clear()​

clear(): Promise<void>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/Neo4jKnowledgeGraph.ts:966

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/Neo4jKnowledgeGraph.ts:894

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/Neo4jKnowledgeGraph.ts:247

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/Neo4jKnowledgeGraph.ts:464

Delete the episodic memories that copy the filter's traces or scopes. A trace's copies are read through their trace id (traceId, indexed); the first delete by trace id of this graph first gives the copies an older release recorded their trace id (backfillCopyTraceIds). While that pass fails, a delete by trace id also reads the copies that carry no trace id by the text their stored context JSON must hold ("memoryTraceId":"<id>") and matches them exactly in code. A scope's copies are read by the text their stored context JSON must hold (CONTAINS) and matched exactly in code, so a malformed context_json is skipped rather than failing the delete.

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/Neo4jKnowledgeGraph.ts:351

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/Neo4jKnowledgeGraph.ts:835

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/Neo4jKnowledgeGraph.ts:702

Find shortest path between two entities

Parameters​

sourceId​

string

targetId​

string

maxDepth?​

number

Returns​

Promise<object[] | null>

Implementation of​

IKnowledgeGraph.findPath


getEntity()​

getEntity(id): Promise<KnowledgeEntity | undefined>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/Neo4jKnowledgeGraph.ts:194

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/Neo4jKnowledgeGraph.ts:438

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/Neo4jKnowledgeGraph.ts:736

Get neighborhood of an entity

Parameters​

entityId​

string

depth?​

number

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/Neo4jKnowledgeGraph.ts:315

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/Neo4jKnowledgeGraph.ts:913

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/Neo4jKnowledgeGraph.ts:108

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/Neo4jKnowledgeGraph.ts:846

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/Neo4jKnowledgeGraph.ts:203

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/Neo4jKnowledgeGraph.ts:555

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/Neo4jKnowledgeGraph.ts:598

Recall relevant memories (updates access count)

Parameters​

query​

string

topK?​

number

Returns​

Promise<EpisodicMemory[]>

Implementation of​

IKnowledgeGraph.recallMemories


recordMemory()​

recordMemory(memory): Promise<EpisodicMemory>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/Neo4jKnowledgeGraph.ts:367

Record an episodic memory. A memory trace's copy (a context that names the trace, memoryTraceId) carries the trace id (traceId, indexed) and replaces the copy recorded for the trace before.

Parameters​

memory​

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/Neo4jKnowledgeGraph.ts:770

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/Neo4jKnowledgeGraph.ts:624

Traverse the graph from a starting entity

Parameters​

startEntityId​

string

options?​

TraversalOptions

Returns​

Promise<TraversalResult>

Implementation of​

IKnowledgeGraph.traverse


upsertEntity()​

upsertEntity(entity): Promise<KnowledgeEntity>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/Neo4jKnowledgeGraph.ts:144

Add or update an entity

Parameters​

entity​

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

Returns​

Promise<KnowledgeEntity>

Implementation of​

IKnowledgeGraph.upsertEntity


upsertRelation()​

upsertRelation(relation): Promise<KnowledgeRelation>

Defined in: packages/agentos/src/cognition/memory/retrieval/graph/knowledge/Neo4jKnowledgeGraph.ts:259

Add or update a relation

Parameters​

relation​

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

Returns​

Promise<KnowledgeRelation>

Implementation of​

IKnowledgeGraph.upsertRelation