API Reference
Quick Overview
typescript
import { createMnemo } from '@mnemoai/core';
const mnemo = await createMnemo(config);
await mnemo.store({ text: '...', category: 'fact' });
const results = await mnemo.recall('query');
await mnemo.delete('memory-id');
const stats = await mnemo.stats();
await mnemo.close();Methods
| Method | Description |
|---|---|
createMnemo(config) | Create a Mnemo instance |
mnemo.store(entry) | Store a memory |
mnemo.recall(query, options?) | Recall memories by semantic search |
mnemo.delete(id) | Delete a memory |
mnemo.stats() | Get memory statistics |
mnemo.close() | Close and release resources |
Types
| Type | Description |
|---|---|
MnemoConfig | Configuration for createMnemo() |
MnemoInstance | The instance returned by createMnemo() |
MemoryCategory | Union type for memory categories |
StorageBackend | Union type for storage backends |
Advanced Exports
For advanced use cases, the package also exports:
typescript
import { MemoryStore } from '@mnemoai/core'; // Low-level store
import { registerAdapter } from '@mnemoai/core'; // Custom backends
import { log, setLogger } from '@mnemoai/core'; // Logger
import type { StorageAdapter } from '@mnemoai/core'; // Adapter interface