@chen_hu_hu/pi-qq 1.1.0 → 1.2.2
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.
- package/README-zh.md +123 -0
- package/README.md +43 -30
- package/doc/features-v1.md +50 -50
- package/doc/features-v2.md +132 -19
- package/doc/plan-v1.md +19 -19
- package/doc/plan-v2.md +100 -13
- package/index.ts +17 -9
- package/package.json +4 -1
- package/src/bot.ts +5 -3
- package/src/files.ts +162 -39
- package/src/inbound.ts +46 -9
- package/src/run-feedback.ts +5 -0
package/README-zh.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# pi-qq
|
|
2
|
+
|
|
3
|
+
[English](./README.md) | 简体中文
|
|
4
|
+
|
|
5
|
+
将 [pi](https://github.com/earendil-works/pi) 接入 QQ 私聊。在手机 QQ 上发送文字、语音、图片或文件,pi 在你的电脑上工作,并把结果发回 QQ。
|
|
6
|
+
|
|
7
|
+
## 安装
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pi install npm:@chen_hu_hu/pi-qq
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
本地开发:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pi --extension /path/to/pi-qq
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## 登录
|
|
20
|
+
|
|
21
|
+
1. 启动 pi。
|
|
22
|
+
2. 执行 `/qq-login`。
|
|
23
|
+
3. 用手机 QQ 扫描二维码。
|
|
24
|
+
|
|
25
|
+
登录凭据只保存在进程内存中。重启 pi 后需要重新扫码。`/qq-logout` 会立即清除内存中的凭据。
|
|
26
|
+
|
|
27
|
+
## 使用
|
|
28
|
+
|
|
29
|
+
给机器人发送 QQ 私聊消息即可开始任务。
|
|
30
|
+
|
|
31
|
+
- **文字**:普通聊天消息。
|
|
32
|
+
- **语音**:直接使用 QQ 内置 ASR 文本;音频不会下载或保存。如果 ASR 没有返回文本,机器人会提示你重发或改用文字。
|
|
33
|
+
- **图片**:作为视觉输入交给 pi。
|
|
34
|
+
- **文件**:保存到当前工作区的 `.pi/pi-qq/<sessionId>/uploads/`,并等待你的下一条指令。
|
|
35
|
+
|
|
36
|
+
### 文件
|
|
37
|
+
|
|
38
|
+
**只发送文件不会启动 pi。** 文件会先保存,pi 等待下一条文字或语音指令后再处理。
|
|
39
|
+
|
|
40
|
+
- 先上传一个或多个文件,再发送文字或语音说明要做什么。
|
|
41
|
+
- 下一条文字/语音会作为指令;保存路径、文件大小和原始文件名会加入该提示词。
|
|
42
|
+
- 指令到达前上传的多个文件会合并到同一个提示词中。
|
|
43
|
+
- `/new` 会清空等待指令的文件。
|
|
44
|
+
- 文件按当前 pi 会话隔离。相同文件名且内容相同会复用已有文件;相同文件名但内容不同会保存为 `name-1.ext`;不同文件名但内容相同会分别保存。
|
|
45
|
+
|
|
46
|
+
pi 看到的文件提示词示例:
|
|
47
|
+
|
|
48
|
+
```text
|
|
49
|
+
User sent the following file via QQ (saved locally; use read/bash or other tools to access it):
|
|
50
|
+
- /home/chen/project/myproj/.pi/pi-qq/<sessionId>/uploads/report.pdf (1.4MB, original name: report.pdf)
|
|
51
|
+
|
|
52
|
+
User message:
|
|
53
|
+
Summarize this file.
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### 语音消息
|
|
57
|
+
|
|
58
|
+
语音消息使用 QQ 内置 ASR(`asr_refer_text`)。转写文本会作为普通用户文本交给 pi;pi 不会收到音频文件。
|
|
59
|
+
|
|
60
|
+
- 语音附件不会下载或保存为 `.amr` / `.silk`。
|
|
61
|
+
- 不使用本地或外部语音识别服务。
|
|
62
|
+
- 如果 QQ ASR 没有返回文本,机器人会回复 `Could not transcribe this voice message; please resend or type it.`,并且不会启动 pi。
|
|
63
|
+
- 语音和文字是两条独立的 QQ 消息;需要时按顺序发送。
|
|
64
|
+
- 要查看原始 ASR 结果,可将 `logLevel` 设为 `debug`;日志会包含 `asr_refer_text` 和附件元数据。
|
|
65
|
+
|
|
66
|
+
## 命令
|
|
67
|
+
|
|
68
|
+
在 pi 终端执行:
|
|
69
|
+
|
|
70
|
+
| 命令 | 说明 |
|
|
71
|
+
| -------------------- | -------------------------------------- |
|
|
72
|
+
| `/qq-login` | 扫码登录并绑定扫码的 QQ 用户 |
|
|
73
|
+
| `/qq-status` | 显示登录、连接、模型、上下文和绑定用户 |
|
|
74
|
+
| `/qq-logout` | 退出登录并清除内存中的凭据 |
|
|
75
|
+
| `/qq-test-budget` | 显示被动回复额度和流式气泡诊断信息 |
|
|
76
|
+
| `/qq-test-md [text]` | 发送 Markdown 测试消息 |
|
|
77
|
+
| `/qq-test-stream` | 运行流式时间线诊断 |
|
|
78
|
+
| `/qq-new` | 重置当前会话(由 QQ 侧 `/new` 调用) |
|
|
79
|
+
|
|
80
|
+
QQ 侧命令:
|
|
81
|
+
|
|
82
|
+
| 命令 | 说明 |
|
|
83
|
+
| ---------- | -------------------- |
|
|
84
|
+
| `/new` | 开始新的 pi 会话 |
|
|
85
|
+
| `/stop` | 中止当前运行 |
|
|
86
|
+
| `/compact` | 压缩当前上下文 |
|
|
87
|
+
| `/status` | 显示会话和上下文状态 |
|
|
88
|
+
| `/help` | 显示命令帮助 |
|
|
89
|
+
|
|
90
|
+
## 设置
|
|
91
|
+
|
|
92
|
+
创建 `~/.pi/agent/pi-qq.json` 覆盖默认值。该文件只保存设置;凭据不会写入其中。
|
|
93
|
+
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"markdownSupport": false,
|
|
97
|
+
"streamFlushMs": 10000,
|
|
98
|
+
"logLevel": "silent"
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
| 配置项 | 默认值 | 说明 |
|
|
103
|
+
| ---------------------- | ---------- | ------------------------------------------------------ |
|
|
104
|
+
| `streamAssistant` | `true` | 流式回传 assistant 回复 |
|
|
105
|
+
| `markdownSupport` | `false` | 机器人有 QQ Markdown 权限;设为 `true` 时透传 Markdown |
|
|
106
|
+
| `deliverAs` | `"steer"` | 忙碌时新消息的排队方式:`steer` 或 `followUp` |
|
|
107
|
+
| `imageMaxSize` | `10485760` | QQ 图片下载上限(字节,10MB) |
|
|
108
|
+
| `fileMaxSize` | `52428800` | QQ 文件下载上限(字节,50MB) |
|
|
109
|
+
| `heartbeatMinutes` | `10` | 长任务心跳间隔;`0` 表示关闭 |
|
|
110
|
+
| `heartbeatMaxMessages` | `3` | 每次运行的消息心跳上限 |
|
|
111
|
+
| `streamRelay` | `true` | 使用 append 模式流式气泡 |
|
|
112
|
+
| `streamFlushMs` | `10000` | 流式汇总帧间隔(毫秒,最小 300) |
|
|
113
|
+
| `logLevel` | `"silent"` | 日志阈值:`silent`、`error`、`warn`、`info` 或 `debug` |
|
|
114
|
+
|
|
115
|
+
启用日志后,日志写入 `<cwd>/.pi/pi-qq/logs/pi-qq-YYYY-MM-DD.log`。可用 `PI_QQ_LOG_DIR` 覆盖目录。`info` 只记录元数据;`debug` 记录完整事件、附件、提示词和工具参数/结果。旧配置 `debug: true` 会映射为 `logLevel: "debug"`。
|
|
116
|
+
|
|
117
|
+
## 说明
|
|
118
|
+
|
|
119
|
+
- 仅支持 C2C(QQ 私聊)。
|
|
120
|
+
- 只有 QQ 入站消息触发的任务才会回传 QQ;在 pi 侧直接发起的任务只在本地处理,不推送 QQ。
|
|
121
|
+
- 收到的图片会作为视觉输入传给模型;当前模型必须支持图片输入。
|
|
122
|
+
- 保存的文件位于工作区 `.pi/` 下;如有需要,请把 `.pi/` 加入你自己的项目 `.gitignore`。
|
|
123
|
+
- QQ 对每条入站消息的被动回复次数有限制。可用 `/qq-test-budget` 查看本地额度。
|
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# pi-qq
|
|
2
2
|
|
|
3
|
+
[English](./README.md) | [简体中文](./README-zh.md)
|
|
4
|
+
|
|
3
5
|
Connect [pi](https://github.com/earendil-works/pi) to a QQ private chat. Send text, voice, images, or files from mobile QQ; pi works on your machine and sends the result back to QQ.
|
|
4
6
|
|
|
5
7
|
## Install
|
|
@@ -29,13 +31,23 @@ Send a QQ private message to the bot to start a task.
|
|
|
29
31
|
- **Text**: normal chat message.
|
|
30
32
|
- **Voice**: QQ built-in ASR text is sent to pi directly; the audio is not downloaded or saved. If ASR returns no text, the bot asks you to resend or type it.
|
|
31
33
|
- **Images**: sent to pi as vision input.
|
|
32
|
-
- **Files**: saved under the current workspace at `.pi/pi-qq
|
|
34
|
+
- **Files**: saved under the current workspace at `.pi/pi-qq/<sessionId>/uploads/` and wait for your next instruction.
|
|
35
|
+
|
|
36
|
+
### Files
|
|
37
|
+
|
|
38
|
+
A file-only message does **not** start pi. The file is saved, and pi waits for your next text or voice instruction before processing it.
|
|
39
|
+
|
|
40
|
+
- Upload one or more files, then send a text or voice message describing what to do.
|
|
41
|
+
- The next text/voice message is used as the instruction; the saved path(s), size, and original filename are added to that prompt.
|
|
42
|
+
- Multiple files uploaded before the instruction are combined into one prompt.
|
|
43
|
+
- `/new` clears files waiting for an instruction.
|
|
44
|
+
- Uploads are scoped to the current pi session. If you upload the same filename with identical content, pi reuses the existing file; the same filename with different content is saved as `name-1.ext`; different filenames with identical content are kept as separate files.
|
|
33
45
|
|
|
34
46
|
Example file prompt seen by pi:
|
|
35
47
|
|
|
36
48
|
```text
|
|
37
49
|
User sent the following file via QQ (saved locally; use read/bash or other tools to access it):
|
|
38
|
-
- /home/chen/project/myproj/.pi/pi-qq/
|
|
50
|
+
- /home/chen/project/myproj/.pi/pi-qq/<sessionId>/uploads/report.pdf (1.4MB, original name: report.pdf)
|
|
39
51
|
|
|
40
52
|
User message:
|
|
41
53
|
Summarize this file.
|
|
@@ -55,25 +67,25 @@ Voice messages use QQ's built-in ASR (`asr_refer_text`). The transcript is sent
|
|
|
55
67
|
|
|
56
68
|
Run these in the pi terminal:
|
|
57
69
|
|
|
58
|
-
| Command
|
|
59
|
-
|
|
|
60
|
-
| `/qq-login`
|
|
61
|
-
| `/qq-status`
|
|
62
|
-
| `/qq-logout`
|
|
63
|
-
| `/qq-test-budget`
|
|
64
|
-
| `/qq-test-md [text]` | Send a Markdown test message
|
|
65
|
-
| `/qq-test-stream`
|
|
66
|
-
| `/qq-new`
|
|
70
|
+
| Command | Description |
|
|
71
|
+
| -------------------- | ------------------------------------------------------- |
|
|
72
|
+
| `/qq-login` | Log in with a QR code and bind the scanning QQ user |
|
|
73
|
+
| `/qq-status` | Show login, connection, model, context, and bound user |
|
|
74
|
+
| `/qq-logout` | Log out and clear in-memory credentials |
|
|
75
|
+
| `/qq-test-budget` | Show passive-reply budget and stream-bubble diagnostics |
|
|
76
|
+
| `/qq-test-md [text]` | Send a Markdown test message |
|
|
77
|
+
| `/qq-test-stream` | Run a streamed timeline diagnostic |
|
|
78
|
+
| `/qq-new` | Reset the current session (used by QQ `/new`) |
|
|
67
79
|
|
|
68
80
|
QQ-side commands:
|
|
69
81
|
|
|
70
|
-
| Command
|
|
71
|
-
|
|
|
72
|
-
| `/new`
|
|
73
|
-
| `/stop`
|
|
74
|
-
| `/compact` | Compact the current context
|
|
75
|
-
| `/status`
|
|
76
|
-
| `/help`
|
|
82
|
+
| Command | Description |
|
|
83
|
+
| ---------- | ------------------------------- |
|
|
84
|
+
| `/new` | Start a new pi session |
|
|
85
|
+
| `/stop` | Abort the current run |
|
|
86
|
+
| `/compact` | Compact the current context |
|
|
87
|
+
| `/status` | Show session and context status |
|
|
88
|
+
| `/help` | Show command help |
|
|
77
89
|
|
|
78
90
|
## Settings
|
|
79
91
|
|
|
@@ -87,24 +99,25 @@ Create `~/.pi/agent/pi-qq.json` to override defaults. This file contains setting
|
|
|
87
99
|
}
|
|
88
100
|
```
|
|
89
101
|
|
|
90
|
-
| Key
|
|
91
|
-
|
|
|
92
|
-
| `streamAssistant`
|
|
93
|
-
| `markdownSupport`
|
|
94
|
-
| `deliverAs`
|
|
95
|
-
| `imageMaxSize`
|
|
96
|
-
| `fileMaxSize`
|
|
97
|
-
| `heartbeatMinutes`
|
|
98
|
-
| `heartbeatMaxMessages` | `3`
|
|
99
|
-
| `streamRelay`
|
|
100
|
-
| `streamFlushMs`
|
|
101
|
-
| `logLevel`
|
|
102
|
+
| Key | Default | Description |
|
|
103
|
+
| ---------------------- | ---------- | ------------------------------------------------------------ |
|
|
104
|
+
| `streamAssistant` | `true` | Stream assistant replies |
|
|
105
|
+
| `markdownSupport` | `false` | Bot has QQ Markdown permission; pass Markdown through |
|
|
106
|
+
| `deliverAs` | `"steer"` | Queue new messages while busy: `steer` or `followUp` |
|
|
107
|
+
| `imageMaxSize` | `10485760` | QQ image download limit in bytes (10MB) |
|
|
108
|
+
| `fileMaxSize` | `52428800` | QQ file download limit in bytes (50MB) |
|
|
109
|
+
| `heartbeatMinutes` | `10` | Long-task heartbeat interval; `0` disables |
|
|
110
|
+
| `heartbeatMaxMessages` | `3` | Per-run message heartbeat limit |
|
|
111
|
+
| `streamRelay` | `true` | Use append-mode stream bubbles |
|
|
112
|
+
| `streamFlushMs` | `10000` | Stream summary frame interval in ms (minimum 300) |
|
|
113
|
+
| `logLevel` | `"silent"` | Log threshold: `silent`, `error`, `warn`, `info`, or `debug` |
|
|
102
114
|
|
|
103
115
|
When enabled, logs are written to `<cwd>/.pi/pi-qq/logs/pi-qq-YYYY-MM-DD.log`. `PI_QQ_LOG_DIR` overrides the directory. `info` records metadata only; `debug` records full events, attachments, prompts, and tool payloads. Legacy `debug: true` maps to `logLevel: "debug"`.
|
|
104
116
|
|
|
105
117
|
## Notes
|
|
106
118
|
|
|
107
119
|
- Only C2C (QQ private chat) is supported.
|
|
120
|
+
- Only runs triggered by inbound QQ messages are relayed to QQ. Tasks started directly in pi stay local.
|
|
108
121
|
- Incoming images are passed to the model as vision input; the current model must support image input.
|
|
109
122
|
- Saved files are workspace-local under `.pi/`; add `.pi/` to your own project `.gitignore` if needed.
|
|
110
123
|
- QQ limits passive replies per inbound message. Use `/qq-test-budget` to inspect the local budget.
|
package/doc/features-v1.md
CHANGED
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
|
|
6
6
|
技术栈:
|
|
7
7
|
|
|
8
|
-
| 依赖
|
|
9
|
-
|
|
|
10
|
-
| `@tencent-connect/qqbot-nodejs`
|
|
11
|
-
| `@tencent-connect/qqbot-connector`
|
|
12
|
-
| `@earendil-works/pi-coding-agent`(ExtensionAPI) | pi 扩展宿主:事件订阅、命令注册、消息注入、上下文用量
|
|
8
|
+
| 依赖 | 用途 |
|
|
9
|
+
| ------------------------------------------------- | --------------------------------------------------------------------------- |
|
|
10
|
+
| `@tencent-connect/qqbot-nodejs` | QQ 开放平台协议层:WebSocket Gateway、C2C 消息收发、媒体上传、流式消息 |
|
|
11
|
+
| `@tencent-connect/qqbot-connector` | 扫码登录:展示二维码,扫码后换取 `appId / appSecret / userOpenid`(仅内存) |
|
|
12
|
+
| `@earendil-works/pi-coding-agent`(ExtensionAPI) | pi 扩展宿主:事件订阅、命令注册、消息注入、上下文用量 |
|
|
13
13
|
|
|
14
14
|
---
|
|
15
15
|
|
|
@@ -166,13 +166,13 @@ pi-qq 扩展 ── pi.sendUserMessage(text+images) ─┴─ pi 事件:
|
|
|
166
166
|
|
|
167
167
|
QQ 开放平台的发送限制直接决定回传策略,必须统一管理:
|
|
168
168
|
|
|
169
|
-
| 限制
|
|
170
|
-
|
|
|
171
|
-
| 被动回复额度 | 每条入站消息 5 分钟内有效,约 4 条/小时
|
|
172
|
-
| 主动消息
|
|
173
|
-
| 流式消息
|
|
174
|
-
| 文本长度
|
|
175
|
-
| markdown
|
|
169
|
+
| 限制 | 数值 | 应对 |
|
|
170
|
+
| ------------ | ------------------------------------------ | ----------------------------------------------------------------------------------- |
|
|
171
|
+
| 被动回复额度 | 每条入站消息 5 分钟内有效,约 4 条/小时 | 扩展内维护回复预算(复用 SDK `ReplyLimiter` 思路);assistant 时间线按文本/活动分泡 |
|
|
172
|
+
| 主动消息 | 无 `msgId` 发送受平台额度限制 | 被动额度耗尽时才降级为主动发送,且给出明确提示 |
|
|
173
|
+
| 流式消息 | 仅 C2C;节流 ≥300ms;基于 5 分钟内 `msgId` | 流式仅用于 assistant 文本;无关联 `msgId` 时自动降级 `sendText` |
|
|
174
|
+
| 文本长度 | 单条 ~5000 字符 | SDK 分块;超出部分按序发送 |
|
|
175
|
+
| markdown | 默认无权限(`markdownSupport: false`) | Markdown → 纯文本降级渲染 |
|
|
176
176
|
|
|
177
177
|
**合并规则**(默认):assistant 文本消息与活动时间线严格分泡(每条文本消息 1 条纯文本气泡,工具间隔另起活动气泡);不再发送用量摘要,上下文占比通过 `/status` 查询。气泡数随回合内文本消息数增长,需关注 `msgId` 的被动额度;若平台拒绝(帧失败),自动降级消息路径。工具调用过程本身不逐条回传。
|
|
178
178
|
|
|
@@ -180,31 +180,31 @@ QQ 开放平台的发送限制直接决定回传策略,必须统一管理:
|
|
|
180
180
|
|
|
181
181
|
`~/.pi/agent/pi-qq.json`(只保存设置;不含凭据、不写入登录信息):
|
|
182
182
|
|
|
183
|
-
| 字段
|
|
184
|
-
|
|
|
185
|
-
| `streamAssistant`
|
|
186
|
-
| `markdownSupport`
|
|
187
|
-
| `deliverAs`
|
|
188
|
-
| `imageMaxSize`
|
|
189
|
-
| `fileMaxSize`
|
|
190
|
-
| `heartbeatMinutes`
|
|
191
|
-
| `heartbeatMaxMessages` | `3`
|
|
192
|
-
| `streamRelay`
|
|
193
|
-
| `streamFlushMs`
|
|
194
|
-
| `debug`
|
|
183
|
+
| 字段 | 默认 | 说明 |
|
|
184
|
+
| ---------------------- | ------------------- | ------------------------------------------------------------------------------------ |
|
|
185
|
+
| `streamAssistant` | `true` | assistant 流式回传开关 |
|
|
186
|
+
| `markdownSupport` | `false` | 机器人是否有 markdown 权限;`true` 时回传透传 Markdown |
|
|
187
|
+
| `deliverAs` | `"steer"` | 忙碌时新消息的处理方式 |
|
|
188
|
+
| `imageMaxSize` | `10MB` | QQ 图片下载上限 |
|
|
189
|
+
| `fileMaxSize` | `50MB` | QQ 文件下载上限 |
|
|
190
|
+
| `heartbeatMinutes` | `10`(0 关闭) | F7 节流心跳间隔 |
|
|
191
|
+
| `heartbeatMaxMessages` | `3` | F7 每 run 消息心跳上限(流式心跳不受限) |
|
|
192
|
+
| `streamRelay` | `true` | F7 流式载体开关(append 追加 + 节流合帧 + 限流退避,实测可用;失败自动降级消息路径) |
|
|
193
|
+
| `streamFlushMs` | `10000`(最小 300) | F7 流式汇总帧间隔(毫秒,默认每 10s 汇总工具调用) |
|
|
194
|
+
| `debug` | `false` | 诊断模式:SDK 日志转终端 + 流式重试/超时日志 + 行组/文本帧时间戳 |
|
|
195
195
|
|
|
196
196
|
## 5. 命令总表
|
|
197
197
|
|
|
198
|
-
| 位置
|
|
199
|
-
|
|
|
200
|
-
| pi 侧 | `/qq-login`
|
|
201
|
-
| pi 侧 | `/qq-status`
|
|
202
|
-
| pi 侧 | `/qq-test-budget`
|
|
203
|
-
| pi 侧 | `/qq-logout`
|
|
204
|
-
| pi 侧 | `/qq-new`
|
|
205
|
-
| pi 侧 | `/qq-test-md [text]`
|
|
206
|
-
| pi 侧 | `/qq-test-stream`
|
|
207
|
-
| QQ 侧 | `/new` `/stop` `/compact` `/status` `/help` | 会话控制(见 F2)
|
|
198
|
+
| 位置 | 命令 | 行为 |
|
|
199
|
+
| ----- | ------------------------------------------- | ---------------------------------------------------- |
|
|
200
|
+
| pi 侧 | `/qq-login` | 扫码登录并绑定(QR only) |
|
|
201
|
+
| pi 侧 | `/qq-status` | 登录态、连接状态、绑定用户 |
|
|
202
|
+
| pi 侧 | `/qq-test-budget` | 诊断:被动额度、流式气泡数、最近 msgId 新鲜度 |
|
|
203
|
+
| pi 侧 | `/qq-logout` | 清除内存凭据并断开 |
|
|
204
|
+
| pi 侧 | `/qq-new` | 重置当前会话(QQ `/new` 调用) |
|
|
205
|
+
| pi 侧 | `/qq-test-md [text]` | 诊断:发送 Markdown 消息,验证 C2C markdown 渲染能力 |
|
|
206
|
+
| pi 侧 | `/qq-test-stream` | 诊断:开流→三帧→complete,验证流式帧是否渲染 |
|
|
207
|
+
| QQ 侧 | `/new` `/stop` `/compact` `/status` `/help` | 会话控制(见 F2) |
|
|
208
208
|
|
|
209
209
|
## 6. 可靠性与安全
|
|
210
210
|
|
|
@@ -216,24 +216,24 @@ QQ 开放平台的发送限制直接决定回传策略,必须统一管理:
|
|
|
216
216
|
|
|
217
217
|
## 7. 决策记录
|
|
218
218
|
|
|
219
|
-
| #
|
|
220
|
-
| --- |
|
|
221
|
-
| 1
|
|
222
|
-
| 2
|
|
223
|
-
| 3
|
|
224
|
-
| 4
|
|
225
|
-
| 5
|
|
226
|
-
| 6
|
|
227
|
-
| 7
|
|
228
|
-
| 8
|
|
229
|
-
| 9
|
|
219
|
+
| # | 问题 | 决策 |
|
|
220
|
+
| --- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
221
|
+
| 1 | TUI 二维码渲染 | 登录协议用 connector;展示用 `qrcode-terminal`(零依赖)在 `ctx.ui` 弹窗画码 |
|
|
222
|
+
| 2 | thinking 内容 | 不回传具体内容(始终剔除,无配置开关);F7 时间线中仅以 `[💭] Thinking...` 标记体现 |
|
|
223
|
+
| 3 | tool 消息 | **完全不回传**;只回传 assistant 消息,上下文占比通过 `/status` 查询 |
|
|
224
|
+
| 4 | 图片方向 | F3 为 QQ → pi(用户发图给 pi);pi 不向 QQ 发图片(LLM 仅输出纯文本) |
|
|
225
|
+
| 5 | 成本/用量摘要 | 已移除每轮用量摘要;不展示 token、缓存命中率、成本 |
|
|
226
|
+
| 6 | 回复格式 | 回复通常为 Markdown 格式的总结/提问文本(不在回复中写代码);默认轻量转纯文本,有 markdown 权限可透传 |
|
|
227
|
+
| 7 | 登录方式 | 仅 `/qq-login` 扫码;凭据只存进程内存、不落盘;pi 进程退出后必须重新扫码 |
|
|
228
|
+
| 8 | 长任务反馈 | typing 保鲜 + 每 10s 汇总工具调用 + 节流心跳(默认 10 分钟/条,流式载体优先,每 run ≤3 条消息心跳保险丝)+ 机会性流式(平台拒绝即降级);不发送开始确认 |
|
|
229
|
+
| 9 | 流式可用性(实测三轮) | ① C2C markdown(msg_type=2,`sendMarkdown`)渲染正常;② SDK 内置流式 `input_mode="replace"` 被平台拒绝("已经提交的消息内容不可修改"),首帧可渲染、后续帧报错;③ 自实现 `AppendStream`(input_mode="append",增量追加 + DONE)实测通过;补齐节流合帧(500ms)与限流退避重试后**默认开启**,失败自动降级消息路径 |
|
|
230
230
|
|
|
231
231
|
## 8. 里程碑
|
|
232
232
|
|
|
233
|
-
| 阶段 | 内容
|
|
234
|
-
|
|
|
235
|
-
| M1
|
|
236
|
-
| M2
|
|
237
|
-
| M4
|
|
233
|
+
| 阶段 | 内容 | 验收 |
|
|
234
|
+
| ---- | -------------------------------------------- | -------------------------------------------- |
|
|
235
|
+
| M1 | F1 扫码登录 + 内存凭据 + 连接启动 | 扫码后 `/qq-status` 在线;重启 pi 需重新扫码 |
|
|
236
|
+
| M2 | F2 单人聊天 + F4 assistant 回传(先非流式) | QQ 发消息得到 pi 回复 |
|
|
237
|
+
| M4 | F3 QQ 图片/文件消息 + markdownSupport + 打磨 | 图片可进入 pi 会话;文件保存并关联到提示词 |
|
|
238
238
|
|
|
239
239
|
> 原 M3 用量摘要已取消(2026-10-29)。
|
package/doc/features-v2.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# pi-qq — features-v2.md
|
|
2
2
|
|
|
3
|
-
> V2 增量:F8 语音自动转写、F9
|
|
3
|
+
> V2 增量:F8 语音自动转写、F9 轻量日志基础设施、F10 文件消息等待指令、F11 文件存储与去重。
|
|
4
4
|
> 基线见 [features-v1.md](./features-v1.md);本文只描述新增/变更内容。
|
|
5
5
|
|
|
6
6
|
## 1. 背景与结论
|
|
@@ -19,11 +19,11 @@
|
|
|
19
19
|
|
|
20
20
|
### 行为
|
|
21
21
|
|
|
22
|
-
| 情况
|
|
23
|
-
|
|
|
24
|
-
| 有 ASR 文本 | `markQQTrigger()` → `pi.sendUserMessage(text, { deliverAs })`
|
|
25
|
-
| ASR 为空
|
|
26
|
-
| 语音消息
|
|
22
|
+
| 情况 | 处理 |
|
|
23
|
+
| ----------- | ------------------------------------------------------------------------------------- |
|
|
24
|
+
| 有 ASR 文本 | `markQQTrigger()` → `pi.sendUserMessage(text, { deliverAs })` |
|
|
25
|
+
| ASR 为空 | 回复 `Could not transcribe this voice message; please resend or type it.`,不触发 run |
|
|
26
|
+
| 语音消息 | 不下载 `url` / `voice_wav_url`,不保存文件,不走图片/文件分支 |
|
|
27
27
|
|
|
28
28
|
- 语音和文字是两条独立消息,不做同条组合。
|
|
29
29
|
- 转写文本不参与 QQ 命令解析,作为普通用户消息交给 pi。
|
|
@@ -64,13 +64,13 @@
|
|
|
64
64
|
}
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
| 级别
|
|
68
|
-
|
|
|
69
|
-
| `silent` | 不写日志(默认)
|
|
70
|
-
| `error`
|
|
71
|
-
| `warn`
|
|
72
|
-
| `info`
|
|
73
|
-
| `debug`
|
|
67
|
+
| 级别 | 输出 |
|
|
68
|
+
| -------- | ---------------------------------------------------- |
|
|
69
|
+
| `silent` | 不写日志(默认) |
|
|
70
|
+
| `error` | error |
|
|
71
|
+
| `warn` | warn + error |
|
|
72
|
+
| `info` | info + warn + error |
|
|
73
|
+
| `debug` | 全部,含 raw 事件、附件、prompt、工具参数/结果、正文 |
|
|
74
74
|
|
|
75
75
|
- 配置键使用 `logLevel`,不使用 `log_level`。
|
|
76
76
|
- 移除 `debug` 配置;旧 `debug: true` 迁移为 `logLevel: "debug"`,其他情况默认 `silent`。
|
|
@@ -84,14 +84,127 @@
|
|
|
84
84
|
- 旧 `debug` 配置可迁移。
|
|
85
85
|
- 日志路径、日期滚动、写入失败降级正常。
|
|
86
86
|
|
|
87
|
-
## 4.
|
|
87
|
+
## 4. F10 文件消息等待指令
|
|
88
88
|
|
|
89
|
-
|
|
90
|
-
| --- | --- |
|
|
91
|
-
| `logLevel` | 新增;默认 `silent` |
|
|
92
|
-
| `debug` | 移除;仅保留迁移读取 |
|
|
89
|
+
### 目标
|
|
93
90
|
|
|
94
|
-
|
|
91
|
+
QQ 不能同时发送文字和文件。非图片文件上传后先保存,等待用户下一条文字或语音指令,避免立即触发 pi。
|
|
92
|
+
|
|
93
|
+
### 行为
|
|
94
|
+
|
|
95
|
+
| 情况 | 处理 |
|
|
96
|
+
| ------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
97
|
+
| 只发文件 | 保存到 F11 定义的 session uploads 目录;加入 pending 队列;不回复;不调用 `sendUserMessage` / `markQQTrigger` |
|
|
98
|
+
| 连续上传文件 | 追加到同一 pending 队列;不回复 |
|
|
99
|
+
| 下一条文字 | 合并 pending 文件与当前文件,`formatFilePrompt(files, text)` 后 `sendUserMessage`;清空 pending;触发 run |
|
|
100
|
+
| 下一条语音 | 用 ASR 文本作为指令,合并 pending 文件;清空 pending |
|
|
101
|
+
| `/new` | 清空 pending |
|
|
102
|
+
| 其他 QQ 命令 | 不消费 pending,命令行为不变 |
|
|
103
|
+
| 图片 | 保持 v1 行为;图片可以随文字发送,不进入 pending |
|
|
104
|
+
|
|
105
|
+
- 部分文件保存失败:只把成功文件加入 pending,并回复失败清单。
|
|
106
|
+
- 文件消息不回复确认,不触发 agent run。
|
|
107
|
+
- pending 状态只保存在当前会话内存;pi 重启后丢失,已落盘文件仍保留。
|
|
108
|
+
- pending 文件按保存顺序合并;消费后清空,不重复注入。
|
|
109
|
+
|
|
110
|
+
### 代码边界
|
|
111
|
+
|
|
112
|
+
- `src/inbound.ts`:维护 pending 队列;文件消息先入队,下一条文字/语音指令出队并合并。
|
|
113
|
+
- `/new` 命令清空 pending。
|
|
114
|
+
- 图片路径不变。
|
|
115
|
+
|
|
116
|
+
### 验收
|
|
117
|
+
|
|
118
|
+
- 只发文件:文件已保存,不回复,`sendUserMessage` / `markQQTrigger` 均未调用。
|
|
119
|
+
- 文件后发文字:只触发一次 run,提示词包含文件路径和文字指令。
|
|
120
|
+
- 连续两个文件后发文字:两个文件路径都在提示词中。
|
|
121
|
+
- 文件后发语音:ASR 文本与文件一起注入。
|
|
122
|
+
- `/new`:pending 被清空。
|
|
123
|
+
- 文件保存失败:不进入 pending,仍回复失败信息。
|
|
124
|
+
- 图片、普通文字、既有文件+文字行为不变。
|
|
125
|
+
|
|
126
|
+
## 5. F11 文件存储与去重
|
|
127
|
+
|
|
128
|
+
### 路径
|
|
129
|
+
|
|
130
|
+
- 非图片文件保存到:
|
|
131
|
+
```text
|
|
132
|
+
<cwd>/.pi/pi-qq/<sessionId>/uploads/
|
|
133
|
+
```
|
|
134
|
+
- `sessionId` 来自 `ctx.sessionManager.getSessionId()`。
|
|
135
|
+
- 不再使用日期目录或 `msgId` 子目录。
|
|
136
|
+
- 文件名使用清理后的 basename;同名文件通过后缀区分。
|
|
137
|
+
|
|
138
|
+
### 索引
|
|
139
|
+
|
|
140
|
+
索引文件:
|
|
141
|
+
|
|
142
|
+
```text
|
|
143
|
+
<cwd>/.pi/pi-qq/<sessionId>/uploads/.index.json
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
格式只记录文件名和内容摘要,不记录完整路径:
|
|
147
|
+
|
|
148
|
+
```json
|
|
149
|
+
{
|
|
150
|
+
"a.txt": "<sha256>",
|
|
151
|
+
"a-1.txt": "<sha256>"
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### 保存规则
|
|
156
|
+
|
|
157
|
+
| 情况 | 处理 |
|
|
158
|
+
| -------------------- | ------------------------------------------------------------ |
|
|
159
|
+
| 文件名不重复 | 保存文件;计算 SHA-256;写入索引;引用文件 |
|
|
160
|
+
| 文件名重复,内容不同 | 保存为下一个可用文件名(如 `a-1.txt`);写入索引;引用新文件 |
|
|
161
|
+
| 文件名重复,内容相同 | 不保存新文件;复用已有文件路径 |
|
|
162
|
+
|
|
163
|
+
- 只有文件名重复时才比较内容摘要;文件名不重复时即使内容已存在于其他文件名下,也按规则保存新文件。
|
|
164
|
+
- 文件名重复且内容不同时,从 `name-1.ext` 开始寻找可用文件名;如果该后缀文件已存在且内容相同,复用该后缀文件。
|
|
165
|
+
- 文件名重复且内容相同,复用已有同名文件,不生成副本。
|
|
166
|
+
- 图片、语音不进入该文件索引。
|
|
167
|
+
|
|
168
|
+
### 索引维护
|
|
169
|
+
|
|
170
|
+
- QQ 登录 / 会话启动时加载索引:
|
|
171
|
+
- 对每个 `fileName` 检查 `uploads/fileName` 是否存在。
|
|
172
|
+
- 文件不存在则删除对应索引项。
|
|
173
|
+
- 只做存在性检查,不读取文件内容,不重新计算 hash。
|
|
174
|
+
- 索引有变化才原子写回。
|
|
175
|
+
- 保存或复用文件前再次检查目标文件是否存在;不存在则删除索引项并按新文件处理。
|
|
176
|
+
- 索引缺失或损坏时从空索引开始;遇到同名文件时再计算已有文件 hash 并补写索引。
|
|
177
|
+
- 文件保存与索引更新按用户消息串行执行;当前消息处理完成前不处理下一条,避免并发覆盖索引。
|
|
178
|
+
- 索引写入失败只记 warn,不影响文件保存和消息处理。
|
|
179
|
+
- 不新增配置参数。
|
|
180
|
+
|
|
181
|
+
### 与 pending 的关系
|
|
182
|
+
|
|
183
|
+
- 同名同内容重复上传:只返回一个 `SavedFile`,pending 不重复加入。
|
|
184
|
+
- 不同文件名但内容相同:按规则保存两份,pending 保留两个路径。
|
|
185
|
+
|
|
186
|
+
### 验收
|
|
187
|
+
|
|
188
|
+
- 文件保存到 `.pi/pi-qq/<sessionId>/uploads/`,不再出现日期 / `msgId` 目录。
|
|
189
|
+
- 索引文件只包含文件名到 SHA-256 的映射。
|
|
190
|
+
- 文件名不重复:保存并引用。
|
|
191
|
+
- 同名不同内容:保存为 `name-1.ext` 并引用新文件。
|
|
192
|
+
- 同名同内容:不新增文件,复用已有路径。
|
|
193
|
+
- 登录 / 会话启动:删除指向不存在文件的索引项,且不重新计算所有文件 hash。
|
|
194
|
+
- 索引缺失或损坏:同名文件仍能通过现有文件 hash 正确判断。
|
|
195
|
+
- 索引写入失败不影响文件保存和消息处理。
|
|
196
|
+
|
|
197
|
+
## 6. 配置变更
|
|
198
|
+
|
|
199
|
+
| 配置 | 变更 |
|
|
200
|
+
| ---------- | -------------------- |
|
|
201
|
+
| `logLevel` | 新增;默认 `silent` |
|
|
202
|
+
| `debug` | 移除;仅保留迁移读取 |
|
|
203
|
+
|
|
204
|
+
## 7. 限制
|
|
95
205
|
|
|
96
206
|
- `asr_refer_text` 可能为空或识别不准确;V2 只提示用户重发或改用文字,不做回退。
|
|
97
207
|
- `debug` 日志可能包含消息正文和 URL token,仅在排查时本地开启。
|
|
208
|
+
- 文件 pending 不跨 pi 重启;未消费的文件仍保留在 `.pi/pi-qq/<sessionId>/uploads/` 下。
|
|
209
|
+
- 索引信任写入时的 hash;如果用户手动修改同名文件内容,登录时的存在性检查不会发现。
|
|
210
|
+
- 回传按 run 来源判断:只有 QQ 入站消息触发的 run 回传 QQ;pi 侧直接发起的 run 不推送。
|
package/doc/plan-v1.md
CHANGED
|
@@ -12,11 +12,11 @@ npm init -y
|
|
|
12
12
|
npm i @tencent-connect/qqbot-nodejs @tencent-connect/qqbot-connector qrcode-terminal
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
| 包
|
|
16
|
-
|
|
|
17
|
-
| `@tencent-connect/qqbot-nodejs`
|
|
18
|
-
| `@tencent-connect/qqbot-connector` | ^1.2.0
|
|
19
|
-
| `qrcode-terminal`
|
|
15
|
+
| 包 | 版本锚点 | 用途 |
|
|
16
|
+
| ---------------------------------- | -------- | ------------------------------------------------------------------ |
|
|
17
|
+
| `@tencent-connect/qqbot-nodejs` | ^1.0.5 | QQ 协议层(本地另有源码 `/home/chen/project/qqbot-nodejs` 可查阅) |
|
|
18
|
+
| `@tencent-connect/qqbot-connector` | ^1.2.0 | 扫码登录(唯一登录方式) |
|
|
19
|
+
| `qrcode-terminal` | ^0.12 | 二维码 ASCII 渲染(零依赖) |
|
|
20
20
|
|
|
21
21
|
开发加载方式:`pi --extension /home/chen/project/pi-qq`(jiti 直接跑 TS,无需构建)。
|
|
22
22
|
|
|
@@ -45,13 +45,13 @@ pi-qq/
|
|
|
45
45
|
|
|
46
46
|
## 2. pi 事件与 SDK 接线总表
|
|
47
47
|
|
|
48
|
-
| 方向
|
|
49
|
-
|
|
|
50
|
-
| QQ → pi | `bot.on("message")`(kind=c2c)
|
|
51
|
-
| pi → QQ | `message_update`(assistant)
|
|
52
|
-
| pi → QQ | `message_end`(assistant)
|
|
53
|
-
| 状态
|
|
54
|
-
| 收尾
|
|
48
|
+
| 方向 | 信号 | 处理 |
|
|
49
|
+
| ------- | ------------------------------------ | --------------------------------------------------------------------------------------------------- |
|
|
50
|
+
| QQ → pi | `bot.on("message")`(kind=c2c) | 白名单 → QQ 命令(`/new` `/stop` `/compact` `/status` `/help`)→ 文本+图片 → `pi.sendUserMessage()` |
|
|
51
|
+
| pi → QQ | `message_update`(assistant) | 流式:`openStream().update(转换后全文)`,节流 ≥300ms |
|
|
52
|
+
| pi → QQ | `message_end`(assistant) | `stream.complete()`;无流上下文时 `sendText`;`stopReason==="error"` 回错误摘要 |
|
|
53
|
+
| 状态 | `session_start` / `session_shutdown` | 有内存登录态则启动 bot / 幂等停止 |
|
|
54
|
+
| 收尾 | `agent_end` | 封口最后一个流式气泡(DONE);不再发送用量摘要 |
|
|
55
55
|
|
|
56
56
|
## 3. 里程碑
|
|
57
57
|
|
|
@@ -111,13 +111,13 @@ pi-qq/
|
|
|
111
111
|
|
|
112
112
|
## 5. 风险与预案
|
|
113
113
|
|
|
114
|
-
| 风险
|
|
115
|
-
|
|
|
116
|
-
| 流式消息对非 C2C/过期 `msgId` 抛错
|
|
117
|
-
| 被动额度耗尽(长 run 多回复)
|
|
118
|
-
| markdown 转换漏判
|
|
119
|
-
| connector 混淆代码异常 / 扫码接口变更 | 无法登录
|
|
120
|
-
| pi 事件在非 TUI 模式无 UI
|
|
114
|
+
| 风险 | 影响 | 预案 |
|
|
115
|
+
| ------------------------------------- | ------------- | ------------------------------------------------------- |
|
|
116
|
+
| 流式消息对非 C2C/过期 `msgId` 抛错 | 流式路径崩溃 | `openStream` 前置校验,失败即降级 `sendText`(M4 已含) |
|
|
117
|
+
| 被动额度耗尽(长 run 多回复) | 消息发不出去 | reply-budget 统一发牌,超限降级主动+提示;摘要固定合并 |
|
|
118
|
+
| markdown 转换漏判 | QQ 端残留记号 | 转换函数单测覆盖常见结构;允许透传开关兜底 |
|
|
119
|
+
| connector 混淆代码异常 / 扫码接口变更 | 无法登录 | 重试扫码;升级 connector;保留日志排查 |
|
|
120
|
+
| pi 事件在非 TUI 模式无 UI | 扩展报错 | 所有 `ctx.ui` 调用前判 `ctx.hasUI`/`ctx.mode` |
|
|
121
121
|
|
|
122
122
|
## 6. Todo-List(随进度勾选)
|
|
123
123
|
|