openclaw-memory-alibaba-mysql 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +37 -51
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,33 +1,36 @@
1
- # openclaw_memory_alibaba_mysql
1
+ # openclaw-memory-alibaba-mysql
2
2
 
3
- OpenClaw 记忆插件，使用阿里云 RDS MySQL 向量存储。用户记忆细分为 fact / preference / decision 三类；支持全文记忆与自我改进记忆，抽取方式可选 regex 或 llm。
3
+ OpenClaw 记忆插件，使用阿里云 RDS MySQL 做向量存储。支持用户记忆、全文对话记录、自进化记忆；可与 OpenClaw 的 before_agent_start / agent_end 配合，自动召回与自动落库。
4
4
 
5
- ## 记忆分类 (category)
5
+ ## 功能概览
6
6
 
7
- | 类型 | category | 说明 |
8
- |------|----------|------|
9
- | 用户事实 | `user_memory_fact` | 用户陈述的事实、习惯、身份信息等 |
10
- | 用户偏好 | `user_memory_preference` | 喜欢/不喜欢、偏好、意愿 |
11
- | 用户决策 | `user_memory_decision` | 已做的决定、打算、计划 |
7
+ - **用户记忆**：从对话中自动抽取事实、偏好、决策（如「喜欢寿司」「打算用 Python」），支持按向量检索并注入到每轮上下文。
8
+ - **全文记忆**：按消息来源分为用户、助手、系统、工具等 6 类，每类按会话保留一份，每轮更新；只存真实对话内容，不存系统注入的上下文块。
9
+ - **自进化记忆**：从对话中抽取学习要点、错误、需求等，可选参与召回。
10
+ - **冲突与去重**：可选用 LLM 判断新记忆与已有记忆是否矛盾或重复，避免重复、矛盾条目堆积。
11
+ - **时间衰减**：召回时可对旧记忆降权，让近期信息更突出。
12
+ - **工具**：提供 `memory_recall`（按查询搜记忆）、`memory_store`（显式写入）、`memory_forget`（删除）；若只依赖自动召回与自动抓取，可不给 agent 开放 recall/store，仅保留 forget 用于删除。
12
13
 
13
- - **自动抓取 (autoCapture)**：按 `memoryExtractionMethod` 用 regex 或 LLM 从用户/对话中抽取并写入。
14
- - **memory_store 工具**：可显式指定 `category`，默认 `user_memory_fact`。
15
- - **召回**：`before_agent_start` 与 `memory_recall` 统一按向量检索用户记忆（及可选 self_improving），注入上下文。
14
+ ## 记忆分类
16
15
 
17
- ---
16
+ | 类型 | 说明 |
17
+ |------|------|
18
+ | 用户事实 / 偏好 / 决策 | 从用户话里抽取的事实、喜好、决定，用于后续对话的上下文 |
19
+ | 全文·用户 / 助手 / 系统 / 工具 / 工具结果 / 其它 | 按消息角色分的完整对话记录，按会话维护、每轮更新 |
20
+ | 自进化（学习 / 错误 / 需求） | 从对话中抽取的可复用经验，可选参与召回 |
18
21
 
19
22
  ## 配置示例
20
23
 
21
- ### 最简配置（只接库 + 向量）
24
+ ### 最简配置
22
25
 
23
- 只配必填的 MySQL 和 Embedding，其它用默认：自动召回开、自动抓取关、不启用全文/自我改进/记忆衰减。
26
+ 只接 MySQL 和向量服务，其余用默认（自动召回 + 自动抓取用户记忆，不开启全文与自进化）：
24
27
 
25
28
  ```json
26
29
  {
27
30
  "plugins": {
28
- "slots": { "memory": "openclaw_memory_alibaba_mysql" },
31
+ "slots": { "memory": "openclaw-memory-alibaba-mysql" },
29
32
  "entries": {
30
- "openclaw_memory_alibaba_mysql": {
33
+ "openclaw-memory-alibaba-mysql": {
31
34
  "enabled": true,
32
35
  "config": {
33
36
  "mysql": {
@@ -50,16 +53,16 @@ OpenClaw 记忆插件，使用阿里云 RDS MySQL 向量存储。用户记忆细
50
53
  }
51
54
  ```
52
55
 
53
- ### 最全配置（功能全开）
56
+ ### 功能全开
54
57
 
55
- 显式写出 MySQL、Embedding、LLM、自动抓取/召回、全文记忆、自我改进、记忆衰减、相似度阈值、表名等，便于按需裁剪。
58
+ 开启全文记忆、自进化、LLM 抽取与冲突处理、时间衰减等：
56
59
 
57
60
  ```json
58
61
  {
59
62
  "plugins": {
60
- "slots": { "memory": "openclaw_memory_alibaba_mysql" },
63
+ "slots": { "memory": "openclaw-memory-alibaba-mysql" },
61
64
  "entries": {
62
- "openclaw_memory_alibaba_mysql": {
65
+ "openclaw-memory-alibaba-mysql": {
63
66
  "enabled": true,
64
67
  "config": {
65
68
  "mysql": {
@@ -89,7 +92,7 @@ OpenClaw 记忆插件，使用阿里云 RDS MySQL 向量存储。用户记忆细
89
92
  "memoryExtractionMethod": "llm",
90
93
  "autoRecall": true,
91
94
  "autoCapture": true,
92
- "captureMaxChars": 500,
95
+ "captureMaxChars": 5000,
93
96
  "enableMemoryDecay": true,
94
97
  "tableName": "openclaw_memories"
95
98
  }
@@ -99,38 +102,21 @@ OpenClaw 记忆插件，使用阿里云 RDS MySQL 向量存储。用户记忆细
99
102
  }
100
103
  ```
101
104
 
102
- **配置要点**
105
+ **常用配置说明**
103
106
 
104
- - **必填**：`mysql`（host / user / password / database 等）、`embedding`（apiKey、model）。
105
- - **memoryExtractionMethod**：`"regex"` 或 `"llm"`，对 user_memory_* 与 self_improving_* 同时生效；选 `"llm"` 需配 `llm`。
106
- - **enableFullContextMemory** / **enableSelfImprovingMemory**：开启后可写全文记忆、自我改进记忆；全文记忆不参与常规召回。
107
- - **memory_duplication_conflict_process**：为 true 时用 LLM 做写入前去重/冲突判断，需配 `llm`。
108
- - **enableMemoryDecay**：为 true 时对召回结果做时间衰减（半衰期与策略使用内置默认：30 天、指数衰减）。
109
-
110
- ---
107
+ - **mysql** / **embedding**：必填，用于连接数据库与生成向量。
108
+ - **llm**：使用「LLM 抽取」或「冲突/去重」时必填。
109
+ - **memoryExtractionMethod**：`"llm"`（默认）或 `"regex"`，控制如何从对话里抽取用户记忆与自改进记忆。
110
+ - **enableFullContextMemory**：是否按角色保存全文对话（每会话每类一份，每轮更新）。
111
+ - **enableSelfImprovingMemory**：是否启用自进化记忆的写入与召回。
112
+ - **memory_duplication_conflict_process**：是否用 LLM 做写入前的去重与矛盾判断。
113
+ - **captureMaxChars**：单条记忆与全文截断的最大字符数，建议 5000 以保留完整当轮对话。
114
+ - **enableMemoryDecay**：召回时是否对旧记忆做时间衰减（近期记忆权重更高）。
115
+ - **tableName**：存储表名，默认 `openclaw_memories`。
111
116
 
112
117
  ## 环境变量
113
118
 
114
- - `MYSQL_HOST`, `MYSQL_USER`, `MYSQL_PASSWORD`：MySQL 连接（或在 config 里写死，password 支持 `${VAR}`）。
115
- - `DASHSCOPE_API_KEY`：DashScope 用于 embedding（若 apiKey 使用 `${DASHSCOPE_API_KEY}`）。
116
-
117
- ---
118
-
119
- ## 测试
120
-
121
- ```bash
122
- export MYSQL_HOST=your-host MYSQL_PASSWORD=xxx DASHSCOPE_API_KEY=xxx
123
- npx tsx test-agent-isolation.ts
124
- npx tsx test-three-memory-types.ts
125
- npx tsx test-full-context-memory.ts
126
- ```
127
-
128
- ---
129
-
130
- ## 文件说明
119
+ 配置中可使用占位符引用环境变量，例如 `${MYSQL_PASSWORD}`、`${DASHSCOPE_API_KEY}`。常见需要准备的有：
131
120
 
132
- - `categories.ts`：常量与类型（user_memory_*、self_improving_*、full_context_memory）。
133
- - `config.ts`：配置解析与默认值。
134
- - `db.ts`：MemoryDB 建表、store、search、softDelete（向量 COSINE）。
135
- - `index.ts`：插件注册、memory_recall / memory_store / memory_forget、before_agent_start / agent_end。
136
- - `prompts.ts`：用户记忆与 self_improving 的 LLM 抽取 Prompt。
121
+ - **MYSQL_HOST**, **MYSQL_USER**, **MYSQL_PASSWORD**：MySQL 连接信息。
122
+ - **DASHSCOPE_API_KEY**：DashScope API Key，用于 embedding（以及 LLM 若使用 DashScope）。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "openclaw-memory-alibaba-mysql",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "OpenClaw memory plugin using Alibaba Cloud RDS MySQL vector storage",
5
5
  "type": "module",
6
6
  "license": "MIT",