Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<img alt="Platform" src="https://img.shields.io/badge/platform-QQ%20%7C%20Telegram%20%7C%20Feishu-b4476a">
</p>

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

<picture>
<source media="(prefers-color-scheme: dark)" srcset="website/public/readme/turn.dark.svg">
Expand All @@ -37,11 +37,11 @@
</p>

- **决策回合**:连发消息合批等待后唤醒,判断、查询与回复在同一个 Agent 循环中完成;没话可接就旁听,发言后等待对方下一句接话,无人接话时自动拉长插话间隔。
- **查证回答**:按需搜索网页、读取正文、查询聊天记录与长期记忆、检索角色和本群资料、识别图片、读取合并转发。
- **查证回答**:按需搜索网页并读取正文,查询聊天记录和长期记忆、检索角色与本群资料,还能识别图片和读取合并转发。
- **主动跟进**:模型可以为群友创建提醒、登记持续关注的事项,或把耗时工作交给隔离容器中的后台任务。
- **记忆学习**:记忆以 Markdown 文件按群保存在本地。学习群内的说法、黑话和回复效果。
- **角色包**:名字和人物设定即可组成一个角色,附带说话方式、轮换风格、样例、资料与表情库。
- **插件**:用 Python 添加命令、定时播报、模型工具或长期记忆实现,按群启用。
- **角色包**:名字和人物设定即可组成一个角色,可配置说话方式、轮换风格,并附上样例、资料与表情库。
- **插件**:用 Python 添加命令和定时播报,或扩展模型工具与长期记忆实现,按群启用。

## 对话测试

Expand All @@ -50,7 +50,7 @@
<img src="website/public/readme/playground.svg" alt="对话测试页:依次以老周、橘子、小满的身份发言,小然在左侧回复,右侧列出每个回合" width="100%">
</picture>

来使用面板的对话测试模拟群聊吧:添加群友、选择发言身份、复制群内最近的消息作为初始上下文。[对话测试 →](https://lendevs.github.io/LenBot/start/playground)
在面板的对话测试里可以模拟群聊:添加群友、选择发言身份,再复制群内最近的消息作为初始上下文。[对话测试 →](https://lendevs.github.io/LenBot/start/playground)

## 快速开始

Expand All @@ -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 令牌,飞书则准备一个企业自建应用。

| 部署方式 | 运行环境 | 文档 |
|---|---|---|
Expand Down
14 changes: 7 additions & 7 deletions website/connect/models.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 模型与用量

LenBot 只需配置一个聊天模型即可运行完整对话循环。本页说明模型服务商协议、多用途模型分工、向量检索、语音转写与每日 token 上限。
LenBot 只需配置一个聊天模型即可运行完整对话循环。

## 服务商与协议

在**模型 → 服务商**中管理接口连接。每项连接包含名称、协议、接口地址、密钥和可选的网络代理(支持 HTTP/HTTPS 代理,留空直连)。保存前可点击**读取模型列表**并按名称搜索,也可直接点击**测试文本**(1 次请求)或**测试工具调用**(2 次请求)验证连通。
在**模型 → 服务商**中管理接口连接。每项连接填写名称、协议、接口地址和密钥,也可配置网络代理(支持 HTTP/HTTPS 代理,留空直连)。保存前可点击**读取模型列表**并按名称搜索,也可直接点击**测试文本**(1 次请求)或**测试工具调用**(2 次请求)验证连通。

| 协议标识 | 面板名称 | 适用接口 |
|---|---|---|
Expand All @@ -19,7 +19,7 @@ LenBot 只需配置一个聊天模型即可运行完整对话循环。本页说

## 模型用途

在**模型 → 用途**中为不同工作分配模型。除**聊天**为必填项、**语音转写**需显式启用外,其余用途未单独配置时均自动跟随聊天模型。
在**模型 → 用途**中为不同工作分配模型。**聊天**为必填项,**语音转写**需单独启用,其余用途没有单独配置时都跟随聊天模型。

| 用途名称 | 配置键 | 职责 | 未单独配置时 |
|---|---|---|---|
Expand All @@ -42,7 +42,7 @@ LenBot 只需配置一个聊天模型即可运行完整对话循环。本页说

## 模型调用失败排查

宿主在发出请求前会先按用途配置的**上下文长度**估算输入与输出总和,超出窗口时直接中止并给出估算值与调整项。服务端返回错误时,面板按以下分类提示处理方向:
宿主在发出请求前会先按用途配置的**上下文长度**估算输入与输出总和,超出窗口时直接中止并给出估算值与调整项。服务端返回错误时,面板按错误类型提示处理方向:

| 错误类型 | 排查方向 |
|---|---|
Expand Down Expand Up @@ -78,14 +78,14 @@ 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)。

## 用量与上限

**模型 → 用量与上限**按**今天**与**本月**统计输入、缓存命中、输出与总 token 数,分别提供**按模型**和**按群和用途**明细表,并支持设置**每日 token 上限**(可设**所有群每日合计**,也可**按群单独设置**)。

![模型 → 用量与上限:今天的 token 合计,按模型、按群和用途的调用次数与 token,以及各群的唤醒与发言](/screenshots/usage.png)

同一页底部的**唤醒与发言**表按群聊、日期和唤醒方式汇总唤醒次数、发言次数、发言率,以及聊天模型的输入 token 与缓存命中 token。每次进入回合计 1 次唤醒;回合内发出文字、单独发送表情或给消息贴表情均计为有发言回合。
同一页底部的**唤醒与发言**表按群聊、日期和唤醒方式汇总唤醒次数、发言次数与发言率,同时列出聊天模型的输入 token 和缓存命中 token。每次进入回合计 1 次唤醒;回合内发出文字、单独发表情或给消息贴表情,都计为有发言回合。

每次模型请求完成时,宿主都会将时间戳、场景、用途、服务商、模型名及服务端报告的 token 数写入独立的 `usage` 账本表。数据保留任务清理过期的模型请求快照正文时不会删除账本记录。语音转写与向量调用单独展示调用记录,不计入每日聊天 token 限额。
每次模型请求完成时,宿主把时间戳、场景、用途,以及服务商、模型名和服务端报告的 token 数写入独立的 `usage` 账本表。数据保留任务清理过期的模型请求快照正文时不会删除账本记录。语音转写与向量调用单独展示调用记录,不计入每日聊天 token 限额。
2 changes: 1 addition & 1 deletion website/connect/onebot.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ OneBot 客户端的消息上报格式需设为 **array(消息段数组)**,
- **正向 WebSocket**:按指数退避自动重连,首次等待 1 秒,随后翻倍直至上限 30 秒;连接恢复并稳定保持 30 秒后重置退避计数。每次重连成功后都会重新校验登录的 QQ 号。断线原因与重试倒计时展示在**总览**页,并以 `platform_error`(平台连接出错)事件记入**系统 → 日志**。
- **反向 WebSocket**:保持端口监听,等待 OneBot 客户端重新连入。

以下两种情形不会自动重连,需人工操作:
两种情形不会自动重连,需要手动处理:

- **进程启动时首次握手失败**(例如 OneBot 尚未启动或地址有误):排查后在**总览**状态卡点击**手动连接**。
- **在总览点击了断开连接**:点击**连接**重新接入平台,已配置的群继续使用原来的会话。
Expand Down
6 changes: 3 additions & 3 deletions website/connect/web.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 联网与工具

聊天模型在回合中可按需调用内置工具与外部 MCP(Model Context Protocol,模型上下文协议)服务核实信息。本页说明网页搜索与正文读取、内置工具清单、MCP 服务配置,以及本机代理开启 `fake-ip` 时的网络设置。
聊天模型在回合中可按需调用内置工具与外部 MCP(Model Context Protocol,模型上下文协议)服务核实信息。

## 搜索网页与读取网页

Expand Down Expand Up @@ -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` 等真实内网网段或公网网段。
4 changes: 2 additions & 2 deletions website/develop/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) 私下报告。
Loading
Loading