51n1au5k1 / simplest_chatgpt_telegram_bot

This is a Telegram bot that generates responses to user messages using OpenAI's API. It can also generate images using DALL-E and has commands for starting a new conversation, stopping the current conversation, and displaying available commands. Access to the bot can be restricted by configuring a list of allowed users.

Simplest ChatGPT Telegram Bot

This is a Python script that sets up a Telegram bot using the python-telegram-bot library, which communicates with OpenAI's GPT-3 API to generate responses to user messages.

The bot responds to any message sent to it by generating a response using the last five messages in the conversation history as a prompt for the GPT-3 API. The bot can also start a new conversation, stop the current conversation and delete context, generate an image using DALL-E, and display a list of available commands. The list of allowed users is read from a file and can be configured to limit access to the bot.

Update April, 19 2023

• Added support for generating images using DALL-E.
• Split bot.py into separate files according to their role.
• Added the ability to customize bot settings by setting environment variables.
• Updated the README.md file to reflect these changes.

Update April, 17 2023

• Added command for setting from the menu

Update April, 13 2023

• Added support for loading configuration from a file
• Implemented a feature to restrict bot access based on user ID
• Improved error handling and logging

Requirements

• Python 3.7 or higher
• A Telegram bot token (get one from @BotFather)
• An OpenAI API key (get one from the OpenAI API dashboard)
• python-telegram-bot version not higher than 13.15

The bot responds to the following commands:

• /new - Start a new conversation.
• /stop - Stop the current conversation and delete context.
• /image - Generate an image using DALL-E. Usage: /image .
• /settings - Show or update user preferences by typing /settings, or /settings to update a setting.
• /help - Show the available commands.

Installation

1. Clone the repository:

   git clone https://github.com/51n1au5k1/simplest_chatgpt_telegram_bot.git

2. Install the required packages:

   pip install -r requirements.txt

3. Edit a tokens.env file in the 'private' folder of the project with the following contents

   nano private/tokens.env

TELEGRAM_BOT_TOKEN=<your_telegram_bot_token>
OPENAI_API_KEY=<your_openai_api_key>
OPENAI_MODEL_ID=<the_id_of_the_gpt_model_you_want_to_use>

Replace <your_telegram_bot_token> with your actual Telegram bot token, <your_openai_api_key> with your actual OpenAI API key, and <the_id_of_the_gpt_model_you_want_to_use> with the ID of the GPT model you want to use (it's text-davinci-003 by default).

You can also customize the other settings in this file if needed.

To create a list of allowed users, you can edit a text file called "allowed_users.txt" and write one username per line.

    nano private/allowed_users.txt

For example:
546512
1324654
8945313

To allow everyone to chat, leave this file empty.

4. If you're using a cloud to run the bot, change the permissions so that only you can read and write to it:

   chmod 600 private/tokens.env
   chmod 600 private/allowed_users.txt
   chmod 600 private/config.env

Usage

1. Start the bot by running the bot.py script:

   python bot.py

2. Open Telegram and find your bot by its username.

3. Send a message to the bot and it will respond with a generated message based on the context of the conversation.

Running the Bot in Docker

To run the bot in Docker, follow these steps:

1. Install Docker on your machine.

2. Clone the repository:

   git clone https://github.com/51n1au5k1/simplest_chatgpt_telegram_bot.git

3. Navigate to the project directory:

   cd simplest_chatgpt_telegram_bot

4. Edit a tokens.env file in the 'private' folder of the project with the following contents

   nano private/tokens.env

TELEGRAM_BOT_TOKEN=<your_telegram_bot_token>
OPENAI_API_KEY=<your_openai_api_key>
OPENAI_MODEL_ID=<the_id_of_the_gpt_model_you_want_to_use>

Replace <your_telegram_bot_token> with your actual Telegram bot token, <your_openai_api_key> with your actual OpenAI API key, and <the_id_of_the_gpt_model_you_want_to_use> with the ID of the GPT model you want to use (it's text-davinci-003 by default).

You can also customize the other settings in this file if needed.

To create a list of allowed users, you can edit a text file called "allowed_users.txt" and write one username per line.

nano private/allowed_users.txt

For example:
561653154
561355131
556513

To allow everyone to chat, leave this file empty.

5. Build the Docker image:

   docker build -t simplest-chatgpt-bot .

6. Run the Docker container:

   docker run simplest-chatgpt-bot

7. The bot should now be up and running!

Note: If you encounter any issues while running the bot in Docker, please check that your bot token and OpenAI API key are correctly configured in the <tokens.env> file.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is licensed under the MIT License.