aljaz/chatgpt-telegram-bot
1
1
Fork 0
mirror of https://github.com/aljazceru/chatgpt-telegram-bot.git synced 2025-12-20 22:24:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Apply PEP8 styling standard & reformat

Browse Source
This commit is contained in:
bugfloyd
2023-04-15 14:47:30 +02:00
parent a2361a0033
commit 431aeecd95
4 changed files with 114 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
bot/main.py
View File

@@ -71,7 +71,7 @@ def main():
'ignore_group_transcriptions': os.environ.get('IGNORE_GROUP_TRANSCRIPTIONS', 'true').lower() == 'true', 'ignore_group_transcriptions': os.environ.get('IGNORE_GROUP_TRANSCRIPTIONS', 'true').lower() == 'true',
'group_trigger_keyword': os.environ.get('GROUP_TRIGGER_KEYWORD', ''), 'group_trigger_keyword': os.environ.get('GROUP_TRIGGER_KEYWORD', ''),
'token_price': float(os.environ.get('TOKEN_PRICE', 0.002)), 'token_price': float(os.environ.get('TOKEN_PRICE', 0.002)),
'image_prices': [float(i) for i in os.environ.get('IMAGE_PRICES',"0.016,0.018,0.02").split(",")], 'image_prices': [float(i) for i in os.environ.get('IMAGE_PRICES', "0.016,0.018,0.02").split(",")],
'transcription_price': float(os.environ.get('TOKEN_PRICE', 0.006)), 'transcription_price': float(os.environ.get('TOKEN_PRICE', 0.006)),
'bot_language': os.environ.get('BOT_LANGUAGE', 'en'), 'bot_language': os.environ.get('BOT_LANGUAGE', 'en'),
} }

12
bot/openai_helper.py
View File

@@ -26,9 +26,11 @@ def default_max_tokens(model: str) -> int:
""" """
return 1200 if model in GPT_3_MODELS else 2400 return 1200 if model in GPT_3_MODELS else 2400
with open('translations.json', 'r', encoding='utf-8') as f: with open('translations.json', 'r', encoding='utf-8') as f:
translations = json.load(f) translations = json.load(f)
def localized_text(key, bot_language): def localized_text(key, bot_language):
""" """
Return translated text for a key in specified bot_language. Return translated text for a key in specified bot_language.
@@ -46,6 +48,7 @@ def localized_text(key, bot_language):
# return key as text # return key as text
return key return key
class OpenAIHelper: class OpenAIHelper:
""" """
ChatGPT helper class. ChatGPT helper class.
@@ -198,7 +201,10 @@ class OpenAIHelper:
if 'data' not in response or len(response['data']) == 0: if 'data' not in response or len(response['data']) == 0:
logging.error(f'No response from GPT: {str(response)}') logging.error(f'No response from GPT: {str(response)}')
raise Exception(f"⚠️ _{localized_text('error', bot_language)}._ ⚠️\n{localized_text('try_again', bot_language)}.") raise Exception(
f"⚠️ _{localized_text('error', bot_language)}._ "
f"⚠️\n{localized_text('try_again', bot_language)}."
)
return response['data'][0]['url'], self.config['image_size'] return response['data'][0]['url'], self.config['image_size']
except Exception as e: except Exception as e:
@@ -253,8 +259,8 @@ class OpenAIHelper:
:return: The summary :return: The summary
""" """
messages = [ messages = [
{ "role": "assistant", "content": "Summarize this conversation in 700 characters or less" }, {"role": "assistant", "content": "Summarize this conversation in 700 characters or less"},
{ "role": "user", "content": str(conversation) } {"role": "user", "content": str(conversation)}
] ]
response = await openai.ChatCompletion.acreate( response = await openai.ChatCompletion.acreate(
model=self.config['model'], model=self.config['model'],

75
bot/telegram_bot.py
View File

@@ -7,8 +7,8 @@ import asyncio
import telegram import telegram
from uuid import uuid4 from uuid import uuid4
from telegram import constants, BotCommandScopeAllGroupChats from telegram import constants, BotCommandScopeAllGroupChats
from telegram import InlineKeyboardMarkup, InlineKeyboardButton from telegram import InlineKeyboardMarkup, InlineKeyboardButton, InlineQueryResultArticle
from telegram import Message, MessageEntity, Update, InlineQueryResultArticle, InputTextMessageContent, BotCommand, ChatMember from telegram import Message, MessageEntity, Update, InputTextMessageContent, BotCommand, ChatMember
from telegram.error import RetryAfter, TimedOut from telegram.error import RetryAfter, TimedOut
from telegram.ext import ApplicationBuilder, ContextTypes, CommandHandler, MessageHandler, \ from telegram.ext import ApplicationBuilder, ContextTypes, CommandHandler, MessageHandler, \
filters, InlineQueryHandler, CallbackQueryHandler, Application, CallbackContext filters, InlineQueryHandler, CallbackQueryHandler, Application, CallbackContext
@@ -17,6 +17,7 @@ from pydub import AudioSegment
from openai_helper import OpenAIHelper, localized_text from openai_helper import OpenAIHelper, localized_text
from usage_tracker import UsageTracker from usage_tracker import UsageTracker
def message_text(message: Message) -> str: def message_text(message: Message) -> str:
""" """
Returns the text of a message, excluding any bot commands. Returns the text of a message, excluding any bot commands.
@@ -25,20 +26,22 @@ def message_text(message: Message) -> str:
if message_text is None: if message_text is None:
return '' return ''
for _, text in sorted(message.parse_entities([MessageEntity.BOT_COMMAND]).items(), key=(lambda item: item[0].offset)): for _, text in sorted(message.parse_entities([MessageEntity.BOT_COMMAND]).items(),
key=(lambda item: item[0].offset)):
message_text = message_text.replace(text, '').strip() message_text = message_text.replace(text, '').strip()
return message_text if len(message_text) > 0 else '' return message_text if len(message_text) > 0 else ''
class ChatGPTTelegramBot: class ChatGPTTelegramBot:
""" """
Class representing a ChatGPT Telegram Bot. Class representing a ChatGPT Telegram Bot.
""" """
# Mapping of budget period to cost period # Mapping of budget period to cost period
budget_cost_map = { budget_cost_map = {
"monthly":"cost_month", "monthly": "cost_month",
"daily":"cost_today", "daily": "cost_today",
"all-time":"cost_all_time" "all-time": "cost_all_time"
} }
def __init__(self, config: dict, openai: OpenAIHelper): def __init__(self, config: dict, openai: OpenAIHelper):
@@ -58,7 +61,8 @@ class ChatGPTTelegramBot:
BotCommand(command='resend', description=localized_text('resend_description', bot_language)) BotCommand(command='resend', description=localized_text('resend_description', bot_language))
] ]
self.group_commands = [ self.group_commands = [
BotCommand(command='chat', description=localized_text('chat_description', bot_language)) BotCommand(command='chat',
description=localized_text('chat_description', bot_language))
] + self.commands ] + self.commands
self.disallowed_message = localized_text('disallowed', bot_language) self.disallowed_message = localized_text('disallowed', bot_language)
self.budget_limit_message = localized_text('budget_limit', bot_language) self.budget_limit_message = localized_text('budget_limit', bot_language)
@@ -84,7 +88,6 @@ class ChatGPTTelegramBot:
) )
await update.message.reply_text(help_text, disable_web_page_preview=True) await update.message.reply_text(help_text, disable_web_page_preview=True)
async def stats(self, update: Update, context: ContextTypes.DEFAULT_TYPE): async def stats(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
""" """
Returns token usage statistics for current day and month. Returns token usage statistics for current day and month.
@@ -137,12 +140,19 @@ class ChatGPTTelegramBot:
) )
# text_budget filled with conditional content # text_budget filled with conditional content
text_budget = "\n\n" text_budget = "\n\n"
budget_period =self.config['budget_period'] budget_period = self.config['budget_period']
if remaining_budget < float('inf'): if remaining_budget < float('inf'):
text_budget += f"{localized_text('stats_budget', bot_language)}{localized_text(budget_period, bot_language)}: ${remaining_budget:.2f}.\n" text_budget += (
f"{localized_text('stats_budget', bot_language)}"
f"{localized_text(budget_period, bot_language)}: "
f"${remaining_budget:.2f}.\n"
)
# add OpenAI account information for admin request # add OpenAI account information for admin request
if self.is_admin(update): if self.is_admin(update):
text_budget += f"{localized_text('stats_openai', bot_language)}{self.openai.get_billing_current_month():.2f}" text_budget += (
f"{localized_text('stats_openai', bot_language)}"
f"{self.openai.get_billing_current_month():.2f}"
)
usage_text = text_current_conversation + text_today + text_month + text_budget usage_text = text_current_conversation + text_today + text_month + text_budget
await update.message.reply_text(usage_text, parse_mode=constants.ParseMode.MARKDOWN) await update.message.reply_text(usage_text, parse_mode=constants.ParseMode.MARKDOWN)
@@ -161,7 +171,8 @@ class ChatGPTTelegramBot:
if chat_id not in self.last_message: if chat_id not in self.last_message:
logging.warning(f'User {update.message.from_user.name} (id: {update.message.from_user.id})' logging.warning(f'User {update.message.from_user.name} (id: {update.message.from_user.id})'
f' does not have anything to resend') f' does not have anything to resend')
await context.bot.send_message(chat_id=chat_id, text=localized_text('resend_failed', self.config['bot_language'])) await context.bot.send_message(chat_id=chat_id,
text=localized_text('resend_failed', self.config['bot_language']))
return return
# Update message text, clear self.last_message and send the request to prompt # Update message text, clear self.last_message and send the request to prompt
@@ -194,13 +205,15 @@ class ChatGPTTelegramBot:
""" """
Generates an image for the given prompt using DALL·E APIs Generates an image for the given prompt using DALL·E APIs
""" """
if not self.config['enable_image_generation'] or not await self.check_allowed_and_within_budget(update, context): if not self.config['enable_image_generation'] or not await self.check_allowed_and_within_budget(update,
context):
return return
chat_id = update.effective_chat.id chat_id = update.effective_chat.id
image_query = message_text(update.message) image_query = message_text(update.message)
if image_query == '': if image_query == '':
await context.bot.send_message(chat_id=chat_id, text=localized_text('image_no_prompt', self.config['bot_language'])) await context.bot.send_message(chat_id=chat_id,
text=localized_text('image_no_prompt', self.config['bot_language']))
return return
logging.info(f'New image generation request received from user {update.message.from_user.name} ' logging.info(f'New image generation request received from user {update.message.from_user.name} '
@@ -257,7 +270,10 @@ class ChatGPTTelegramBot:
await context.bot.send_message( await context.bot.send_message(
chat_id=chat_id, chat_id=chat_id,
reply_to_message_id=self.get_reply_to_message_id(update), reply_to_message_id=self.get_reply_to_message_id(update),
text=f"{localized_text('media_download_fail', bot_language)[0]}: {str(e)}. {localized_text('media_download_fail', bot_language)[1]}", text=(
f"{localized_text('media_download_fail', bot_language)[0]}: "
f"{str(e)}. {localized_text('media_download_fail', bot_language)[1]}"
),
parse_mode=constants.ParseMode.MARKDOWN parse_mode=constants.ParseMode.MARKDOWN
) )
return return
@@ -323,7 +339,10 @@ class ChatGPTTelegramBot:
self.usage["guests"].add_chat_tokens(total_tokens, self.config['token_price']) self.usage["guests"].add_chat_tokens(total_tokens, self.config['token_price'])
# Split into chunks of 4096 characters (Telegram's message limit) # Split into chunks of 4096 characters (Telegram's message limit)
transcript_output = f"_{localized_text('transcript', bot_language)}:_\n\"{transcript}\"\n\n_{localized_text('answer', bot_language)}:_\n{response}" transcript_output = (
f"_{localized_text('transcript', bot_language)}:_\n\"{transcript}\"\n\n"
f"_{localized_text('answer', bot_language)}:_\n{response}"
)
chunks = self.split_into_chunks(transcript_output) chunks = self.split_into_chunks(transcript_output)
for index, transcript_chunk in enumerate(chunks): for index, transcript_chunk in enumerate(chunks):
@@ -361,7 +380,8 @@ class ChatGPTTelegramBot:
if not await self.check_allowed_and_within_budget(update, context): if not await self.check_allowed_and_within_budget(update, context):
return return
logging.info(f'New message received from user {update.message.from_user.name} (id: {update.message.from_user.id})') logging.info(
f'New message received from user {update.message.from_user.name} (id: {update.message.from_user.id})')
chat_id = update.effective_chat.id chat_id = update.effective_chat.id
user_id = update.message.from_user.id user_id = update.message.from_user.id
prompt = message_text(update.message) prompt = message_text(update.message)
@@ -400,7 +420,8 @@ class ChatGPTTelegramBot:
if chunk != len(chunks) - 1: if chunk != len(chunks) - 1:
chunk += 1 chunk += 1
try: try:
await self.edit_message_with_retry(context, chat_id, str(sent_message.message_id), chunks[-2]) await self.edit_message_with_retry(context, chat_id, str(sent_message.message_id),
chunks[-2])
except: except:
pass pass
try: try:
@@ -414,9 +435,11 @@ class ChatGPTTelegramBot:
if is_group_chat: if is_group_chat:
# group chats have stricter flood limits # group chats have stricter flood limits
cutoff = 180 if len(content) > 1000 else 120 if len(content) > 200 else 90 if len(content) > 50 else 50 cutoff = 180 if len(content) > 1000 else 120 if len(content) > 200 else 90 if len(
content) > 50 else 50
else: else:
cutoff = 90 if len(content) > 1000 else 45 if len(content) > 200 else 25 if len(content) > 50 else 15 cutoff = 90 if len(content) > 1000 else 45 if len(content) > 200 else 25 if len(
content) > 50 else 15
cutoff += backoff cutoff += backoff
@@ -463,6 +486,7 @@ class ChatGPTTelegramBot:
else: else:
total_tokens = 0 total_tokens = 0
async def _reply(): async def _reply():
nonlocal total_tokens nonlocal total_tokens
response, total_tokens = await self.openai.get_chat_response(chat_id=chat_id, query=prompt) response, total_tokens = await self.openai.get_chat_response(chat_id=chat_id, query=prompt)
@@ -571,7 +595,10 @@ class ChatGPTTelegramBot:
if query: if query:
self.inline_queries_cache.pop(unique_id) self.inline_queries_cache.pop(unique_id)
else: else:
error_message = f'{localized_text("error", bot_language)}. {localized_text("try_again", bot_language)}' error_message = (
f'{localized_text("error", bot_language)}. '
f'{localized_text("try_again", bot_language)}'
)
await self.edit_message_with_retry(context, await self.edit_message_with_retry(context,
chat_id=None, chat_id=None,
message_id=inline_message_id, message_id=inline_message_id,
@@ -644,7 +671,8 @@ class ChatGPTTelegramBot:
logging.warning(str(e)) logging.warning(str(e))
raise e raise e
async def wrap_with_indicator(self, update: Update, context: CallbackContext, chat_action: constants.ChatAction, coroutine): async def wrap_with_indicator(self, update: Update, context: CallbackContext, chat_action: constants.ChatAction,
coroutine):
""" """
Wraps a coroutine while repeatedly sending a chat action to the user. Wraps a coroutine while repeatedly sending a chat action to the user.
""" """
@@ -829,7 +857,8 @@ class ChatGPTTelegramBot:
return remaining_budget > 0 return remaining_budget > 0
async def check_allowed_and_within_budget(self, update: Update, context: ContextTypes.DEFAULT_TYPE, is_inline=False) -> bool: async def check_allowed_and_within_budget(self, update: Update, context: ContextTypes.DEFAULT_TYPE,
is_inline=False) -> bool:
""" """
Checks if the user is allowed to use the bot and if they are within their budget Checks if the user is allowed to use the bot and if they are within their budget
:param update: Telegram update object :param update: Telegram update object

13
bot/usage_tracker.py
View File

@@ -3,10 +3,12 @@ import pathlib
import json import json
from datetime import date from datetime import date
def year_month(date): def year_month(date):
# extract string of year-month from date, eg: '2023-03' # extract string of year-month from date, eg: '2023-03'
return str(date)[:7] return str(date)[:7]
class UsageTracker: class UsageTracker:
""" """
UsageTracker class UsageTracker class
@@ -75,7 +77,8 @@ class UsageTracker:
last_update = date.fromisoformat(self.usage["current_cost"]["last_update"]) last_update = date.fromisoformat(self.usage["current_cost"]["last_update"])
token_cost = round(tokens * tokens_price / 1000, 6) token_cost = round(tokens * tokens_price / 1000, 6)
# add to all_time cost, initialize with calculation of total_cost if key doesn't exist # add to all_time cost, initialize with calculation of total_cost if key doesn't exist
self.usage["current_cost"]["all_time"] = self.usage["current_cost"].get("all_time", self.initialize_all_time_cost()) + token_cost self.usage["current_cost"]["all_time"] = \
self.usage["current_cost"].get("all_time", self.initialize_all_time_cost()) + token_cost
# add current cost, update new day # add current cost, update new day
if today == last_update: if today == last_update:
self.usage["current_cost"]["day"] += token_cost self.usage["current_cost"]["day"] += token_cost
@@ -132,7 +135,8 @@ class UsageTracker:
today = date.today() today = date.today()
last_update = date.fromisoformat(self.usage["current_cost"]["last_update"]) last_update = date.fromisoformat(self.usage["current_cost"]["last_update"])
# add to all_time cost, initialize with calculation of total_cost if key doesn't exist # add to all_time cost, initialize with calculation of total_cost if key doesn't exist
self.usage["current_cost"]["all_time"] = self.usage["current_cost"].get("all_time", self.initialize_all_time_cost()) + image_cost self.usage["current_cost"]["all_time"] = \
self.usage["current_cost"].get("all_time", self.initialize_all_time_cost()) + image_cost
# add current cost, update new day # add current cost, update new day
if today == last_update: if today == last_update:
self.usage["current_cost"]["day"] += image_cost self.usage["current_cost"]["day"] += image_cost
@@ -163,7 +167,7 @@ class UsageTracker:
:return: total number of images requested per day and per month :return: total number of images requested per day and per month
""" """
today=date.today() today = date.today()
if str(today) in self.usage["usage_history"]["number_images"]: if str(today) in self.usage["usage_history"]["number_images"]:
usage_day = sum(self.usage["usage_history"]["number_images"][str(today)]) usage_day = sum(self.usage["usage_history"]["number_images"][str(today)])
else: else:
@@ -186,7 +190,8 @@ class UsageTracker:
last_update = date.fromisoformat(self.usage["current_cost"]["last_update"]) last_update = date.fromisoformat(self.usage["current_cost"]["last_update"])
transcription_price = round(seconds * minute_price / 60, 2) transcription_price = round(seconds * minute_price / 60, 2)
# add to all_time cost, initialize with calculation of total_cost if key doesn't exist # add to all_time cost, initialize with calculation of total_cost if key doesn't exist
self.usage["current_cost"]["all_time"] = self.usage["current_cost"].get("all_time", self.initialize_all_time_cost()) + transcription_price self.usage["current_cost"]["all_time"] = \
self.usage["current_cost"].get("all_time", self.initialize_all_time_cost()) + transcription_price
# add current cost, update new day # add current cost, update new day
if today == last_update: if today == last_update:
self.usage["current_cost"]["day"] += transcription_price self.usage["current_cost"]["day"] += transcription_price