Class HnswSidecar

Memory-specific HNSW sidecar that wraps the canonical HnswIndexSidecar.

Maintains the original constructor-based API expected by Memory facade and Brain consumers, while delegating all index operations to the shared RAG implementation.

Index

Accessors

isActive

get isActive(): boolean
Whether the HNSW index is currently active and queryable.

Returns boolean
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:107

size

get size(): number
Number of vectors currently indexed.

Returns number
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:112

Constructors

constructor

new HnswSidecar(config): HnswSidecar
Parameters
- config: HnswSidecarConfig
Returns HnswSidecar
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:93

Methods

init

init(): Promise<void>
Initialize the sidecar. Loads existing index from disk if present. If hnswlib-node is not installed, silently stays inactive.

Returns Promise<void>
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:124

add

add(traceId, embedding, _totalCount): Promise<void>
Add a vector to the index. If below threshold, does nothing. If threshold is crossed, caller should call rebuildFromData().
Parameters
- traceId: string
  The trace ID to associate with this vector.
- embedding: number[]
  The embedding vector.
- _totalCount: number
  Current total trace count (unused, kept for API compat).
Returns Promise<void>
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:144

query

query(embedding, topK): HnswQueryResult[]
Query the HNSW index for top-K nearest neighbors. Returns trace IDs sorted by distance (closest first).
Parameters
- embedding: number[]
  Query vector.
- topK: number
  Number of results to return.
Returns HnswQueryResult[]
Array of { id, distance } sorted by distance ascending.
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:156

remove

remove(traceId): void
Remove a trace from the index by marking its label as deleted. HNSW doesn't support true deletion — cleaned up on rebuild.
Parameters
- traceId: string
  The trace ID to remove.
Returns void
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:198

rebuildFromData

rebuildFromData(data): Promise<void>
Rebuild the entire index from a set of id/embedding pairs. Called on first threshold crossing or when the index file is missing/corrupt. Filters out dimension-mismatched vectors before delegating.
Parameters
- data: {
  id: string;
  embedding: number[];
  }[]
  Array of { id, embedding } to index.
Returns Promise<void>
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:210

saveToDisk

saveToDisk(): void
Persist index and label map to disk. Called after rebuildFromData() and periodically after adds.

Returns void
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:222

destroy

destroy(): void
Delete index files from disk and deactivate.

Returns void
- Defined in src/cognition/memory/retrieval/store/HnswSidecar.ts:229

Class HnswSidecar

Index

Accessors

Constructors

Methods

Accessors

isActive

Returns boolean

size

Returns number

Constructors

constructor

Parameters

Returns HnswSidecar

Methods

init

Returns Promise<void>

add

Parameters

Returns Promise<void>

query

Parameters

Returns HnswQueryResult[]

remove

Parameters

Returns void

rebuildFromData

Parameters

Returns Promise<void>

saveToDisk

Returns void

destroy

Returns void

Settings

Member Visibility

Theme

On This Page