forked from Zakaria/hermes-agent
41 lines
1.0 KiB
Markdown
41 lines
1.0 KiB
Markdown
# RetainDB Memory Provider
|
|
|
|
Cloud memory API with hybrid search (Vector + BM25 + Reranking) and 7 memory types.
|
|
|
|
## Requirements
|
|
|
|
- RetainDB account ($20/month) from [retaindb.com](https://www.retaindb.com)
|
|
- `pip install requests`
|
|
|
|
## Setup
|
|
|
|
```bash
|
|
hermes memory setup # select "retaindb"
|
|
```
|
|
|
|
Or manually:
|
|
```bash
|
|
hermes config set memory.provider retaindb
|
|
echo "RETAINDB_API_KEY=your-key" >> ~/.hermes/.env
|
|
```
|
|
|
|
## Config
|
|
|
|
All config via environment variables in `.env`:
|
|
|
|
| Env Var | Default | Description |
|
|
|---------|---------|-------------|
|
|
| `RETAINDB_API_KEY` | (required) | API key |
|
|
| `RETAINDB_BASE_URL` | `https://api.retaindb.com` | API endpoint |
|
|
| `RETAINDB_PROJECT` | auto (profile-scoped) | Project identifier |
|
|
|
|
## Tools
|
|
|
|
| Tool | Description |
|
|
|------|-------------|
|
|
| `retaindb_profile` | User's stable profile |
|
|
| `retaindb_search` | Semantic search |
|
|
| `retaindb_context` | Task-relevant context |
|
|
| `retaindb_remember` | Store a fact with type + importance |
|
|
| `retaindb_forget` | Delete a memory by ID |
|