main
md 53 lines 2.11 KB
Rendered Raw
1 # Memory
2
3 Provide persistent vector-based memory and knowledge retrieval for Agent Zero.
4
5 ## What It Does
6
7 This plugin stores memories and knowledge embeddings in a FAISS-backed vector database, exposes tools for saving and recalling memories, and provides APIs and UI support for browsing, importing, updating, and deleting memory entries.
8
9 ## Main Behavior
10
11 - **Persistent vector store**
12 - Creates and loads FAISS indexes per memory subdirectory.
13 - Stores embedding metadata so the index can be rebuilt if the embedding model changes.
14 - **Knowledge preloading**
15 - Loads configured knowledge directories into memory when a database is initialized.
16 - **Memory tools**
17 - Includes tools for saving, loading, deleting, forgetting, and behavior adjustment workflows.
18 - **Automatic conversation memory**
19 - Stores durable preferences, project facts, and recurring constraints while filtering transient action-history fragments before insertion.
20 - **Dashboard APIs**
21 - Exposes search, delete, bulk delete, update, and subdirectory listing endpoints for the memory dashboard.
22 - **Scoped storage**
23 - Supports different memory subdirectories so memory can be separated by context or agent scope.
24
25 ## Key Files
26
27 - **Core memory engine**
28 - `helpers/memory.py` implements FAISS storage, index loading, embedding configuration, and knowledge preload.
29 - **Knowledge import**
30 - `helpers/knowledge_import.py` imports external knowledge into memory storage.
31 - **Consolidation**
32 - `helpers/memory_consolidation.py` contains memory consolidation logic.
33 - **Tools**
34 - `tools/memory_save.py`
35 - `tools/memory_load.py`
36 - `tools/memory_delete.py`
37 - `tools/memory_forget.py`
38 - `tools/behaviour_adjustment.py`
39 - **API**
40 - `api/memory_dashboard.py` powers the memory management dashboard.
41 - `api/import_knowledge.py` and `api/knowledge_reindex.py` handle knowledge import and reindexing.
42
43 ## Configuration Scope
44
45 - **Settings section**: `agent`
46 - **Per-project config**: `true`
47 - **Per-agent config**: `true`
48
49 ## Plugin Metadata
50
51 - **Name**: `_memory`
52 - **Title**: `Memory`
53 - **Description**: Provides persistent memory capabilities to Agent Zero agents.