telegram chat summarizer

Telegram 聊天摘要应用程序

您是否厌倦了每天浏览大量 Telegram 消息来寻找有价值的信息？救赎就在这里！

该存储库托管 Telegram 应用程序的实现，用于监视和汇总群聊。它最初是为个人用途而创建的，适用于需要从一个或多个实时大规模 Telegram 群聊中收集信息的人，这些群聊会生成太多消息而需要手动查看。

根据给定的配置：

1. 使用 Telegram API 监控一组给定的 Telegram 群聊。
2. 汇总定义的回溯期内受监控的聊天（即，如果您将回溯期设置为 12 小时，您将每天两次收到过去 12 小时的摘要）。目前仅分析短信。
3. 使用 Bot API 将摘要发送给一组给定的 Telegram 用户。
4. 对于每个发送的摘要，应用程序都会保留摘要上下文，直到下一个摘要，以便用户可以针对摘要提出澄清问题。

安装

1. 使用本指南获取 Telegram API 的api_id和api_hash值。
2. 使用本指南创建 Telegram 机器人并获取其令牌。
3. 从此处获取 OpenAI API 密钥。目前，该应用程序具有 OpenAI 后端硬编码（ gpt-4-turbo-preview模型），但很容易将其替换为您选择的后端，因为它是通过 LangChain 库调用使用的。
4. 编写聊天摘要提示。使用examples/夹中的文件夹作为参考。
5. 定义配置并将其保存到config.json文件中：

{
  "telegram_api_id" : <api_id>,
  "telegram_api_hash" : " <api_hash> " ,
  "openai_api_key" : " <key> " ,
  "telegram_bot_auth_token" : " <token> " ,
  "chats_to_summarize" : [
    {
      "id" : " <group chat ID or name> " ,
      "lookback_period_seconds" : 86400 ,
      "summarization_prompt_path" : " prompts/example_summarization_prompt.txt "
    }
  ],
  "telegram_summary_receivers" : [
    " <Telegram username> "
  ]
}

5. 安装在requirements.txt文件中定义的Python需求或构建Docker镜像：

python3 -m pip install -r requirements.txt

或者

docker build -t tcsa:latest .

6. 运行应用程序：

python3 app.py config.json

或者

docker run -it tcsa:latest

第一次运行时，应用程序会要求您登录使用的 Telegram 帐户，如下所示：

user@pc: ~ /telegram-chat-summarizer $ python3 app.py config.json
2024-03-27 23:03:11,618 - INFO - Started !
Please enter your phone (or bot token): < phone number >
Please enter the code you received: < OTP >
Please enter your password:

然后会话将存储在磁盘上，后续运行将不需要身份验证。

用法

应用程序启动并运行后，每个摘要订阅者都需要向机器人发送/verify消息，以便它可以注册用户。

机器人可以通过提供命令/<summarized chat name>来切换对话上下文（聊天名称可以是配置中定义的任何名称）。如果您有多个聊天被总结，则使用此机制：通过给出相应的命令，您可以将 LLM 上下文切换到不同的聊天并讨论该聊天的摘要。

实施细节和限制

实现非常简单，肯定还有改进的空间。一些即时的好东西（欢迎 PR！）：

1. 用于用户验证和聊天上下文的磁盘存储持久性。
2. 摆脱摘要订阅机制，转而采用不那么不便的机制。
3. 通过机器人进行基本应用程序管理（摘要聊天、摘要订阅者等），作为配置文件的替代方案。
4. 支持除文字以外的消息：语音消息、图片、视频。

在此实施之后编写了一份关于 Habr (RU) 的分步指南。