Note GPT-4 support will be added as soon as APIs are released to the public!

ChatGPT Telegram Bot

A Telegram bot that integrates with OpenAI's official ChatGPT APIs to provide answers. Ready to use with minimal configuration required.

Screenshots

Features

• Support markdown in answers
• Reset conversation with the /reset command
• Typing indicator while generating a response
• Access can be restricted by specifying a list of allowed users
• Docker and Proxy support
• (NEW!) Image generation using DALL·E via the /image command
• (NEW!) Transcribe audio and video messages using Whisper (may require ffmpeg)
• (NEW!) Automatic conversation summary to avoid excessive token usage
• (NEW!) Group chat support with inline queries
  • To use this feature, enable inline queries for your bot in BotFather via the /setinline command
• (NEW!) Track token usage per user
• (NEW!) Get personal token usage statistics and cost per day/month via the /stats command
• (NEW!) User budgets and guest budget
• (NEW!) Stream support

Additional features - help needed!

• Add session persistence

PRs are always welcome!

Prerequisites

• Python 3.9+
• A Telegram bot and its token (see tutorial)
• An OpenAI account (see configuration section)

Getting started

Configuration

Customize the configuration by copying .env.example and renaming it to .env, then editing the required parameters as desired:

Parameter	Description
OPENAI_API_KEY	Your OpenAI API key, you can get it from here
TELEGRAM_BOT_TOKEN	Your Telegram bot's token, obtained using BotFather (see tutorial)
ADMIN_USER_IDS	Telegram user IDs of admins. These users have access to special admin commands, information and no budget restrictions. Admin IDs don't have to be added to ALLOWED_TELEGRAM_USER_IDS. Note: by default, no admin ('-')
ALLOWED_TELEGRAM_USER_IDS	A comma-separated list of Telegram user IDs that are allowed to interact with the bot (use getidsbot to find your user ID). Note: by default, everyone is allowed (*)

Optional configuration

Parameter	Description	Default value
MONTHLY_USER_BUDGETS	A comma-separated list of $-amounts per user from list ALLOWED_TELEGRAM_USER_IDS to set custom usage limit of OpenAI API costs for each. Note: by default, no limits for anyone (*)	*
MONTHLY_GUEST_BUDGET	$-amount as usage limit for all guest users. Guest users are users in group chats that are not in the ALLOWED_TELEGRAM_USER_IDS list. Value is ignored if no usage limits are set in user budgets (MONTHLY_USER_BUDGETS="*")	100.0
PROXY	Proxy to be used for OpenAI and Telegram bot (e.g. http://localhost:8080)	-
OPENAI_MODEL	The OpenAI model to use for generating responses	gpt-3.5-turbo
ASSISTANT_PROMPT	A system message that sets the tone and controls the behavior of the assistant	You are a helpful assistant.
SHOW_USAGE	Whether to show OpenAI token usage information after each response	false
STREAM	Whether to stream responses	true
MAX_TOKENS	Upper bound on how many tokens the ChatGPT API will return	1200
MAX_HISTORY_SIZE	Max number of messages to keep in memory, after which the conversation will be summarised to avoid excessive token usage	15
MAX_CONVERSATION_AGE_MINUTES	Maximum number of minutes a conversation should live since the last message, after which the conversation will be reset	180
VOICE_REPLY_WITH_TRANSCRIPT_ONLY	Whether to answer to voice messages with the transcript only or with a ChatGPT response of the transcript	true
N_CHOICES	Number of answers to generate for each input message	1
TEMPERATURE	Number between 0 and 2. Higher values will make the output more random	1.0
PRESENCE_PENALTY	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far	0
FREQUENCY_PENALTY	Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far	0
IMAGE_SIZE	The DALL·E generated image size. Allowed values: "256x256", "512x512" or "1024x1024"	"512x512"
GROUP_TRIGGER_KEYWORD	If set, the bot in group chats will only respond to messages that start with this keyword	""
IGNORE_GROUP_TRANSCRIPTIONS	If set to true, the bot will not process transcriptions in group chats	true
TOKEN_PRICE	$-price per 1000 tokens used to compute cost information in usage statistics (https://openai.com/pricing)	0.002
IMAGE_PRICES	A comma-separated list with 3 elements of prices for the different image sizes: "256x256", "512x512" and "1024x1024"	"0.016,0.018,0.02"
TRANSCRIPTION_PRICE	USD-price for one minute of audio transcription	0.002

Check out the official API reference for more details.

Installing

Clone the repository and navigate to the project directory:

git clone https://github.com/TheKostVK/TelegramBotOpenAI.git
cd TelegramBotOpenAI

From Source

1. Create a virtual environment:

python -m venv venv

2. Activate the virtual environment:

# For Linux or macOS:
source venv/bin/activate

# For Windows:
venv\Scripts\activate

3. Install the dependencies using requirements.txt file:

pip install -r requirements.txt

4. Use the following command to start the bot:

python bot/main.py

Using Docker Compose

Run the following command to build and run the Docker image:

docker compose up

Credits

• ChatGPT from OpenAI
• python-telegram-bot
• jiaaro/pydub

Disclaimer

This is a personal project and is not affiliated with OpenAI in any way.