Files
mai-bot/plugins/A_memorix/QUICK_START.md
DawnARC 71b3a828c6 添加 A_Memorix 插件 v2.0.0(包含运行时与文档)
引入 A_Memorix 插件 v2.0.0:新增大量运行时组件、存储/模式更新、检索能力提升、管理工具、导入/调优工作流以及相关文档。关键新增内容包括:lifecycle_orchestrator、SDKMemoryKernel/运行时初始化器、新的存储层与 metadata_store 变更(SCHEMA_VERSION v8)、检索增强(双路径检索、图关系召回、稀疏 BM25),以及多种工具服务(episode/person_profile/relation/segmentation/tuning/search execution)。同时新增 Web 导入/摘要导入器及大量维护脚本。还更新了插件清单、embedding API 适配器、plugin.py、requirements/pyproject,以及主入口文件,使新插件接入项目。该变更为 2.0.0 版本发布做好准备,实现统一的 SDK Tool 接口并扩展整体运行能力。
2026-03-19 00:09:04 +08:00

4.2 KiB
Raw Blame History

A_Memorix Quick Start (v2.0.0)

本文档面向当前 2.0.0 架构SDK Tool 接口)。

0. 版本与接口变更

  • 当前插件版本:2.0.0
  • 接口形态:memory_provider + Tool 调用
  • 旧版 slash 命令(如 /query/memory/visualize)不再作为本分支主文档入口

1. 环境准备

  • Python 3.10+
  • 与 MaiBot 主程序相同的运行环境
  • 可访问你配置的 embedding 服务

安装依赖:

pip install -r plugins/A_memorix/requirements.txt --upgrade

如果当前目录就是插件目录,也可以:

pip install -r requirements.txt --upgrade

2. 启用插件

在主程序插件配置中启用 A_Memorix

若你使用 plugins/A_memorix/config.toml 方式,最小示例:

[plugin]
enabled = true

[storage]
data_dir = "./data"

[embedding]
model_name = "auto"
dimension = 1024
batch_size = 32
max_concurrent = 5
quantization_type = "int8"

3. 运行时自检(强烈建议)

先确认 embedding 实际输出维度与向量库兼容:

python plugins/A_memorix/scripts/runtime_self_check.py --json

如果结果 ok=false,先修复 embedding 配置或向量库,再继续导入。

4. 导入数据

4.1 文本批量导入

把文本放到:

plugins/A_memorix/data/raw/

执行:

python plugins/A_memorix/scripts/process_knowledge.py

常用参数:

python plugins/A_memorix/scripts/process_knowledge.py --force
python plugins/A_memorix/scripts/process_knowledge.py --chat-log
python plugins/A_memorix/scripts/process_knowledge.py --chat-log --chat-reference-time "2026/02/12 10:30"

4.2 其他导入脚本

python plugins/A_memorix/scripts/import_lpmm_json.py <json文件或目录>
python plugins/A_memorix/scripts/convert_lpmm.py -i <lpmm数据目录> -o plugins/A_memorix/data
python plugins/A_memorix/scripts/migrate_chat_history.py --help
python plugins/A_memorix/scripts/migrate_maibot_memory.py --help
python plugins/A_memorix/scripts/migrate_person_memory_points.py --help

5. 核心 Tool 调用

5.1 检索

{
  "tool": "search_memory",
  "arguments": {
    "query": "项目复盘",
    "mode": "aggregate",
    "limit": 5,
    "chat_id": "group:dev"
  }
}

mode 支持:search/time/hybrid/episode/aggregate

5.2 写入摘要

{
  "tool": "ingest_summary",
  "arguments": {
    "external_id": "chat_summary:group-dev:2026-03-18",
    "chat_id": "group:dev",
    "text": "今天完成了检索调优评审"
  }
}

5.3 写入普通记忆

{
  "tool": "ingest_text",
  "arguments": {
    "external_id": "note:2026-03-18:001",
    "source_type": "note",
    "text": "模型切换后召回质量更稳定",
    "chat_id": "group:dev",
    "tags": ["worklog"]
  }
}

5.4 画像与维护

{
  "tool": "get_person_profile",
  "arguments": {
    "person_id": "Alice",
    "limit": 8
  }
}
{
  "tool": "maintain_memory",
  "arguments": {
    "action": "protect",
    "target": "模型切换后召回质量更稳定",
    "hours": 24
  }
}
{
  "tool": "memory_stats",
  "arguments": {}
}

6. 管理 Tool进阶

2.0.0 提供完整管理工具:

  • memory_graph_admin
  • memory_source_admin
  • memory_episode_admin
  • memory_profile_admin
  • memory_runtime_admin
  • memory_import_admin
  • memory_tuning_admin
  • memory_v5_admin
  • memory_delete_admin

可先用 action=list / action=status 等只读动作验证链路。

7. 常见问题

Q1: 检索为空

  1. 先看 memory_stats 是否有段落/关系
  2. 检查 chat_idperson_id 过滤条件是否过严
  3. 运行 runtime_self_check.py --json 确认 embedding 维度无误

Q2: 启动时报向量维度不一致

  • 原因:现有向量库维度与当前 embedding 输出不一致
  • 处理:恢复原配置或重建向量数据后再启动

Q3: Web 页面打不开

本分支不内置独立 server.py

  • web/index.htmlweb/import.htmlweb/tuning.html 由宿主侧路由/API 集成暴露
  • 请检查宿主是否已映射对应静态页与 /api/* 接口

8. 下一步