- A simple-to-use, quick-to-deploy Python-based Telegram bot for OpenAI API
- Supports transcribed voice messages over Whisper API
- (auto-transcriptions, translations, and other messages to the bot over TG's voice messages)
- Supports real-time weather info via OpenWeatherMap API
- Supports geolocation and map lookups via MapTiler API
- (with weather forecasts around the world in all OpenAI API supported languages)
- Supports navigation instructions via Openrouteservice API
- Daily token usage tracking & rate limiting for API usage / cost management
- Supports Perplexity API models in conjunction with OpenAI models
- Very useful for i.e. fact-checking latest data to supplement OpenAI's cutoff dates
- Supports Elasticsearch for RAG
- Increase the knowledge rate with your own documents
- Quickly generate additional knowledge with the built-in Q&A pair creator
- Tested & working on Python 3.10.12
- Required Python packages (tested & working with these, install with
pip install -r requirements.txtfor potentially newer versions):
configparser>=6.0.0
httpx>=0.25.2
langdetect>=1.0.9
matplotlib>=3.8.2
nltk>=3.8.1
openai>=1.6.1
pydub>=0.25.1
python-telegram-bot>=20.7
transformers>=4.36.2
requests>=2.31.0
pytz>=2024.1
timezonefinder>=6.4.0
yt-dlp>=2024.3.10
- (In some instances,
pydubmight requireffmpegto be installed separately. Note that neitherpydubnorffmpegare practically not required if you are not utilizing the voice message/WhisperAPI functionality.)
- Telegram API bot token
- use the
@BotFatherbot on Telegram (set up a bot and get a bot token)
- use the
- OpenAI API token
- Install the required packages either from the list above or with:
pip install -r requirements.txt - Set up your Telegram bot token either as
TELEGRAM_BOT_TOKENenvironment variable or put it into a text file namedbot_token.txtinside the main program directory - Set up your OpenAI API token either as
OPENAI_API_KEYenvironment variable or put into a text file namedapi_token.txtinside the main program directory - If you wish to use the OpenWeatherMap API and the MapTiler API for i.e. localized weather data retrieval, set the
OPENWEATHERMAP_API_KEYand theMAPTILER_API_KEYenvironment variables accordingly. You can get the API keys from OpenWeather and MapTiler - If you wish to use the Openrouteservice API for driving instructions, set the
OPENROUTESERVICE_API_KEYenvironment variable from Openrouteservice - If you wish to use Perplexity API's supplementary fact-checking with their online models, register at Perplexity.ai, buy some API credits and set your Perplexity API key to environment variable:
PERPLEXITY_API_KEY - Adjust your configuration and settings in
config.inito your liking - Run with:
python main.py
- Use the
configmerger.pyto update old configuration files into a newer version'sconfig.ini. You can do this by creating a copy of your existing config to i.e. a file namedmyconfig.txtand including in it the lines you want to keep for the newer version. Then, just runpython configmerger.py config.ini myconfig.txtand all your existing config lines will be migrated to the new one. Works in most cases, but remember to be careful and double-check any migration issues with i.e.diff!
- v0.60 - url info pre-parsing and additional info fetching for media sources, i.e. with
yt-dlp - v0.59 - custom function calling via Elasticsearch RAG (if enabled)
- v0.58.4 - more parsing & formatting fixes
- v0.58.3 - parsing, formatting & chunking adjustments
- v0.58.2 - improved formatting in pplx API calls
- v0.58.1 - improved markdown parsing in translated Perplexity API calls
- v0.58 - chunking, parsing and other small fixes
- v0.57.5 - changes made to Perplexity API handling; new sonar-online models
- v0.57.1 - improved fallbacks on external API calls like Perplexity API
- v0.57 - improved error catching & failsafe fallbacks
- v0.56 - Added Elasticsearch support for RAG - use the
ElasticsearchEnabledflag in newconfig.ini(set toTrueorFalseto enable or disable) - v0.55.4 - API call tracking, extra wait times if needed for external API calls
- v0.55.3 - reply activity, better chunking logic
- v0.55 - better reply animation handling
- v0.52 - more accurate weather data globally via the OpenWeatherMap API & Maptiler API
- v0.51 - "smart" chunking of external requests to mitigate timeout-related issues
- v0.50.3 -
langdetect& handling fixes - v0.50.2 - typing animation on replies, adjustments on processing logic
- v0.50.1 -
langdetecton auto-assessing translation requirements - v0.50 - Custom function call: Perplexity API fact-checking
- v0.49.1 - Modularity adjustments
- v0.48 - Openrouteservice API implementation
- v0.47 - more token counting & polling logic fixes
- v0.46.2 - fixes to token count & polling logic
- v0.46 - rewrote the polling logic on daily token count resets
- v0.45 -
/usagechartfeature added for utilization charts (requiresmatplotlib) - v0.44 - API function calling, OpenWeatherMap API weather searches and MapTiler API geolookup
- v0.43.2 - Fixed a small bug in daily token caps
- v0.43.1 - Better error catching
- v0.43 - New admin commands:
/setsystemmessage <message>(valid until bot restart) and/resetsystemmessage(reset fromconfig.ini) - v0.42 -
/resetcommand added for bot reset. SetResetCommandEnabledandAdminOnlyResetflags inconfig.iniaccordingly. - v0.41 - modularized text message handling to
text_message_handler.pyand voice message handling tovoice_message_handler.py - v0.40 - session timeout management for compacting chat history (see
config.ini=>SessionTimeoutMinutes,MaxRetainedMessages) - v0.39.5 - small fixes to OpenAI API payload implementation
- v0.39.4 - modularized
log_message&rotate_log_file(log file handling) =>modules.py - v0.39.3 - modularized
check_global_rate_limit=>modules.py - v0.39.2 - text style parsing and WhisperAPI STT pre-processing for the model improved
- v0.39 - better parsing for codeblocks, html and other markups, modularized more; see
modules.py - v0.38 - keep better record of daily token usage, streamlined (note: you will need to clear out your existing
token_usage.json, the file structure has changed from the previous version) - v0.37 - better enforcing of voice msg limits
- v0.36 - bot command fixes and adjustments
- v0.35 - modularized bot commands to
bot_commands.py, fixedconfigmerger.pyversion - v0.34 - added
configmerger.pyto ease updating the bot (merge old configuration flags with new versions) - v0.33 - more performance fixes and added+unified async functionalities
- v0.32 - Daily token counter reset polling & small bugfixes
- v0.31 - Context memory token counter adjusted & fixed to be more precise
- v0.30 - Whisper API interaction fine adjustments & small fixes
- v0.29 - WhisperAPI transcriptions via voice messages added
- WhisperAPI voice messages use the same OpenAI API token as the regular text chat version
- see the
config.inito turn the option on or off - WIP for additional transcription features
- see the
- v0.28 - customizable
/startgreeting inconfig.ini - v0.27 - added
/usagecommand to track token usage (for bot owner only, 0 to disable inconfig.ini) - v0.26 - added separate chat logging and a global limiter functionality for requests/min (see
config.ini) - v0.25 - daily token usage limit functionality
- added a functionality to set daily token usage limits (for bot cost control), see
config.ini - modularized extra utils (startup msg etc) into
utils.py
- added a functionality to set daily token usage limits (for bot cost control), see
- v0.24 - bug fixes & rate limit pre-alpha
- v0.23 - option to log to file added, see new logging options in
config.ini - v0.22 -
escape_markdownmoved into a separate.pyfile, it was unused anyway - v0.21 - Comprehensive Refactoring and Introduction of Object-Oriented Design
- Implemented object-oriented programming principles by encapsulating bot functionality within the TelegramBot class.
- Refined code structure for improved readability, maintainability, and scalability.
- v0.20 - modularization, step 1 (key & token reading:
api_key.py,bot_token.py) - v0.19 - timeout error fixes, retry handling;
Timeoutvalue added toconfig.ini - v0.18 - model temperature can now be set in
config.ini - v0.17 - time & date stamping for better temporal awareness
- v0.16 -
/help&/about - v0.15 - chat history context memory (trim with MAX_TOKENS)
- v0.14 - bug fixes
- v0.13 - parsing/regex for url title+address markdowns
- v0.12 - more HTML regex parsing from the API markdown
- v0.11 - switched to HTML parsing
- v0.10 - MarkdownV2 tryouts (code blocks + bold is mostly working)
- v0.09 - using MarkdownV2
- v0.08 - markdown for bot's responses
- v0.07 - log incoming and outgoing messages
- v0.06 - API system message fixed
- v0.05 - retry, max retries, retry delay
- v0.04 - chat history trimming
- All contributions appreciated! Feel free to also post any bugs and other issues on the repo's "Issues" page.
- Written by FlyingFathead
- Digital ghost code by ChaosWhisperer