Article Assistant (RAG Telegram Bot)

Contact: @Konstantin_vanov

A Telegram bot for Q&A about articles using Retrieval-Augmented Generation. Indexes web content and PDF files, then provides accurate answers with sources.

Examples

📖 Table of Contents

• Features
• Quick Start
• Docker Deployment
• Traditional Installation
• Usage Examples
• Troubleshooting
• Contributing

🌟 Features

• Web Article Processing - Index content from URLs ✅
• YouTube Video Processing - Download and transcribe YouTube videos ✅
• Multilingual Support - English/Russian interfaces ✅
• Q&A System - Ask questions about indexed content ✅
• Text Summarization - Generate key points summaries ✅
• PDF File Support - Upload and process PDF documents ✅
• TXT File Support - Process text files directly ✅
• No Request Limits - Unlimited questions and processing ✅
• Custom Prompts - Adjust AI behavior and responses ✅

🚀 Quick Start

Prerequisites

• Python 3.9+ or Docker
• Telegram Bot Token
• OpenAI API Key

RAG System Workflow

🐳 Docker Deployment (Recommended)

The easiest way to deploy with all dependencies included:

Prerequisites

• Docker
• Docker Compose

Quick Start with Docker

# Clone the repository
git clone https://github.com/Konstantin-vanov-hub/Article-Assistant--RAG-Telegram-Bot.git
cd Article-Assistant--RAG-Telegram-Bot

# Configure environment variables
cp .env.example .env
# Edit .env with your Telegram Bot Token and OpenAI API Key
nano .env

# Build and start the containers
docker-compose up -d --build

# View logs to verify everything is working
docker-compose logs -f telegram-bot

Docker Commands

Command	Description
docker-compose up -d --build	Build and start in background
docker-compose down	Stop and remove containers
docker-compose logs -f telegram-bot	Follow bot logs
docker-compose restart telegram-bot	Restart only the bot

🔧 Traditional Installation (Without Docker)

Clone and Setup

git clone https://github.com/Konstantin-vanov-hub/Article-Assistant--RAG-Telegram-Bot
cd Article-Assistant--RAG-Telegram-Bot
python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows
pip install -r requirements.txt

Configuration

cp .env.example .env

Environment Variables

Create a .env file with:

TELEGRAM_TOKEN=your_telegram_bot_token_here
OPENAI_API_KEY=your_openai_api_key_here

Launch

python RAG_bot/bot_main.py

📱 Usage Examples

1. Upload a PDF: Send a PDF file to the bot
2. Process YouTube Videos: Enter a YouTube URL to download and transcribe
3. Ask questions: Type your question after indexing
4. Get summaries: Use the "Summary" button for key points
5. Change language: Use the language button to switch between English/Russian

YouTube Video Processing

The bot can now process YouTube videos! Here's how:

1. Click "📹 Process YouTube Video" in the main menu
2. Paste a YouTube video URL
3. The bot will:
   • Download the video audio
   • Transcribe it using OpenAI Whisper
   • Index the transcript for Q&A
4. Ask questions about the video content
5. Get summaries of the video

Supported formats: YouTube URLs (youtube.com, youtu.be) Limitations: Videos up to 2 hours maximum

🔧 Troubleshooting

Common Issues

• Bot not responding: Check if all environment variables are set correctly
• Indexing fails: Ensure OpenAI API key is valid and has sufficient credits
• File upload issues: Check file size limits (max 10MB for files)
• Vector store errors: Delete faiss_index folder and re-index your content
• YouTube processing fails:
  • Ensure video is not longer than 2 hours
  • Check if the YouTube URL is valid and accessible
  • Verify Whisper model is properly installed
  • Check available disk space for temporary files

Getting Help

• Check the logs: docker-compose logs -f telegram-bot
• Verify environment variables are loaded
• Ensure OpenAI API key has sufficient credits

🤝 Contributing

We love contributions! Please read our Contributing Guide to learn how you can help improve this project.

How to Contribute

1. Fork the repository
2. Create a feature branch (git checkout -b feature/improvement)
3. Commit your changes (git commit -am 'Add new feature')
4. Push to the branch (git push origin feature/improvement)
5. Open a Pull Request

📜 License

MIT License © 2025 Konstantin. See LICENSE file for details.

📬 Support

For assistance, please:

• Search existing issues
• Open a new issue with detailed information
• Contact @Konstantin_vanov on Telegram