Telegrambot-with-GPT: A Python repository from MrNice78

Telegrambot-with-GPT4free

🤖 A Telegram bot powered by ChatGPT using the Aiogram API.

ℹ️ Note: The Hugging Face token is only required for image captioning.

✨ Features:

Supports OCR with Tesseract in addition to salesforce blip image captioning.
Easy to translate to your own language with multi-language support.
Supports voice transcription with speech_recognition
Image generation using Stability Diffusion and DALL-E.
Plugin support by n3d1117 under GNU GENERAL PUBLIC LICENSE.

Installation Steps

Linux

Download or clone this repository
Go to the directory

git clone https://github.com/noes14155/Telegrambot-with-GPT4free
cd Telegrambot-with-GPT4free

Copy example.env file to .env

cp example.env .env

Change environment variables in .env file Environment Variables

nano .env

Create virtual environment for this project/directory

python3 -m venv venv
source venv/bin/activate

Install the requirements

apt install -y flac ffmpeg tesseract-ocr

pip install -r requirements.txt

Run the bot

python main.py

Windows

Download or clone this repository:

git clone https://github.com/noes14155/Telegrambot-with-GPT4free
cd Telegrambot-with-GPT4free

Copy the example.env file to .env
Change the environment variables in the .env file using a text editor of your choice.
Create a virtual environment for this project/directory:

python -m venv venv
venv\Scripts\activate

Install the required dependencies:

pip install -r requirements.txt

Install additional dependencies:

Install Tesseract OCR:
- Install using single command 'choco install tesseract' or manually using the following steps.
- Download the Windows installer from the Tesseract OCR GitHub page.
- Run the installer and make sure to check download Additional script data option in the installation options.
- Add the Tesseract installation directory to the system's PATH environment variable.
Install FFmpeg:
- Install using single command 'choco install ffmpeg' or manually using the following steps.
- Download the latest static build of FFmpeg for Windows from the official FFmpeg website
- Extract the downloaded ZIP file to a location of your choice.
- Add the FFmpeg bin directory to the system's PATH environment variable.

Run the bot:

python main.py

Docker

Build (change environment variables before build)

Uncomment this section (If yu want to use gpt4free)

  g4f_server:
    container_name: g4f_server
    ports:
      - '1337:1337'
    environment:
      - PYTHONUNBUFFERED=1
    build:
      context: ./interference
      dockerfile: Dockerfile
    restart: always

Build containers

docker-compose up --build -d

Environment Variables

To run this project, you will need to create a .env file or rename the existing example.env to .env and add the following environment variables

BOT_TOKEN Get this by messaging @botfather Refer to 📖 Telegram Bot Tutorial
HG_TOKEN Optional(Required for image captioning). Sign up on hugging face and get the token from 🔗 Hugging Face.
HG_IMG2TEXT If you want to use another model for image captioning. change it here.
Default value HG_IMG2TEXT = 'https://api-inference.huggingface.co/models/Salesforce/blip-image-captioning-large'
HG_TEXT2IMAGE If you want to use another model for image generation with /img command, change it here Default value HG_TEXT2IMAGE = 'stabilityai/stable-diffusion-2-1'
DEFAULT_LANG Change to your language default english. If you want to translate to your own language please do so in the language_files folder make your own language.yml file and add the language to languages.yml file.
PLUGINS Enable or disable plugins. Default value True.
TTS Enable or disable TTS. Default value True.
BOT_OWNER_ID Add your userid from telegram. If empty DM enable or disable option will be disabled.
GPT_KEY To use GPT4free GPT_KEY = ''
Key from the provider (including openai). Whichever api base you want use the key provided. Naga AI, Novo, Genius AI, Mandrill AI tested, Use correct API_base and GPT_KEY according to the provider Get this by messaging run the /key get command in th bot channel in Naga AI Discord, MandrillaiAI
API_BASE To use GPT4free API_BASE = 'http://localhost:1337'
You can use any provider. I have included Naga AI api base. Use the key for the same.
DEFAULT_MODEL For some providers like Mandrill, which doesn't support models query, provide a default model. Used only if model query returns 404 from the provider.
MAX_HISTORY Number of conversation history to be sent with each request. Default value 10. Don't put more than 20.
ENABLED_PLUGINS List of enabled plugins. Only wolfram is disabled by default. Add Worlframalpha api key before adding wolfram to this list.
WOLFRAM_APP_ID Wolframalpha api key
DUCKDUCKGO_SAFESEARCH Valid values are 'safe', 'moderate', 'off'
WORLDTIME_DEFAULT_TIMEZONE Timezone should be in the format Asia/Dubai or Europe/Rome

🎉 You're all set! Enjoy using the Telegram bot with ChatGPT!

MrNice78/Telegrambot-with-GPT