Skip to content

Ljzd-PRO/ChatGuardian

ChatGuardian

ChatGuardian

基于大模型的群聊/私聊话题检测与提醒、用户画像分析系统,让您高效地管理消息 99+ 的各种聊天平台。

BSD 3-Clause Last Commit

English | 简体中文 | 繁體中文 | 日本語 | 한국어 | Français | Русский

当前仍是测试阶段,消息平台中只有OneBot进行了验证,其他消息平台尚未经过验证,不能确保可用。欢迎反馈使用体验。

✨ 功能特性

  • 💬 设置群聊/私聊话题检测规则,当群里聊到自己感兴趣的话题时发送通知

    • 例如:当聊到时事新闻时提醒、当聊到会员购再版预售开始时提醒、当聊到某游戏时提醒
    • 检测规则支持限定范围(私聊/群聊、群号、参与群友等),并且支持与或非关系叠加
  • 🤖 通过内置的智能体,一句话生成检测规则,管理后台等

    • 内置智能体所用 MCP 均可作为 HTTP 服务开放,您可以在外部平台定制自己的智能体(如 OpenClaw, AstrBot, LangBot, CherryStudio, Dify 等)
    • 【HTTP MCP 服务暂未经过测试】
  • 👤 设置需要进行用户画像分析的群友,每当该群友发送消息时就会触发一次分析

    • 随着分析次数的积累,该群友的用户画像信息会非常完善

    用户画像数据大致包含以下信息:

    • 该群友感兴趣的话题
    • 该群友常聊的群号
    • 该群友经常与哪些群友聊天互动,都聊些什么话题
  • 💰 消息最小数量要求等待最小消息超时重复触发抑制 等支持自定义的消息处理机制,能够节省您的 Token 消耗

  • 💬 支持多个消息平台

    • OneBot(QQ)、企业微信、Telegram、Discord、钉钉、飞书 等
    • 【目前仅 OneBot 经过了测试】
  • ⚙ 所有配置项均可通过 WebUI 界面进行设置,无需设置环境变量,简单方便

  • 🔔 支持多种通知服务

    • 邮件通知
    • iOS Bark
    • 【更多通知服务待实现~】
  • 🤖 支持多种大模型平台

    • OpenAI
    • Antrophic
    • Google
    • OpenAI 兼容 API(xAI, DeepSeek 等)

🔧 安装

🐳 Docker 快速部署

git clone https://github.com/Ljzd-PRO/ChatGuardian.git --depth 1
cd ChatGuardian
docker compose up -d

数据库文件 db.sqlite 将被创建在 ChatGuardian/data 目录下

若后续进行了更新,数据库定义可能发生变化,启动时可能执行迁移,因此建议在更新前对 db.sqlite 文件进行备份

💻 手动安装

  1. 克隆项目

    git clone https://github.com/Ljzd-PRO/ChatGuardian.git --depth 1
    cd ChatGuardian
  2. 安装依赖(后端)

    poetry install
  3. 构建前端

    cd frontend
    npm ci --legacy-peer-deps
    npm run build
    cd ..
  4. 启动服务

    poetry run uvicorn chat_guardian.api.app:app --host 0.0.0.0 --port 8000

    若后续进行了更新,数据库定义可能发生变化,启动时可能执行迁移,因此建议在更新前对 db.sqlite 文件进行备份

  5. 访问

    Web UI: http://127.0.0.1:8000/app/

About

AI 驱动的聊天管理工具,智能检测话题、分析用户画像,轻松搞定 99 + 消息!

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors