Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/memory / / EpisodicMemory
Class: EpisodicMemory
Defined in: packages/memory/src/tiers/episodic-memory.ts:69
EpisodicMemory — record + retrieve summarized stretches of past activity. Stored embeddings power triple-signal retrieval (recency × relevance × importance).
Stable
Constructors
Constructor
new EpisodicMemory(args): EpisodicMemory;Defined in: packages/memory/src/tiers/episodic-memory.ts:75
Parameters
| Parameter | Type |
|---|---|
args | { embedder: | EmbedderProvider | null; embedderIdProvider: () => string | null; store: MemoryStoreAdapter; tracer: Tracer; } |
args.embedder | | EmbedderProvider | null |
args.embedderIdProvider | () => string | null |
args.store | MemoryStoreAdapter |
args.tracer | Tracer |
Returns
EpisodicMemory
Methods
archive()
archive(
scope,
episodeId,
reason?): Promise<void>;Defined in: packages/memory/src/tiers/episodic-memory.ts:184
Soft-archive an episode. Storage adapters that implement EpisodicMemoryStoreExt.archive(...) mark the row archived in place. Adapters that do not expose the extension surface a friendly TypeError so the operator can opt the storage layer in (or call episodic.put(...) with the archived state set manually).
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
episodeId | string |
reason? | string |
Returns
Promise<void>
get()
get(id): Promise<Episode | null>;Defined in: packages/memory/src/tiers/episodic-memory.ts:134
Lookup a single episode by id.
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<Episode | null>
recent()
recent(scope, opts?): Promise<readonly Episode[]>;Defined in: packages/memory/src/tiers/episodic-memory.ts:203
List the most recent episodes (no embedding required).
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
opts | { topK?: number; } |
opts.topK? | number |
Returns
Promise<readonly Episode[]>
record()
record(scope, input): Promise<Episode>;Defined in: packages/memory/src/tiers/episodic-memory.ts:88
Persist an episode + its embedding (when an embedder is configured).
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
input | EpisodeInput |
Returns
Promise<Episode>
search()
search(
scope,
query,
opts?): Promise<readonly MemoryHit<Episode>[]>;Defined in: packages/memory/src/tiers/episodic-memory.ts:145
Triple-signal episode retrieval (recency × relevance × importance). The vector signal is computed on demand when an embedder is configured AND the storage adapter exposes searchVector; otherwise the FTS5 BM25 score is fed into the relevance term as a normalized fallback.
Parameters
| Parameter | Type |
|---|---|
scope | SessionScope |
query | string |
opts | EpisodeSearchOptions |