diff --git a/docSite/assets/docs/scss/custom/pages/_custom.scss b/docSite/assets/docs/scss/custom/pages/_custom.scss index 182ddd3b7..34db7d966 100644 --- a/docSite/assets/docs/scss/custom/pages/_custom.scss +++ b/docSite/assets/docs/scss/custom/pages/_custom.scss @@ -1,4 +1,4 @@ -.docs-content .main-content img, .docs-content .main-content svg:not(.gitinfo svg) { +.docs-content .main-content img, .docs-content .main-content svg:not(.gitinfo svg):not(a svg) { max-width: 80% !important; height: auto; display: block !important; diff --git a/docSite/content/docs/use-cases/feishu.md b/docSite/content/docs/use-cases/feishu.md index 232854c67..35f51b8e4 100644 --- a/docSite/content/docs/use-cases/feishu.md +++ b/docSite/content/docs/use-cases/feishu.md @@ -1,21 +1,21 @@ --- -title: "对接 飞书" -description: "FastGPT 对接 飞书" +title: " 接入飞书 " +description: "FastGPT 接入飞书机器人 " icon: "chat" draft: false toc: true -weight: 320 +weight: 322 --- -# FastGPT一分钟接入飞书 +# FastGPT 一分钟接入飞书 -[Feishu-GPT GitHub 地址](https://github.com/ConnectAI-E/Feishu-OpenAI) +[Feishu OpenAI GitHub 地址](https://github.com/ConnectAI-E/Feishu-OpenAI) -由于 FastGPT 的 OpenAPI 功能和 GPT 的规范一直，可以很方便接入第三方系统。 +由于 FastGPT 的 API 接口和 OpenAI 的规范一致，可以无需变更第三方应用即可使用 FastGPT 上编排好的应用。API 使用可参考 [这篇文章](/docs/use-cases/openai/)。编排示例，可参考 [高级编排介绍](/docs/workflow/intro) -## 1. 获取 FastGPT的OpenAPI 秘钥 +## 1. 获取 FastGPT 的 OpenAPI 秘钥 -依次选择应用 -> 「API访问」，然后点击「API 密钥」来创建密钥。 [参考这篇文章](/docs/use-cases/openai/) +依次选择应用 -> 「API 访问」，然后点击「API 密钥」来创建密钥。 [参考这篇文章](/docs/use-cases/openai/) ![](/imgs/fastgpt-api.png) @@ -23,17 +23,15 @@ weight: 320 ## 2. 部署飞书服务 -推荐使用Railway一键部署 +推荐使用 Railway 一键部署 [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/10D-TF?referralCode=oMcVS2) - - 参考环境变量配置： ![](/imgs/feishu-env.png) -FastGPT集成**重点参数：** +FastGPT 集成**重点参数：** ```bash #上一步FastGPT的OpenAPI 秘钥 @@ -44,29 +42,29 @@ API_URL=https://fastgpt.run/api/openapi ## 3. 创建飞书机器人 -1. 前往[开发者平台](https://open.feishu.cn/app?lang=zh-CN)创建应用,并获取到 APPID 和 Secret +1. 前往 [开发者平台](https://open.feishu.cn/app?lang=zh-CN) 创建应用 , 并获取到 APPID 和 Secret 2. 前往`应用功能-机器人`, 创建机器人 3. 从 cpolar、serverless 或 Railway 获得公网地址，在飞书机器人后台的 `事件订阅` 板块填写。例如， - - `http://xxxx.r6.cpolar.top`为 cpolar 暴露的公网地址 - - `/webhook/event`为统一的应用路由 + - `http://xxxx.r6.cpolar.top` 为 cpolar 暴露的公网地址 + - `/webhook/event` 为统一的应用路由 - 最终的回调地址为 `http://xxxx.r6.cpolar.top/webhook/event` 4. 在飞书机器人后台的 `机器人` 板块，填写消息卡片请求网址。例如， - - `http://xxxx.r6.cpolar.top`为 cpolar 暴露的公网地址 - - `/webhook/card`为统一的应用路由 + - `http://xxxx.r6.cpolar.top` 为 cpolar 暴露的公网地址 + - `/webhook/card` 为统一的应用路由 - 最终的消息卡片请求网址为 `http://xxxx.r6.cpolar.top/webhook/card` 5. 在事件订阅板块，搜索三个词`机器人进群`、 `接收消息`、 `消息已读`, 把他们后面所有的权限全部勾选。 进入权限管理界面，搜索`图片`, 勾选`获取与上传图片或文件资源`。 最终会添加下列回调事件 - im:resource(获取与上传图片或文件资源) - im:message - im:message.group_at_msg(获取群组中所有消息) - - im:message.group_at_msg:readonly(接收群聊中@机器人消息事件) + - im:message.group_at_msg:readonly(接收群聊中 @ 机器人消息事件) - im:message.p2p_msg(获取用户发给机器人的单聊消息) - im:message.p2p_msg:readonly(读取用户发给机器人的单聊消息) - - im:message:send_as_bot(获取用户在群组中@机器人的消息) + - im:message:send_as_bot(获取用户在群组中 @ 机器人的消息) - im:chat:readonly(获取群组信息) - im:chat(获取与更新群组信息) ## 4. 测试飞书机器人 -私聊机器人，或者群里艾特它，就可以基于FastGPT的应用进行回答啦 +私聊机器人，或者群里艾特它，就可以基于 FastGPT 的应用进行回答啦 ![](/imgs/feishu-res.png) \ No newline at end of file diff --git a/docSite/content/docs/use-cases/onwechat.md b/docSite/content/docs/use-cases/onwechat.md index 17dd91a8b..7f51c750e 100644 --- a/docSite/content/docs/use-cases/onwechat.md +++ b/docSite/content/docs/use-cases/onwechat.md @@ -1,17 +1,17 @@ --- -title: "对接 OnWeChat" -description: "FastGPT 对接 OnWeChat" +title: "对接 chatgpt-on-wechat" +description: "FastGPT 对接 chatgpt-on-wechat" icon: "chat" draft: false toc: true weight: 320 --- -# 1 分钟对接 OnWeChat +# 1 分钟对接 chatgpt-on-wechat -[OnWeChat GitHub 地址](https://github.com/zhayujie/chatgpt-on-wechat) +[chatgpt-on-wechat GitHub 地址](https://github.com/zhayujie/chatgpt-on-wechat) -由于 FastGPT 的 OpenAPI 功能和 GPT 的对齐，可以无需变更原来的应用即可使用 FastGPT 上编排好的应用。API 使用，可 [参考这篇文章](/docs/use-cases/openai/)。编排示例，可参考 [高级编排介绍](/docs/workflow/intro) +由于 FastGPT 的 API 接口和 OpenAI 的规范一致，可以无需变更原来的应用即可使用 FastGPT 上编排好的应用。API 使用可参考 [这篇文章](/docs/use-cases/openai/)。编排示例，可参考 [高级编排介绍](/docs/workflow/intro) ## 1. 获取 OpenAPI 秘钥 @@ -29,7 +29,7 @@ weight: 320 这个秘钥将会调用指定的应用。 -## 3. 创建 OnWeChat docker-compose.yml 文件 +## 3. 创建 docker-compose.yml 文件 只需要修改 `OPEN_AI_API_KEY` 和 `OPEN_AI_API_BASE` 两个环境变量即可。其中 `OPEN_AI_API_KEY` 为第二步的组合秘钥，`OPEN_AI_API_BASE` 为 FastGPT 的 OpenAPI 地址，例如：`https://fastgpt.run/api/openapi/v1`。 @@ -67,9 +67,9 @@ services: ``` -## 4. 运行 OnWeChat +## 4. 运行 chatgpt-on-wechat -```base +```bash docker-compose pull docker-compose up -d ``` diff --git a/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content b/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content index 294e8278c..8948f84df 100644 --- a/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content +++ b/docSite/resources/_gen/assets/scss/docs/scss/style.scss_b97bf3f19a5ec64d7a7c5d60f7e31818.content @@ -11921,7 +11921,7 @@ div.code-toolbar > .toolbar > .toolbar-item > span:focus { width: 20.1rem; padding-left: 1rem; } } -.docs-content .main-content img, .docs-content .main-content svg:not(.gitinfo svg) { +.docs-content .main-content img, .docs-content .main-content svg:not(.gitinfo svg):not(a svg) { max-width: 80% !important; height: auto; display: block !important; @@ -11947,6 +11947,9 @@ li p { margin-top: 1rem !important; margin-bottom: 1rem; } +footer { + height: 118px !important; } + /* footer a:hover { text-decoration: none !important;