evrz hackathon

Telegram Review Bot

Bot telegram Python yang memproses file arsip, mengekstrak struktur proyek, kode parses, dan menghasilkan laporan ulasan berdasarkan basis pengetahuan yang disediakan.

Fitur

• Dukungan File: Menerima berbagai format file.
• Dukungan Arsip: Menerima format arsip RAR, ZIP, dan 7Z.
• Tinjauan Pratinjau: Mengirim pratinjau paginated dari hasil ulasan.
• Ulasan Unduh: Menyediakan tombol untuk mengunduh laporan ulasan lengkap sebagai file PDF.
• Rag: Menggunakan kain untuk memberikan konteks untuk model.
• LLM Kecil: Menggunakan Model Mistral-Nemo 12B untuk memberikan tinjauan komprehensif yang membutuhkan kurang dari 20GB VRAM.

Pengaturan

Prasyarat

• Python 3.11+
• Puisi untuk manajemen ketergantungan. Instal dari situs resmi puisi
• Server minio dengan catatan DNS untuk URL yang telah ditetapkan sebelumnya (kredensial akan disediakan secara terpisah)
• Ketergantungan Sistem :
  • Untuk ekstraksi rar, pastikan unrar diinstal pada sistem Anda:
    • Ubuntu: sudo apt-get install unrar
    • MacOS (dengan Homebrew): brew install unrar
    • Windows: Tidak didukung karena kurangnya perpustakaan yang didukung.

Catatan Penting untuk Pengembangan Lokal

Jika menjalankan bot secara lokal (Docker luar), Anda harus menangani pemasangan pytorch secara terpisah:

• Baik run: pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• Atau melepaskan ketergantungan torch di pyproject.toml dan mencoba menginstalnya, tetapi mungkin gagal .

Instalasi

1. Klon Repositori

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

2. Konfigurasi Variabel Lingkungan Buat file .env dengan variabel yang diperlukan berikut:

    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
   

   Catatan: Kredensial minio akan disediakan melalui Dokumen Manajer dan Cloud Drive.

3. Pilih Metode Instalasi Anda

   Docker (disarankan) :

   docker-compose up -d

   Ini akan memulai wadah Bot dan Minio Server.

   Instalasi lokal :

   poetry install
   poetry run telegram-review-bot

Penggunaan

1. Mulai bot

   Buka telegram dan cari bot Anda. Mulailah percakapan dengan mengirim /start .

2. 2.1 Kirim file

   Kirim file ke bot.

   2.2 Kirim arsip

   Atau Anda dapat mengirim file arsip (rar, zip, 7z) ke bot.

3. Menerima output

   • Tinjauan Pratinjau: Bot akan membalas dengan pratinjau paginated dari hasil ulasan.
   • Ulasan Unduh: Gunakan tombol yang disediakan untuk mengunduh laporan ulasan lengkap sebagai file PDF.

Tinjau pipa

1. Rag : Buat database vektor dari basis pengetahuan untuk menyelaraskan potongan kode dengan contoh ulasan yang relevan.
2. Tinjauan :
   • Struktur Proyek Parse
   • Menganalisis struktur masing -masing file.
   • Bagilah file menjadi potongan yang dapat dikelola.
   • Gunakan RAG untuk menghasilkan petunjuk dan informasi kontekstual untuk model.
   • Menghasilkan dan memformat ulasan

Struktur Paket

• src/bot - Kode Bot Telegram.
• src/review - Logika tinjauan kode.
• • src/review/parsers - Logika Chunking Kode

Berkontribusi

Kontribusi dipersilakan! Harap buka masalah atau kirimkan permintaan tarik untuk perbaikan atau perbaikan bug.

Lisensi

Mit