Merge branch 'main' of https://github.com/bucolucas/cyclop

telegram_inference_bot.py

@@ -1,3 +1,15 @@
+"""
+telegram_inference_bot.py
+
+This module implements a Telegram bot that processes user messages and
+images, interacts with the OpenAI API to provide intelligent responses,
+and manages conversation history and temporary file storage for images.
+
+It supports the following commands:
+- /start: Initializes the bot and welcomes the user.
+- /clear: Clears the user's conversation history and any uploaded images.
+"""
+
 import json
 import os
 import importlib
@@ -62,10 +74,25 @@ for tool in tools:
     functions.extend(tool.get_functions())
 
 async def start(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+    """
+    Handles the /start command. Sends a welcome message to the user.
+    
+    Args:
+        update (Update): Incoming update containing the message.
+        context (ContextTypes.DEFAULT_TYPE): Context for the callback.
+    """
     logging.info("Bot started")
     await update.message.reply_text("Hello! I'm your AI assistant. How can I help you today? You can send me images and then ask questions about them.")
 
 async def clear(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+    """
+    Handles the /clear command. Clears the user's conversation history
+    and any uploaded images.
+
+    Args:
+        update (Update): Incoming update containing the message.
+        context (ContextTypes.DEFAULT_TYPE): Context for the callback.
+    """
     user_id = update.effective_user.id
     if user_id in conversation_history:
         del conversation_history[user_id]
@@ -76,6 +103,14 @@ async def clear(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
     await update.message.reply_text("Conversation history and image cleared. Let's start fresh!")
 
 async def handle_image(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+    """
+    Handles image uploads from users. Downloads the largest photo to 
+    a temporary file for further processing.
+
+    Args:
+        update (Update): Incoming update containing the image.
+        context (ContextTypes.DEFAULT_TYPE): Context for the callback.
+    """
     user_id = update.effective_user.id
     
     # Get the largest available photo
@@ -93,6 +128,14 @@ async def handle_image(update: Update, context: ContextTypes.DEFAULT_TYPE) -> No
     await update.message.reply_text("I've received your image. What would you like to know about it?")
 
 async def handle_message(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+    """
+    Processes incoming text messages from users, calls the OpenAI API 
+    for inference, and sends the assistant's reply back to the user.
+
+    Args:
+        update (Update): Incoming update containing the text message.
+        context (ContextTypes.DEFAULT_TYPE): Context for the callback.
+    """
     try:
         user_id = update.effective_user.id
         user_message = update.message.text