深入ChatGPT-Feishu源码:事件处理与OpenAI API交互的实现原理

【免费下载链接】ChatGPT-Feishu 给飞书准备的 ChatGPT 机器人 【免费下载链接】ChatGPT-Feishu 项目地址: https://gitcode.com/gh_mirrors/ch/ChatGPT-Feishu

ChatGPT-Feishu是一款为飞书用户打造的智能机器人,能够将OpenAI的强大AI能力无缝集成到飞书聊天环境中。本文将深入解析其核心源码,揭示事件处理机制与OpenAI API交互的实现原理,帮助开发者理解机器人如何接收消息、处理指令并生成智能回复。

核心功能模块概览

ChatGPT-Feishu的核心逻辑集中在event.js文件中,主要包含三大功能模块:

  • 事件处理系统:负责接收和解析飞书平台的消息事件
  • 指令解析中心:处理用户发送的特殊指令(如/clear清除上下文、/image生成图片)
  • OpenAI交互层:管理与OpenAI API的通信,处理会话历史和token限制

这些模块通过函数调用形成完整的处理链,从消息接收到AI回复生成,构成了机器人的核心工作流程。

事件处理流程:从消息到响应

飞书平台的消息事件通过Webhook推送到机器人服务,event.js中的主函数module.exports负责接收并处理这些事件:

  1. 事件验证与过滤:首先验证事件合法性并过滤重复事件

    // 对于同一个事件,只处理一次
    const count = await EventDB.where({ event_id: eventId }).count();
    if (count != 0) {
      logger("skip repeat event");
      return { code: 1 };
    }
    
  2. 消息类型判断:区分私聊(p2p)和群聊(group)消息,群聊需@机器人才能触发响应

    // 群聊,需要 @ 机器人
    if (params.event.message.chat_type === "group") {
      // 没有 mention 机器人,则退出
      if (params.event.message.mentions[0].name != FEISHU_BOTNAME) {
        logger("bot name not equal first mention name ");
        return { code: 0 };
      }
    }
    
  3. 消息分发处理:将有效消息传递给handleReply函数进行后续处理

指令系统设计:让机器人更智能

ChatGPT-Feishu实现了灵活的指令系统,通过cmdProcess函数处理各种用户指令:

  • 基础指令集

    • /clear:清除当前会话历史
    • /help:显示帮助信息
    • /image [提示词]:生成图片
  • 指令处理流程

    async function cmdProcess(cmdParams) {
      if(cmdParams && cmdParams.action.startsWith("/image")){
        // 图片生成逻辑
        url = await getOpenaiImageUrl(prompt);
        await reply(cmdParams.messageId,url);
        return;
      }
      switch (cmdParams && cmdParams.action) {
        case "/help":
          await cmdHelp(cmdParams.messageId);
          break;
        case "/clear":
          await cmdClear(cmdParams.sessionId, cmdParams.messageId);
          break;
        default:
          await cmdHelp(cmdParams.messageId);
          break;
      }
    }
    

这个设计允许用户通过简单的命令与机器人交互,极大提升了使用体验。

OpenAI API交互:智能回复的幕后工作

与OpenAI API的交互是机器人的核心能力,由getOpenAIReply函数实现:

  1. API请求构造

    var data = JSON.stringify({
      model: OPENAI_MODEL,
      messages: prompt
    });
    
  2. 请求配置

    var config = {
      method: "post",
      url: "https://api.openai.com/v1/chat/completions",
      headers: {
        Authorization: `Bearer ${OPENAI_KEY}`,
        "Content-Type": "application/json",
      },
      data: data,
      timeout: 50000
    };
    
  3. 错误处理

    try{
      const response = await axios(config);
      if (response.status === 429) {
        return '问题太多了,我有点眩晕,请稍后再试';
      }
      return response.data.choices[0].message.content;
    }catch(e){
      logger(e.response.data)
      return "问题太难了 出错了. (uДu〃).";
    }
    

会话管理:上下文保持与token控制

为了提供连贯的对话体验,ChatGPT-Feishu实现了会话管理机制:

  1. 会话构建buildConversation函数从数据库加载历史消息,构造完整对话上下文

    async function buildConversation(sessionId, question) {
      let prompt = [];
      // 从 MsgTable 表中取出历史记录构造 question
      const historyMsgs = await MsgTable.where({ sessionId }).find();
      for (const conversation of historyMsgs) {
          prompt.push({"role": "user", "content": conversation.question})
          prompt.push({"role": "assistant", "content": conversation.answer})
      }
      // 拼接最新 question
      prompt.push({"role": "user", "content": question})
      return prompt;
    }
    
  2. 会话存储saveConversation函数保存新的对话内容

  3. token控制discardConversation函数确保对话不超过模型的token限制,自动删除最早的消息

部署与配置:让机器人运行起来

要让ChatGPT-Feishu机器人正常工作,需要正确配置环境变量:

const FEISHU_APP_ID = process.env.APPID || ""; // 飞书的应用 ID
const FEISHU_APP_SECRET = process.env.SECRET || ""; // 飞书的应用的 Secret
const FEISHU_BOTNAME = process.env.BOTNAME || ""; // 飞书机器人的名字
const OPENAI_KEY = process.env.KEY || ""; // OpenAI 的 Key
const OPENAI_MODEL = process.env.MODEL || "gpt-3.5-turbo"; // 使用的模型
const OPENAI_MAX_TOKEN = process.env.MAX_TOKEN || 1024; // 最大 token 的值

这些配置通过环境变量注入,确保敏感信息不会硬编码在代码中,同时提供了灵活的部署选项。

结语:探索更多可能性

ChatGPT-Feishu的源码展示了如何将飞书平台与OpenAI API无缝集成,实现智能机器人功能。通过理解事件处理流程、指令系统设计和API交互机制,开发者可以进一步扩展机器人功能,如添加新指令、支持更多消息类型或优化会话管理策略。

项目的简洁架构和清晰的代码组织使其成为学习如何构建聊天机器人的良好范例。无论是想扩展功能还是定制自己的机器人,深入理解这些核心实现原理都是必不可少的第一步。

要开始使用或贡献此项目,可以克隆仓库:https://gitcode.com/gh_mirrors/ch/ChatGPT-Feishu,按照README中的指南进行部署和配置。

【免费下载链接】ChatGPT-Feishu 给飞书准备的 ChatGPT 机器人 【免费下载链接】ChatGPT-Feishu 项目地址: https://gitcode.com/gh_mirrors/ch/ChatGPT-Feishu

Logo

这里是“一人公司”的成长家园。我们提供从产品曝光、技术变现到法律财税的全栈内容,并连接云服务、办公空间等稀缺资源,助你专注创造,无忧运营。

更多推荐