mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-10-29 20:05:25 +08:00
docs: update platform and usage documentation across multiple languagesDingTalk, Discord, and WeCom
This commit is contained in:
Junyan Qin
@@ -1,34 +1,3 @@
|
||||
# 使用知识库 (Knowledge Base)
|
||||
|
||||
LangBot 原生支持 RAG（Retrieval-Augmented Generation，即检索增强生成），您可以创建内置知识库，并将其与流水线绑定，流水线将根据知识库中的内容回答问题。同时，我们支持接入外部服务（Dify、RAGFLow等）提供的知识检索服务。
|
||||
|
||||
## 构建内置知识库
|
||||
|
||||
:::info
|
||||
- 内置知识库的创建和使用需要先配置嵌入模型，请先阅读[配置模型](/zh/deploy/models/readme)。
|
||||
:::
|
||||
|
||||
在知识库页面，点击`创建知识库`按钮，填写知识库名称，选择已配置好的嵌入模型，然后点击`创建`按钮。
|
||||
之后请到知识库的“文档”页面，上传文档，LangBot 将会在后台开始解析和索引。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/upload_docs.png" alt="create_kb" />
|
||||
|
||||
## 接入外部知识库
|
||||
|
||||
请在知识库页面，切换到“外部知识库”标签页，添加外部知识库。在对话框中可以选择需要使用的外部知识库检索器，您需要先在插件管理中安装对应的插件。目前支持的知识检索器可以在[插件市场](https://space.langbot.app/market?category=KnowledgeRetriever)中查看。
|
||||
|
||||
## 使用知识库
|
||||
|
||||
请到流水线配置中，“AI 能力”页，选择`内置 Agent`作为运行器，并在下方选择您刚刚创建的知识库。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_local_agent.png" alt="use_kb" />
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_kb.png" alt="use_kb" />
|
||||
|
||||
:::info
|
||||
仅当运行器为`内置 Agent`时，才可以使用 LangBot 原生知识库，若要在使用其他运行器时使用知识库，请参考所使用的运行器对应产品的文档。
|
||||
:::
|
||||
|
||||
现在即可在`对话调试`或流水线所绑定的机器人上使用知识库进行对话：
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_kb_in_chat.png" alt="use_kb_in_chat" />
|
||||
<script setup>
|
||||
window.location.href = '/zh/usage/knowledge/readme'
|
||||
</script>
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
# 使用MCP服务器
|
||||
|
||||
|
||||
LangBot 支持 SSE 模式 MCP 服务器，您可以添加 MCP 服务器，使用大语言模型中的工具调用特性，更好的处理 LLM 请求。
|
||||
|
||||
:::info
|
||||
- MCP 服务仅支持 SSE 模式。
|
||||
- MCP 服务器推荐获取渠道：[ModelScope](https://modelscope.cn/mcp)
|
||||
:::
|
||||
|
||||
## 打开模型的函数调用功能
|
||||
|
||||
如图，将模型的`函数调用`功能打开。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/mcp/mcp_01.png" alt="enable function call" />
|
||||
|
||||
## 创建MCP服务器
|
||||
|
||||
点击`插件管理` -> `MCP管理`，如图所示：
|
||||
|
||||
<img width="1000px" src="/assets/image/zh/deploy/mcp/mcp02.png" alt="server page" />
|
||||
|
||||
点击右上角的`添加`，选择`添加 MCP 服务器`，
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/mcp/mcp03.png" alt="create new mcp server" />
|
||||
|
||||
比如使用 Fetch HTML 服务器，填写对应的 URL，点击`测试`用来测试 MCP 服务器，点`提交`添加此服务器。
|
||||
|
||||
添加完成之后，点击卡片上的开关以连接 MCP 服务器，点击卡片可以看到 MCP 服务器的详情：
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/mcp/mcp05.png" alt="detailed server" />
|
||||
|
||||
## 效果
|
||||
|
||||
需要在流水线设置中选用 `内置 Agent` 作为运行器，并使用支持函数调用的模型。
|
||||
|
||||
<img width="1000px" src="/assets/image/zh/deploy/mcp/mcp04.png" alt="dialog with mcp" />
|
||||
@@ -1,47 +1,3 @@
|
||||
# 配置模型 (Models)
|
||||
|
||||
## 对话模型 (LLM Model)
|
||||
|
||||
对话模型将被流水线用于处理消息，您配置的第一个模型将被设置为默认流水线的模型。
|
||||
|
||||
|
||||
|
||||
可以添加多个模型，然后再流水线中选择具体使用什么模型
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/model_config.png" alt="model_config" />
|
||||
|
||||
填入这四个参数`模型名称`、`模型供应商`、`请求 URL`、`API Key`，然后提交即可
|
||||
|
||||
模型能力方面，请根据具体模型特性来选择：
|
||||
|
||||
- 视觉能力：需要启用才可以识图
|
||||
|
||||
- 函数调用：需要启用才可以在对话中使用 Agent 工具
|
||||
|
||||
:::info
|
||||
|
||||
*如果你没有API Key，你可以[在此中转站获取](https://api.qhaigc.net/)*
|
||||
|
||||
如果需要使用第三方中转 API 等模型提供商
|
||||
|
||||
选择 `OpenAI`即可
|
||||
|
||||
请求 URL 填入中转的 Base URL 即可，例如
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/other_provider.png" alt="other_provider" />
|
||||
|
||||
:::
|
||||
|
||||
## 嵌入模型 (Embedding Model)
|
||||
|
||||
嵌入模型将被用于计算消息的向量，若您需要使用知识库，请配置此模型。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/embedding_model.png" alt="embedding_model" />
|
||||
|
||||
填入这四个参数`模型名称`、`模型供应商`、`请求 URL`、`API Key`，然后提交即可，之后请在知识库中配置使用此模型。
|
||||
|
||||
### 使用 seekdb 内置嵌入模型（零配置）
|
||||
系统已集成 seekdb 提供的官方嵌入模型，无需填写任何参数。
|
||||
- 在“嵌入模型”页面选择「seekdb-内置」；
|
||||
- 点击「保存」即可立即使用；
|
||||
- 后续在知识库中选择该模型即可生效。
|
||||
<script setup>
|
||||
window.location.href = '/zh/usage/models/readme'
|
||||
</script>
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
# 接入 Coze API
|
||||
|
||||
本文仅说明如何在 Coze 平台获取 Token 与 Bot ID，并将其填写到 LangBot 流水线配置中。
|
||||
|
||||
## 1. 获取 Token 与 Bot ID
|
||||
|
||||
1. 登录 Coze 平台，进入你的开发控制台。
|
||||
|
||||
2. 在“API 管理”中创建并复制令牌。
|
||||
|
||||
|
||||
:::info
|
||||
coze.cn 的授权中有可以长期授权的`服务身份及凭证`，但是 coze.com 只有个人访问令牌。
|
||||
:::
|
||||
|
||||
3. 从项目开发中选择你自己的智能体，或者新建智能体，拿到一下id就是bot_id。
|
||||
|
||||
* 智能体发布一定要选上api的选项
|
||||
|
||||
|
||||
|
||||
|
||||
请妥善保存以上两项信息：
|
||||
- token：Coze 平台生成的令牌
|
||||
- bot_id：机器人 ID
|
||||
|
||||
## 2. 在 LangBot 中填写配置
|
||||
|
||||
1. 打开 LangBot WebUI，进入一个流水线的配置页面（或新建流水线后进入配置页面）。
|
||||
2. 在“AI 能力”中选择运行器为 `Coze API`。
|
||||
3. 在运行器的配置项中，填写：
|
||||
- token：粘贴你在 Coze 平台复制的 API Token
|
||||
- bot_id：粘贴对应机器人的 Bot ID
|
||||
- 请根据您使用的 Coze 站点选择 `API 基础 URL`：coze.cn 请填写 `https://api.coze.cn`；coze.com 请填写 `https://api.coze.com`
|
||||
|
||||
|
||||
4. 点击“保存”完成配置。
|
||||
|
||||
完成后，你即可在该流水线中调用 Coze 机器人完成对话处理。
|
||||
|
||||
## 常见问题
|
||||
- 保存失败或调用报错：请确认 token 与 bot_id 是否正确且未包含多余空格。
|
||||
- 无法选择 `Coze API`：请确认当前版本是否已支持该运行器；若尚未支持，请升级到包含 Coze 运行器的版本。
|
||||
|
||||
更多流水线通用配置说明，请参考[修改对话流水线配置](/zh/deploy/pipelines/readme)。
|
||||
@@ -1,42 +0,0 @@
|
||||
# 在 LangBot 上使用 Dify
|
||||
|
||||
[Dify](https://dify.ai) 是一款开源的大语言模型(LLM) 应用开发平台。它融合了后端即服务（Backend as Service）和 LLMOps 的理念，使开发者可以快速搭建生产级的生成式 AI 应用。
|
||||
Dify 可以创建聊天助手（含Chatflow）、Agent、文本生成应用、工作流等应用。
|
||||
|
||||
LangBot 目前支持`聊天助手`（含Chatflow）、`Agent`、`工作流`三种 Dify 应用类型。
|
||||
|
||||
## 在 Dify 上创建应用
|
||||
|
||||
请根据 [Dify文档](https://docs.dify.ai) 部署dify并创建你的应用。
|
||||
|
||||
发布应用后，在应用的 `访问API` 页面，生成 API 密钥。
|
||||
|
||||
|
||||
|
||||
保存 API 服务器和 API 密钥，在 LangBot 的流水线的`AI 能力`配置。
|
||||
|
||||
:::info
|
||||
以上为 Dify 云服务版本的示例，若您使用本地自部署的社区版本，请使用 LangBot 访问你自己 Dify 服务的地址作为 `base-url`，后方需要添加 `/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 页面，添加一个新的流水线或在已有流水线中切换到 AI 能力配置页面。
|
||||
|
||||
|
||||
|
||||
::: info
|
||||
### 工作流输出键
|
||||
|
||||
如果使用的是 Dify 的工作流应用，那么请使用 `summary` 作为键传递输出内容。
|
||||
|
||||
|
||||
|
||||
## 输出处理
|
||||
|
||||
使用 工作流 应用或 Agent 应用时，如果开启了 LangBot 流水线`输出处理`中的`track-function-calls`，将会在 Dify 执行每个工具调用时，输出一个`调用函数xxx`的消息给用户。
|
||||
但如果是使用`chat`应用下的`ChatFlow`（聊天助手->工作流编排），无论如何只会输出 Answer（直接回复）节点返回的文本。
|
||||
:::
|
||||
@@ -1,31 +0,0 @@
|
||||
# 在 LangBot 上使用 Langflow
|
||||
|
||||
Langflow 是一个开源的用于构建和部署基于 AI 的 Agent 和工作流的项目。其支持本地和云端部署，并提供 API 供其他应用接入。
|
||||
|
||||
LangBot 目前支持使用 Langflow 作为运行器。
|
||||
|
||||
## 在 Langflow 上创建工作流
|
||||
|
||||
请根据 [Langflow 文档](https://langflow.com/docs/introduction) 部署 Langflow 实例。
|
||||
|
||||
以默认模板中的 Simple Agent 为例：
|
||||
|
||||
|
||||
|
||||
您可根据需求修改工作流：
|
||||
|
||||
|
||||
|
||||
## 配置 LangBot
|
||||
|
||||
打开 LangBot WebUI 页面，添加一个新的流水线或在已有流水线中切换到 AI 能力配置页面，选择`Langflow API` 作为运行器。
|
||||
|
||||
|
||||
|
||||
根据提示填入`Base URL`(根据实际网络情况填写) `API Key` `Flow ID` 等信息，API Key 可在 Langflow 的 Settings 中获取：
|
||||
|
||||
|
||||
|
||||
Flow ID 可点击编辑页右上角的`Share` -> `API access` 并示例代码中获取：
|
||||
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
# 在 LangBot 上使用 n8n
|
||||
|
||||
[n8n](https://n8n.io/) 是一款开源的自动化工作流平台，可以创建、调度、执行各种自动化任务。
|
||||
|
||||
LangBot 目前支持通过 n8n 工作流的 `Webhook` 节点，来触发工作流并获取回复。
|
||||
|
||||
## 选用 n8n 作为运行器
|
||||
|
||||
请打开已有的流水线配置页面，或新建流水线（推荐）并打开配置页面，到 `AI 能力`中选择 `n8n 工作流 API` 作为运行器。
|
||||
|
||||
|
||||
|
||||
|
||||
并根据下方内容设置并填写其他配置。
|
||||
|
||||
## 配置 n8n 工作流连接
|
||||
|
||||
|
||||
or
|
||||
|
||||
|
||||
需要选择`Webhook`或者`On chat message`触发，并参考下图配置：
|
||||
* webhook
|
||||
|
||||
* on chat message
|
||||
|
||||
|
||||
:::info
|
||||
如果要需要流式，其中的`Response Mode`都需要选择为`Streaming`。
|
||||
|
||||
:::
|
||||
|
||||
|
||||
:::info
|
||||
Authentication 对应 LangBot 流水线配置中的几种鉴权方式，可自行更改。
|
||||
|
||||
|
||||
:::
|
||||
|
||||
|
||||
调用ai模型的节点可配置为`AI Agent`，并参考下图配置：
|
||||
> 需要流式则将图片中红框内容添加，不需要则不管
|
||||
|
||||
|
||||
|
||||
|
||||
n8n 的工作流响应内容请使用`Respond to Webhook`节点，并参考下图配置（如果你选择的是流式响应和`AI Agent`节点，则不需要操作此步骤）：
|
||||
|
||||
|
||||
|
||||
`Response Body`中的响应内容键名需要与 LangBot 流水线配置中的`输出键名`一致。
|
||||
|
||||
在完成 n8n 工作流的配置之后，请在其顶部点击`Active`以启用工作流。
|
||||
@@ -1,54 +1,3 @@
|
||||
# 修改对话流水线配置 (Pipelines)
|
||||
|
||||
流水线控制了收到消息之后的处理流程，以及与大模型之间的信息交互。每个机器人可以绑定到一条流水线上，同一条流水线能被多个机器人绑定。
|
||||
|
||||
LangBot 首次启动时会自动创建一个默认的流水线。创建机器人时，会自动绑定到默认流水线。创建第一个模型时，会自动将其设置为默认流水线的模型。
|
||||
|
||||
|
||||
|
||||
您可以创建多条流水线，用于不同的机器人，适应不同的场景。
|
||||
|
||||
|
||||
|
||||
当前流水线可以配置以下功能
|
||||
|
||||
## AI 能力
|
||||
|
||||
可以选择使用：`内置 Agent`、[`Dify`](https://dify.ai/)、[`阿里云百炼`](https://www.aliyun.com/product/bailian?source=5176.29345612&userCode=ys4ad8gs)、[`n8n`](https://n8n.io/)、[`TBox（蚂蚁百宝箱）`](https://tbox.cn/)
|
||||
|
||||
AI 能力主要分为两个部分，选择运行器和配置运行器参数。
|
||||
|
||||
运行器定义了如何调度大模型处理消息，默认为`内置 Agent`，这是 LangBot 实现的一个多回合 Agent 策略，当且仅当选择此运行器时，才会使用 LangBot 内部配置的模型和工具。
|
||||
|
||||
*<!--  -->*
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/pipelines/edit_pipeline_ai.png" alt="edit_pipeline" />
|
||||
|
||||
您也可以选择使用 `Dify`、 [`n8n`](https://n8n.io/) 等外部 LLMOps 平台，这种情况下所使用的模型和提示词、工具等资源将由 LLMOps 平台提供。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/pipelines/more_runner.png" alt="more_runner" />
|
||||
|
||||
- 接入 Dify 的详细步骤可以[参考教程](/zh/deploy/pipelines/dify.html)。
|
||||
- 接入 n8n 的详细步骤可以[参考教程](/zh/deploy/pipelines/n8n.html)。
|
||||
|
||||
### 请求变量
|
||||
|
||||
当使用外部 LLMOps 平台时，LangBot 会显式传入以下参数，您可以自行在 LLMOps 平台的开始节点中添加（下图以 Dify 为例）：
|
||||
|
||||
- `launcher_type`：发起对象类型，私聊为 `person`，群聊为 `group`
|
||||
- `launcher_id`：发起对象ID，私聊为用户ID，群聊为群ID
|
||||
- `sender_id`：发送者ID
|
||||
- `user_message_text`：用户消息的纯文本
|
||||
- `session_id`：用户会话id，私聊为 `person_<id>`，群聊为 `group_<id>`
|
||||
- `conversation_id`：字符串，用户会话id，由 LangBot 生成。用户重置会话后，会重新生成
|
||||
- `msg_create_time`：数字类型，收到此消息的时间戳（秒）
|
||||
- `group_name`：群聊名称，仅在群消息事件时设置
|
||||
- `sender_name`：发送者名称
|
||||
|
||||
您可以[通过插件自定义任何变量](/zh/plugin/dev/apis/common.html#%E8%AE%BE%E7%BD%AE%E8%AF%B7%E6%B1%82%E5%8F%98%E9%87%8F)。
|
||||
|
||||
|
||||
|
||||
## 其他配置
|
||||
|
||||
请参考配置表单中的描述信息。
|
||||
<script setup>
|
||||
window.location.href = '/zh/usage/pipelines/readme'
|
||||
</script>
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
# 在 LangBot 上使用 TBox（蚂蚁百宝箱）
|
||||
|
||||
[TBox（百宝箱）](https://tbox.cn/)是蚂蚁集团推出的面向 AI 开发者的一站式智能体应用开发平台。在平台上，无论您是否拥有编程基础，都可以通过自然语言，基于各种大模型搭建属于您自己的智能体应用，并将其发布到支付宝小程序、web 服务、浏览器插件等生态渠道。
|
||||
|
||||
LangBot 支持接入 TBox 上编排好的智能体，用作流水线 Runner。
|
||||
|
||||
在 TBox 上搭建好智能体后，请到[`开放平台`](https://www.tbox.cn/open/authorized-management)创建 API Key：
|
||||
|
||||
|
||||
|
||||
并在 TBox 的智能体编排页面找到该应用的 AppID：
|
||||
|
||||
|
||||
|
||||
接着回到 LangBot 流水线设置中，切到`AI 能力`配置页面，选择`蚂蚁百宝箱平台 API` 作为运行器：
|
||||
|
||||
|
||||
|
||||
现在即可使用 TBox 上的智能体了。
|
||||
@@ -1,83 +0,0 @@
|
||||
# 部署钉钉机器人
|
||||
|
||||
部署 LangBot 到钉钉。
|
||||
|
||||
## 创建机器人
|
||||
|
||||
进入 [钉钉开发者后台](https://open-dev.dingtalk.com/?spm=ding_open_doc.document.0.0.74f445e5MkawbT#/)，登录并且进入组织。登录成功后进入开放平台，是这样的：
|
||||
|
||||
|
||||
点击上方的 `应用开发`,然后点击右面蓝色的按钮 `创建应用`，填写机器人的基本信息，点击保存。
|
||||
|
||||
进入机器人的后台，比如我们有机器人 langbot2 ,那么它的管理页面是这样的：
|
||||
|
||||
|
||||
## 配置机器人
|
||||
|
||||
点击 `添加应用能力`，`其他应用能力`，`机器人`中的 `配置`，点击配置并且填写信息之后，如下图：
|
||||
|
||||
|
||||
点击页面下方的`发布`，发布成功之后，点击机器人页面中左侧最下方的`版本管理与发布`，如图：
|
||||
|
||||
|
||||
如果是第一次创建机器人，那么右边是空的，需要点击`创建新版本`，在其中设置信息，然后设置`应用可见范围`，点击保存。
|
||||
|
||||
点击`事件订阅`，将其中的推送方式改为`Stream模式推送`。
|
||||
|
||||
如果需要卡片流式，则需要在权限管理中申请卡片权限，如图:
|
||||
|
||||
|
||||
|
||||
|
||||
另外卡片消息主要创建卡片模板，并记录模板id填入配置信息，流程如下：
|
||||
> 卡片内容模板ID，可通过登录开发者后台 > [卡片平台](https://open-dev.dingtalk.com/fe/card?spm=ding_open_doc.document.0.0.33cf2281L0fXsV)获取
|
||||
|
||||
新建模板填写信息，如图：
|
||||
|
||||
|
||||
选择预设模板（直接选第一个然后进去后更改模板内容），如图：
|
||||
|
||||
点击使用
|
||||
|
||||
创建
|
||||
|
||||
|
||||
点击创建后会跳转到编辑模板。如图，这样你就可以尽情的编辑你想要的卡片消息了：
|
||||
|
||||
|
||||
主内容这里默认content不要改动即可：
|
||||
|
||||
|
||||
编辑好没问题之后保存即可，并复制模板id用以填写配置文件：
|
||||
|
||||
|
||||
|
||||
|
||||
## 填写配置信息
|
||||
|
||||
点击`凭证与基础信息`，记录`Client ID` 和 `Client Secret`，
|
||||
点击`应用能力`，`机器人`，记录下 RobotCode 和 机器人名称。
|
||||
`markdown_card` 为是否启用 Markdown 形式的回复，当此配置项关闭时，`@发送者` 配置开关不会生效。
|
||||
将以上配置项 记录下来，填到 LangBot 机器人配置表单中。
|
||||
|
||||
点击[卡片平台](https://open-dev.dingtalk.com/fe/card?spm=ding_open_doc.document.0.0.33cf2281L0fXsV)模板列表复制绑定的对应的模板id填入卡片模板id
|
||||
|
||||
|
||||
|
||||
|
||||
流式相关：
|
||||
|
||||
|
||||
**启动 LangBot** 。
|
||||
|
||||
## 添加机器人
|
||||
|
||||
本文使用钉钉 windows 桌面版举例，点击上方的`搜索`，`功能`，然后输入刚才机器人创建的名称，如图：
|
||||
|
||||
|
||||
点击机器人即可和机器人聊天。
|
||||
|
||||
如果想要添加到群里，那么点击钉钉群的`群管理`，`机器人`，`添加机器人`，然后搜索机器人名称就可以在群中使用。
|
||||
|
||||
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
# 接入 Discord 机器人
|
||||
|
||||
## 创建机器人
|
||||
|
||||
前往[Discord 开发者门户](https://discord.com/developers/applications)，登录后，创建应用。
|
||||
|
||||
|
||||
|
||||
修改基础信息，点击`Save Changes`保存。
|
||||
|
||||
|
||||
|
||||
点击左侧`Bot`，点击`Reset Token`，复制生成的 Token。
|
||||
|
||||
|
||||
|
||||
并在此页面的`Privileged Gateway Intents`中勾选所有选项，点击`Save Changes`保存。
|
||||
|
||||
|
||||
|
||||
**最后，点击左侧`OAuth2`，复制页面上的`Client ID`。**
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
点击添加一个新的机器人，将上一步获取的`Client ID`和`Token`填写到配置中。
|
||||
|
||||
|
||||
|
||||
:::warning
|
||||
|
||||
如果你在中国大陆境内使用此适配器，可能需要设置网络代理。
|
||||
|
||||
:::
|
||||
|
||||
填写完成后启动 LangBot，若成功配置，日志中会出现`[02-02 16:48:15.263] manager.py (68) - [INFO] : 初始化平台适配器 1: discord`的字样，保持 LangBot 运行。
|
||||
|
||||
## 邀请机器人到服务器
|
||||
|
||||
你需要先创建一个服务器，然后邀请机器人到服务器。
|
||||
|
||||
前往`OAuth2`页面，选择`URL Generator`，选择`bot`，按照图中所示勾选权限。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
点击`Copy`，将生成的 URL 粘贴到浏览器中打开，邀请机器人到你的服务器。
|
||||
|
||||
|
||||
|
||||
## 使用机器人
|
||||
|
||||
现在在群里或者私聊机器人都可以正常使用了。
|
||||
|
||||
|
||||
@@ -1,63 +0,0 @@
|
||||
# 接入 KOOK 机器人
|
||||
|
||||
## 创建机器人
|
||||
|
||||
前往 [KOOK 开发者中心](https://developer.kookapp.cn/)，登录后进入控制台。
|
||||
|
||||
|
||||
|
||||
点击「新建应用」，填写应用信息。
|
||||
|
||||
|
||||
|
||||
应用创建完成后，进入应用详情页。
|
||||
|
||||
|
||||
|
||||
在应用概览页面可以查看应用的基本信息。
|
||||
|
||||
|
||||
|
||||
## 获取 Bot Token
|
||||
|
||||
在应用页面中，点击「机器人」标签，复制 Bot Token 并妥善保存，后续需要使用。
|
||||
|
||||
|
||||
|
||||
## 配置机器人权限
|
||||
|
||||
**重要：** 在「机器人」设置中，找到「消息过滤」选项，点击配置。
|
||||
|
||||
|
||||
|
||||
开启所有消息相关事件权限，包括频道消息和私聊消息事件，否则机器人将无法接收消息。
|
||||
|
||||
|
||||
|
||||
## 邀请机器人
|
||||
|
||||
在机器人设置页面，可以生成邀请链接，将机器人邀请到你的服务器。
|
||||
|
||||
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
打开 LangBot Webui 页面，在「机器人」页面点击创建新机器人。
|
||||
|
||||
|
||||
|
||||
选择 KOOK 平台，填写机器人名称和 Bot Token。
|
||||
|
||||
|
||||
|
||||
保存后，机器人将出现在列表中。
|
||||
|
||||
|
||||
|
||||
点击启用按钮，启动机器人。若成功配置，机器人状态将显示为运行中。
|
||||
|
||||
|
||||
|
||||
## 使用机器人
|
||||
|
||||
现在在 KOOK 服务器中，机器人就可以正常接收和回复消息了。机器人支持频道消息和私聊消息。
|
||||
@@ -1,86 +0,0 @@
|
||||
# 接入飞书机器人
|
||||
|
||||
## 创建机器人
|
||||
|
||||
前往[飞书开放平台](https://open.feishu.cn/app)，登录后，创建企业自建应用/商店应用 [(区别介绍)](https://open.feishu.cn/document/platform-overveiw/overview)。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
为应用添加机器人能力：
|
||||
|
||||
|
||||
在权限管理中添加图中所示权限：
|
||||
|
||||
|
||||
|
||||
如需卡片流式权限则多添加如下图的创建与更新卡片：
|
||||
|
||||
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
在`凭证与基础信息`页找到`app_id`和`app_secret`。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
打开LangBot 的 Webui 配置页面，创建一个新的机器人
|
||||
|
||||
将相关信息填入表单
|
||||
|
||||
|
||||
|
||||
流式相关：
|
||||
|
||||
|
||||
填写完成后启动 LangBot，若成功配置，日志中会出现`[01-29 23:42:56.796] manager.py (68) - [INFO] : 初始化平台适配器 1: lark`的字样，保持 LangBot 运行。
|
||||
|
||||
:::warning
|
||||
默认使用的是 WebSocket 长连接模式，对应下方的长连接订阅。但某些情况下（如国际版飞书）不具有长连接模式，此时需要使用 Webhook 模式，对应`将事件发送到开发者服务器`模式，请参考以下配置：
|
||||
|
||||
- `enable-webhook`：设置为`true`
|
||||
- `encrypt-key`：设置为`事件与回调`页面的`加密策略`中的`Encrypt Key`
|
||||
|
||||
注意，在Webhook模式中，LangBot 需要部署在具有公网 IP 的服务器上，并确保防火墙已开放上方配置的端口。
|
||||
:::
|
||||
|
||||
## 配置事件订阅
|
||||
|
||||
前往`事件与回调`页，配置订阅方式为`长连接`：
|
||||
|
||||
|
||||
|
||||
并添加事件：`接收消息`
|
||||
|
||||
|
||||
|
||||
:::warning
|
||||
Webhook 模式配置方式：
|
||||
|
||||
|
||||
|
||||
请先启动 LangBot，在此处填写你的服务器地址和端口，路径为`/lark/callback`，点击`保存`。
|
||||
|
||||
:::
|
||||
|
||||
## 发布机器人
|
||||
|
||||
点击顶部`创建版本`，填写版本号等信息，点击下方`保存`。
|
||||
|
||||
|
||||
|
||||
在飞书群中添加机器人，即可使用：
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
私聊也可以直接使用
|
||||
|
||||
|
||||
|
||||
## 常见问题
|
||||
- 商店应用机器人创建/保存后无法立刻响应聊天消息，由于[app_ticket事件](https://open.feishu.cn/document/server-docs/application-v6/event/app_ticket-events)延迟机制，需要等待2分钟左右才可以正常使用。
|
||||
@@ -1,162 +0,0 @@
|
||||
# 接入LINE机器人
|
||||
|
||||
本文介绍如何将 LangBot 与 LINE 平台进行对接，实现 LINE 机器人功能。
|
||||
|
||||
## 创建LINE机器人
|
||||
|
||||
### 注册LINE开发者账号
|
||||
|
||||
1. 访问 [LINE Developers 官网](https://developers.line.biz/)，使用 LINE 账号登录
|
||||
2. 登录后，进入开发者控制台
|
||||
|
||||
### 创建 Provider 和 Channel
|
||||
|
||||
> [开发者控制台](https://developers.line.biz/console)
|
||||
|
||||
1. 在开发者控制台中，创建一个新的 Provider（如果没有的话）
|
||||
|
||||
|
||||
|
||||
2. 在 Provider 下，点击 "Create"
|
||||
|
||||
|
||||
|
||||
3. 填入名称，并点击 Create
|
||||
|
||||
|
||||
|
||||
4. 跳转页面后选择 Create a Message API
|
||||
|
||||
* 继续点击 Create a Message API
|
||||
|
||||
* 跳转页面后填入基本信息
|
||||
|
||||
- Channel Name（频道名称）
|
||||
- Channel Description（频道描述）
|
||||
- Category（类别）
|
||||
- Subcategory（子类别）
|
||||
- Email Address（邮箱地址）
|
||||
5. 全部填好之后点击 "Continue" 创建
|
||||
|
||||
6. 检查填入的信息，无问题点击 Submit 即可
|
||||
|
||||
7. 创建成功去使用
|
||||
|
||||
|
||||
### 获取配置信息
|
||||
|
||||
创建完成后，您将获得以下重要信息，请记录下来：
|
||||
|
||||
1. Channel Secret
|
||||
> [刚刚点击使用跳转页面](https://manager.line.biz/account)
|
||||
* 选择 Settings
|
||||
|
||||
* 点击 Message API
|
||||
|
||||
* 开启 Message API
|
||||
|
||||
* 选择刚刚新建的 Provider 并点击 Agree
|
||||
|
||||
* 隐私条款直接点击 OK
|
||||
|
||||
* 点击 OK 创建成功
|
||||
|
||||
* Copy 即可
|
||||
|
||||
|
||||
2. Channel Access Token（需要点击 "Issue" 按钮生成）
|
||||
* 点击控制台或者直接访问 [控制台](https://developers.line.biz/console/)
|
||||
|
||||
* 选择你创建的 Provider 并点击 Message API
|
||||
|
||||
* 点击 Message API
|
||||
|
||||
* 下滑到最下面，点击 Issue
|
||||
|
||||
* 点击图标复制
|
||||
|
||||
|
||||
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
接下来打开 LangBot 配置页面：
|
||||
|
||||
1. 点击 "机器人"，然后点击 "添加"
|
||||
|
||||
2. 在 "平台/适配器选择" 中选择 "LINE"
|
||||
|
||||
|
||||
3. 填写配置信息：
|
||||
- Channel Secret：您之前获取的 Channel Secret
|
||||
- Channel Access Token：您之前获取的 Channel Access Token
|
||||
|
||||
|
||||
4. 点击 "保存" 完成配置
|
||||
|
||||
|
||||
|
||||
## 配置Webhook
|
||||
|
||||
::: info
|
||||
推荐您先参照[配置 HTTP 反向代理](/zh/workshop/production/proxy-and-ssl)来配置 LangBot 回调地址。
|
||||
:::
|
||||
|
||||
* 从 LangBot 配置页面获取 Webhook 回调地址
|
||||
|
||||
|
||||
* 点击控制台或者直接访问 [控制台](https://developers.line.biz/console/)
|
||||
|
||||
* 选择你创建的 Provider 并点击 Message API
|
||||
|
||||
* 点击 Message API
|
||||
|
||||
* 点击 Edit 填写连接
|
||||
|
||||
* 填入连接（必须要 HTTPS 的连接，也就是要 SSL 证书），点击 Update
|
||||
|
||||
|
||||
* 选择 Use Webhook
|
||||
|
||||
|
||||
5. 点击 "Verify" 按钮测试连接是否成功
|
||||
|
||||
|
||||
|
||||
|
||||
## 功能配置
|
||||
|
||||
在 LINE 开发者控制台中，您可以进一步配置机器人的功能：
|
||||
|
||||
1. 在 "Messaging API" 选项卡中，找到 "LINE Official Account Features" 部分
|
||||
2. 根据需要开启或关闭以下功能：
|
||||
- 自动回复消息
|
||||
- 加好友欢迎消息
|
||||
- 群组和多人聊天
|
||||
- 机器人加入群组时的问候语
|
||||
|
||||
## 使用
|
||||
|
||||
配置完成后，用户可以通过以下方式与您的 LINE 机器人互动：
|
||||
|
||||
1. 扫描 LINE 开发者控制台中提供的 QR 码添加机器人为好友
|
||||
2. 在聊天中发送消息，机器人将通过 LangBot 处理并回复
|
||||
|
||||
## 常见问题
|
||||
|
||||
### Webhook 验证失败
|
||||
|
||||
- 确保您的服务器可以通过 HTTPS 访问
|
||||
- 检查 Webhook URL 是否正确
|
||||
- 确认 LangBot 服务是否正常运行
|
||||
|
||||
### 消息无法接收
|
||||
|
||||
- 检查 Channel Access Token 是否有效
|
||||
- 确认 "Use Webhook" 选项已开启
|
||||
- 查看 LangBot 日志是否有错误信息
|
||||
|
||||
### 权限问题
|
||||
|
||||
- 确保您已在 LINE 开发者控制台中为机器人开启了必要的权限
|
||||
- 对于某些高级功能，可能需要 LINE Premium 账号
|
||||
@@ -1,67 +0,0 @@
|
||||
# 部署消息平台 Lagrange
|
||||
|
||||
## Lagrange介绍
|
||||
|
||||
Lagrange 是一个 QQNT 协议逆向工程框架，轻便且相对稳定。通过 OneBot 11 协议接入，需选择使用`OneBot v11`作为适配器。
|
||||
|
||||
::: warning
|
||||
需要使用 NT QQ 与机器人交互，旧版QQ无法正常使用
|
||||
:::
|
||||
|
||||
## 部署步骤
|
||||
|
||||
以下仅提供 Windows 上的大致步骤，详细步骤或其他平台请参考 [Lagrange官方文档](https://lagrangedev.github.io/Lagrange.Doc/v1/Lagrange.OneBot/)
|
||||
|
||||
### 环境配置
|
||||
|
||||
安装.NET 8运行时，[点击直达微软官网下载](https://dotnet.microsoft.com/zh-cn/download/dotnet/thank-you/runtime-desktop-8.0.4-windows-x64-installer)
|
||||
|
||||
### 从Github Actions下载最新的build
|
||||
|
||||
需要登录Github后才能下载，如果你不需要部分特性，可以在Release下载，看图片3
|
||||
|
||||
[Github Actions](https://github.com/KonataDev/Lagrange.Core/actions)
|
||||
|
||||
看图进行下载:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 尾声
|
||||
|
||||
解压你所下载的zip，打开到有Lagrange.OneBot.exe的目录，在此目录下打开cmd命令提示符，输入
|
||||
|
||||
```bash
|
||||
.\Lagrange.OneBot
|
||||
```
|
||||
|
||||
运行一次，如果输出了一个二维码，即可直接用机器人号扫码登录（若二维码显示不清楚，可以到lagrange的data目录下寻找图片文件）。
|
||||
|
||||
若无法登录，请检查是否正常填写了lagrange配置文件appsettings.json中的签名地址 SignServerUrl ，签名地址请到lagrange文档中寻找。
|
||||
|
||||
## 修改配置
|
||||
|
||||
需要配置 Lagrange 以让其连接上 LangBot，请编辑 Lagrange 的配置文件 appsettings.json，确保 Implementations 中的连接配置符合下图内容：
|
||||
|
||||
|
||||
|
||||
其中 Type 必须为 `ReverseWebSocket`;
|
||||
Host 为 LangBot 运行的主机 IP，若在同一主机上，可以写 `127.0.0.1`；
|
||||
Suffix 必须为 `/ws`；
|
||||
|
||||
## Lagrange 对接
|
||||
|
||||
接下来打开 LangBot 配置页面
|
||||
|
||||
点击机器人，点击添加
|
||||
|
||||
`平台/适配器选择`为`OneBot v11`
|
||||
|
||||
|
||||
|
||||
::: info
|
||||
注意，如果涉及多个 docker 容器的网络连接问题，请参考[网络配置详解](/zh/workshop/network-details)
|
||||
:::
|
||||
@@ -1,27 +0,0 @@
|
||||
# 部署消息平台 LiteLoaderQQNT
|
||||
|
||||
通过 OneBot 11 协议接入，需选择使用``OneBot v11``作为适配器。
|
||||
|
||||
# LiteLoaderQQNT
|
||||
|
||||
- [LiteLoaderQQNT 的 OneBot API 插件](https://github.com/LLOneBot/LLOneBot) 注入 QQ 客户端并将其转换为 OneBot 11 协议
|
||||
|
||||
安装LiteLoaderQQNT的教程：https://llonebot.github.io/zh-CN/guide/getting-started
|
||||
|
||||
|
||||
|
||||
确保地址中 IP地址 是 LangBot 运行的主机的地址（若在同一网络内运行则为 127.0.0.1）
|
||||
|
||||
## Lagrange 对接
|
||||
|
||||
接下来打开 LangBot 配置页面
|
||||
|
||||
点击机器人，点击添加
|
||||
|
||||
`平台/适配器选择`为`OneBot v11`
|
||||
|
||||
|
||||
|
||||
::: info
|
||||
注意，如果涉及多个 docker 容器的网络连接问题，请参考[网络配置详解](/zh/workshop/network-details)
|
||||
:::
|
||||
@@ -1,33 +0,0 @@
|
||||
# 部署消息平台 NapCat
|
||||
|
||||
通过 OneBot 11 协议接入，需选择使用``OneBot v11``作为适配器。
|
||||
|
||||
## NapCat安装教程
|
||||
|
||||
按照 [NapCat 官方文档安装](https://napcat.napneko.icu/guide/start-install)
|
||||
|
||||
## NapCat配置教程
|
||||
|
||||
仅以 webui 操作为例，其他的配置方式请查看 NapCat 文档。
|
||||
|
||||
登录后，在控制台或Bash上可以查看日志 , 找到 `[NapCat] [WebUi] WebUi Publish Panel Url: http://x.x.x.x:6099/webui?token=xxxxx `
|
||||
|
||||
|
||||
复制Url到浏览器或者 Windows11 按照Ctrl点击Url即可 扫码登录后即可进入网络配置一页
|
||||
|
||||
点击添加网络配置 WebSocket客户端 点击启用 然后在Url一栏填入 `ws://127.0.0.1:2280/ws` 并保存即可
|
||||
|
||||
|
||||
## NapCat 对接
|
||||
|
||||
接下来打开 LangBot 配置页面
|
||||
|
||||
点击机器人，点击添加
|
||||
|
||||
`平台/适配器选择`为`OneBot v11`
|
||||
|
||||
|
||||
|
||||
::: info
|
||||
注意，如果涉及多个 docker 容器的网络连接问题，请参考[网络配置详解](/zh/workshop/network-details)
|
||||
:::
|
||||
@@ -1,15 +0,0 @@
|
||||
# 使用 QQ 官方机器人 API（使用websocket方式）
|
||||
|
||||
:::warning
|
||||
QQ 官方已停止维护 WebSocket 方式，请使用 Webhook 方式。
|
||||
:::
|
||||
|
||||
QQ官方机器人所有人均可申请，可以在频道和群聊中使用，私聊也可。
|
||||
|
||||
## 注册 QQ 机器人
|
||||
|
||||
前往[QQ开放平台](https://q.qq.com/#/)，找到下方的 QQ 机器人文档，按照指引注册 QQ 频道机器人。
|
||||
|
||||
## 获取凭证
|
||||
|
||||
注册完成后，前往机器人控制台，找到 开发设置，获取 `AppId(机器人ID)` 和 `AppSecret(机器人密钥)`，接下来进入填写配置信息步骤。
|
||||
@@ -1,80 +0,0 @@
|
||||
# 使用 QQ 官方机器人 API（使用webhook方式）
|
||||
|
||||
本文章只提供测试版机器人的发布，具体机器人上线请按照 [发布流程](https://q.qq.com/qqbot/#/home) 进行部署。
|
||||
|
||||
:::warning
|
||||
目前 QQ 官方发布公告，禁止违规接入 AIGC 功能，请慎重使用。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
## 注册 QQ 机器人（测试机器人）
|
||||
|
||||
### 配置机器人基本信息
|
||||
|
||||
前往 [QQ开放平台](https://q.qq.com/#/) ，找到下方的 `应用管理` ，点击创建机器人，填写基本信息之后，进入机器人页面，如图：
|
||||
|
||||
|
||||
|
||||
`首页` 选项中的 `发布流程` 即为上线机器人的步骤。由于部署的是测试版机器人，所以只需要进行其中的 `资料` 和 `沙箱配置` 。<br>
|
||||
|
||||
先进行资料填写，然后点击沙箱配置。
|
||||
|
||||
#### 配置沙箱配置项
|
||||
|
||||
点击 `沙箱配置` 。
|
||||
如果要部署在QQ群中，那么按照 `QQ群ID` 下方的要求进行选择群聊，在消息列表配置中添加有私聊权限的用户。<br>
|
||||
如果要部署在QQ频道中，那么按照 `频道ID` 下方的要求选择频道ID，机器人类型为0。
|
||||
|
||||
#### 配置开发管理项
|
||||
|
||||
点击 `开发管理` 。
|
||||
|
||||
|
||||
|
||||
记录其中的 `AppID` , `Token` , `AppSecret` ,并将 LangBot 所在服务器的IP地址填写到IP白名单中。
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
接下来打开 LangBot 配置页面
|
||||
|
||||
点击机器人，点击添加
|
||||
|
||||
`平台/适配器选择`为`QQ官方API`
|
||||
|
||||
|
||||
|
||||
|
||||
## 配置回调地址
|
||||
|
||||
要求 LangBot 部署在具有公网 IP 的服务器上，并已成功启用 HTTPS。请根据文档[配置 HTTP 反向代理和 SSL](/zh/workshop/production/proxy-and-ssl) 操作。
|
||||
|
||||
|
||||
#### 后续配置
|
||||
|
||||
若 Caddy 启动不成功，请自行阅读 [Caddy文档](https://caddy2.dengxiaolong.com/docs/quick-starts/caddyfile)，或者加入 LangBot 社区群请求帮助。<br>
|
||||
|
||||
以下是一些可能出现的问题：
|
||||
|
||||
- 没有开启443端口
|
||||
- 没有将域名解析到本机
|
||||
- 没有成功保存 Caddyfile
|
||||
|
||||
### 设置管理端回调地址
|
||||
|
||||
|
||||
首先 **启动 LangBot** 。
|
||||
|
||||
点击 机器人管理端网页中的 `回调配置`，勾选下面 `添加事件` 中的所有事件。
|
||||
|
||||
进入 LangBot 配置页面，启用并且选择对应的QQ机器人，粘贴对应机器人配置页面中的 Webhook 回调地址，将其中的 IP 地址和端口改成之前 Caddy 配置的域名，在请求地址中填入。
|
||||
|
||||
如图：
|
||||
|
||||
|
||||
|
||||
比如域名为 `testlb.com`，那么请求地址中填写 `testlb.com/bots/xxxxxx-xxxxxx` ，点击确定配置。如果回调地址保存成功，那么意味着部署成功。若出现 `校验失败` 字样，请认真检查上述配置项是否填写正确。
|
||||
|
||||
## 发布方式
|
||||
|
||||
进入 `首页` 的发布流程 ，按照流程进行机器人发布，上线。
|
||||
@@ -1,22 +1,3 @@
|
||||
# 配置机器人 (Bots)
|
||||
|
||||
机器人用于从消息平台接收消息事件并调用流水线处理消息。
|
||||
|
||||
|
||||
|
||||
|
||||
| 平台 | 状态 | 备注 |教程 |
|
||||
| ------ | ---- | ---- | ---- |
|
||||
| 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) |
|
||||
| 企业微信智能机器人 | ✅ | 智能机器人 | [教程](/zh/deploy/platforms/wecom/wecombot) |
|
||||
| 微信公众号 | ✅ | 微信公众平台机器人 | [教程](/zh/deploy/platforms/wxoa.md) |
|
||||
| 飞书 | ✅ | | [教程](/zh/deploy/platforms/lark) |
|
||||
| 钉钉 | ✅ | | [教程](/zh/deploy/platforms/dingtalk) |
|
||||
| Discord | ✅ | | [教程](/zh/deploy/platforms/discord) |
|
||||
| Telegram | ✅ | | [教程](/zh/deploy/platforms/telegram) |
|
||||
| Slack | ✅ | | [教程](/zh/deploy/platforms/slack) |
|
||||
| LINE | ✅ | | [教程](/zh/deploy/platforms/line) |
|
||||
| KOOK | ✅ | | [教程](/zh/deploy/platforms/kook) |
|
||||
<script setup>
|
||||
window.location.href = '/zh/usage/platforms/readme'
|
||||
</script>
|
||||
|
||||
@@ -1,55 +0,0 @@
|
||||
# 接入 Slack 机器人
|
||||
|
||||
## 创建机器人
|
||||
|
||||
前往 [Slack的App平台](https://api.slack.com/apps)。
|
||||
|
||||
|
||||
|
||||
点击右上角的 `Create New App` ，选择从 `from a manifest` ， 选择要部署机器人的工作区，选择下一步，
|
||||
选择创建机器人。
|
||||
|
||||
进入左侧 `Basic Information` 选项，记录 `signing_secret`。
|
||||
|
||||
进入左侧 `OAuth & Permissions` ，往下拉到 `Scopes`，添加如下机器人权限：
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
添加上述权限之后，点击 `Install to your workspace`，记录下开头为 `xoxb-xxxxx`的token。<br>
|
||||
|
||||
**注：**
|
||||
**若没有一次性添加成功权限，后续则需要重新安装App。**<br>
|
||||
|
||||
进入左侧 `App Home` 栏，滑到最下面有 `Message Tab`，打开并且勾选
|
||||
`Allow users to send Slash commands and messages from the messages tab`。
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
进入左侧 `Event Subscriptions` ，打开开关，点击 `Subscribe to bot events`，
|
||||
将如下权限添加进去:
|
||||
|
||||
|
||||
上述操作都完成之后，打开 LangBot Webui 配置页面，添加一个新的机器人
|
||||
|
||||
|
||||
|
||||
## 启动机器人
|
||||
|
||||
::: info
|
||||
由于 Slack 官方要求使用 https，请根据文档[配置 HTTP 反向代理和 SSL](/zh/workshop/production/proxy-and-ssl) 先配置好反向代理。
|
||||
:::
|
||||
|
||||
Slack 配置项在填写完成后，**启动 LangBot**。
|
||||
启用并打开 LangBot 主页中的 Slack 机器人配置页面，复制其中的 WebHook URL，在刚才Event Subscriptions的 `Request URL`中，填写入 WebHook URL。
|
||||
|
||||
|
||||
上述配置项都填写完成后，点击保存链接，若标识为绿色的**Verified**，那么就说明部署成功。
|
||||
否则查看上述配置项是否填写正确。
|
||||
|
||||
## 效果图
|
||||
|
||||
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# 接入 Telegram 机器人
|
||||
|
||||
## 创建机器人
|
||||
|
||||
前往 [Telegram 机器人创建页面](https://t.me/botfather)，按照提示操作，创建一个机器人。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
创建完成后，BotFather 会返回一个 API Token，请妥善保存。接下来关闭`Privacy Mode`，以便在群聊中使用。
|
||||
|
||||
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
打开 LangBot Webui 页面，创建一个新机器人
|
||||
|
||||
|
||||
|
||||
填写完成后启动 LangBot，若成功配置，日志中会出现`[02-02 16:48:15.263] manager.py (68) - [INFO] : 初始化平台适配器 1: telegram`的字样，保持 LangBot 运行。
|
||||
|
||||
## 使用机器人
|
||||
|
||||
现在在群里或者私聊机器人都可以正常使用了。
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,401 +0,0 @@
|
||||
# 通过 WeChatPadPro 接入个人微信
|
||||
|
||||
> 异地警告，没有 Socks5 代理或者本地服务器慎用！！！！！！
|
||||
|
||||
**本教程仅说明 Docker 部署教程，如果可以尽量将 WeChatPadPro 部署到同一网络**
|
||||
|
||||
|
||||
## 拉取 WeChatPad-Docker
|
||||
|
||||
1. 原项目
|
||||
|
||||
```bash
|
||||
git clone https://github.com/WeChatPadPro/WeChatPadPro.git
|
||||
cd WeChatPadPro/deploy
|
||||
```
|
||||
|
||||
2. 简化
|
||||
|
||||
```bash
|
||||
git clone https://github.com/fdc310/WeChatPad-Docker.git
|
||||
```
|
||||
|
||||
|
||||
### 一、如果不更改 Redis、MySQL、AdminKey 和相关端口及其网络的情况下可以直接运行
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
* 查看日志是否启动成功
|
||||
|
||||
```bash
|
||||
# 简化
|
||||
docker logs wechatpad
|
||||
# or 原版
|
||||
docker logs wechatpadpro
|
||||
```
|
||||
|
||||
启动成功实例如下输出：
|
||||
|
||||
查看并记录自己的日志生成的 `adminKey`，后面登录会用到。
|
||||
|
||||
```bash
|
||||
版本号: v20240818.00
|
||||
======== ADMIN_KEY === adminKey ========
|
||||
connect MySQL success
|
||||
auto create MySQL tables success
|
||||
connect Redis success
|
||||
GET Connection locfree Failed by ee4c9a06-cf5e-4451-9e81-5290d0217625 abandon the conntection get !
|
||||
updateApiVersion success
|
||||
|
||||
启动GIN服务成功！ http://0.0.0.0:8849
|
||||
```
|
||||
|
||||
* 然后在本机或者局域网下访问 `http://serveip:9090` 进入 Swagger 即可。（这是简化版 docker-compose 中映射端口号）
|
||||
* 然后在本机或者局域网下访问 `http://serveip:1239` 进入 Swagger 即可。（这是原版 docker-compose 中映射端口号）
|
||||
|
||||
|
||||
### 二、如果要更改（简化版）docker-compose 网络与 langbot 在同一个 Docker 网络中，以及数据库密码和端口更改
|
||||
|
||||
参考修改 YAML 文件，以下是 WeChatPad 的 YAML 文件，容器连接方式可以参考 [文档](/zh/workshop/network-details.html)。
|
||||
|
||||
* 如需修改数据库账号密码等，有能力的自行修改，此版本修改需要同时修改项目目录下 ``app/assets/setting.json`` 中的用户密码相关
|
||||
|
||||
```yaml
|
||||
version: "3.3"
|
||||
services:
|
||||
mysql_wx:
|
||||
container_name: mysql_wxpad
|
||||
image: mysql:8.0
|
||||
ports:
|
||||
- "3306:3306"
|
||||
restart: always
|
||||
logging:
|
||||
driver: "json-file"
|
||||
options:
|
||||
max-size: "5g"
|
||||
environment:
|
||||
MYSQL_ROOT_PASSWORD: test_mysql
|
||||
MYSQL_ROOT_HOST: '%'
|
||||
MYSQL_DATABASE: wechatpadpro
|
||||
volumes:
|
||||
- "./mysql/data:/var/lib/mysql"
|
||||
- "./mysql/config:/etc/mysql/conf.d"
|
||||
networks:
|
||||
- langbot-network
|
||||
healthcheck:
|
||||
test: [ "CMD", "mysqladmin", "ping", "-h", "localhost" ]
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 5
|
||||
|
||||
redis_wx:
|
||||
image: redis:alpine
|
||||
container_name: redis_wxpad
|
||||
restart: unless-stopped
|
||||
command: redis-server --requirepass test_redis
|
||||
environment:
|
||||
- REDIS_PASSWORD=test_redis
|
||||
volumes:
|
||||
- ./redis/data:/data
|
||||
ports:
|
||||
- "6381:6379"
|
||||
networks:
|
||||
- langbot-network
|
||||
healthcheck:
|
||||
test: ["CMD", "redis-cli", "-a", "test_redis", "ping"]
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 5
|
||||
|
||||
wechatpad:
|
||||
container_name: wechatpad
|
||||
image: alpine:latest
|
||||
ports:
|
||||
- "9090:8849"
|
||||
restart: always
|
||||
depends_on:
|
||||
mysql_wx:
|
||||
condition: service_healthy
|
||||
redis_wx:
|
||||
condition: service_healthy
|
||||
links:
|
||||
- mysql_wx
|
||||
- redis_wx
|
||||
volumes:
|
||||
- ./app:/app # 映射数据目录，宿主机:容器
|
||||
working_dir: /app
|
||||
command: [ "/bin/sh", "-c", "chmod +x ./stay && ./stay" ]
|
||||
logging:
|
||||
driver: "json-file"
|
||||
options:
|
||||
max-size: "5g"
|
||||
environment:
|
||||
- TZ=Asia/Shanghai
|
||||
- LANG=zh_CN.UTF-8
|
||||
- LC_ALL=zh_CN.UTF-8
|
||||
networks:
|
||||
- langbot-network
|
||||
networks:
|
||||
langbot-network:
|
||||
external: true
|
||||
```
|
||||
|
||||
|
||||
### 三、原版 docker-compose 需要修改与 langbot 同一 Docker 网络中，以及数据库用户密码，都那口映射修改可参考以下：
|
||||
|
||||
* 如需修改数据库账号密码等，有能力的自行修改，此版本修改需要同时修改项目目录下 ``deploy/.env`` 中的用户密码相关
|
||||
|
||||
```yaml
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
wechatpadpro:
|
||||
image: registry.cn-hangzhou.aliyuncs.com/wechatpad/wechatpadpro:v0.11
|
||||
container_name: wechatpadpro
|
||||
restart: always
|
||||
ports:
|
||||
- "1239:1239"
|
||||
volumes:
|
||||
- wechatpadpro_data:/app/data
|
||||
- wechatpadpro_logs:/app/logs
|
||||
environment:
|
||||
- TZ=Asia/Shanghai
|
||||
- DEBUG=false
|
||||
- ADMIN_KEY=12345
|
||||
- HOST=0.0.0.0
|
||||
- PORT=1239
|
||||
- REDIS_HOST=redis
|
||||
- REDIS_PORT=6379
|
||||
- REDIS_DB=1
|
||||
- REDIS_PASS=123456
|
||||
- MYSQL_CONNECT_STR=wechatpadpro:123456@tcp(mysql:3306)/wechatpadpro?charset=utf8mb4&parseTime=true&loc=Local
|
||||
depends_on:
|
||||
mysql:
|
||||
condition: service_healthy
|
||||
redis:
|
||||
condition: service_healthy
|
||||
networks:
|
||||
- langbot-network
|
||||
|
||||
redis:
|
||||
image: registry.cn-hangzhou.aliyuncs.com/wechatpad/wechatpadpro-redis:v0.1
|
||||
container_name: wechatpadpro_redis
|
||||
restart: always
|
||||
command: redis-server --requirepass 123456
|
||||
volumes:
|
||||
- redis_data:/data
|
||||
healthcheck:
|
||||
test: ["CMD", "redis-cli", "ping"]
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 3
|
||||
networks:
|
||||
- langbot-network
|
||||
|
||||
mysql:
|
||||
image: registry.cn-hangzhou.aliyuncs.com/wechatpad/wechatpadpro-mysql:v0.11
|
||||
container_name: wechatpadpro_mysql
|
||||
restart: always
|
||||
environment:
|
||||
- MYSQL_ROOT_PASSWORD=123456
|
||||
- MYSQL_DATABASE=wechatpadpro
|
||||
- MYSQL_USER=wechatpadpro
|
||||
- MYSQL_PASSWORD=123456
|
||||
- TZ=Asia/Shanghai
|
||||
volumes:
|
||||
- mysql_data:/var/lib/mysql
|
||||
healthcheck:
|
||||
test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "wechatpadpro", "-p123456"]
|
||||
interval: 5s
|
||||
timeout: 3s
|
||||
retries: 3
|
||||
networks:
|
||||
- langbot-network
|
||||
|
||||
networks:
|
||||
langbot-network:
|
||||
driver: bridge
|
||||
|
||||
volumes:
|
||||
wechatpadpro_data:
|
||||
wechatpadpro_logs:
|
||||
redis_data:
|
||||
mysql_data:
|
||||
```
|
||||
|
||||
#### `.env` 环境变量说明
|
||||
|
||||
| 变量名 | 说明 | 默认值 | 是否必填 |
|
||||
|--------------------|----------------|------------|----------|
|
||||
| DEBUG | 调试模式 | false | 否 |
|
||||
| ADMIN_KEY | 管理员密钥 | 12345 | 是 |
|
||||
| PORT | 服务端口 | 1239 | 否 |
|
||||
| REDIS_PASS | Redis 密码 | 123456 | 是 |
|
||||
| MYSQL_CONNECT_STR | MySQL 连接串 | 见配置文件 | 是 |
|
||||
|
||||
|
||||
## 如果要手动部署
|
||||
|
||||
* 手动部署或者 Win 上使用 Docker 部署参考以下官方文档
|
||||
|
||||
请查看 [WeChatPadPro 文档](https://github.com/luolin-ai/WeChatPadPro)
|
||||
|
||||
|
||||
## 登录微信
|
||||
|
||||
1. 成功启动 WeChatPadPro 后根据你的 serverip:port 访问 WeChatPadPro 的 Swagger
|
||||
|
||||
|
||||
2. 填入 adminKey
|
||||
|
||||
|
||||
3. 获取 token
|
||||
** try it out `/admin/GanAuthKey1` 接口 body 中的 days 改为 365 即可
|
||||
|
||||
|
||||
等待返回拿到里面的 token 回填入上面的 token
|
||||
|
||||
|
||||
5. 登录微信
|
||||
** try it out `/login/GetLoginQrCodeNew` 接口即可（和服务器是同市或者同省）
|
||||
|
||||
|
||||
** 如果是云服务器，需要填入 Proxy
|
||||
|
||||
|
||||
** 返回的参数中有登录二维码链接，打开扫码登录即可
|
||||
|
||||
|
||||
** 手机登录后看是否有 iPad 在线，如果不在线就使用, 查看扫码状态
|
||||
|
||||
|
||||
> 没有在线的话是因为什么（这是我已经成功登录，扫码状态过期了）
|
||||
|
||||
|
||||
|
||||
6. 记录你的 adminkey、token、wx 地址和访问地址（wxid 可以不管）
|
||||
|
||||
|
||||
## 在 langbot 的创建机器人中填写信息
|
||||
|
||||
- `wechatpad_key` 填写 adminKey
|
||||
- `wechatpad_url` 填写 WeChatPadPro 的地址
|
||||
- `wechatpad_ws` 填写 WeChatPadPro 的 ws 地址
|
||||
- `wxid` 填写该登录账号的 wxid
|
||||
- `wechatpad_token` 填写 WeChatPadPro 的 token
|
||||
|
||||
|
||||
|
||||
|
||||
## 详细的 API 接口文档
|
||||
|
||||
如果有想要为该适配器做贡献，或者制作微信相关插件请查看 [WeChatPadPro API 文档](https://doc.apipost.net/docs/460ada21e884000?locale=zh-cn)
|
||||
里面有相关接口及其参数说明
|
||||
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 1. 服务无法启动
|
||||
|
||||
检查步骤：
|
||||
|
||||
```bash
|
||||
# 查看服务日志
|
||||
docker-compose logs
|
||||
|
||||
# 查看具体服务日志
|
||||
docker-compose logs wechatpadpro
|
||||
docker-compose logs mysql
|
||||
docker-compose logs redis
|
||||
```
|
||||
|
||||
### 2. 数据持久化
|
||||
|
||||
数据默认保存在以下 Docker volumes 中：
|
||||
- `wechatpadpro_data`：应用数据
|
||||
- `wechatpadpro_logs`：应用日志
|
||||
- `redis_data`：Redis 数据
|
||||
- `mysql_data`：MySQL 数据
|
||||
|
||||
查看数据卷：
|
||||
|
||||
```bash
|
||||
docker volume ls | grep wechatpadpro
|
||||
```
|
||||
|
||||
### 3. 服务重启
|
||||
|
||||
```bash
|
||||
# 重启所有服务
|
||||
docker-compose restart
|
||||
|
||||
# 重启单个服务
|
||||
docker-compose restart wechatpadpro
|
||||
```
|
||||
|
||||
|
||||
## 维护指南
|
||||
|
||||
### 日常维护
|
||||
|
||||
1. 查看服务状态：
|
||||
|
||||
```bash
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
2. 查看服务日志：
|
||||
|
||||
```bash
|
||||
docker-compose logs -f --tail=100
|
||||
```
|
||||
|
||||
3. 备份数据：
|
||||
|
||||
```bash
|
||||
# 备份 MySQL 数据
|
||||
docker exec wechatpadpro_mysql mysqldump -u root -p123456 wechatpadpro > backup.sql
|
||||
```
|
||||
|
||||
### 官方版本升级
|
||||
|
||||
1. 拉取最新镜像：
|
||||
|
||||
```bash
|
||||
docker-compose pull
|
||||
```
|
||||
|
||||
2. 重新部署服务：
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### 简化版升级
|
||||
|
||||
* 需要重新拉取 GitHub
|
||||
|
||||
```bash
|
||||
git clone
|
||||
cd WeCahtPad_Docker
|
||||
docker compose down
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
|
||||
## 安全建议
|
||||
|
||||
1. 修改默认密码
|
||||
- 修改 `ADMIN_KEY`
|
||||
- 修改 MySQL 密码
|
||||
- 修改 Redis 密码
|
||||
|
||||
2. 限制端口访问
|
||||
- 只对必要端口开放外部访问
|
||||
- 使用防火墙限制 IP 访问
|
||||
|
||||
3. 定期备份
|
||||
- 备份 MySQL 数据
|
||||
- 备份应用数据
|
||||
@@ -1,79 +0,0 @@
|
||||
# 部署企业微信机器人
|
||||
|
||||
部署企业微信机器人接入 LangBot 。
|
||||
|
||||
:::info
|
||||
- 此种接入方式为企业内部自建应用，是在企业内部使用的，若需要对外接待，请查看[企业微信客服接入方案](wecomcs.md)。
|
||||
- 企业微信回调地址需要公网IP和域名，推荐您先参照[配置 HTTP 反向代理](/zh/workshop/production/proxy-and-ssl)来配置 LangBot 回调地址。
|
||||
:::
|
||||
|
||||
## 记录企业ID
|
||||
|
||||
打开[企业微信管理后台](https://work.weixin.qq.com/)，点击`我的企业`，记录下最下面的`企业ID`。
|
||||
|
||||
|
||||
|
||||
## 创建机器人
|
||||
|
||||
点击` 应用管理 `,` 自建 `,` 创建应用`
|
||||
|
||||
|
||||
|
||||
填写机器人基本信息：
|
||||
|
||||
|
||||
|
||||
查看并记录机器人密钥（Secret）：
|
||||
|
||||
|
||||
|
||||
从企业微信客户端根据提示获取。
|
||||
|
||||
## 开启通讯录同步权限
|
||||
|
||||
:::info
|
||||
- 此配置项是为了实现 LangBot 的群发消息，具体代码位于libs/wecom_api/api.py 。
|
||||
- 目前 LangBot 仍在开发，所以未实现此配置项的相关功能。
|
||||
- 此配置项可以填写入随机字符，**不能为空**。
|
||||
:::
|
||||
|
||||
点击`安全与管理`,`管理工具`,`通讯录同步`；先配置可信IP，添加部署 LangBot 的服务器IP。
|
||||
|
||||
点击`查看secret`，记录下来，这是 contacts_secret（通讯录同步 secret）。
|
||||
|
||||
|
||||
|
||||
## 在 LangBot 新建机器人
|
||||
|
||||
在 LangBot 机器人页面，点击`创建机器人`，填入名称，选择`企业微信`，此步骤只需要填入 企业ID 和 机器人密钥，以及通讯录同步 secret。
|
||||
|
||||
|
||||
|
||||
点击提交，跳转到机器人编辑页面，点击启用；此时即可看到 Webhook 回调地址，复制下来：
|
||||
|
||||
|
||||
|
||||
## 设置回调地址
|
||||
|
||||
回到企业微信的机器人管理页面，点击`接收消息`，`设置API接收`，将 LangBot 的 Webhook 回调地址填入`URL`中：
|
||||
|
||||
|
||||
|
||||
点击 Token 和 EncodingAESKey 的`随机获取`，并记录下来，**保持此页开启**。返回到 LangBot 的企微机器人配置页面，将 Token 和 EncodingAESKey 填入，点击保存。
|
||||
|
||||
|
||||
|
||||
再回到**刚刚填写 Webhook 回调地址的页面**，点击保存即可配置完成；如果出现**请求URL失败**，请再三检查你的配置项填写是否正确。
|
||||
|
||||
## 配置应用的企业可信 IP
|
||||
|
||||
回到该应用到管理页，在下方找到`企业可信 IP`，添加部署 LangBot 的服务器IP。
|
||||
|
||||
|
||||
|
||||
点击保存即可。
|
||||
|
||||
## 常见问题
|
||||
|
||||
Q：企微上找不到机器人对话框？
|
||||
A：可以到企微管理页面上该应用的详情页，点击`功能`->`发送消息`->`发消息`，选择自己账号，发送消息，即可在自己的对话框中看到机器人。
|
||||
@@ -1,63 +0,0 @@
|
||||
# 部署企业微信智能机器人
|
||||
|
||||
|
||||
## 创建机器人
|
||||
|
||||
首先登录[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#/)。
|
||||
|
||||
|
||||
|
||||
点击左边栏的`安全与管理`，点击`管理工具`里面的`智能机器人`。
|
||||
|
||||
如图:
|
||||
|
||||
|
||||
|
||||
点击`创建机器人`，拉至页面最底部，点击`API模式创建`，进入页面：
|
||||
|
||||
|
||||
|
||||
点击随机获取 Token 和 EncodingAESKey，然后填写上方的机器人基本信息，**注意设置可见范围**。
|
||||
|
||||
点击左边栏的`我的企业`，保存最下方的企业ID。
|
||||
|
||||
## 配置回调地址
|
||||
|
||||
启动 LangBot 主程序，适配器选择 `企业微信智能机器人`，填写配置项，
|
||||
其中，令牌为 Token，消息加解密密钥为 EncodingAESKey，机器人ID填写入xxx（或者随便填写，后续会改），填写之后点击
|
||||
`保存`，并`启用`机器人。
|
||||
|
||||
|
||||
|
||||
在 LangBot 主页中，启用并选择对应的机器人，点击进入配置页面，复制其中的 Webhook 回调地址
|
||||
|
||||
::: info
|
||||
推荐您先参照[配置 HTTP 反向代理](/zh/workshop/production/proxy-and-ssl)来配置 LangBot 回调地址。
|
||||
:::
|
||||
|
||||
|
||||
|
||||
返回企业微信机器人配置页面将复制的webhook地址填写到`URL回调`中。若创建成功，则会跳转至详情页面，若出现`请求URL失败`字样，请再三检查上述操作是否一一完成。
|
||||
|
||||
创建成功之后的详情页：
|
||||
|
||||
|
||||
复制企业微信机器人详情页的`Bot ID`，回到LangBot管理页面，将部署的智能机器人的机器人Id改为复制的ID，重新启动机器人。
|
||||
|
||||
## 开始使用
|
||||
|
||||
进入企业微信，点击 `➕`,如图：
|
||||
|
||||
|
||||
|
||||
点击`企业创建的`,选择创建的机器人，进入聊天界面。
|
||||
|
||||
同理，若想邀请机器人进入群聊，那么点击群聊的添加人员，在其中添加机器人。
|
||||
|
||||
## 效果图
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
# 部署企业微信客服
|
||||
|
||||
:::info
|
||||
|
||||
本文详细讲述 LangBot 部署到企业微信客服号的过程，此功能可以将客服号与普通微信进行对话。若只需要在企业微信内部使用，请参考[企业微信内部应用实现](wecom.md)。
|
||||
|
||||
**部署企业微信客服号需要企业资质**，具体查看[企业微信客服号接入指南](https://developer.work.weixin.qq.com/document/path/94638)，并且根据此文档提供对应的企业资质证明。
|
||||
|
||||
:::
|
||||
|
||||
## 效果图
|
||||
|
||||
|
||||
|
||||
## 对接 LangBot
|
||||
|
||||
|
||||
|
||||
后续的配置方式和配置项和[企业微信内部应用](wecom.md)一样，只是不需要 `contacts_secret`。
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. 一定要按照上文的企业微信官方文档步骤走，将客服账号添加入 `api 管理`中。
|
||||
2. 步骤与企业微信内部应用一样，不要漏看，同样需要保存回调地址，因为本质上只是在企业微信内部应用上增加了其他的权限。
|
||||
3. LangBot 不会读取敏感信息如聊天记录和企业资质内容。
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
# 部署微信公众号机器人
|
||||
|
||||
部署微信公众号机器人接入 LangBot 。
|
||||
|
||||
## LangBot 微信公众号接入模式
|
||||
|
||||
目前，LangBot 提供两种方式接入微信公众号：
|
||||
|
||||
1. **传统收发消息模式**
|
||||
- 公众号要求请求必须在 **15 秒内** 处理完成，超时的 AI 生成内容将无法发送。
|
||||
- 当 AI 生成内容超时发生后，LangBot 会在控制台打印请求超时信息。
|
||||
|
||||
2. **“发送任意文字回复消息”模式**
|
||||
- 该方法可突破 **15 秒** 限制，但 **过长的文本** 可能无法成功发送。
|
||||
- 使用此方法时，给公众号发消息，公众号会回复“AI正在思考中，请发送任意内容获取回答”，此时，需要发送任意内容获取回答。
|
||||
|
||||
如需更复杂的功能，请联系 **LangBot 团队** 进行定制化支持。
|
||||
|
||||
## 创建机器人
|
||||
|
||||
进入[微信公众平台](https://mp.weixin.qq.com/)，如果已经有公众号账号，那么直接扫码登录，进入控制台。
|
||||
如果之前没有注册过公众号，那么点击立即注册，选择 `公众号`，依次填写信息，进入控制台。控制台是这样的：
|
||||
|
||||
|
||||
|
||||
## 设置回调地址
|
||||
|
||||
### 获取配置项
|
||||
|
||||
点击`设置与开发`，`开发接口管理`，出现这样的页面：
|
||||
|
||||
|
||||
记录下来`开发者ID（AppID）`，`开发者密码（AppSecret）`，并将部署 LangBot 的服务器添加入`IP白名单`。
|
||||
|
||||
### 为 LangBot 设置反向代理
|
||||
|
||||
由于微信公众号的只支持http（80端口），https（443端口），请根据文档[配置 HTTP 反向代理和 SSL](/zh/workshop/production/proxy-and-ssl) 操作。
|
||||
|
||||
### 保存回调地址
|
||||
|
||||
点击设置服务器配置，输入`Token`，`EncodingAESKey`，并将消息加解密方式改为`安全模式`。
|
||||
|
||||
至此，打开 LangBot Webui 页面，创建一个新的机器人，将获取到的四个配置项( AppID , AppSecret , token , EncodingAESKey )填入
|
||||
|
||||
|
||||
|
||||
在配置项中，`Mode`选项为选择的接入模式，其中默认为`drop`，`drop` 为传统收发消息模式，`passive` 为发送任意文字获取回复模式。
|
||||
|
||||
`LoadingMessage`选项为加载信息，可以更改为其他内容，仅在模式为`passive`下有效。将 `enable` 设置为 `true` 。
|
||||
|
||||
填写成功后，在 LangBot 主页中，启用并选择对应的机器人，点击进入配置页面，复制其中的 Webhook 回调地址，返回微信公众号机器人配置页面，填写到`URL`。比如 URL 填写为`https://your_domain_name/bots/xxxxx`，其中的 `your_domain_name` 就是 Caddy 中填写的域名。点击保存。如果可以保存成功，那么意味着部署成功。如果出现**系统发生错误，请稍后重试**，那么请重新检查以上配置内容是否填写正确。
|
||||
|
||||
Reference in New Issue
Block a user