summary-gpt-bot

项目简介

summary-gpt-bot 是一个基于人工智能的文本摘要机器人。这个机器人在 Telegram 平台上工作，它可以为文本、网址、PDF 文件和 YouTube 视频生成简洁的摘要。然而，它并不支持对 YouTube Shorts 的内容进行摘要。

功能特色

• 支持多种格式：summary-gpt-bot 可以对普通文本、网址、PDF 文件，以及 YouTube 视频进行分析和摘要。
• 便捷操作：只需在 Telegram 上发送需要摘要的内容，机器人便会自动返回简洁明了的总结。

使用方法

部署到 OpenAI GPT-4

用户可以通过以下命令启动一个仅限自己和朋友使用的 OpenAI GPT-4 摘要机器人：

docker run -d \
    -e LLM_MODEL=gpt-4 \
    -e OPENAI_API_KEY=$OPENAI_API_KEY \
    -e TELEGRAM_TOKEN=$YOUR_TG_TOKEN \
    -e TS_LANG=$YOUR_LANGUAGE \
    -e ALLOWED_USERS=<friend1_id>,<friend2_id>,<your_id> \
    tonypai/summary-gpt-bot:latest

部署到 Azure OpenAI

此外，还可以使用 Azure OpenAI 启动摘要机器人：

docker run -d \
    -e AZURE_API_BASE=https://<your_azure_resource_name>.openai.azure.com \
    -e AZURE_API_KEY=$AZURE_API_KEY \
    -e AZURE_API_VERSION=2024-02-15-preview \
    -e LLM_MODEL=azure/<your_deployment_name> \
    -e TELEGRAM_TOKEN=$YOUR_TG_TOKEN \
    -e TS_LANG=$YOUR_LANGUAGE \
    tonypai/summary-gpt-bot:latest

重要变量

为了使机器人正常运作，需要正确配置以下环境变量：

LLM 相关变量

• AZURE_API_BASE: AZURE OpenAI API 的基础 URL。
• AZURE_API_KEY: 用于 AZURE OpenAI API 的密钥。
• AZURE_API_VERSION: AZURE OpenAI API 的版本信息。
• OPENAI_API_KEY: OpenAI API 的密钥，用于调用 OpenAI 的服务。

机器人相关变量

• CHUNK_SIZE: 当输入过大时，分块的最大 token 数量（默认为 10000）。
• LLM_MODEL: 用于文本摘要的语言模型（默认为 gpt-3.5-turbo-16k）。
• TELEGRAM_TOKEN: Telegram API 所需的令牌（此项必需）。
• TS_LANG: 要摘要的文本语言（默认是台湾普通话）。
• DDG_REGION: duckduckgo 搜索的地区设置（默认是 wt-wt）。
• ALLOWED_USERS: 被允许使用机器人的用户 ID 列表。这可以通过 Telegram 上 @myidbot 获取（此项可选）。

通过以上描述，任何对文本信息快速归纳总结有所需求的用户，不论是个人还是小团队，都可以考虑使用 summary-gpt-bot 来提高效率与准确性。