vrr/agent-zero
2
0
Fork 0
mirror of https://github.com/agent0ai/agent-zero.git synced 2026-07-09 17:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
agent-zero/plugins/_memory
History
frdel e138e33ca9 Add file-level DOX docs & update AGENTS indexes 
Add comprehensive file-level DOX documentation across the repo and update directory AGENTS.md indexes. Many new `*.py.dox.md` files were added under api, helpers, tools, plugins, extensions, webui, and other dirs to document endpoint purpose, ownership, runtime contracts, work guidance, and verification. Several AGENTS.md files were created or updated (agents profiles, api, docker, extensions, helpers, plugins, skills, webui components, etc.) to list child DOX files and clarify documentation/work guidance. Also add example and bundled profile DOX files (agent0, default, developer, hacker, researcher) and minor updates to helpers/dirty_json.py and its tests. These changes improve on-disk documentation coverage and establish the convention that each direct runtime file should have a matching `*.dox.md` describing its contracts and verification steps.
2026-06-08 12:41:53 +02:00
..
api Refactor: use user locale for time displays 2026-05-21 15:26:00 +02:00
extensions Improve auto-memory extraction quality 2026-06-02 09:42:47 +02:00
helpers Improve auto-memory extraction quality 2026-06-02 09:42:47 +02:00
prompts Guide memory staleness with timestamps 2026-06-02 11:13:41 +02:00
tools fix: make memory cleanup update stale fragments 2026-05-11 11:51:58 +02:00
webui Refactor: use user locale for time displays 2026-05-21 15:26:00 +02:00
AGENTS.md Add file-level DOX docs & update AGENTS indexes 2026-06-08 12:41:53 +02:00
default_config.yaml refactor - plugin names and builtin plugins 2026-03-10 22:20:53 +01:00
plugin.yaml refactor - plugin names and builtin plugins 2026-03-10 22:20:53 +01:00
README.md Improve auto-memory extraction quality 2026-06-02 09:42:47 +02:00

README.md

Memory

Provide persistent vector-based memory and knowledge retrieval for Agent Zero.

What It Does

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.

Main Behavior

  • Persistent vector store
    • Creates and loads FAISS indexes per memory subdirectory.
    • Stores embedding metadata so the index can be rebuilt if the embedding model changes.
  • Knowledge preloading
    • Loads configured knowledge directories into memory when a database is initialized.
  • Memory tools
    • Includes tools for saving, loading, deleting, forgetting, and behavior adjustment workflows.
  • Automatic conversation memory
    • Stores durable preferences, project facts, and recurring constraints while filtering transient action-history fragments before insertion.
  • Dashboard APIs
    • Exposes search, delete, bulk delete, update, and subdirectory listing endpoints for the memory dashboard.
  • Scoped storage
    • Supports different memory subdirectories so memory can be separated by context or agent scope.

Key Files

  • Core memory engine
    • helpers/memory.py implements FAISS storage, index loading, embedding configuration, and knowledge preload.
  • Knowledge import
    • helpers/knowledge_import.py imports external knowledge into memory storage.
  • Consolidation
    • helpers/memory_consolidation.py contains memory consolidation logic.
  • Tools
    • tools/memory_save.py
    • tools/memory_load.py
    • tools/memory_delete.py
    • tools/memory_forget.py
    • tools/behaviour_adjustment.py
  • API
    • api/memory_dashboard.py powers the memory management dashboard.
    • api/import_knowledge.py and api/knowledge_reindex.py handle knowledge import and reindexing.

Configuration Scope

  • Settings section: agent
  • Per-project config: true
  • Per-agent config: true

Plugin Metadata

  • Name: _memory
  • Title: Memory
  • Description: Provides persistent memory capabilities to Agent Zero agents.