insights-bot  by nekomeowww

Insights bot for summarizing information flows using OpenAI GPT models

created 2 years ago
277 stars

Top 94.5% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides a bot that leverages OpenAI's GPT models to generate insights from various information flows, primarily targeting users of messaging platforms like Telegram, Slack, and Discord. It aims to automate summarization of web content and chat histories, enhancing productivity by distilling key information.

How It Works

The bot operates by integrating with messaging platform APIs (Telegram, Slack, Discord) and interacting with OpenAI's GPT models. It processes user commands to fetch web content via URLs or analyze chat logs. For chat summarization, it captures messages, potentially across group chats, and uses GPT to generate concise recaps, with configurable token limits for context management.

Quick Start & Requirements

  • Deployment: Docker is the recommended method.
    • docker run -it --rm -e TELEGRAM_BOT_TOKEN=<Telegram Bot API Token> -e OPENAI_API_SECRET=<OpenAI API Secret Key> -e DB_CONNECTION_STR="<PostgresSQL connection URL>" ghcr.io/nekomeowww/insights-bot:latest
    • Docker Compose is also supported for local development and deployment.
  • Prerequisites: OpenAI API Key, Telegram Bot Token, PostgreSQL database, Redis.
  • Build: Requires Go for building from source.
  • Resources: Requires network access to OpenAI API and database/Redis instances.

Highlighted Details

  • Supports Telegram, Slack, and Discord integrations.
  • Features commands for summarizing webpages (/smr) and chat histories (/recap, /subscribe_recap).
  • Allows configuration of chat history recap settings and subscription to group recaps.
  • Includes options for forwarding and summarizing messages in private chats.

Maintenance & Community

The project is maintained by nekomeowww. Links to community channels or roadmaps are not explicitly provided in the README.

Licensing & Compatibility

The project's license is not specified in the README. Compatibility for commercial use or closed-source linking is not detailed.

Limitations & Caveats

Chat history summarization commands (/configure_recap, /recap, /subscribe_recap, /unsubscribe_recap, /recap_forwarded_start, /recap_forwarded) are explicitly noted as not available in Slack/Discord integrations. The project requires significant configuration of environment variables for deployment.

Health Check
Last commit

11 months ago

Responsiveness

Inactive

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

Explore Similar Projects

Feedback? Help us improve.