Interface: MemoryGraphIndex

Defined in: packages/kernl/src/memory/indexes.ts:78

Memory graph index - relationship/graph traversal over memories (stub).

Extends

MemoryIndexBase<GraphTraversalQuery, GraphTraversalResult>

Properties

Property	Modifier	Type	Inherited from	Defined in
`id`	`readonly`	`string`	`MemoryIndexBase`.`id`	packages/kernl/src/memory/indexes.ts:24

Methods

delete()

delete(ids: string | string[]): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:44

Remove one or more records from this index (DB row remains).

Parameters

Parameter	Type
`ids`	`string` \| `string`[]

Returns

Promise<void>

Inherited from

MemoryIndexBase.delete

index()

index(memories: 
  | MemoryRecord
| MemoryRecord[]): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:34

Index one or more memory records (idempotent upsert).

Parameters

Parameter	Type
`memories`	\| `MemoryRecord` \| `MemoryRecord`[]

Returns

Promise<void>

Inherited from

MemoryIndexBase.index

query()

query(query: GraphTraversalQuery): Promise<GraphTraversalResult>;

Defined in: packages/kernl/src/memory/indexes.ts:29

Query the index.

Parameters

Parameter	Type
`query`	`GraphTraversalQuery`

Returns

Promise<GraphTraversalResult>

Inherited from

MemoryIndexBase.query

traverse()

traverse(query: GraphTraversalQuery): Promise<GraphTraversalResult>;

Defined in: packages/kernl/src/memory/indexes.ts:83

Explicit traversal API (alias for query).

Parameters

Parameter	Type
`query`	`GraphTraversalQuery`

Returns

Promise<GraphTraversalResult>

update()

update(updates: 
  | MemoryRecordUpdate
| MemoryRecordUpdate[]): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:39

Partially update one or more records' projections.

Parameters

Parameter	Type
`updates`	\| `MemoryRecordUpdate` \| `MemoryRecordUpdate`[]

Returns

Promise<void>

Inherited from

MemoryIndexBase.update

warm()

warm(index: string): Promise<void>;

Defined in: packages/kernl/src/memory/indexes.ts:49

Index warming (optional).

Parameters

Parameter	Type
`index`	`string`

Returns

Promise<void>

Inherited from

MemoryIndexBase.warm

On this page