evrz hackathon

Телеграмма обзор бот

Бот Python Telegram, который обрабатывает архивирующие файлы, извлекает структуры проекта, анализируется код и генерирует отчет об просмотре на основе предоставленной базы знаний.

Функции

• Поддержка файлов: принимает различные форматы файлов.
• Архивная поддержка: принимает форматы архива RAR, ZIP и 7Z.
• Предварительный просмотр обзора: отправляет предварительный просмотр результатов обзора.
• Просмотр Скачать: предоставляет кнопку для загрузки полного обзора отчета в качестве файла PDF.
• Рэг: использует тряпку, чтобы обеспечить контекст для модели.
• Small LLM: использует модель Mistral-Nemo 12B для проведения комплексного обзора, требующего менее 20 ГБ VRAM.

Настраивать

Предварительные условия

• Python 3.11+
• Поэзия для управления зависимостями. Установите с официального сайта поэзии
• Minio Server с DNS-записи для предварительно назначенных URL-адресов (учетные данные будут предоставлены отдельно)
• Системные зависимости :
  • Для извлечения RAR убедитесь, что unrar установлен в вашей системе:
    • Ubuntu: sudo apt-get install unrar
    • macOS (с домашним заводом): brew install unrar
    • Windows: не поддерживается из -за отсутствия поддерживаемых библиотек.

Важное примечание для местного развития

Если запустить бот локально (снаружи Docker), вам нужно обрабатывать установку Pytorch отдельно:

• Любого запуска: pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• Или расстроен зависимость torch в pyproject.toml и попытаться установить ее, но она может потерпеть неудачу .

Установка

1. Клонировать репозиторий

   git clone https://github.com/isofinly/telegram_review_bot.git
   cd telegram_review_bot

2. Настройка переменных среды Создайте файл .env со следующими необходимыми переменными:

    BOT_TOKEN=your_telegram_bot_token
   MINIO_ENDPOINT=your_minio_endpoint
   MINIO_ACCESS_KEY=your_minio_access_key
   MINIO_SECRET_KEY=your_minio_secret_key
   MINIO_SECURE=true_or_false
   MODEL_API_KEY=your_model_api_key
   

   Примечание: учетные данные Minio будут предоставлены с помощью документа Manager и Cloud Drive.

3. Выберите метод установки

   Docker (рекомендуется) :

   docker-compose up -d

   Это запустит контейнеры Bot и Minio Server.

   Местная установка :

   poetry install
   poetry run telegram-review-bot

Использование

1. Начать бот

   Откройте телеграмму и ищите своего бота. Начните разговор, отправив /start .

2. 2.1 Отправить файл

   Отправить файл боту.

   2.2 Отправить архив

   Или вы можете отправить архивный файл (rar, zip, 7z) боту.

3. Получить выходы

   • Предварительный просмотр обзора: Бот ответит с помощью лицензионного предварительного просмотра результатов обзора.
   • Просмотр Скачать: используйте предоставленную кнопку, чтобы загрузить отчет о полном обзоре в качестве файла PDF.

Обзор трубопровод

1. RAG : Создайте векторную базу данных из базы знаний, чтобы выравнивать куски кода с соответствующими примерами проверки.
2. Обзор :
   • Parse Project Structure
   • Проанализируйте структуру отдельных файлов.
   • Разделите файлы на управляемые куски.
   • Используйте RAG, чтобы сгенерировать подсказки и контекстную информацию для модели.
   • Генерировать и отформатировать обзор

Структура пакетов

• src/bot - Telegram Bot Code.
• src/review - логика обзора кода.
• • src/review/parsers - логика кода кода

Внося

Взносы приветствуются! Пожалуйста, откройте проблему или отправьте запрос на привлечение на любые улучшения или исправления ошибок.

Лицензия

Грань