From ed986e11d352b378f3f000769ad4c3c45eec4629 Mon Sep 17 00:00:00 2001 From: anyu0804 Date: Sun, 8 Nov 2026 03:49:59 +1100 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B6=A6=E8=89=B2=20README=20=E4=B8=8E?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=AB=99=E4=B8=AD=E6=96=87=E6=8E=AA=E8=BE=9E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++------ website/connect/models.md | 14 +++++++------- website/connect/onebot.md | 2 +- website/connect/web.md | 6 +++--- website/develop/contributing.md | 4 ++-- website/develop/personas.md | 22 ++++++++-------------- website/develop/plugin-platforms.md | 2 +- website/develop/plugins.md | 2 +- website/start/agent.md | 4 ++-- website/start/first-setup.md | 8 ++++---- website/start/introduction.md | 2 +- website/start/playground.md | 2 +- website/use/chatting.md | 8 ++------ website/use/commands.md | 8 ++------ website/use/faq.md | 2 +- website/use/logs.md | 10 +++++----- website/use/maintenance.md | 8 +++----- website/use/memory.md | 10 +++++----- website/use/panel.md | 6 +++--- website/use/personas.md | 8 ++++---- website/use/plugins.md | 6 +++--- website/use/reference.md | 2 +- website/use/tasks.md | 6 +++--- 23 files changed, 69 insertions(+), 85 deletions(-) diff --git a/README.md b/README.md index bdf6f38eb..c06c70bd7 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Platform

-**LenBot 是自主决策的群聊 Agent。** 何时开口、回复谁、先查什么、何时跟进,由 ReAct Loop 决定。接入 QQ(OneBot v11)、Telegram 和飞书,几个平台可以同时运行,需要一个聊天模型和它的 API Key。 +**LenBot 是自主决策的群聊 Agent。** 何时开口、回复谁、先查什么,以及什么时候跟进,由 ReAct Loop 决定。接入 QQ(OneBot v11)、Telegram 和飞书,几个平台可以同时运行,需要一个聊天模型和它的 API Key。 @@ -37,11 +37,11 @@

- **决策回合**:连发消息合批等待后唤醒,判断、查询与回复在同一个 Agent 循环中完成;没话可接就旁听,发言后等待对方下一句接话,无人接话时自动拉长插话间隔。 -- **查证回答**:按需搜索网页、读取正文、查询聊天记录与长期记忆、检索角色和本群资料、识别图片、读取合并转发。 +- **查证回答**:按需搜索网页并读取正文,查询聊天记录和长期记忆、检索角色与本群资料,还能识别图片和读取合并转发。 - **主动跟进**:模型可以为群友创建提醒、登记持续关注的事项,或把耗时工作交给隔离容器中的后台任务。 - **记忆学习**:记忆以 Markdown 文件按群保存在本地。学习群内的说法、黑话和回复效果。 -- **角色包**:名字和人物设定即可组成一个角色,附带说话方式、轮换风格、样例、资料与表情库。 -- **插件**:用 Python 添加命令、定时播报、模型工具或长期记忆实现,按群启用。 +- **角色包**:名字和人物设定即可组成一个角色,可配置说话方式、轮换风格,并附上样例、资料与表情库。 +- **插件**:用 Python 添加命令和定时播报,或扩展模型工具与长期记忆实现,按群启用。 ## 对话测试 @@ -50,7 +50,7 @@ 对话测试页:依次以老周、橘子、小满的身份发言,小然在左侧回复,右侧列出每个回合
-来使用面板的对话测试模拟群聊吧:添加群友、选择发言身份、复制群内最近的消息作为初始上下文。[对话测试 →](https://lendevs.github.io/LenBot/start/playground) +在面板的对话测试里可以模拟群聊:添加群友、选择发言身份,再复制群内最近的消息作为初始上下文。[对话测试 →](https://lendevs.github.io/LenBot/start/playground) ## 快速开始 @@ -65,7 +65,7 @@ 请阅读 https://lendevs.github.io/LenBot/start/agent ,按页面中给 Agent 的部署步骤帮我部署 LenBot:先问我选择部署方式和要接入的聊天平台,再在这台机器上安装并启动,最后把首次配置链接交给我。 ``` -也可以自己部署。准备要接入的平台和聊天模型服务的 API Key:QQ 需要一个已登录的 OneBot v11 实现(例如 [SnowLuma](https://github.com/SnowLuma/SnowLuma),推荐使用),Telegram 需要 BotFather 给出的 Bot 令牌,飞书需要一个企业自建应用。再选一种部署方式: +也可以自己部署。准备要接入的平台和聊天模型服务的 API Key:QQ 需要一个已登录的 OneBot v11 实现(例如 [SnowLuma](https://github.com/SnowLuma/SnowLuma),推荐使用),Telegram 用 BotFather 给出的 Bot 令牌,飞书则准备一个企业自建应用。 | 部署方式 | 运行环境 | 文档 | |---|---|---| diff --git a/website/connect/models.md b/website/connect/models.md index 4afc70a9e..8e9cf8e31 100644 --- a/website/connect/models.md +++ b/website/connect/models.md @@ -1,10 +1,10 @@ # 模型与用量 -LenBot 只需配置一个聊天模型即可运行完整对话循环。本页说明模型服务商协议、多用途模型分工、向量检索、语音转写与每日 token 上限。 +LenBot 只需配置一个聊天模型即可运行完整对话循环。 ## 服务商与协议 -在**模型 → 服务商**中管理接口连接。每项连接包含名称、协议、接口地址、密钥和可选的网络代理(支持 HTTP/HTTPS 代理,留空直连)。保存前可点击**读取模型列表**并按名称搜索,也可直接点击**测试文本**(1 次请求)或**测试工具调用**(2 次请求)验证连通。 +在**模型 → 服务商**中管理接口连接。每项连接填写名称、协议、接口地址和密钥,也可配置网络代理(支持 HTTP/HTTPS 代理,留空直连)。保存前可点击**读取模型列表**并按名称搜索,也可直接点击**测试文本**(1 次请求)或**测试工具调用**(2 次请求)验证连通。 | 协议标识 | 面板名称 | 适用接口 | |---|---|---| @@ -19,7 +19,7 @@ LenBot 只需配置一个聊天模型即可运行完整对话循环。本页说 ## 模型用途 -在**模型 → 用途**中为不同工作分配模型。除**聊天**为必填项、**语音转写**需显式启用外,其余用途未单独配置时均自动跟随聊天模型。 +在**模型 → 用途**中为不同工作分配模型。**聊天**为必填项,**语音转写**需单独启用,其余用途没有单独配置时都跟随聊天模型。 | 用途名称 | 配置键 | 职责 | 未单独配置时 | |---|---|---|---| @@ -41,7 +41,7 @@ LenBot 只需配置一个聊天模型即可运行完整对话循环。本页说 ## 模型调用失败排查 -宿主在发出请求前会先按用途配置的**上下文长度**估算输入与输出总和,超出窗口时直接中止并给出估算值与调整项。服务端返回错误时,面板按以下分类提示处理方向: +宿主在发出请求前会先按用途配置的**上下文长度**估算输入与输出总和,超出窗口时直接中止并给出估算值与调整项。服务端返回错误时,面板按错误类型提示处理方向: | 错误类型 | 排查方向 | |---|---| @@ -75,7 +75,7 @@ docker exec lenbot-embeddings ollama pull bge-m3:567m 1. 在**模型 → 服务商**中添加**OpenAI 兼容语音转写**服务商,并在**模型 → 用途**中启用**语音转写**。 2. 在需要转写的群中打开**群聊 → 设置 → 参与方式 → 自动转写语音消息**(角色允许 `transcribe` 工具时,模型也可按需主动转写指定语音)。 -在 macOS 本机编译部署 `whisper.cpp`(`whisper-server`)的步骤及大体积语音的帧上限计算见仓库中的 [ASR 部署说明](https://github.com/lendevs/LenBot/blob/master/deploy/current/asr.md)。 +在 macOS 本机编译部署 `whisper.cpp`(`whisper-server`),以及计算大体积语音的帧上限,见仓库中的 [ASR 部署说明](https://github.com/lendevs/LenBot/blob/master/deploy/current/asr.md)。 ## 用量与上限 @@ -83,6 +83,6 @@ docker exec lenbot-embeddings ollama pull bge-m3:567m ![模型 → 用量与上限:今天的 token 合计,按模型、按群和用途的调用次数与 token,以及各群的唤醒与发言](/screenshots/usage.png) -同一页底部的**唤醒与发言**表按群聊、日期和唤醒方式汇总唤醒次数、发言次数、发言率,以及聊天模型的输入 token 与缓存命中 token。每次进入回合计 1 次唤醒;回合内发出文字、单独发送表情或给消息贴表情均计为有发言回合。 +同一页底部的**唤醒与发言**表按群聊、日期和唤醒方式汇总唤醒次数、发言次数与发言率,同时列出聊天模型的输入 token 和缓存命中 token。每次进入回合计 1 次唤醒;回合内发出文字、单独发表情或给消息贴表情,都计为有发言回合。 -每次模型请求完成时,宿主都会将时间戳、场景、用途、服务商、模型名及服务端报告的 token 数写入独立的 `usage` 账本表。数据保留任务清理过期的模型请求快照正文时不会删除账本记录。语音转写与向量调用单独展示调用记录,不计入每日聊天 token 限额。 +每次模型请求完成时,宿主把时间戳、场景、用途,以及服务商、模型名和服务端报告的 token 数写入独立的 `usage` 账本表。数据保留任务清理过期的模型请求快照正文时不会删除账本记录。语音转写与向量调用单独展示调用记录,不计入每日聊天 token 限额。 diff --git a/website/connect/onebot.md b/website/connect/onebot.md index fa323e8f3..b4f64a23c 100644 --- a/website/connect/onebot.md +++ b/website/connect/onebot.md @@ -34,7 +34,7 @@ OneBot 客户端的消息上报格式需设为 **array(消息段数组)**, - **正向 WebSocket**:按指数退避自动重连,首次等待 1 秒,随后翻倍直至上限 30 秒;连接恢复并稳定保持 30 秒后重置退避计数。每次重连成功后都会重新校验登录的 QQ 号。断线原因与重试倒计时展示在**总览**页,并以 `platform_error`(平台连接出错)事件记入**系统 → 日志**。 - **反向 WebSocket**:保持端口监听,等待 OneBot 客户端重新连入。 -以下两种情形不会自动重连,需人工操作: +两种情形不会自动重连,需要手动处理: - **进程启动时首次握手失败**(例如 OneBot 尚未启动或地址有误):排查后在**总览**状态卡点击**手动连接**。 - **在总览点击了断开连接**:点击**连接**重新接入平台,已配置的群继续使用原来的会话。 diff --git a/website/connect/web.md b/website/connect/web.md index b2b8e02dd..afc0cb960 100644 --- a/website/connect/web.md +++ b/website/connect/web.md @@ -1,6 +1,6 @@ # 联网与工具 -聊天模型在回合中可按需调用内置工具与外部 MCP(Model Context Protocol,模型上下文协议)服务核实信息。本页说明网页搜索与正文读取、内置工具清单、MCP 服务配置,以及本机代理开启 `fake-ip` 时的网络设置。 +聊天模型在回合中可按需调用内置工具与外部 MCP(Model Context Protocol,模型上下文协议)服务核实信息。 ## 搜索网页与读取网页 @@ -69,8 +69,8 @@ } ``` -配置后,当按域名发起的连接解析结果落入 `fake_ip_networks` 时,宿主会通过 `public_dns_url`(支持标准 DNS over HTTPS JSON 查询参数 `name` 与 `type`)核验该域名的真实公网 A/AAAA 记录: +配置后,按域名发起的连接解析结果落入 `fake_ip_networks` 时,宿主通过 `public_dns_url`(支持标准 DNS over HTTPS JSON 查询参数 `name` 与 `type`)核验该域名的真实公网 A/AAAA 记录: - 真实记录确认为公网地址后,放行连接。 - DNS 查询失败,或真实记录指向局域网/回环地址时,立即拒绝连接。 -- URL 中直接写死保留 IP 字面量的请求始终拒绝;`fake_ip_networks` 亦不允许填写 `10.0.0.0/8`、`192.168.0.0/16` 等真实内网网段或公网网段。 +- URL 中直接写死保留 IP 字面量的请求始终拒绝;`fake_ip_networks` 也不允许填写 `10.0.0.0/8`、`192.168.0.0/16` 等真实内网网段或公网网段。 diff --git a/website/develop/contributing.md b/website/develop/contributing.md index 6b7b3d1ca..567366e75 100644 --- a/website/develop/contributing.md +++ b/website/develop/contributing.md @@ -26,6 +26,6 @@ uv run --no-sync pytest -q 完整的工程约定与模块细节维护在仓库内,避免与文档站重复: -- [CONTRIBUTING.md](https://github.com/lendevs/LenBot/blob/master/CONTRIBUTING.md):源码目录结构、错误处理与配置原则、测试边界、持久化数据格式编号、打包与提交规范。 -- [developer/README.md](https://github.com/lendevs/LenBot/blob/master/developer/README.md):内部架构总览、唤醒与合批机制、上下文与缓存分段、模型协议适配、面板前端规范及插件接口 v1 完整契约。 +- [CONTRIBUTING.md](https://github.com/lendevs/LenBot/blob/master/CONTRIBUTING.md):源码目录结构、错误处理与配置原则、测试边界,以及持久化数据格式编号、打包与提交规范。 +- [developer/README.md](https://github.com/lendevs/LenBot/blob/master/developer/README.md):内部架构总览、唤醒与合批机制、上下文与缓存分段,以及模型协议适配、面板前端规范和插件接口 v1 契约。 - [问题反馈](https://github.com/lendevs/LenBot/issues):提交缺陷报告或功能讨论;涉及安全漏洞请按 [SECURITY.md](https://github.com/lendevs/LenBot/blob/master/SECURITY.md) 私下报告。 diff --git a/website/develop/personas.md b/website/develop/personas.md index c3dce587b..53f1a1ef4 100644 --- a/website/develop/personas.md +++ b/website/develop/personas.md @@ -1,6 +1,6 @@ # 写角色包 -角色包定义 Bot 的人物身份、说话习惯、轮换风格、设定资料、专属表情以及工具与技能权限。每个角色包是一个独立文件夹,既可在面板的**角色**页图形化编辑,也可直接维护目录文件或打包为 ZIP 分发。完整参考实现见仓库中的[示例角色小然](https://github.com/lendevs/LenBot/tree/master/examples/personas/companion)。 +角色包定义 Bot 的人物身份、说话习惯与轮换风格,同时存放设定资料、专属表情以及工具和技能权限。每个角色包是一个独立文件夹,既可在面板的**角色**页图形化编辑,也可直接维护目录文件或打包为 ZIP 分发。完整参考实现见仓库中的[示例角色小然](https://github.com/lendevs/LenBot/tree/master/examples/personas/companion)。 ## 目录结构 @@ -29,8 +29,6 @@ name: 小一 brief: 班里爱聊天的同学,说话直接,喜欢接梗。 ``` -完整字段说明: - | 字段 | 类型与约束 | 作用 | 缺省值 | |---|---|---|---| | `name` | 非空字符串 | 角色名字,用于系统提示词与群内点名唤醒 | 必填 | @@ -50,20 +48,20 @@ brief: 班里爱聊天的同学,说话直接,喜欢接梗。 ### 框架能力与角色口吻分离 -框架内置提示词只负责群聊通用能力(工具调用契约、查证习惯、防全知边界、表情发送协议)以及可被替换的默认自然度基线,不限制具体口吻。标点符号(例如是否爱用 `!` 或 `~`)、语气助词、颜文字、口头禅、句长节奏以及发表情包的频率,全部由角色包自身决定。 +框架内置提示词只负责群聊通用能力(工具调用契约、查证习惯、防全知边界、表情发送协议)以及可被替换的默认自然度基线,不限制具体口吻。标点符号(例如是否爱用 `!` 或 `~`)、语气助词、颜文字和口头禅,以及句长节奏与发表情包的频率,都由角色包自己决定。 撰写 `behavior`、`voice.md` 和 `boundaries.md` 时,直接正面描述这个角色平时怎样说话、怎样对待朋友,避免堆砌一长串否定禁令。 ### 人物特点与日常细节 - **把设定写成背景而非口头禅**:若在 `brief` 中强调某项爱好(例如喜欢甜食),应同时在 `behavior` 中说明它只在聊到吃喝或闲暇近况时自然带出,避免模型每轮回答无关问题都强行拐回该设定。 -- **写清手机打字习惯**:相比抽象的性格形容词,明确写出句长偏好、句末是否省略句号、何时只回两三个字、连发两句时的断句方式,更能稳定塑造真人口感。 -- **交代关心人的方式**:写明朋友遇到倒霉事时角色习惯怎样回应(例如先顺着具体细节吐槽一句、问清卡在哪一步),防止模型滑向千篇一律的句尾祝福或喝水早睡叮嘱。 +- **写清手机打字习惯**:直接写出句长偏好、句末省不省句号,以及什么时候只回两三个字、连发两句怎么断句,比抽象的性格形容词更容易写出真人聊天的感觉。 +- **交代关心人的方式**:写明朋友遇到倒霉事时角色平时怎么回应(例如先顺着具体细节吐槽一句、问清卡在哪一步),免得模型总在句尾嘱咐喝水早睡。 - **说明表情使用节奏**:配有 `stickers/` 时,在 `voice.md` 中交代角色平时是喜欢单甩一张表情包,还是习惯一句话配一张图,或是只在情绪强烈时偶尔发图。 ### 轮换风格(`styles`) -同一个人在不同对话里的节奏并非固定不变:有时简短接一句,有时多聊两句近况,熟人打趣时语气更活。配置 `styles` 后,宿主在每个新回合开始时按 `weight` 权重抽取其中一种风格,仅在当轮注入一段简短补充说明(配置为空列表 `[]` 时只使用 `voice.md` 基础说话方式): +同一个人在不同对话里的节奏会有变化:有时简短接一句,有时多聊两句近况,熟人打趣时语气更活。配置 `styles` 后,宿主在每个新回合开始时按 `weight` 权重抽取其中一种风格,仅在当轮注入一段简短补充说明(配置为空列表 `[]` 时只使用 `voice.md` 基础说话方式): ```yaml styles: @@ -78,8 +76,6 @@ styles: note: 熟人闲聊或接梗时语气轻快一点,带点玩笑感;遇上正经求助或坏消息仍按正常分寸回应。 ``` -注意事项: - - 各项风格仍属于同一个人物,不改变身份认知、事实记忆或 `boundaries.md` 中的底线。 - 避免在单条 `note` 中规定必用的固定口头禅,否则抽中该风格时容易高频复读同一词语。 - 涉及遇正事收敛分寸的说明,可在活泼风格的 `note` 末尾一句话点明,无需拆成繁琐的条件规则表。 @@ -94,9 +90,7 @@ styles: tags: [daily, comfort] ``` -编写样例时的经验: - -- 覆盖几类典型跨度(日常接话、朋友吐槽倒霉事、互相斗嘴、被纠正错误、遇到拿不准的事情)比同一种闲聊写十几条更有效;示例角色小然在 `examples/personas/companion/examples.yaml` 中就采用了这种组合。 +- 覆盖几类不同情境(日常接话、朋友吐槽倒霉事、互相斗嘴,以及被纠正错误或遇到拿不准的事)比同一种闲聊写十几条更有效;示例角色小然在 `examples/personas/companion/examples.yaml` 中就采用了这种组合。 - 样例只示范口吻和分寸,避免在样例台词里编造会与真实群聊混淆的私密往事;模型在上下文中看到明确标注,不会把样例情节当成群内发生过的事实。 - 准备了多组不同场景的样例时,可通过 `tags` 与 `persona.yaml` 的 `example_tags` 按需筛选;单轮最多带入 8 条样例。 @@ -115,7 +109,7 @@ styles: tags: [笑, 开心] ``` -`description` 需准确描述画面动作、神态或图中文字以及适用语境。当同一情绪下存在多张图片时,模型可根据文字描述区分,也可先拉取带编号的缩略预览拼图核对画面后再发出,且同等匹配下优先挑选近期使用较少的一张。 +`description` 需准确描述画面动作、神态或图中文字以及适用语境。同一情绪下有多张图片时,模型可根据文字描述区分,也可先拉取带编号的缩略预览拼图核对画面后再发出,同等匹配下优先挑选近期用得较少的一张。 ## 替换框架默认表达规则 @@ -127,7 +121,7 @@ styles: | `expression_principles.md` | `next_expression_principles.md` | 群聊发消息的自然度基线,避免复述点评、总结升华或抢话 | | `chat_examples.md` | `next_chat_examples.md` | 不含具体台词的通用应对思路示范 | -当角色包目录中存在上述同名非空文件时,该角色单独使用自带版本,不影响实例中的其他角色;文件不存在或内容为空时回退使用框架版本(含在**系统 → 设置 → 提示词**中保存过的全局自定义版本)。三份文件中可使用 `$name` 占位符代表当前角色名,其余 `$` 字符原样保留。 +角色包目录中有上述同名非空文件时,该角色单独使用自带版本,不影响实例中的其他角色;文件不存在或内容为空时回退使用框架版本(含在**系统 → 设置 → 提示词**中保存过的全局自定义版本)。三份文件中可使用 `$name` 占位符代表当前角色名,其余 `$` 字符原样保留。 注意:主行为循环契约(`next_mind.md`,含防全知、查证要求与安全边界)及表情工具操作协议(`next_react.md`)属于宿主核心机制,不支持由角色包覆盖;请勿在角色覆盖文件中削弱查证或工具调用约束。 diff --git a/website/develop/plugin-platforms.md b/website/develop/plugin-platforms.md index 1b20cce82..2a5d5054c 100644 --- a/website/develop/plugin-platforms.md +++ b/website/develop/plugin-platforms.md @@ -22,7 +22,7 @@ chat_platforms = ["onebot"] ``` - 值是 `onebot`、`telegram`、`feishu` 中的一个或几个;不写时为全部平台。 -- 配置里在其他平台的群启用这个插件时,插件加载失败并说明是哪些群。面板的**使用的群**页签只列出支持的平台的群。 +- 配置里在其他平台的群启用这个插件时,插件加载失败并说明是哪些群。面板**使用的群**页签只列出所支持平台的群。 - 插件目录的条目可以写同名字段,在安装前展示;从目录安装时与仓库清单核对,不一致就不准备候选版本。 ## 收到的消息 diff --git a/website/develop/plugins.md b/website/develop/plugins.md index 3a4bb4029..72b242341 100644 --- a/website/develop/plugins.md +++ b/website/develop/plugins.md @@ -43,7 +43,7 @@ uv pip install ../LenBot pytest pytest-asyncio uv run --no-project python -m pytest -q ``` -插件在 `plugin.toml` 的 `dependencies` 中声明了依赖时,用 `uv pip install` 一并装进这个环境。插件仓库的 CI 按同样的步骤安装宿主的 `master` 并运行测试。 +插件在 `plugin.toml` 的 `dependencies` 中声明了依赖时,用 `uv pip install` 一并装进这个环境。插件仓库的 CI 按同样步骤安装宿主 `master` 分支并运行测试。 ## 最小插件 diff --git a/website/start/agent.md b/website/start/agent.md index d1dc9df0d..fdc255fa5 100644 --- a/website/start/agent.md +++ b/website/start/agent.md @@ -71,14 +71,14 @@ uv run --no-sync len-bot ### 4. 交给用户完成首次配置 -启动输出中有一次性配置链接:Docker 是 `http://127.0.0.1:11307/#token=...`,部署包和源码是 `http://127.0.0.1:<随机端口>/#token=...`。把完整链接交给用户,在浏览器中按[首次配置](https://lendevs.github.io/LenBot/start/first-setup)填写五步向导:管理员账号、接入平台、主人与时区、聊天模型、角色和第一个群。 +启动输出中有一次性配置链接:Docker 是 `http://127.0.0.1:11307/#token=...`,部署包和源码是 `http://127.0.0.1:<随机端口>/#token=...`。把完整链接交给用户,在浏览器中按[首次配置](https://lendevs.github.io/LenBot/start/first-setup)完成五步向导,依次填写管理员账号、接入平台、主人与时区,再配置聊天模型、角色和第一个群。 - 远程服务器上,给出端口转发命令,例如 `ssh -L 11307:127.0.0.1:11307 <服务器>`,端口与链接中的一致。 - 没有浏览器可用时,可以用 JSON 文件无交互初始化,见 [Docker 部署的无交互初始化](https://lendevs.github.io/LenBot/start/docker#无交互初始化)。 ### 5. 完成后 -向用户说明以下几点: +完成后向用户说明: - 面板地址:Docker 是 `http://127.0.0.1:11307`,部署包和源码默认是 `http://127.0.0.1:8088`。 - 先在面板的**对话测试**中模拟群聊,确认回复正常后,在**总览**把发送方式切换为**真实发送**,见[对话测试](https://lendevs.github.io/LenBot/start/playground)。 diff --git a/website/start/first-setup.md b/website/start/first-setup.md index 941a62230..6ec4afe9c 100644 --- a/website/start/first-setup.md +++ b/website/start/first-setup.md @@ -38,11 +38,11 @@ OneBot 客户端一侧的配置要求见[接入 QQ](../connect/onebot)。 **访问令牌**需与 OneBot 客户端中的设置完全一致,未设置时留空;反向 WebSocket 监听非回环地址时必须设置访问令牌。 -点击**测试连接**,LenBot 会握手并读取当前登录的 Bot QQ 号,显示 `已连接:…` 后方可进入下一步。 +点击**测试连接**,LenBot 握手并读取当前登录的 Bot QQ 号,显示 `已连接:…` 后进入下一步。 ### Telegram 与飞书 -填写凭据后点击**测试连接**,显示 `已连接:…` 后方可进入下一步。飞书会同时读取机器人所在的群;Telegram 的 Bot API 不能列出所在的群,把 Bot 拉进群并在群里发一条消息后再测试一次,这个群和发消息的人会出现在后面两步的列表里。 +填写凭据后点击**测试连接**,显示 `已连接:…` 后进入下一步。飞书会同时读取机器人所在的群;Telegram 的 Bot API 不能列出所在的群,把 Bot 拉进群并在群里发一条消息后再测试一次,这个群和发消息的人会出现在后面两步的列表里。 ### 发送方式 @@ -62,7 +62,7 @@ OneBot 客户端一侧的配置要求见[接入 QQ](../connect/onebot)。 ## 4. 聊天模型 -本步配置主聊天模型(`mind` 用途)。看图、记忆摘要、插件生成与后台任务未单独指定模型时均默认复用该聊天模型,详见[模型与用量](../connect/models#模型用途)。 +这一步配置主聊天模型(`mind` 用途)。看图、记忆摘要、插件生成和后台任务没有单独指定模型时,都默认跟随聊天模型,见[模型与用量](../connect/models#模型用途)。 服务商预设提供 **DeepSeek**、**OpenAI 兼容**和 **Anthropic 兼容**三项: @@ -89,7 +89,7 @@ OneBot 客户端一侧的配置要求见[接入 QQ](../connect/onebot)。 | Tavily | 与 Tavily 搜索共用同一连接 | | Jina Reader | 填写 Jina API Key,也可选择**关闭读取网页** | -展开底部的**更多设置**可调整网络代理、上下文长度、**输入压缩阈值**、最长输出、思考参数、**聊天模型支持图片**、**每轮最多步数**(默认 `16`),以及可选的**向量模型(推荐)**: +展开底部的**更多设置**可调整网络代理、上下文长度与**输入压缩阈值**、最长输出与思考参数,以及**聊天模型支持图片**、**每轮最多步数**(默认 `16`)和可选的**向量模型(推荐)**: - 配置向量模型后,长期记忆与资料文件支持语义与全文混合检索;选择**不使用**时仅使用全文检索。 - DeepSeek 官方接口不提供向量端点,配置向量模型时请选择**使用其他服务商**(例如本地 Ollama 或其他兼容 `openai-embeddings` 的服务商),也可留到进入面板后在**模型 → 向量模型**中开启。 diff --git a/website/start/introduction.md b/website/start/introduction.md index 847973529..1ca728487 100644 --- a/website/start/introduction.md +++ b/website/start/introduction.md @@ -1,6 +1,6 @@ # 认识 LenBot -LenBot 是面向群聊的自主决策 Agent 框架,接入 QQ、Telegram 和飞书。何时开口、回复谁、先查什么、何时跟进,由 ReAct Loop 决定。 +LenBot 是面向群聊的自主决策 Agent 框架,接入 QQ、Telegram 和飞书。何时开口、回复谁,先查什么再何时跟进,都由 ReAct Loop 决定。 LenBot 通过已登录 QQ 的 OneBot v11 实现(例如 [SnowLuma](https://github.com/SnowLuma/SnowLuma),推荐使用)收发 QQ 消息,直接调用 Telegram Bot API 和飞书开放平台收发另外两个平台的消息,几个平台可以同时运行。模型服务由部署者自行配置,只需准备一个聊天模型及其 API Key(例如 DeepSeek)。 diff --git a/website/start/playground.md b/website/start/playground.md index 2c2845941..4db1a96e4 100644 --- a/website/start/playground.md +++ b/website/start/playground.md @@ -45,7 +45,7 @@ ## 查看回合 -右侧**回合**列表与群聊页现场的回合卡片一致:唤醒原因、召回的记忆、每一步的想法、工具调用和发出的消息。点击 Bot 的消息可跳到它所在的回合。 +右侧**回合**列表与群聊页现场的回合卡片一致,展示唤醒原因、召回的记忆,以及每一步的想法、工具调用和发出的消息。点击 Bot 的消息可跳到它所在的回合。 ## 隔离范围 diff --git a/website/use/chatting.md b/website/use/chatting.md index 5c82d1cc5..14088d7e4 100644 --- a/website/use/chatting.md +++ b/website/use/chatting.md @@ -1,7 +1,5 @@ # 在群里聊天 -本页说明 Bot 在群聊中的唤醒渠道、连发消息合批、回复方式、安静控制与发言上限。 - ## 唤醒方式 Bot 仅在被唤醒时发起聊天模型请求;未被唤醒的群消息只写入本地记录作为后续上下文。被唤醒后,是否开口以及回复哪条消息均由聊天模型自行决定。 @@ -63,10 +61,10 @@ Bot 每次发言后等一次接话:回复了谁,就等这个人的下一条 ### 回复形式 -聊天模型在同一回合内可选择以下任意组合: +聊天模型在同一回合内可组合使用这几种方式: - **文字发言(`say`)**:发送一条或多条消息,支持引用目标消息或 `@` 指定群友。单条文本超过字数上限(默认 300 字)时在换行或句末自动分段,并按配置的打字速度控制分条间隔。 -- **发送表情(`react`)**:单独发送角色表情或本群收集的表情图片,或在调用 `say` 时将文字与表情合成为同一条消息发出。当同一情绪下有多张相近候选、仅凭文字描述难以区分画面细节时,支持看图的聊天模型可先预览最多 9 张带编号的候选缩略拼图,再按编号发送;发送副本最长边自动缩放至 320 像素并保留动图帧,角色包原图不变。 +- **发送表情(`react`)**:单独发送角色表情或本群收集的表情图片,或在调用 `say` 时将文字与表情合成为同一条消息发出。同一情绪下有多张相近候选、只看文字描述难以区分画面细节时,支持看图的聊天模型可先预览最多 9 张带编号的候选缩略拼图,再按编号发送;发送副本最长边自动缩放至 320 像素并保留动图帧,角色包原图不变。 - **贴表情回应(`message_reaction`)**:调用 QQ 群消息贴表情接口,为某条群消息贴一个简短表情回应而不发出新气泡。 - **旁听不发言**:不调用任何对外表达工具(或显式结束回合),继续保持安静。 @@ -92,8 +90,6 @@ Bot 每次发言后等一次接话:回复了谁,就等这个人的下一条 LenBot 按滑动 60 分钟窗口统计每个群的发言次数,全局默认上限为每群每小时 60 条(在**系统 → 设置 → 群聊**中修改);单群可在**群聊 → 设置 → 每小时发言上限**中选择**跟随全局**、**自定义**或**不限**。私聊不设每小时发言上限。 -计入上限的规则: - - 每次成功送达的 `say`(无论自动拆分为几段或是否附带表情)、`react` 单独发表情,以及 `/help`、`/id` 命令回复,各计 1 条。 - `message_reaction`(给消息贴表情)、管理员维护命令回复、每日安静时段的固定提示语,以及插件自行发出的消息均不计入上限。 diff --git a/website/use/commands.md b/website/use/commands.md index b80efdfab..6bd6e6022 100644 --- a/website/use/commands.md +++ b/website/use/commands.md @@ -30,9 +30,7 @@ LenBot 区分五级成员身份与黑名单: - **群友(`member`)**:群内其他普通成员。 - **黑名单(`blacklist`)**:全局或本群黑名单账号,Bot 忽略其消息、命令与唤醒。 -在**群聊 → 设置 → 权限**的**权限矩阵**中,可按上述五种身份分别勾选本群的七项操作许可:委托任务、任务执行超过 30 分钟、管理他人的任务、为自己创建提醒、为他人创建提醒、管理他人的提醒、**在群内让 Bot 临时安静**。 - -其中: +在**群聊 → 设置 → 权限**的**权限矩阵**中,可按上述五种身份分别勾选本群的七项操作许可:委托任务、任务执行超过 30 分钟与管理他人的任务,为自己或他人创建提醒、管理他人的提醒,以及**在群内让 Bot 临时安静**。 - **在群内让 Bot 临时安静**一栏勾选的身份即上表中的**本群聊天管理**(默认包含主人、管理员和群管理),同时控制 `/status`、`/quiet`、`/resume` 命令与聊天中的 `scene_control` 工具。 - **仅对任务或提醒生效的名单**可为个别成员单独授予本群任务或提醒方向的管理员/白名单身份,或从黑名单中单独排除。 @@ -52,9 +50,7 @@ LenBot 区分五级成员身份与黑名单: ## 主人在群内自然语言改设置 -当本群角色允许 `host_manage` 与 `tool_search` 工具时,主人和全局管理员可以直接在群内用自然语言指示 Bot 查看或修改运行设置(QQ 群主与群管理员无此权限)。 - -支持在群内调整的范围包括: +本群角色允许 `host_manage` 与 `tool_search` 工具时,主人和全局管理员可以直接在群内用自然语言让 Bot 查看或修改这些运行设置(QQ 群主与群管理员无此权限): - 各群聊天开关、参与方式、等待参数与群内学习开关 - 提醒开关、后台任务配额与群角色绑定 diff --git a/website/use/faq.md b/website/use/faq.md index 326d2464b..244c6e480 100644 --- a/website/use/faq.md +++ b/website/use/faq.md @@ -10,7 +10,7 @@ ssh -L 52811:127.0.0.1:52811 你的服务器 ## 测试 OneBot 连接时读取不到 Bot 账号 -按以下顺序逐项核对: +依次核对: 1. OneBot 客户端(如 NapCat)已完成 QQ 登录,且对应的 WebSocket 服务已启用。 2. 正向 WebSocket 模式下,地址以 `ws://` 或 `wss://` 开头;OneBot 运行在容器中时需将端口发布到宿主机,LenBot 运行在容器中连接宿主机 OneBot 时使用 `ws://host.docker.internal:<端口>`。 diff --git a/website/use/logs.md b/website/use/logs.md index 1acec243f..0a7a8dd8c 100644 --- a/website/use/logs.md +++ b/website/use/logs.md @@ -12,7 +12,7 @@ - 本轮开始前自动**召回记忆**的具体块列表。 - 每一模型步的**想法**、回复正文、工具调用**参数**、返回**结果**、失败重试次数或底层错误原文。 -已结束的回合卡片底部提供两个诊断入口: +已结束的回合卡片底部有两个入口: - **本轮运行日志**:跳转至系统日志页并自动按该回合的 `turn_id` 过滤全部关联事件。 - **下载诊断包**:将该回合的元数据、模型请求与响应快照、工具记录及关联 JSONL 日志打包为脱敏 ZIP 文件(自动遮盖配置密钥及 5 位以上长数字)。后台任务同样可在**群聊 → 任务**详情的**更多**菜单中点击**下载诊断包(不含文件)**。 @@ -23,7 +23,7 @@ **系统 → 日志**包含两个页签: -- **系统日志**:支持按日志级别(**全部**、**警告以上**、**仅错误**)、群聊、模块来源、插件名、任务编号和具体事件类型组合过滤,或全文搜索关键字;开启**实时跟随**后自动滚动追加新事件。底部列出按天切分的原始**日志文件**供直接下载。 +- **系统日志**:可按日志级别(**全部**、**警告以上**、**仅错误**)、群聊、模块来源过滤,也可按插件名、任务编号和事件类型组合筛选,或全文搜索关键字;开启**实时跟随**后自动滚动追加新事件。底部列出按天切分的原始**日志文件**供直接下载。 - **运行健康**:持续监测异步事件主循环的调度延迟(记录卡顿次数、最长阻塞毫秒数与调用栈,并区分电脑休眠引起的进程暂停),同时按模型用途汇总近 7 天最近一次成功与失败调用(点击失败时间可直接展开该次原始请求与错误响应)。 ## 磁盘日志文件 @@ -34,8 +34,8 @@ | 关联字段 | 覆盖范围 | |---|---| -| `turn_id` | 单轮对话从唤醒、记忆召回、模型与工具调用到消息发出的全链路记录 | -| `task_id` | 单个后台任务从登记、容器启动、模型请求到交付结束的全周期记录 | +| `turn_id` | 单轮对话从唤醒、记忆召回、模型与工具调用到发出消息的完整记录 | +| `task_id` | 单个后台任务从登记、容器启动、模型请求到交付结束的完整记录 | | `scene` | 所属群聊或私聊的场景标识符 | | `plugin` | 写入该日志或触发异常的插件名称 | @@ -49,7 +49,7 @@ uv run --no-sync python -m len_bot.next.maintenance.doctor ``` -`doctor` 以只读模式逐项检查 `lenbot.config.json`、业务数据库(含表格式、SQLite `quick_check` 与外键关联一致性)、记忆处理库、本地记忆索引库以及已配置插件的清单与 `data_version`,每项输出一行 JSON(状态全部为 `ok` 或 `disabled` 时退出码为 `0`,任一项为 `error` 时退出码为 `1`)。由于全程只读打开数据库,LenBot 运行期间也可安全执行。 +`doctor` 以只读模式逐项检查 `lenbot.config.json`、业务数据库(含表格式、SQLite `quick_check` 与外键关联一致性),以及记忆处理库、本地记忆索引库和已配置插件的清单与 `data_version`。每项输出一行 JSON,状态全部为 `ok` 或 `disabled` 时退出码为 `0`,任一项为 `error` 时退出码为 `1`。由于全程只读打开数据库,LenBot 运行期间也可安全执行。 ## 提交问题报告 diff --git a/website/use/maintenance.md b/website/use/maintenance.md index 6fba2c923..90ca974fc 100644 --- a/website/use/maintenance.md +++ b/website/use/maintenance.md @@ -1,7 +1,5 @@ # 更新与备份 -本页说明源码、部署包与 Docker 实例的版本更新、完整备份、数据清理、隔离测试副本以及系统后台服务托管。 - ## 更新代码 ### 从源码运行的实例 @@ -46,7 +44,7 @@ uv run --no-sync python -m len_bot.next.maintenance.plugin_dependencies ### 完整备份范围 -在**已停止** LenBot 的状态下复制以下内容即可获得一致性完整备份: +先**停止** LenBot,再复制以下内容完成完整备份: - **实例运行文件**:`lenbot.config.json`、SQLite 主数据库及旁边的 `.memory.sqlite3`(若尚未完全合并还需连同 `-wal`、`-shm` 文件一并复制,正常停机后 WAL 已落盘)、`state/`、`personas/`、`plugins/` 和 `logs/`。 - **外部引用路径**:`lenbot.config.json` 中指向实例目录以外的角色目录、插件目录或后台任务的工作区、运行目录与交付目录。 @@ -70,11 +68,11 @@ uv run --no-sync python -m len_bot.next.maintenance.test_copy . /tmp/lenbot-test cd /tmp/lenbot-test && uv run --project /path/to/LenBot --no-sync len-bot ``` -命令会将配置及其引用的数据库、记忆、资料、角色与任务目录复制到目标位置,自动将副本切换为**模拟发送**、断开 OneBot 连接(`onebot: null`)、绑定指定的面板端口,并把原实例内的绝对路径重写为副本路径。副本中的模型、插件和后台任务按原配置连接运行。 +命令把配置和它引用的数据库、记忆、资料,以及角色和任务目录复制到目标位置,同时把副本设为**模拟发送**、断开 OneBot 连接(`onebot: null`)、绑定指定的面板端口,并把原实例内的绝对路径改写为副本路径。副本中的模型、插件和后台任务按原配置连接运行。 ## 作为系统后台服务运行 -`len-bot` 作为前台启动器运行,收到 `SIGINT`(`Ctrl+C`)或 `SIGTERM` 时优雅等待当前回合收尾后退出;面板内的**重启 LenBot** 由启动器进程自行拉起新子进程完成,因此外部服务管理器无需配置崩溃无限重启。部署包用目录中的 `service` 或 `service.ps1` 注册,见[部署包](../start/package#后台服务);下面是从源码运行时的做法。 +`len-bot` 作为前台启动器运行,收到 `SIGINT`(`Ctrl+C`)或 `SIGTERM` 时等待当前回合收尾后退出;面板内的**重启 LenBot** 由启动器进程自行拉起新子进程完成,因此外部服务管理器无需配置崩溃无限重启。部署包用目录中的 `service` 或 `service.ps1` 注册,见[部署包](../start/package#后台服务);下面是从源码运行时的做法。 - **Linux(`systemd`)**:仓库提供 [`deploy/current/lenbot.service`](https://github.com/lendevs/LenBot/blob/master/deploy/current/lenbot.service) 单元模板(默认 `Restart=no` 并启用文件系统沙箱保护)。按机器实际路径修改 `User`、`Group`、`WorkingDirectory`、`ExecStart` 及 `ReadWritePaths`(必须覆盖实例目录及位于实例外的任务目录)后安装: ```sh diff --git a/website/use/memory.md b/website/use/memory.md index 17bd3af1a..1f5daec56 100644 --- a/website/use/memory.md +++ b/website/use/memory.md @@ -24,16 +24,16 @@ LenBot 的原生长期记忆以本地 Markdown 文件按群分开保存;群内 ![群聊 → 记忆 → 浏览:左侧是本群记忆的目录,右侧是打开的记忆文件和编辑、修改历史、删除按钮](/screenshots/memory.png) -删除一份记忆文件时提供两种方式: +删除记忆文件有两种方式: - **仅删除文件**:移除当前记忆文件,保留历史修改记录。 - **彻底忘记**:同时清除记忆正文、索引、全部历史版本和目录摘要,并可勾选关联的原始聊天消息(单次最多 500 条),后续后台整理会永久跳过这些消息,防止再次写出同一内容。 ### 换用插件接管记忆或回想 -实现了记忆入口的插件可按群替代原生长期记忆。在**群聊 → 设置 → 本群启用的插件**中先勾选启用该插件,再将**长期记忆**切换为该插件;实现了压缩入口的插件也可在**压缩回想**中单独选用。当目标插件已在该群加载运行时,保存设置后在当前回合结束时生效。 +实现了记忆入口的插件可按群替代原生长期记忆。在**群聊 → 设置 → 本群启用的插件**中先勾选启用该插件,再将**长期记忆**切换为该插件;实现了压缩入口的插件也可在**压缩回想**中单独选用。目标插件已在该群运行时,保存设置后在当前回合结束时生效。 -- 插件全面接管该群的每轮自动召回、`memory` 工具和后台整理,数据存放在插件自身的数据目录中。 +- 该群的每轮自动召回、`memory` 工具和后台整理由插件接管,数据存放在插件自己的数据目录中。 - 原生记忆文件原样保留在磁盘上,插件可通过只读接口读取它们用于迁移导入。 - 切回**原生**记忆后,原生后台整理从切回时刻的新消息起算,插件接管期间产生的历史消息不补做抽取。 - 卸载记忆或回想插件时,使用它的群自动切回原生实现。 @@ -62,10 +62,10 @@ LenBot 的原生长期记忆以本地 Markdown 文件按群分开保存;群内 开启**后台自动整理**(位于**群聊 → 记忆 → 设置**)或任一学习子项后,宿主在群聊空闲时调度整理回合: - 整理回合由聊天模型沿用当前群聊会话前缀执行,可命中服务商的提示词缓存;一次运行同时完成记忆更新与学习抽取,token 用量在**模型 → 用量与上限**中单列为**整理记忆和学习**。 -- 当群内静默达到**群内安静多久后整理**且未整理消息数达到**最少消息数**,或距上次整理超过**最长等待时间**时自动触发;会话压缩前也会先行触发一次整理。 +- 群内静默达到**群内安静多久后整理**且未整理消息数达到**最少消息数**,或距上次整理超过**最长等待时间**时自动触发;会话压缩前也会先触发一次整理。 - 整理记忆要求当前角色的工具许可包含 `memory`。 -原生记忆将群友个人档案按固定分节维护:身份与称呼、关系、稳定事实、相处偏好与雷点、近期情况、不确定信息,每条附带日期与来源消息定位;玩笑与自嘲会保留原始语境,过期的近期状态在后续整理中自动合并或清理。 +原生记忆将群友个人档案按六个固定分节维护(身份与称呼、关系、稳定事实,以及相处偏好与雷点、近期情况和不确定信息),每条附带日期与来源消息定位;玩笑与自嘲会保留原始语境,过期的近期状态在后续整理中自动合并或清理。 单次整理失败时不推进处理游标,60 秒后自动重试,连续失败 3 次后暂停该群后台整理并在**总览**提示,排查后可在**群聊 → 记忆 → 后台整理**中点击**重新整理此批**。 diff --git a/website/use/panel.md b/website/use/panel.md index 57afee6a9..064c8b526 100644 --- a/website/use/panel.md +++ b/website/use/panel.md @@ -17,7 +17,7 @@ | 配置 | 模型 | 管理模型服务商连接、各用途模型绑定、向量模型、token 用量统计与每日额度上限 | | | 系统 | **设置**(连接、全局权限、群聊、面板账号、数据保留、提示词、版本与更新、高级)与**日志**(系统日志、运行健康) | -顶栏右侧依次排列:**快速跳转**、发送方式徽标、平台连接状态、待处理通知与**账号菜单**。按下 `⌘K`(macOS)或 `Ctrl+K`(Windows/Linux)可随时唤起快速跳转框,直接切换页面、跳转指定群聊、暂停或恢复某群聊天,或为某群切换角色。账号菜单支持切换界面外观(跟随系统/浅色/深色)、界面语言(中文/English)、重启 LenBot 与退出登录。 +顶栏右侧依次是**快速跳转**、发送方式徽标、平台连接状态,以及待处理通知和**账号菜单**。按下 `⌘K`(macOS)或 `Ctrl+K`(Windows/Linux)唤起快速跳转框,可以直接切换页面、跳到指定群聊,也可以暂停或恢复某群聊天、为某群换角色。账号菜单用于切换界面外观(跟随系统/浅色/深色)和语言(中文/English),以及重启 LenBot 或退出登录。 ## 群聊工作台 @@ -43,7 +43,7 @@ 现场时间线中,群友消息居左,Bot 发言居右。每条群友消息旁带有唤醒判定图标:闪电代表唤醒了回合,月亮代表未唤醒,点击可查看唤醒渠道、原因及回复效果系数。 -Bot 每执行一轮决策就生成一张回合卡片。折叠态摘要展示唤醒渠道、步数、发言条数、首句耗时、输入/输出 token 与调用的工具;展开后完整列出本轮自动召回的记忆条目,以及每一步的模型思考内容、工具参数、返回结果或错误原文。 +Bot 每执行一轮决策就生成一张回合卡片。折叠时显示唤醒渠道、步数、发言条数,以及首句耗时、输入/输出 token 和调用的工具;展开后列出本轮自动召回的记忆,还有每一步的想法、工具参数、返回结果或错误原文。 ![Bot 被 @ 后,回合卡片逐步展开:先查询聊天记录,再分两条回复](/screenshots/live.gif) @@ -62,7 +62,7 @@ onebot:private:70001 QQ 私聊(平台:private:对方号码) 面板中的设置按影响范围分为三类生效方式: - **保存即生效**:群开关、聊天/插件模式、唤醒档位、群聊接入、权限与额度、模型服务商与用途绑定、平台连接、MCP、网络参数、日志、数据保留、框架提示词和面板登录账号。模型新请求使用新连接,平台连接按服务重连。 -- **当前回合结束时生效**:编辑在用角色、为群切换角色、切换已在群内运行的**长期记忆**或**压缩回想**插件。若该群当前没有进行中的回合则立即切换;正在回复时等本轮收尾后无缝切换。 +- **当前回合结束时生效**:编辑在用角色、为群切换角色、切换已在群内运行的**长期记忆**或**压缩回想**插件。该群没有进行中的回合时立即切换;正在回复时等本轮结束后切换。 - **需要重新装配服务**:面板监听地址、端口与代理信任设置,向量模型与索引绑定,记忆后端与目录、任务执行器,以及声明 `reload = "host"` 或替换同进程已有依赖的插件。对应修改集中显示在顶栏的待重启列表。 在面板点击**重启**时,对话框会先列出待应用的修改项以及当前受影响的活动:进行中的群聊回合会先等待完成,执行中的后台任务会安全中断并保留工作区以便重启后按原编号续接,排队中的任务保留,进行中的试聊停止。新宿主进程就绪后自动刷新面板,登录会话保留。 diff --git a/website/use/personas.md b/website/use/personas.md index f67d237a3..bcfc0dcf9 100644 --- a/website/use/personas.md +++ b/website/use/personas.md @@ -1,6 +1,6 @@ # 角色管理 -角色包定义 Bot 的身份设定、说话方式、设定资料、表情库以及工具与技能许可。本页说明如何在管理面板中编辑、试聊、导入导出和按群切换角色;角色目录的文件结构、字段规范与写作方法见[写角色包](../develop/personas)。 +角色包定义 Bot 的身份设定、说话方式、设定资料与表情库,以及工具和技能许可。角色目录的文件结构与写作方法见[写角色包](../develop/personas)。 ## 在面板中管理角色 @@ -27,7 +27,7 @@ ## 给群换角色 -每个群聊或私聊在同一时刻绑定一个角色。以下三种切换方式均无需重启,空闲时立即完成,回复进行中则在本轮结束后切换: +每个群聊或私聊在同一时刻绑定一个角色。三种切换方式都不需要重启,空闲时立即完成,正在回复时等本轮结束后切换: 1. 在**角色 → 群**页签勾选目标群,点击**切换为此角色**(或顶栏的**应用到群**)。 2. 在**群聊**工作台顶栏点击当前角色名,或在**群聊 → 设置 → 角色**中选择新角色(也可按下 `⌘K`/`Ctrl+K` 通过快速跳转切换)。 @@ -35,10 +35,10 @@ ### 角色交接与数据隔离 -群聊切换角色时,宿主自动执行以下交接逻辑: +群聊切换角色时: - **共享群友认知**:群友个人画像、群内公共事件与本群画像对所有角色共享,新角色接手后依然认识群成员。 - **隔离角色自身记录**:长期记忆中属于 Bot 自身经历与承诺的记录按角色 ID 分开存放,自动召回只读取当前在用角色的记录;日后切回旧角色时,旧角色的记录原样恢复。 - **生成会话交接摘要**:切换瞬间,宿主调用一次聊天模型将当前活跃对话整理为角色交接摘要,明确区分此前哪些发言和承诺属于上一任角色,新角色在此交接摘要基础上继续对话。 -- **按角色保存本群补充设定**:**群聊 → 设置 → 本群的称呼与额外要求**中的三项(**群友对 Bot 的其他称呼**、**与群友的关系**、**本群的额外要求**)按群和角色独立保存,切换角色时自动切换为对应角色在该群的配置,切回原角色时自动恢复。 +- **按角色保存本群补充设定**:**群聊 → 设置 → 本群的称呼与额外要求**中的三项(**群友对 Bot 的其他称呼**、**与群友的关系**、**本群的额外要求**)按群和角色分别保存,换角色时切换到新角色在本群的设置,切回原角色时恢复。 - **延续待办提醒与任务**:上一任角色登记的定时提醒和后台任务继续按原计划执行,到点或完成时由当前在任角色接手播报。 diff --git a/website/use/plugins.md b/website/use/plugins.md index 8f5986f98..d5aec103d 100644 --- a/website/use/plugins.md +++ b/website/use/plugins.md @@ -1,6 +1,6 @@ # 插件管理 -插件通过 Python 扩展斜杠命令、消息匹配规则、定时播报、聊天模型工具、后台任务技能,或按群接管长期记忆与回想压缩。LenBot 核心不内置具体业务功能,官方业务插件按需独立安装与升级。 +插件用 Python 扩展斜杠命令、消息匹配规则与定时播报,提供聊天模型工具和后台任务技能,或按群接管长期记忆与回想压缩。LenBot 核心不内置具体业务功能,官方业务插件按需独立安装与升级。 ## 官方插件目录 @@ -22,7 +22,7 @@ - **从 Git 仓库安装**:填写 HTTP(S) 或 `ssh://` 仓库地址,可选填标签、分支或提交哈希(主机需已安装 `git`)。 - **导入 ZIP 文件**:上传打包好的插件发行归档(支持离线环境)。 -安装采用安全的两阶段候选机制,准备期间不影响正在运行的旧版本: +安装分两步进行,准备期间不影响正在运行的旧版本: 1. **准备候选版本**:下载或解压源码至 `plugins/.candidates/<名称>`,校验 `plugin.toml` 清单中的接口代次、宿主版本范围、Python 版本和操作系统平台。 2. **填写参数并应用**:在插件详情的**设置**页签补全必填参数后点击**应用**(新插件点击**保存并启用**)。若 Python 依赖未变化且插件声明 `reload = "plugin"`,宿主当场热加载该插件;若需要安装新 Python 依赖、切换进程隔离模式或插件声明 `reload = "host"`,则登记为待应用状态并在下次点击面板**重启**时自动安装依赖并切换。 @@ -47,6 +47,6 @@ - **停用**:停止命令、工具、定时任务与后台循环,保留全部配置参数、启用群列表和数据文件。 - **卸载**:停止插件并移除源码目录与 `lenbot.config.json` 中的启用配置,但默认保留 `plugins/.data/<名称>` 下的业务数据。 -- **删除数据**:卸载或停用后,可在**已安装**页底部的**已卸载插件的数据**中单独执行不可逆的数据目录删除。 +- **删除数据**:卸载或停用后,可在**已安装**页底部的**已卸载插件的数据**中删除数据目录,删除后不可恢复。 自行开发插件的完整步骤见[写插件](../develop/plugins)。 diff --git a/website/use/reference.md b/website/use/reference.md index f4aca57cc..7a64aa522 100644 --- a/website/use/reference.md +++ b/website/use/reference.md @@ -37,7 +37,7 @@ Bot 回答问题时可通过 `knowledge` 工具检索参考资料,涵盖角色 ## 检索机制 -- 当角色存在设定资料或本群存在资料文件,且角色工具许可允许 `knowledge` 时,聊天模型可按关键词检索片段、列出资料清单,或按字符区间与页码分段阅读原文。 +- 角色有设定资料或本群有资料文件,且角色允许 `knowledge` 工具时,聊天模型可按关键词检索片段、列出资料清单,或按字符区间与页码分段阅读原文。 - 模型已知目标文件名时可通过 `filename` 参数限定单文件检索,也可通过 `scope` 参数指定只查角色资料(`persona`)、只查本群资料(`chat`)或同时检索两者(`all`)。 - 未配置向量模型时使用 SQLite FTS5 三元组(trigram)全文检索;在**模型 → 向量模型**中配置**记忆和资料向量**后自动启用全文与向量混合检索(向量按查询批次渐进补齐,接口临时出错时当次自动回退全文检索),详见[模型与用量](../connect/models#向量检索)。 - 资料文件发生更新或删除后,宿主会在该群下一轮模型请求前注入变更提示,告知模型以新版本为准并停用已删除文件的内容。 diff --git a/website/use/tasks.md b/website/use/tasks.md index 0a301ddac..6193b6ae1 100644 --- a/website/use/tasks.md +++ b/website/use/tasks.md @@ -14,7 +14,7 @@ | Docker 部署 | **Docker 任务容器** | 同版本的 `ghcr.io/lendevs/lenbot-worker` 镜像,任务目录放在 `lenbot-data` 数据卷内 | | Windows 部署包 | **Docker 任务容器** | Docker Desktop 地址 `npipe:////./pipe/docker_engine` 与同版本镜像 | - 本机沙箱点击**检查本机沙箱**,依次确认 bwrap、用户命名空间、任务运行时、沙箱读写和 Pi 启动,失败的步骤附原始输出,可改用 Docker 任务容器。Docker 任务容器点击**检查 Docker**,镜像不在本机时点击**拉取镜像**。 + 本机沙箱点击**检查本机沙箱**,依次确认 bwrap、用户命名空间与任务运行时,再测试沙箱读写和 Pi 启动;失败的步骤附原始输出,可改用 Docker 任务容器。Docker 任务容器点击**检查 Docker**,镜像不在本机时点击**拉取镜像**。 2. 选择**任务模型是否支持推理**后保存并重启。任务默认跟随聊天模型;如需独立编程模型,在**模型 → 用途**中配置**后台任务**(`worker`)。 3. 页面顶部的清单逐项列出运行方式、任务模型、群聊和文件发送的状态,缺少的项附跳转: - 在**群聊 → 设置**中开启**允许委托任务**,并在权限矩阵中勾选可以**委托任务**的成员身份; @@ -22,7 +22,7 @@ - 文件可在面板下载,也可通过发送工具交付到所属群聊,见下文[发送到群聊](#发送到群聊)。 4. 群聊一项显示可以委托任务后,点击**运行示例任务**创建一个写入 `hello.txt` 并交付的任务,在群任务页查看过程和交付文件。 -任务环境不能直接联网,模型请求、按联网方式放行的访问、浏览器操作与本群数据工具(记忆、资料、历史聊天查询、网页搜索与网页读取)都经由宿主进程代理。模型请求计入用量额度;联网访问、浏览器和网页工具的字节数计入流量上限;记忆、资料和历史聊天查询在本机完成,不计流量。API Key 始终留在宿主进程内。 +任务环境不能直接联网。模型请求、按联网方式放行的访问、浏览器操作,以及本群数据工具(记忆、资料、历史聊天查询与网页搜索、读取)都经由宿主进程代理。模型请求计入用量额度;联网访问、浏览器和网页工具的字节数计入流量上限;记忆、资料和历史聊天查询在本机完成,不计流量。API Key 始终留在宿主进程内。 数据工具跟随角色权限和任务的联网方式(`worker.egress.mode`): @@ -92,7 +92,7 @@ sudo apt install poppler-utils - **资料输入**:在**任务空间与文件**视图中可上传**本群共享资料**,也可从历史任务的工作区或交付副本中挑选文件(单个新建任务最多挂载 16 份只读输入快照)。 - **实时预览、提问与续接**:任务执行期间可在面板查看实时输出流与每一步操作事件。任务需要发起人确认方案或补充信息时会进入**等待回答**状态(等待期间不占用并发运行槽位);任务完成后,只要工作区尚未释放,群友或运营者均可追加要求按原会话和原目录**继续任务**。 - **网页渲染**:无头渲染工具 `lenbot-render` 可将生成的 HTML 页面直接导出为排版好的 PDF 或高清长截图。Docker 任务容器内置;Linux 本机沙箱在 Chromium 下载并试渲染成功后提供。 -- **任务编写的技能**:任务在执行过程中编写的可复用技能可在任务详情的**更多 → 任务编写的技能**中审阅,并一键采纳移入**本群**或**共享**技能库(之后可在**能力 → 技能**中管理)。 +- **任务编写的技能**:任务运行中写出的可复用技能,可在任务详情的**更多 → 任务编写的技能**中审阅,采纳后移入**本群**或**共享**技能库(之后在**能力 → 技能**中管理)。 - **分级清理空间**:在**任务空间与文件**中可按时间筛选任务并计算磁盘用量。**清理临时文件**仅移除控制管道、运行日志和浏览器临时目录,保留工作区与会话供后续续接;**释放环境**彻底删除工作区和运行目录(不可再续接),已登记的交付副本、本群共享资料和数据库任务记录仍然保留。 ## 发送到群聊