Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/sessions / facade / SessionMemoryFacade

Interface: SessionMemoryFacade

Defined in: packages/sessions/src/facade.ts:82

Subset of the Memory.session surface this package consumes. Kept structural so callers can pass either the Memory facade from @graphorin/memory or any custom shim with the same shape.

Stable

Methods

compact()?

ts
optional compact(scope, opts?): Promise<{
  removed: number;
  summarized: number;
  summary?: string;
}>;

Defined in: packages/sessions/src/facade.ts:91

Parameters

ParameterType
scopeSessionScope
opts?{ keepLastN?: number; }
opts.keepLastN?number

Returns

Promise<{ removed: number; summarized: number; summary?: string; }>


flushImportant()?

ts
optional flushImportant(scope, opts?): Promise<{
  flushed: number;
}>;

Defined in: packages/sessions/src/facade.ts:90

Parameters

ParameterType
scopeSessionScope
opts?{ silent?: boolean; }
opts.silent?boolean

Returns

Promise<{ flushed: number; }>


list()

ts
list(scope, opts?): Promise<readonly Message[]>;

Defined in: packages/sessions/src/facade.ts:84

Parameters

ParameterType
scopeSessionScope
opts?SessionListOptions

Returns

Promise&lt;readonly Message[]&gt;


push()

ts
push(scope, message): Promise<MessageRef>;

Defined in: packages/sessions/src/facade.ts:83

Parameters

ParameterType
scopeSessionScope
messageMessage

Returns

Promise&lt;MessageRef&gt;


ts
search(
   scope, 
   query, 
opts?): Promise<readonly MemoryHit<MemoryRecord>[]>;

Defined in: packages/sessions/src/facade.ts:85

Parameters

ParameterType
scopeSessionScope
querystring
opts?{ signal?: AbortSignal; topK?: number; }
opts.signal?AbortSignal
opts.topK?number

Returns

Promise<readonly MemoryHit&lt;MemoryRecord&gt;[]>