Class KnowledgeGraph

In-memory Knowledge Graph implementation

Implements

IKnowledgeGraph

Constructors

constructor

new KnowledgeGraph(config?): KnowledgeGraph
Parameters
- config: KnowledgeGraphConfig = {}
Returns KnowledgeGraph
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:66

Methods

initialize

initialize(): Promise<void>
Initialize the knowledge graph

Returns Promise<void>
Implementation of IKnowledgeGraph.initialize
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:73

upsertEntity

upsertEntity(entityInput): Promise<KnowledgeEntity>
Add or update an entity
Parameters
- entityInput: Omit<KnowledgeEntity, "updatedAt" | "createdAt" | "id"> & {
  id?: string;
  }
Returns Promise<KnowledgeEntity>
Implementation of IKnowledgeGraph.upsertEntity
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:81

getEntity

getEntity(id): Promise<undefined | KnowledgeEntity>
Get entity by ID
Parameters
- id: string
Returns Promise<undefined | KnowledgeEntity>
Implementation of IKnowledgeGraph.getEntity
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:125

queryEntities

queryEntities(options?): Promise<KnowledgeEntity[]>
Query entities
Parameters
- Optional options: KnowledgeQueryOptions
Returns Promise<KnowledgeEntity[]>
Implementation of IKnowledgeGraph.queryEntities
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:129

deleteEntity

deleteEntity(id): Promise<boolean>
Delete an entity and its relations
Parameters
- id: string
Returns Promise<boolean>
Implementation of IKnowledgeGraph.deleteEntity
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:175

upsertRelation

upsertRelation(relationInput): Promise<KnowledgeRelation>
Add or update a relation
Parameters
- relationInput: Omit<KnowledgeRelation, "createdAt" | "id"> & {
  id?: string;
  }
Returns Promise<KnowledgeRelation>
Implementation of IKnowledgeGraph.upsertRelation
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:203

getRelations

getRelations(entityId, options?): Promise<KnowledgeRelation[]>
Get relations for an entity
Parameters
- entityId: string
- Optional options: {
  direction?: "both" | "outgoing" | "incoming";
  types?: RelationType[];
  }
  - Optional direction?: "both" | "outgoing" | "incoming"
  - Optional types?: RelationType[]
Returns Promise<KnowledgeRelation[]>
Implementation of IKnowledgeGraph.getRelations
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:236

deleteRelation

deleteRelation(id): Promise<boolean>
Delete a relation
Parameters
- id: string
Returns Promise<boolean>
Implementation of IKnowledgeGraph.deleteRelation
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:267

recordMemory

recordMemory(memoryInput): Promise<EpisodicMemory>
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, "createdAt" | "id" | "accessCount" | "lastAccessedAt">
Returns Promise<EpisodicMemory>
Implementation of IKnowledgeGraph.recordMemory
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:283

getMemory

getMemory(id): Promise<undefined | EpisodicMemory>
Get memory by ID
Parameters
- id: string
Returns Promise<undefined | EpisodicMemory>
Implementation of IKnowledgeGraph.getMemory
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:316

queryMemories

queryMemories(options?): Promise<EpisodicMemory[]>
Query episodic memories
Parameters
- Optional options: {
      types?: ("error" | "success" | "discovery" | "conversation" | "task" | "interaction")[];
      participants?: string[];
      minImportance?: number;
      timeRange?: {
          from?: string;
          to?: string;
      };
      limit?: number;
  }
  - Optional types?: ("error" | "success" | "discovery" | "conversation" | "task" | "interaction")[]
  - Optional participants?: string[]
  - Optional minImportance?: number
  - Optional timeRange?: {
    from?: string;
    to?: string;
    }
    - Optional from?: string
    - Optional to?: string
  - Optional limit?: number
Returns Promise<EpisodicMemory[]>
Implementation of IKnowledgeGraph.queryMemories
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:326

recallMemories

recallMemories(query, topK?): Promise<EpisodicMemory[]>
Recall relevant memories (updates access count)
Parameters
- query: string
- topK: number = 5
Returns Promise<EpisodicMemory[]>
Implementation of IKnowledgeGraph.recallMemories
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:368

deleteMemories

deleteMemories(filter): Promise<number>
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
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:404

traverse

traverse(startEntityId, options?): Promise<TraversalResult>
Traverse the graph from a starting entity
Parameters
- startEntityId: string
- Optional options: TraversalOptions
Returns Promise<TraversalResult>
Implementation of IKnowledgeGraph.traverse
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:428

findPath

findPath(sourceId, targetId, maxDepth?): Promise<null | {
entity: KnowledgeEntity;
relation?: KnowledgeRelation;
}[]>
Find shortest path between two entities
Parameters
- sourceId: string
- targetId: string
- maxDepth: number = 5
Returns Promise<null | {
entity: KnowledgeEntity;
relation?: KnowledgeRelation;
}[]>
Implementation of IKnowledgeGraph.findPath
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:491

getNeighborhood

getNeighborhood(entityId, depth?): Promise<{
entities: KnowledgeEntity[];
relations: KnowledgeRelation[];
}>
Get neighborhood of an entity
Parameters
- entityId: string
- depth: number = 1
Returns Promise<{
entities: KnowledgeEntity[];
relations: KnowledgeRelation[];
}>
Implementation of IKnowledgeGraph.getNeighborhood
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:540

semanticSearch

semanticSearch(options): Promise<SemanticSearchResult[]>
Semantic search across entities and memories
Parameters
- options: SemanticSearchOptions
Returns Promise<SemanticSearchResult[]>
Implementation of IKnowledgeGraph.semanticSearch
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:556

extractFromText

extractFromText(text, options?): Promise<{
entities: KnowledgeEntity[];
relations: KnowledgeRelation[];
}>
Extract entities and relations from text
Parameters
- text: string
- Optional options: {
  extractRelations?: boolean;
  entityTypes?: EntityType[];
  }
  - Optional extractRelations?: boolean
  - Optional entityTypes?: EntityType[]
Returns Promise<{
entities: KnowledgeEntity[];
relations: KnowledgeRelation[];
}>
Implementation of IKnowledgeGraph.extractFromText
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:628

mergeEntities

mergeEntities(entityIds, primaryId): Promise<KnowledgeEntity>
Merge duplicate entities
Parameters
- entityIds: string[]
- primaryId: string
Returns Promise<KnowledgeEntity>
Implementation of IKnowledgeGraph.mergeEntities
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:682

decayMemories

decayMemories(decayFactor?): Promise<number>
Decay old memories (reduce importance over time)
Parameters
- Optional decayFactor: number
Returns Promise<number>
Implementation of IKnowledgeGraph.decayMemories
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:716

getStats

getStats(): Promise<KnowledgeGraphStats>
Get knowledge graph statistics

Returns Promise<KnowledgeGraphStats>
Implementation of IKnowledgeGraph.getStats
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:742

clear

clear(): Promise<void>
Clear all knowledge

Returns Promise<void>
Implementation of IKnowledgeGraph.clear
- Defined in src/cognition/memory/retrieval/graph/knowledge/KnowledgeGraph.ts:776

Class KnowledgeGraph

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns KnowledgeGraph

Methods

initialize

Returns Promise<void>

upsertEntity

Parameters

Returns Promise<KnowledgeEntity>

getEntity

Parameters

Returns Promise<undefined | KnowledgeEntity>

queryEntities

Parameters

Returns Promise<KnowledgeEntity[]>

deleteEntity

Parameters

Returns Promise<boolean>

upsertRelation

Parameters

Returns Promise<KnowledgeRelation>

getRelations

Parameters

Optional direction?: "both" | "outgoing" | "incoming"

Optional types?: RelationType[]

Returns Promise<KnowledgeRelation[]>

deleteRelation

Parameters

Returns Promise<boolean>

recordMemory

Parameters

Returns Promise<EpisodicMemory>

getMemory

Parameters

Returns Promise<undefined | EpisodicMemory>

queryMemories

Parameters

Optional types?: ("error" | "success" | "discovery" | "conversation" | "task" | "interaction")[]

Optional participants?: string[]

Optional minImportance?: number

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

Optional from?: string

Optional to?: string

Optional limit?: number

Returns Promise<EpisodicMemory[]>

recallMemories

Parameters

Returns Promise<EpisodicMemory[]>

deleteMemories

Parameters

Returns Promise<number>

traverse

Parameters

Returns Promise<TraversalResult>

findPath

Parameters

Returns Promise<null | { entity: KnowledgeEntity; relation?: KnowledgeRelation; }[]>

getNeighborhood

Parameters

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

semanticSearch

Parameters

Returns Promise<SemanticSearchResult[]>

extractFromText

Parameters

Optional extractRelations?: boolean

Optional entityTypes?: EntityType[]

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

mergeEntities

Parameters

Returns Promise<KnowledgeEntity>

decayMemories

Parameters

Returns Promise<number>

`Optional` direction?: "both" | "outgoing" | "incoming"

`Optional` types?: RelationType[]

`Optional` types?: ("error" | "success" | "discovery" | "conversation" | "task" | "interaction")[]

`Optional` participants?: string[]

`Optional` minImportance?: number

`Optional` timeRange?: {
from?: string;
to?: string;
}

`Optional` from?: string

`Optional` to?: string

`Optional` limit?: number

Returns Promise<null | {
entity: KnowledgeEntity;
relation?: KnowledgeRelation;
}[]>

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

`Optional` extractRelations?: boolean

`Optional` entityTypes?: EntityType[]

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