三分钟搭建飞书机器人

三分钟，将 ChatGPT 飞书机器人部署到 vercel，并同时支持多个应用，可一次性添加多个机器人。

以下是飞书机器人后台管理平台，可快速添加多个机器人应用，并使得企业管理员更好地管理。（后台管理源码尚未开源）

特性

• 负载均衡：多个 Token 增强其稳定性
• 多机器人：可同时配置多个飞书机器人
• 场景模式：可通过 PROMPT 配置机器人为专业的翻译、面试官、医生等
• 反向代理：为不同地区提供更快的 OpenAI 的代理 API 地址
• 群聊控制：可通过正则表达式根据群聊名称控制在哪个群开启机器人
• 私聊控制：可通过正则表达式根据私聊微信昵称控制开启机器人
• 支持日志：可查看每天多少条记录
• 诸多平台：支持飞书、企业微信等诸多平台的机器人应用

配置与环境变量

编辑 ./config.ts 配置文件。

export default {
  // 可配置多个飞书机器人
  app: {
    // key 代表你飞书应用的唯一标识，在下边飞书机器人事件订阅的前缀中会被使用到
    'shanyue-gpt': {
      // 填入每一个飞书机器人应用的 appi_id/app_secret
      appId: process.env.SHANYUE_GPT_APP_ID,
      appSecret: process.env.SHANYUE_GPT_APP_SECRET,
      prompt: ''
    },
    'shanyue-translation': {
      appId: process.env.SHANYUE_TRANSLATION_APP_ID,
      appSecret: process.env.SHANYUE_TRANSLATION_APP_SECRET,
      // 填入 prompt，让每一个飞书机器人都做不同的事儿
      prompt: '以下我输入的语言，如果是任意语言则翻译其为中文，如果为中文则将其翻译为英文：\n'
    },
  },

  // 可配置多个企业微信机器人
  wxwork: {
    'shanyue-gpt': {
      corpId: process.env.SHANYUE_GPT_CORP_ID,
      appSecret: process.env.SHANYUE_GPT_APP_SECRET,
      token: process.env.SHANYUE_GPT_TOKEN,
      aesKey: process.env.SHANYUE_GPT_AES_KEY
    }
  },

  baseURL: process.env.BASE_URL || 'https://api.openai.com/v1',
  apiKey: process.env.OPEN_API_KEY.split(','),
  model: process.env.GPT_MODEL || 'gpt-3.5-turbo',

  // // 判断在哪里开启机器人，默认是私聊以及艾特机器人的群聊
  // // 是否开启群聊模式，可使用正则以及 boolen，如果是正则用以决定在那些群开启群聊
  // enableGroup: /^(技术交流群|面试直通车|学习)$/,
  // // enableGroup: true,

  // // 是否开启私聊模式，可使用正则以及 boolen，如果是正则用以决定与谁私聊
  // // enablePrivate: true,
  // enablePrivate: /(山月)/,
}

对于 OpenAI 的 key 及国内代理 BaseURL 等敏感数据，可以置于环境变量中，编辑 .env 配置文件。

OPEN_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC"

其中，OPEN_API_KEY 支持多个 key 负载均衡，在环境变量中使用 , 隔开

OPEN_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC,k-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC,k-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxybnC"

步骤

1. 编辑环境变量

$ cp .example.env .env

并编辑以下环境变量。注意，如果你在国内服务器部署，必须配置 BASE_URL 环境变量，其为 OpenAI 在国内的代理 API，需自行搭建。

# 如果部署在 vercel 等境外服务器，则不需要此项配置
# 如果部署在境内，可以使用山月的临时代理 API，不过强烈建议自行搭建
BASE_URL="https://ai.devtool.tech/proxy"
OPEN_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# 并配置你 config.ts 中 config.app 对应的环境变量
SHANYUE_GPT_APP_ID="xxx"
SHANYUE_GPT_APP_SECRET="xxx"

如果对环境变量不熟，也可以在 config.ts 中直接配置数据，注意，此时因其中包含敏感数据，请勿提交至 Github 等公共平台。

2. 配置多个飞书机器人或企业微信机器人应用

编辑 ./config.ts，配置多个飞书机器人或者企业微信机器人应用。

export default {
  // 可配置多个飞书机器人
  app: {
    // key 代表你飞书应用的唯一标识，在下边飞书机器人事件订阅的前缀中会被使用到
    'shanyue-gpt': {
      // 填入每一个飞书机器人应用的 appi_id/app_secret
      appId: process.env.SHANYUE_GPT_APP_ID,
      appSecret: process.env.SHANYUE_GPT_APP_SECRET,
      prompt: ''
    },
    'shanyue-translation': {
      appId: process.env.SHANYUE_TRANSLATION_APP_ID,
      appSecret: process.env.SHANYUE_TRANSLATION_APP_SECRET,
      // 填入 prompt，让每一个飞书机器人都做不同的事儿
      prompt: '以下我输入的语言，如果是任意语言则翻译其为中文，如果为中文则将其翻译为英文：\n'
    },
  },

  wxwork: {
    'shanyue-gpt': {
      corpId: process.env.SHANYUE_GPT_CORP_ID,
      appSecret: process.env.SHANYUE_GPT_APP_SECRET,
      token: process.env.SHANYUE_GPT_TOKEN,
      aesKey: process.env.SHANYUE_GPT_AES_KEY
    }
  },
}

3. 将其部署到 vercel

$ npx vercel deploy --prod

4. 配置飞书应用域名

可参考飞书文档：

1. 事件订阅指南

配置飞书中的事件订阅的请求地址，其为以下形式，需要根据你们的配置自行填写：

• xxx.vercel.app：你在 vercel 部署的生产环境的地址
• api/webhook：webhook 统一出口
• shanyue-gpt：在 ./config.ts 中配置的飞书应用的前缀

https://xxx.vercel.app/api/webhook/shanyue-gpt

5. 开始与机器人聊天

开发

# 开启本地开发环境
$ npm run dev

# 模拟发送飞书的 webhook
$ curl localhost:3000/api/webhook/shanyue-translation \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "challenge": "ajls384kdjx98XX",
    "token": "xxxxxx",
    "type": "url_verification"
  }'

# 模拟发送飞书私聊信息的 webhook
$ curl localhost:3000/api/webhook/shanyue-translation \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "schema": "2.0",
    "header": {
      "event_id": "e9ccca3822970e6284ee8b2123b97936",
      "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "create_time": "1680757473021",
      "event_type": "im.message.receive_v1",
      "app_id": "cli_xxxxxxxxxxxxxxxx"
    },
    "event": {
      "message": {
        "chat_id": "oc_d5dd3ad97fefd3f063a176a11dad56f9",
        "chat_type": "p2p",
        "content": "{\"text\":\"你好啊\"}",
        "create_time": "1680757472656",
        "message_id": "om_104c88bc449d2138758cbc7c9d30f158",
        "message_type": "text"
      },
      "sender": {
        "sender_id": {
          "open_id": "ou_1cb5e56348d6d0eb90330b11cd4a53a2",
          "union_id": "on_be1715df18b72479f0ebaca4c6ab2d08",
          "user_id": "267g51ab"
        },
        "sender_type": "user",
        "tenant_key": "11e3bf03c281d75d"
      }
    }
  }

部署

vercel

docker

# 启动容器
$ docker compose up --build -d

# 查看服务状态
$ docker compose ps

# 查看日志
$ docker compose logs --tail 100 --follow

交流