fix: deadlinks

2026-10-30 04:15:45 +08:00 · 2025-05-11 20:24:47 +08:00
parent fd6f0f1963
commit 7f64304ba2
68 changed files with 46 additions and 32 deletions
@@ -28,22 +28,21 @@ AI 能力主要分为两个部分，选择运行器和配置运行器参数。

 <img width="400px" src="/assets/image/zh/deploy/pipelines/more_runner.png" alt="more_runner" />

-## 消息触发条件
+- 接入 Dify 的详细步骤可以[参考教程](/zh/workshop/dify-service-api.html)。

- 群消息响应规则
- 机器人黑/白名单
- 消息忽略规则
+### 对话变量

-## 消息过滤
+当使用 Dify 或者阿里云百炼时，LangBot 会显式传入以下参数，您可以自行在 Dify 工作流的开始节点中添加：

- 内容过滤：敏感词检查配置
- 消息速率管理
+- `user_message_text`：用户消息的纯文本
+- `session_id`：用户会话id，私聊为 `person_<id>`，群聊为 `group_<id>`
+- `conversation_id`：字符串，用户会话id，由 LangBot 生成。用户重置会话后，会重新生成
+- `msg_create_time`：数字类型，收到此消息的时间戳（秒）

-## 消息输出处理
+您可以[通过插件自定义任何变量](/zh/plugin/dev/api-ref.html#%E8%AE%BE%E7%BD%AE%E8%AF%B7%E6%B1%82%E5%8F%98%E9%87%8F)。

- 长文本处理规则
- 回复随机延迟
- 是否@用户
- 是否输出异常信息
- 是否引用原消息
- 是否跟踪函数调用
+![Dify 工作流开始节点配置](/assets/image/zh/workshop/dify-service-api/dify_workflow_var.png)
+
+## 其他配置
+
+请参考配置表单中的描述信息。
@@ -61,3 +61,7 @@ Suffix 必须为 `/ws`；
 `平台/适配器选择`为`OneBot v11`

 ![napcat_webui_03](/assets/image/zh/deploy/bots/qq/onebot/napcat/napcat_webui_03.png)
+
+::: info
+注意，如果涉及多个 docker 容器的网络连接问题，请参考[网络配置详解](/zh/workshop/network-details)
+:::
@@ -21,3 +21,7 @@
 `平台/适配器选择`为`OneBot v11`

 ![napcat_webui_03](/assets/image/zh/deploy/bots/qq/onebot/napcat/napcat_webui_03.png)
+
+::: info
+注意，如果涉及多个 docker 容器的网络连接问题，请参考[网络配置详解](/zh/workshop/network-details)
+:::
@@ -27,3 +27,7 @@
 `平台/适配器选择`为`OneBot v11`

 ![napcat_webui_03](/assets/image/zh/deploy/bots/qq/onebot/napcat/napcat_webui_03.png)
+
+::: info
+注意，如果涉及多个 docker 容器的网络连接问题，请参考[网络配置详解](/zh/workshop/network-details)
+:::
@@ -7,7 +7,7 @@

 | 平台 | 状态 | 备注  |教程 |
 | ------ | ---- | ---- | ---- |
-| QQ 个人号 | ✅ | 使用普通的 QQ 号作为机器人，需要使用独立的协议端，支持 OneBot v11 和 go-cqhttp 协议 | [NapCat](/zh/deploy/platforms/qq/aiocqhttp/napcat) <br> [Lagrange](/zh/deploy/platforms/qq/aiocqhttp/lagrange) <br> [LiteLoaderQQNT](/zh/deploy/platforms/qq/aiocqhttp/llonebot) |
+| OneBot v11 | ✅ | 使用普通的 QQ 号作为机器人，需要使用独立的协议端，支持 OneBot v11 | [NapCat](/zh/deploy/platforms/qq/aiocqhttp/napcat) <br> [Lagrange](/zh/deploy/platforms/qq/aiocqhttp/lagrange) <br> [LiteLoaderQQNT](/zh/deploy/platforms/qq/aiocqhttp/llonebot) |
 | QQ 官方机器人 | ✅ | 接入 QQ 开放平台的机器人 API | [教程](/zh/deploy/platforms/qq/official_webhook) |
 | 企业微信 | ✅ | 企业内部机器人 | [教程](/zh/deploy/platforms/wecom/wecom) |
 | 企业微信客服 | ✅ | 企业对外机器人 | [教程](/zh/deploy/platforms/wecom/wecomcs) |
@@ -1,7 +1,7 @@
 # 通过 Gewechat 接入个人微信

 :::warning 
-LangBot接入gewechat，仅供娱乐，请勿用于违法违规行为，否则后果自负。
+Gewechat 项目已停止维护，请勿使用。
 :::

 **本教程要求 LangBot 以 Docker 容器部署**，请根据 LangBot 部署文档将 LangBot 部署到 Docker 中。
@@ -50,8 +50,6 @@ docker run -itd --network langbot-network -v /root/temp:/root/temp -p 2531:2531

 ## 在 LangBot 中填写信息并启动

-根据[填写配置信息](/deploy/quick-config/config)中的个人微信适配器配置，填写 LangBot 相关配置信息。
-
 ```json
        {
            "adapter": "gewechat",
@@ -68,7 +68,7 @@ ctx.add_return(name: str, value: Any)
 ctx.event.query.set_variable(key: str, value: typing.Any)
 ```

-请求变量是与此次 Query 绑定的一个 `dict`，其中包含了一些程序上下文信息。如果使用的是 Dify 或者 阿里云百炼 等 LLMOps 的runner，[这些变量将被传入对应平台的 API 作为变量](/zh/config/function/provider.html#%E8%AF%B7%E6%B1%82%E5%8F%98%E9%87%8F)。  
+请求变量是与此次 Query 绑定的一个 `dict`，其中包含了一些程序上下文信息。如果使用的是 Dify 或者 阿里云百炼 等 LLMOps 的runner，[这些变量将被传入对应平台的 API 作为变量](/zh/deploy/pipelines/readme.html#%E5%AF%B9%E8%AF%9D%E5%8F%98%E9%87%8F)。  
 如果您需要使用插件设置变量，建议在`PromptPreProcessing`事件时处理。

 - `key`：该变量的名称
@@ -4,7 +4,7 @@
 2025年3月～4月：我们正在进行 4.0 版本重构，组件定义变化较大，现阶段不建议使用组件扩展。请优先考虑使用基于事件的插件接口。
 :::

-> 请先阅读[插件介绍页](/plugin/plugin-intro)  
+> 请先阅读[插件介绍页](/zh/plugin/plugin-intro)  

 :::info 目录
 [[toc]]
@@ -81,14 +81,6 @@ msg_chain = MessageChain([
 除了上述实体之外，还有`好友 Friend`和`群 Group`等实体，这些实体的定义位于`pkg/platform/types/entities.py`中。
 他们一般被包含于上述事件对象中，可以从中取得一些未被包含在插件事件中的信息。

-## 向后兼容性
-
-以 3.x 版本为基础开发的插件，均可以无缝适配 3.4 版本。但 `import mirai` 在新版本已经不受支持，开发插件时编辑器会报错。请做如下修改：
-
- `import mirai` 改为 `import pkg.platform.types as mirai`
-    - 不建议直接改成 `as mirai`，建议使用 `import pkg.platform.types as platform_types` 并将插件代码中对应的 `mirai.xxx` 替换为 `platform_types.xxx`
- `from mirai import *` 改为 `from pkg.platform.types import *`
-
 ## 访问消息平台底层 API

 为了抹平各个平台的差异，LangBot 在消息平台API之上，提供了一个抽象层，即上方所述的内容，以及`pkg/platform/sources`目录下的各个平台适配器。  
@@ -109,7 +101,7 @@ msg_chain = MessageChain([

 | 平台 | 适配器 | 访问方式 | 说明 |
 | --- | --- | --- | --- |
-| QQ 个人号| aiocqhttp | adapter.bot | bot 对象对应 [aiocqhttp](https://github.com/nonebot/aiocqhttp) 的 CQHttp 对象，详细使用方式请参考 aiocqhttp 文档 |
+| OneBot v11| aiocqhttp | adapter.bot | bot 对象对应 [aiocqhttp](https://github.com/nonebot/aiocqhttp) 的 CQHttp 对象，详细使用方式请参考 aiocqhttp 文档 |
 | QQ 官方API | qqofficial | adapter.bot | bot 对象为 libs/qq_official_api 下的 SDK 对象，详细使用方式可以参考 libs/qq_official_api/api.py 中`QQOfficialClient`中的`send_group_text_msg`方法发起 HTTP 请求的方式，具体接口文档请查看 QQ 官方 API 文档|
 | 个人微信 | gewechat | adapter.bot | bot 对象为 [hanfangyuan4396/gewechat-client](https://github.com/hanfangyuan4396/gewechat-python) 的 GewechatClient 对象，详细使用方式可以参考文档 |
 | 企业微信 | wecom | adapter.bot | 参考 libs/wecom_api/api.py 中`WecomClient`中的`send_image`方法发起 HTTP 请求的方式，具体接口文档请查看企业微信 API 文档 |
@@ -18,12 +18,25 @@ LangBot 目前支持`聊天助手`（含Chatflow）、`Agent`、`工作流`三
 :::info
 以上为 Dify 云服务版本的示例，若您使用本地自部署的社区版本，请使用 LangBot 访问你自己 Dify 服务的地址作为 `base-url`，后方需要添加 `/v1` 作为路径。

- 若 LangBot 与 Dify 部署在同一台主机，并且都是使用 Docker 部署的，可以参考文章：[网络配置详解](/deploy/network-details.html#langbot-%E5%92%8C%E6%B6%88%E6%81%AF%E5%B9%B3%E5%8F%B0%E5%9D%87%E8%BF%90%E8%A1%8C%E5%9C%A8-docker-%E5%AE%B9%E5%99%A8%E4%B8%AD)。其中，请将启动 Dify 的 docker-compose.yaml 中所有容器的`networks`均添加`langbot-network`，并为`nginx`容器添加容器名`dify-nginx`，最后在 LangBot 配置中将`base-url`设置为`http://dify-nginx/v1`。
+- 若 LangBot 与 Dify 部署在同一台主机，并且都是使用 Docker 部署的，可以参考文章：[网络配置详解](/zh/workshop/network-details.html#langbot-%E5%92%8C%E6%B6%88%E6%81%AF%E5%B9%B3%E5%8F%B0%E5%9D%87%E8%BF%90%E8%A1%8C%E5%9C%A8-docker-%E5%AE%B9%E5%99%A8%E4%B8%AD)。其中，请将启动 Dify 的 docker-compose.yaml 中所有容器的`networks`均添加`langbot-network`，并为`nginx`容器添加容器名`dify-nginx`，最后在 LangBot 配置中将`base-url`设置为`http://dify-nginx/v1`。
 - 其他情况请咨询贵司运维人员。
 :::

 ## 配置 LangBot

-打开 LangBot Webui 页面，添加一个新的流水线
+打开 LangBot WebUI 页面，添加一个新的流水线或在已有流水线中切换到 AI 能力配置页面。

 ![设置开发项](/assets/image/zh/deploy/pipelines/dify/dify01.png)
+
+::: info
+### 工作流输出键
+
+如果使用的是 Dify 的工作流应用，那么请使用 `summary` 作为键传递输出内容。
+
+![Dify 工作流应用的输出键](/assets/image/zh/workshop/dify-service-api/dify_workflow_output_key.png)
+
+## 输出处理
+
+使用 工作流 应用或 Agent 应用时，如果开启了 LangBot 流水线`输出处理`中的`track-function-calls`，将会在 Dify 执行每个工具调用时，输出一个`调用函数xxx`的消息给用户。  
+但如果是使用`chat`应用下的`ChatFlow`（聊天助手->工作流编排），无论如何只会输出 Answer（直接回复）节点返回的文本。
+:::
@@ -21,6 +21,6 @@

 ## 配置 MCP Server

-查看 [配置文档](/config/function/provider.html#mcp-%E9%85%8D%E7%BD%AE-mcp)
+查看 [系统设置文档](/zh/deploy/settings.html)

 配置完成后即可在聊天中通过`!func`命令查看已经注册的 MCP 工具，在与支持 Function Calling 的模型对话时，LangBot 会自动调用 MCP 工具。