TeLLMgramBot 1.3.2

OpenAI GPT, driven by Telegram

TeLLMgramBot

The basic goal of this project is to create a bridge between a Telegram Bot and a Large Langage Model (LLM), like ChatGPT.

Telegram Bot + LLM Encapsulation

• The Telegram interface handles special commands, especially on some basic "chatty" prompts and responses that don't require LLM, like "Hello".
• The more dynamic conversation gets handed off to the LLM to manage prompts and responses, and Telegram acts as the interaction broker.
• Pass the URL in [square brackets] and mention how the bot should interpret it.
  • Example: "What do you think of this article? [https://some_site/article]"
  • This uses another ChatGPT model, preferrably GPT-4, to support more URL content by OpenAI tokens.
• After starting up, the bot can remember 50% of past conversations by a ChatGPT token limit.
  • Conversations between the Telegram bot assistant and user will be stored in a folder sessionlogs.
  • Users can also clear their conversation history for privacy.

Why Telegram?

Using Telegram as the interface not only solves "exposing" the interface, but gives you boadloads of interactivity over a standard Command Line interface, or trying to create a website with input boxes and submit buttons to try to handle everything:

1. Telegram already lets you paste in verbose, multiline messages.
2. Telegram already lets you paste in pictures, videos, links, etc.
3. Telegram already lets you react with emojis, stickers, etc.

API Keys

To operate TeLLMgramBot, three API keys are required:

• OpenAI - Drives the actual GPT AI.
• BotFather - Helps create a new Telegram bot and provide its API.
• VirusTotal - Performs safety checks on URLs.

There are two ways to populate each API key: environment variables or .key files.

Environment Variables

TeLLMgramBot uses the following environment variables that can be pre-loaded with the three API keys respectively:

1. TELLMGRAMBOT_OPENAI_API_KEY
2. TELLMGRAMBOT_TELEGRAM_API_KEY
3. TELLMGRAMBOT_VIRUSTOTAL_API_KEY

During spin-up time, a user can call out os.environ[env_var] to set those variables, like the following example:

my_keys = Some_Vault_Fetch_Function()

os.environ['TELLMGRAMBOT_OPENAI_API_KEY']     = my_keys['GPTKey']
os.environ['TELLMGRAMBOT_TELEGRAM_API_KEY']   = my_keys['BotFatherToken']
os.environ['TELLMGRAMBOT_VIRUSTOTAL_API_KEY'] = my_keys['VirusTotalToken']

This means the user can implement whatever key vault they want to fetch the keys at runtime, without needing files stored in the directory.

API Key Files

By default, three files are created for the user to input each API key:

1. openai.key
2. telegram.key
3. virustotal.key

Setting each file also updates its respective environment variable as discussed before, if not defined.

Bot Setup

This library includes an example script test_local.py, which extracts values from sample files config.yaml and prompts/test_personality.prmpt for TeLLMgramBot to process.

1. Ensure the previous sections are followed with the proper API keys and your Telegram bot set.
2. Install this library via PIP (pip install TeLLMgramBot) and then import into your project.
3. Instantiate the bot by passing in various configuration pieces needed below:

   telegram_bot = TeLLMgramBot.TelegramBot(
       bot_username   = <Bot username like 'friendly_bot'>,
       bot_owner      = <Bot owner's Telegram username>,
       bot_name       = <Bot name like 'Friendly Bot'>,
       bot_nickname   = <Bot nickname like 'Botty'>,
       bot_initials   = <Bot initials like 'FB'>,
       chat_model     = <Conversation ChatGPT model like 'gpt-3.5-turbo'>,
       url_model      = <URL contents ChatGPT model like 'gpt-4'>,
       token_limit    = <Maximum token count set, by default chat_model max>,
       persona_temp   = <LLM factual to creative value [0-2], by default 1.0>,
       persona_prompt = <System prompt summarizing bot personality>
   )
   

4. Turn on TeLLMgramBot by calling:

   telegram_bot.start_polling()
   

   Once you see TeLLMgramBot polling..., the bot is online in Telegram.
5. Type /commands to show all available reported by the TelegramCommands.txt file.
6. Only by the bot owner, type /start to initiate user conversations.

Resources

• GitHub repository python-telegram-bot has guides to create a Telegram bot.
• For more information on ChatGPT models like gpt-3.5-turbo and tokens, see the following:
  • OpenAI model overview and maximum tokens.
  • OpenAI message conversion to tokens.
• OpenAI Playground helps test a personality prompt more.