IMemoryInstance

Interface for memory instance implementations. Defines the contract for local, persist, and dummy backends.

Methods

waitForInit

waitForInit: (initial: boolean) => Promise<void>
Copy

Initialize the memory instance.

writeMemory

writeMemory: <T extends object = object>(memoryId: string, value: T, description: string, when: Date) => Promise<void>
Copy

Write a value to memory.

searchMemory

searchMemory: <T extends object = object>(query: string, when: Date, settings?: SearchSettings) => Promise<{ memoryId: string; score: number; content: T; }[]>
Copy

Search memory using BM25 full-text scoring. Filters out entries whose when is greater than the requested when.

listMemory

listMemory: <T extends object = object>(when: Date) => Promise<{ memoryId: string; content: T; }[]>
Copy

List all entries in memory. Filters out entries whose when is greater than the requested when.

removeMemory

removeMemory: (memoryId: string, when: Date) => Promise<void>
Copy

Remove an entry from memory.

readMemory

readMemory: <T extends object = object>(memoryId: string, when: Date) => Promise<T>
Copy

Read a single entry from memory. Behaves as not-found if the stored when is greater than the requested when.

dispose

dispose: () => void
Copy

Releases any resources held by this instance.