diff --git a/docSite/assets/imgs/feishu-env.png b/docSite/assets/imgs/feishu-env.png new file mode 100644 index 000000000..4d563f444 Binary files /dev/null and b/docSite/assets/imgs/feishu-env.png differ diff --git a/docSite/assets/imgs/feishu-res.png b/docSite/assets/imgs/feishu-res.png new file mode 100644 index 000000000..e7f396bdf Binary files /dev/null and b/docSite/assets/imgs/feishu-res.png differ diff --git a/docSite/content/docs/use-cases/feishu.md b/docSite/content/docs/use-cases/feishu.md new file mode 100644 index 000000000..232854c67 --- /dev/null +++ b/docSite/content/docs/use-cases/feishu.md @@ -0,0 +1,72 @@ +--- +title: "对接 飞书" +description: "FastGPT 对接 飞书" +icon: "chat" +draft: false +toc: true +weight: 320 +--- + +# FastGPT一分钟接入飞书 + +[Feishu-GPT GitHub 地址](https://github.com/ConnectAI-E/Feishu-OpenAI) + +由于 FastGPT 的 OpenAPI 功能和 GPT 的规范一直,可以很方便接入第三方系统。 + +## 1. 获取 FastGPT的OpenAPI 秘钥 + +依次选择应用 -> 「API访问」,然后点击「API 密钥」来创建密钥。 [参考这篇文章](/docs/use-cases/openai/) + +![](/imgs/fastgpt-api.png) + +利用刚复制的 API 秘钥加上 AppId 组合成一个新的秘钥,格式为:`API 秘钥-AppId`,例如:`fastgpt-z51pkjqm9nrk03a1rx2funoy-642adec15f04d67d4613efdb`。 + +## 2. 部署飞书服务 + +推荐使用Railway一键部署 + +[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/10D-TF?referralCode=oMcVS2) + + + +参考环境变量配置: + +![](/imgs/feishu-env.png) + +FastGPT集成**重点参数:** + +```bash +#上一步FastGPT的OpenAPI 秘钥 +OPENAI_KEY=fastgpt-z51pkjqm9nrk03a1rx2funoy-642adec15f04d67d4613efdb +#调用OpenAI的BaseUrl要换成FastGPT的 +API_URL=https://fastgpt.run/api/openapi +``` + +## 3. 创建飞书机器人 + +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/webhook/event` +4. 在飞书机器人后台的 `机器人` 板块,填写消息卡片请求网址。例如, + - `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.p2p_msg(获取用户发给机器人的单聊消息) + - im:message.p2p_msg:readonly(读取用户发给机器人的单聊消息) + - im:message:send_as_bot(获取用户在群组中@机器人的消息) + - im:chat:readonly(获取群组信息) + - im:chat(获取与更新群组信息) + +## 4. 测试飞书机器人 + +私聊机器人,或者群里艾特它,就可以基于FastGPT的应用进行回答啦 + +![](/imgs/feishu-res.png) \ No newline at end of file