wechat-ai-summarize-bot  by small-tou

AI-powered WeChat group summarizer

Created 2 years ago
256 stars

Top 98.7% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides a WeChat group chat summarization assistant, leveraging AI to process conversations and generate concise reports. It's designed for WeChat group administrators or owners who want to stay informed about discussions without reading every message. The primary benefit is automated, AI-powered summarization of group chats, saving users time and effort.

How It Works

The bot monitors WeChat group chats, collects conversation data, and then uses AI models (specifically mentioning Claude-2 via Dify.ai) to summarize discussions. It can generate summaries in text, image, and audio formats. The core advantage lies in its automation and the ability to distill key topics, participants, and discussion periods from potentially large volumes of chat data.

Quick Start & Requirements

  • Installation: npm install
  • Prerequisites: Node.js, npm. Requires API keys for PadLocal (PADLOCAL_API_KEY) and Dify.ai (DIFY_API_KEY). Optional Azure TTS keys (AZURE_TTS_APPKEY, AZURE_TTS_REGION) for audio summaries.
  • Configuration: Set environment variables in .env file (copy from .env.example).
  • Running:
    • Start monitoring: npm run watch (requires WeChat QR code scan).
    • Manual summarization: npm run summarize <path_to_chat_log>
  • Notes: A Mac desktop version is available for download. Windows users may need to build from source.

Highlighted Details

  • Supports generating summaries as .txt, .png, and .mp3 files.
  • Configurable text length and ending words for summaries.
  • Real-time chat viewing and direct messaging capabilities.
  • Customizable prompts for AI summarization, including topic extraction, participant identification, and sentiment analysis.

Maintenance & Community

The project is supported by "智囊 AI" (zhinang.ai). Links to Dify.ai and PadLocal are provided. No specific community channels (like Discord/Slack) or roadmap details are mentioned in the README.

Licensing & Compatibility

The README does not explicitly state a license. However, it mentions using free tiers and trial accounts for Dify.ai and PadLocal, implying potential usage limitations tied to those services. The project's use of WeChat login carries a risk of account suspension.

Limitations & Caveats

Using this bot to log into WeChat carries a risk of account banning. Currently, only Mac desktop version is provided for download; Windows users need to build from source. The MONITOR_ROOMS variable currently only supports one group name.

Health Check
Last Commit

1 year ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
12 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.