Project Icon

ChatGPT-on-WeChat

快速将ChatGPT功能整合至微信平台

该项目实现了ChatGPT功能与微信的无缝集成。基于Wechaty SDK和OpenAI API开发,支持连接GPT-4和GPT-3.5-turbo等多个AI模型。提供本地和云端两种部署方式,操作简便。支持自定义触发关键词、错误回复和模型参数,并可添加自定义任务处理器以扩展机器人功能。项目设置灵活,适用于各类聊天场景。

ChatGPT on WeChat GitHub License wakatime Railway Deploy GitHub Repo stars

🤖️ Turn your WeChat into ChatGPT within only 2 steps! 🤖️

Group chat demo for @kx-Huang/ChatGPT-on-WeChat

Features

This project is implemented based on this amazing project that I contibuted before, with Wechaty SDK and OpenAI API, we achieve:

  • fast and robust connection to a set of AI models with different features, typically gpt-4o and gpt-3.5-turbo which powers ChatGPT
  • stable, persistent and rapid deployment on cloud servers Railway

0. Table of Content

1. How to Deploy this Bot?

You can deploy in local or on cloud, whatever you want.

The deploy on cloud method is recommended.

1.1 Deploy in Local

1.1.1 Get your OpenAI API Keys


1.1.2 Configure Environment Variables

You can copy the template config.yaml.example into a new file config.yaml, and paste the configurations:

openaiApiKey: "<your_openai_api_key>"
openaiOrganizationID: "<your_organization_id>"
chatgptTriggerKeyword: "<your_keyword>"

Or you can export the environment variables listed in .env.example to your system, which is a more encouraged method to keep your OpenAI API Key safe:

export OPENAI_API_KEY="sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
export OPENAI_ORGANIZATION_KEY="org-XXXXXXXXXXXXXXX"
export CHATGPT_TRIGGER_KEYWORD="Hi bot:"

Please note:

  • chatgptTriggerKeyword is the keyword which can trigger auto-reply:
    • In private chat, the message starts with it will trigger auto-reply
    • In group chat, the message starts with @Name <keyword> will trigger auto-reply
  • chatgptTriggerKeyword can be empty string, which means:
    • In private chat, every messages will trigger auto-reply
    • In group chat, only "@ the bot" will trigger auto-reply

1.1.3 Setup the Docker

  1. Setup Docker Image
docker build -t chatgpt-on-wechat .
  1. Setup Docker Container
docker run -v $(pwd)/config.yaml:/app/config.yaml chatgpt-on-wechat

You can also build with Docker Compose:

  1. Start the container
docker-compose up -d
  1. View the QR code to log in to wechat
docker-compose logs -f

1.1.4 Login your WeChat

Once you deploy the bot successfully, just follow the terminal or Logs in Docker container prompt carefully:

  1. Scan the QR Code with mobile WeChat
  2. Click "Log in" to allow desktop login (where our bot stays)
  3. Wait a few seconds and start chatting!

🤖 Enjoy your powerful chatbot! 🤖


1.2 Deploy on Cloud

Click the button below to fork this repo and deploy with Railway!

Deploy on Railway


1.2.1 Configure on Railway

Fill in the following blanks:

  1. Your forked repo name (can be any name you like)
  2. Choose make it private or not (also up to you)
  3. Environment variables (for how to get OpenAI API keys, please refer to 1.1.1 Get your OpenAI API Keys)

Railway Config

Please note:

Make sure the environment variables are set in RailWay instead of writing directly in config.yaml. It's really NOT recommended to implicitly write out your OpenAI API Key in public repo. Anyone with your key can get access to the OpenAI API services, and it's possbile for you to lose money if you pay for that.


1.2.2 Deploy & Login on Railway

The deploy process is automatic. It may take a few minutes for the first time. As you see the Success, click the tab to see the details. (which is your secret WeChat console!)

Railway Deploy

Click Deply Logs and you will see everything is setting up, wait for a QR Code to pop up. Scan it as if you are login to your desktop WeChat, and click "Log in" on your mobile WeChat.

Railway Scan QR Code

Finally, everything is good to go! You will see the logs when people sending you messagem, and whenever the chatbot is auto-triggered to reply.

Railway Log

🤖 Enjoy your powerful chatbot! 🤖

2. Any Fancy Advanced Settings?

2.1 Config Reply in Error

When the OpenAI API encounters some errors (e.g. over-crowded traffic, no authorization, ...), the chatbot will auto-reply the pre-configured message.

You can change it in src/chatgpt.js:

const chatgptErrorMessage = "🤖️:ChatGPT摆烂了,请稍后再试~";

2.2 Config OpenAI Models

You can change whatever OpenAI Models you like to handle task at different capability, time-consumption and expense trade-off. (e.g. model with better capability costs more time to respond)

Currently, the latest GPT-4o model is up and running!

Since the latest gpt-4 model is currently in a limited beta and only accessible to those who have been granted access, currently we use the gpt-3.5-turbo model as default. Of course, if you have the access to gpt-4 API, you can just change the model to gpt-4 without any other modification.

According to OpenAI doc,

GPT-4o (“o” for “omni”) is our most advanced model. It is multimodal (accepting text or image inputs and outputting text), and it has the same high intelligence as GPT-4 Turbo but is much more efficient—it generates text 2x faster and is 50% cheaper. Additionally, GPT-4o has the best vision and performance across non-English languages of any of our models.

GPT-3.5 models can understand and generate natural language or code. Our most capable and cost effective model in the GPT-3.5 family is gpt-3.5-turbo which has been optimized for chat but works well for traditional completions tasks as well.

Also, for the same model, we can configure dozens of parameter (e.g. answer randomness, maximum word limit...). For example, for the temperature field:

Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

You can configure all of them in src/chatgpt.js:

chatgptModelConfig: object = {
  // this model field is required
  model: "gpt-4o",
  // add your ChatGPT model parameters below
  temperature: 0.8,
  // max_tokens: 2000,
};

For more details, please refer to OpenAI Models Doc.


2.3 Config Model Features

You can change whatever features you like to handle different types of tasks. (e.g. complete text, edit text, generate code...)

Currently, we use createChatCompletion() powered by gpt-4o model, which:

take a series of messages as input, and return a model-generated message as output.

You can configure in src/chatgpt.js:

const response = await this.openaiApiInstance.createChatCompletion({
  ...this.chatgptModelConfig,
  messages: inputMessages,
});

For more details, please refer to OpenAI API Doc.


2.4 Add Customized Task Handler

You can add your own task handlers to expand the ability of this chatbot!

In src/chatgpt.ts ChatGPTBot.onCustimzedTask(), write your own task handler:

// e.g. if a message starts with "Hello", the bot sends "World!"
if (message.text().startsWith("Hello")) {
  await message.say("World!");
  return;
}

3. Common Errors and Troubleshooting

3.1 Assertion Error during Login or Self-chat 🤯

  • Error Log:

    uncaughtException AssertionError [ERR_ASSERTION]: 1 == 0
        at Object.equal (/app/node_modules/wechat4u/src/util/global.js:53:14)
        at /app/node_modules/wechat4u/src/core.js:195:16
        at processTicksAndRejections (node:internal/process/task_queues:96:5) {
      code: 2,
      details: 'AssertionError [ERR_ASSERTION]: 1 == 0\n' +
        '    at Object.equal (/app/node_modules/wechat4u/src/util/global.js:53:14)\n' +
        '    at /app/node_modules/wechat4u/src/core.js:195:16\n' +
        '    at processTicksAndRejections (node:internal/process/task_queues:96:5)'
    }
    
  • Solution:

    • If see this error during login, please check issue #8
    • If see this error during self-chat, please check issue #38

3.2 I can't trigger auto reply 🤔

  • Solution:
    • Before deployment, read the trigger conditions in 1.1.2 Configure Environment Variables
    • After deployment, check the console logs for following lines:
      • 🎯 Trigger keyword in private chat is: <keyword>
      • 🎯 Trigger keyword in group chat is: @Name <keyword>

4. How to Contribute to this Project?

You are more than welcome to raise some issues, fork this repo, commit your code and submit pull request. And after code review, we can merge your contribution. I'm really looking forward to develop more interesting features!

Also, there're something in the to-do list for future enhancement:

  1. Chat with context (integrate with LangChain):
  • Keep track of every on-going conversation for each private chat or group chat
  • Dynamic drop or summarize the history conversation sent throught API in case the token gets oversized
  • Set time-out for a conversation when users stop chatting for a while
  1. More AI capability:
  • Integrate OpenAI DALL·E model for AI image creation. Triggered by customized keyword (e.g. Hi bot, draw...)
  • Integrate OpenAi Whisper model for speech recognition. Triggered by voice messages and do transcription or translation
  1. More flexible depolyment:
  • Make deployment templates on other cloud platforms
  • Optimize depolyment process to be more robust and compatible on different OS

5. Acknowledgement

Great thanks to:

Thanks for your support by starring this project!

Stargazers repo roster for @kx-Huang/ChatGPT-on-WeChat Star history chart for @kx-Huang/ChatGPT-on-WeChat

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

问小白

问小白是一个基于 DeepSeek R1 模型的智能对话平台,专为用户提供高效、贴心的对话体验。实时在线,支持深度思考和联网搜索。免费不限次数,帮用户写作、创作、分析和规划,各种任务随时完成!

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

Trae

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号