mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-17 17:51:20 +08:00
fc33b3eb68
* docs: transfer AstrBotDevs/AstrBot-docs to AstrBotDevs/AstrBot * refactor: reorder imports and improve type hints in sync_docs_to_wiki.py and upload_doc_images_to_r2.py * feat: add GitHub Actions workflow to sync wiki with documentation Co-authored-by: Soulter <37870767+Soulter@users.noreply.github.com> Co-authored-by: anka-afk <110004162+anka-afk@users.noreply.github.com> Co-authored-by: zouyonghe <62183434+zouyonghe@users.noreply.github.com> Co-authored-by: shuiping233 <49360196+shuiping233@users.noreply.github.com> Co-authored-by: LIghtJUNction <106986785+LIghtJUNction@users.noreply.github.com> Co-authored-by: Sjshi763 <179909421+Sjshi763@users.noreply.github.com> Co-authored-by: xiewoc <70128845+xiewoc@users.noreply.github.com> Co-authored-by: QingFeng-awa <151742581+QingFeng-awa@users.noreply.github.com> Co-authored-by: PaloMiku <96452465+PaloMiku@users.noreply.github.com> Co-authored-by: shangxueink <138397030+shangxueink@users.noreply.github.com> Co-authored-by: IGCrystal-A <244300990+IGCrystal-A@users.noreply.github.com> Co-authored-by: RC-CHN <67079377+RC-CHN@users.noreply.github.com> Co-authored-by: MC090610 <113341105+MC090610@users.noreply.github.com> Co-authored-by: Waterwzy <196913419+Waterwzy@users.noreply.github.com> Co-authored-by: Lanhuace-Wan <186303160+Lanhuace-Wan@users.noreply.github.com> Co-authored-by: LiAlH4qwq <61769640+LiAlH4qwq@users.noreply.github.com> Co-authored-by: HSOS6 <209910899+HSOS6@users.noreply.github.com> Co-authored-by: th-dd <162813557+th-dd@users.noreply.github.com> Co-authored-by: miaoxutao123 <81676466+miaoxutao123@users.noreply.github.com> Co-authored-by: nuomicici <143102889+nuomicici@users.noreply.github.com> Co-authored-by: nasyt233 <210103278+nasyt233@users.noreply.github.com> Co-authored-by: jlugjb <7426462+jlugjb@users.noreply.github.com> Co-authored-by: Raven95676 <176760093+Raven95676@users.noreply.github.com> Co-authored-by: Futureppo <180109455+Futureppo@users.noreply.github.com> Co-authored-by: MliKiowa <61873808+MliKiowa@users.noreply.github.com> Co-authored-by: Fridemn <150212937+Fridemn@users.noreply.github.com> Co-authored-by: BakaCookie520 <138355736+BakaCookie520@users.noreply.github.com> Co-authored-by: YumeYuka <125112916+YumeYuka@users.noreply.github.com> Co-authored-by: xming521 <32786500+xming521@users.noreply.github.com> Co-authored-by: ywh555hhh <121592812+ywh555hhh@users.noreply.github.com> Co-authored-by: stevessr <89645372+stevessr@users.noreply.github.com> Co-authored-by: roeseth <41995115+roeseth@users.noreply.github.com> Co-authored-by: ikun-1145141 <265925499+ikun-1145141@users.noreply.github.com> Co-authored-by: evpeople <54983536+evpeople@users.noreply.github.com> Co-authored-by: Yue-bin <60509781+Yue-bin@users.noreply.github.com> Co-authored-by: W1ndys <109416673+W1ndys@users.noreply.github.com> Co-authored-by: TheFurina <218887821+TheFurina@users.noreply.github.com> Co-authored-by: Seayon <12275933+Seayon@users.noreply.github.com> Co-authored-by: OnlyblackTea <38585636+OnlyblackTea@users.noreply.github.com> Co-authored-by: ocetars <74854972+ocetars@users.noreply.github.com> Co-authored-by: railgun19457 <117180744+railgun19457@users.noreply.github.com> Co-authored-by: JunieXD <107397009+JunieXD@users.noreply.github.com> Co-authored-by: advent259141 <197440256+advent259141@users.noreply.github.com> Co-authored-by: Doge2077 <91442300+Doge2077@users.noreply.github.com> Co-authored-by: Bocity <23430545+Bocity@users.noreply.github.com> Co-authored-by: Aurora-xk <192227833+Aurora-xk@users.noreply.github.com>
81 lines
3.1 KiB
Markdown
81 lines
3.1 KiB
Markdown
# 接入 Dify
|
||
|
||
## 安装 Dify
|
||
|
||
如果您还没有安装 Dify，请参考 [Dify 安装文档](https://docs.dify.ai/zh-hans/getting-started/install-self-hosted) 安装。
|
||
|
||
## 在 AstrBot 中配置 Dify
|
||
|
||
在 WebUI 中，点击「模型提供商」->「新增提供商」，选择「Agent 执行器」，选择「Dify」，进入 Dify 的配置页面。
|
||
|
||
|
||
|
||
在 Dify 中，一个 `API Key` 唯一对应一个 Dify 应用。因此，您可以创建多个 Provider 以适配多个 Dify 应用。
|
||
|
||
根据目前的 Dify 项目，一共有三种类型，分别是：
|
||
|
||
- chat
|
||
- agent
|
||
- workflow
|
||
|
||
>[!TIP]
|
||
>请确保你在 AstrBot 里设置的 APP 类型和 Dify 里面创建的应用的类型一致。
|
||
>
|
||
|
||
|
||
### Chat 和 Agent 应用
|
||
|
||
按下图所示创建你的 Dify Chat 和 Agent 应用的密钥：
|
||
|
||
|
||
|
||
|
||
|
||
复制密钥并粘贴到配置中的 `API Key` 字段中，点击「保存」。
|
||
|
||
### Workflow 应用
|
||
|
||
#### 配置输入输出变量名
|
||
|
||
Workflow 应用接收输入变量，然后执行工作流，最后输出结果。
|
||
|
||
|
||
|
||
对于 Workflow 应用，AstrBot 在每次请求时会附上两个变量:
|
||
|
||
- `astrbot_text_query`: 输入变量名。即用户输入的文本内容。
|
||
- `astrbot_session_id`: 会话 ID
|
||
|
||
你可以在配置中自定义输入变量名，即上图配置中的 “Prompt 输入变量名”。
|
||
|
||
您需要修改您的 Workflow 的输入的变量名以适配 AstrBot 的输入。
|
||
|
||
最终，Workflow 会输出一个结果，您可以自定义这个结果的变量名，即上图配置中的 “Dify Workflow 输出变量名”，默认为 `astrbot_wf_output`。你需要在 Dify 的 Workflow 的输出节点中配置这个变量名，否则 AstrBot 无法正确解析。
|
||
|
||
#### 创建 API Key
|
||
|
||
按下图所示创建你的 Dify Workflow 应用的 API Key：
|
||
|
||
点击右上角发布-访问 API-点击右上角 API 密钥-创建密钥，然后复制 API Key。
|
||
|
||
|
||
|
||
复制密钥并粘贴到配置中的 `API Key` 字段中，点击「保存」。
|
||
|
||
### 选择 Agent 执行器
|
||
|
||
进入左边栏配置页面，点击「Agent 执行方式」，选择「Dify」，然后在下方出现的新的配置项中选择你刚刚创建的 Dify Agent 执行器的 ID，点击右下角「保存」，即可完成配置。
|
||
|
||
## 附录：在聊天时动态设置输入 Workflow 变量（可选）
|
||
|
||
可以使用 `/set` 指令动态设置输入变量，如下图所示：
|
||
|
||
|
||
|
||
当设置变量后，AstrBot 会在下次向 Dify 请求时附上您设置的变量，以灵活适配您的 Workflow。
|
||
|
||
|
||
|
||
当然，可以使用 `/unset` 指令来取消设置的变量。
|
||
|
||
变量在当前会话永久有效。 |