ChatGPT Telegram 机器人

English | 中文

一款拥有丝滑般AI体验的Telegram机器人。

⚡功能

[✓] 同时支持Azure OpenAI和原生OpenAI。

[✓] 实时（流式）响应AI，体验更快更流畅。

[✓] 基于OpenAI DALL·E 3模型生成图片。

[✓] 15种预设机器人身份，可快速切换。

[✓] 支持自定义机器人身份，满足个性化需求。

[✓] 支持一键清空聊天内容，并随时重新开始对话。

[✓] 原生Telegram机器人按钮支持，使所需功能的实现简单直观。

[✓] 用户等级划分，不同等级享有不同的单次会话Token数量、上下文数量和会话频率。

[✓] UI界面支持英语和中文。

[✓] 容器化部署。

[✓] 更多...

👨‍💻待办事项

[x] 允许用户在机器人中使用自己的OpenAI Key，以获得更大的自由度。

[x] 改进错误处理机制。

🤖快速体验

Telegram机器人：RoboAceBot

🛠️部署

安装依赖

pip install -r requirements.txt

配置数据库

安装数据库

您可以通过以下命令快速创建本地MySQL数据库：

docker-compose up -d -f db/docker-compose.yaml

初始化数据库

mysql -uusername -p -e "source db/database.sql"

添加配置

所有必要的配置都在config.yaml文件中，请参考config.yaml.example了解文件格式和内容。

参数	可选	描述
BOT.TOKEN	否	从@botFather创建机器人并获取Token。
DEVELOPER_CHAT_ID	否	当机器人遇到错误时接收消息的Telegram账号ID。您可以使用@get_id_bot来获取您的ID。
MYSQL	否	与MySQL连接相关的参数。
TIME_SPAN	否	用于计算限流的时间窗口大小，单位为分钟。
RATE_LIMIT	否	key为用户等级，value为在TIME_SPAN时间内允许的最大聊天次数。
CONTEXT_COUNT	否	key为用户等级，value为每次聊天包含的上下文数量。
MAX_TOKEN	否	key为用户等级，value为每次聊天AI返回的最大Token数量。
AI.TYPE	是	使用的AI类型，有两个选项：openai和azure。默认为openai。
AI.BASE	是	在Azure门户中查看资源时，此值可在“密钥和终结点”部分找到。或者也可以在“Azure OpenAI Studio” > “Playground” > “代码视图”中找到。仅当AI.TYPE为azure时才需要设置。
AI.VERSION	是	Azure OpenAI的版本号，仅当AI.TYPE为azure时才需要设置。
AI.MODEL	是	Azure OpenAI的部署名称，或OpenAI的模型。

如果您使用的是Azure的OpenAI，可以在此链接中获取所有必需的内容：

使用Azure OpenAI服务开始使用ChatGPT和GPT-4

🚀启动

python main.py | tee >> debug.log

Docker构建与运行

docker run --rm --name chatgpt-telegram-bot -v ./config.yaml:/app/config.yaml ghcr.io/v-know/chatgpt-telegram-bot:latest 

Docker Compose

docker-compose up -d

❤️结语

希望这个项目能为您带来流畅的AI体验，并帮助更多人创建和使用自己的Telegram机器人。

星标历史

ChatGPT Telegram Bot 快速上手指南

环境准备

在开始部署前，请确保您的服务器满足以下要求：

• 操作系统：Linux / macOS / Windows (推荐 Linux)
• Python 版本：3.9 或更高版本
• 数据库：MySQL 8.0+ (可通过 Docker 快速部署)
• 依赖项：需安装项目所需的 Python 库
• 账号准备：
  • Telegram Bot Token (通过 @BotFather 获取)
  • OpenAI API Key 或 Azure OpenAI 资源信息

安装步骤

1. 克隆项目与安装依赖

下载项目源码并安装 Python 依赖：

git clone https://github.com/v-know/chatgpt-telegram-bot.git
cd chatgpt-telegram-bot
pip install -r requirements.txt

提示：国内用户若下载依赖较慢，可使用清华源加速： pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

2. 配置数据库

推荐使用 Docker 快速启动本地 MySQL 数据库：

docker-compose up -d -f db/docker-compose.yaml

初始化数据库表结构（请将 username 替换为您的实际数据库用户名）：

mysql -uusername -p -e "source db/database.sql"

3. 配置文件设置

复制配置示例文件并编辑 config.yaml：

cp config.yaml.example config.yaml

使用编辑器打开 config.yaml，填入以下关键信息：

参数	说明
BOT.TOKEN	从 @BotFather 获取的机器人 Token
DEVELOPER_CHAT_ID	接收报错信息的管理员 Telegram ID (可通过 @get_id_bot 查询)
MYSQL	MySQL 连接信息 (默认 Docker 配置通常无需修改，除非自定义)
AI.TYPE	选择 openai 或 azure
AI.MODEL	OpenAI 模型名称 (如 gpt-3.5-turbo) 或 Azure 部署名称
AI.API_KEY	您的 OpenAI Key 或 Azure Key

注：若使用 Azure OpenAI，还需配置 AI.BASE (Endpoint) 和 AI.VERSION。

基本使用

完成配置后，您可以通过以下任一方式启动机器人：

方式一：直接运行 (适合开发调试)

python main.py | tee >> debug.log

方式二：Docker 运行 (推荐生产环境)

确保当前目录下存在配置好的 config.yaml 文件，然后执行：

docker run --rm --name chatgpt-telegram-bot -v ./config.yaml:/app/config.yaml ghcr.io/v-know/chatgpt-telegram-bot:latest

方式三：Docker Compose 一键启动

如果已配置好 docker-compose.yaml (包含数据库和服务)，可直接启动全套环境：

docker-compose up -d

启动成功后，在 Telegram 中搜索您设置的机器人名称或点击链接，即可开始对话。支持流式回复、切换预设角色、生成图片等功能。