Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/memory / / SessionMemoryStoreExt
Interface: SessionMemoryStoreExt
Defined in: packages/memory/src/internal/storage-adapter.ts:210
Extension of the typed SessionMemoryStore with optional token-cache + vector-search + cursor-aware reader helpers that storage adapters may expose.
Stable
Extends
Methods
count()?
optional count(scope): Promise<number>;Defined in: packages/memory/src/internal/storage-adapter.ts:239
Count the live messages in the scoped session (CE-5) - a COUNT(*), never materialising rows; 0 for a user-only scope. Powers honest metadata() counts instead of list(...)-materialising up to 1000 rows.
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
Returns
Promise<number>
list()
list(scope, opts?): Promise<readonly Message[]>;Defined in: packages/core/dist/contracts/memory-store.d.ts
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
opts? | SessionListOptions |
Returns
Promise<readonly Message[]>
Inherited from
listMessagesSince()?
optional listMessagesSince(
scope,
lastMessageId,
limit): Promise<readonly SessionMessageRecord[]>;Defined in: packages/memory/src/internal/storage-adapter.ts:229
List messages for the supplied scope past the optional lastMessageId cursor, oldest-first, capped at limit. Used by the consolidator's standard phase to advance the per-scope idempotency cursor without rereading already-processed turns.
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
lastMessageId | string | null |
limit | number |
Returns
Promise<readonly SessionMessageRecord[]>
listWithMetadata()?
optional listWithMetadata(scope, opts?): Promise<readonly SessionMessageWithMetadata[]>;Defined in: packages/core/dist/contracts/memory-store.d.ts
List messages with their persisted identity (RP-5). Optional: stores that don't implement it fall back to list + fabricated ids on the export path.
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
opts? | SessionListOptions |
Returns
Promise<readonly SessionMessageWithMetadata[]>
Inherited from
SessionMemoryStore.listWithMetadata
push()
push(scope, message): Promise<MessageRef>;Defined in: packages/core/dist/contracts/memory-store.d.ts
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
message | Message |
Returns
Promise<MessageRef>
Inherited from
search()
search(
scope,
query,
opts?): Promise<readonly MemoryHit<MemoryRecord>[]>;Defined in: packages/core/dist/contracts/memory-store.d.ts
Full-text search over the scoped session messages.
Query precedence (W-127): the POSITIONAL query parameter is authoritative; when the caller also sets opts.query (the field exists because MemorySearchOptions is shared with the option-object search surfaces), implementations MUST ignore it. The duplication is a known wart: narrowing opts to Omit<MemorySearchOptions, 'query'> is a candidate for the next major, not a change this line can make compatibly.
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
query | string |
opts? | MemorySearchOptions |
Returns
Promise<readonly MemoryHit<MemoryRecord>[]>
Inherited from
searchVector()?
optional searchVector(
scope,
embedding,
embedderId,
topK): Promise<readonly MemoryHit<MemoryRecord>[]>;Defined in: packages/memory/src/internal/storage-adapter.ts:211
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
embedding | Float32Array |
embedderId | string |
topK | number |
Returns
Promise<readonly MemoryHit<MemoryRecord>[]>
totalCachedTokens()?
optional totalCachedTokens(scope): Promise<number | null>;Defined in: packages/memory/src/internal/storage-adapter.ts:222
Sum of session_messages.token_count for the supplied scope. Returns null when the cache is empty / partially populated so callers can fall back to a heuristic. Surfaced per DEC-131.
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
Returns
Promise<number | null>