evrz hackathon

電報レビューボット

アーカイブファイルを処理し、プロジェクト構造を抽出し、コードを解析し、提供された知識ベースに基づいてレビューレポートを生成するPython電報ボット。

特徴

• ファイルサポート：さまざまなファイル形式を受け入れます。
• アーカイブサポート： RAR、ZIP、および7Zアーカイブ形式を受け入れます。
• レビュープレビュー：レビュー結果のPaginated Previewを送信します。
• レビューダウンロード： PDFファイルとして完全なレビューレポートをダウンロードするボタンを提供します。
• RAG： RAGを使用して、モデルのコンテキストを提供します。
• Small LLM： Mistral-Nemo 12Bモデルを使用して、20GB未満のVRAMを必要とする包括的なレビューを提供します。

設定

前提条件

• Python 3.11+
• 依存関係管理のための詩。詩の公式サイトからインストールします
• 事前に割り当てられたURLのDNSレコードを備えたMINIOサーバー（資格情報は個別に提供されます）
• システムの依存関係：
  • RAR抽出の場合、システムにunrarがインストールされていることを確認してください。
    • ubuntu： sudo apt-get install unrar
    • MacOS（HomeBrewを使用）： brew install unrar
    • Windows：サポートされているライブラリが不足しているため、サポートされていません。

ローカル開発のための重要な注意

ボットをローカルに（Dockerの外側）実行する場合は、Pytorchのインストールを個別に処理する必要があります。

• どちらかの実行： pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• または、 pyproject.tomlのtorchの依存関係を除外して、インストールしようとしますが、失敗する可能性があります。

インストール

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資格情報は、マネージャーおよびクラウドドライブドキュメントを介して提供されます。

3. インストール方法を選択してください

   Docker（推奨） ：

   docker-compose up -d

   これにより、ボットサーバーコンテナとミニオサーバーコンテナの両方が開始されます。

   ローカルインストール：

   poetry install
   poetry run telegram-review-bot

使用法

1. ボットを開始します

   電報を開けてボットを検索します。送信/startから会話を開始します。

2. 2.1ファイルを送信します

   ボットにファイルを送信します。

   2.2アーカイブを送信します

   または、アーカイブファイル（RAR、zip、7z）をボットに送信することもできます。

3. 出力を受信します

   • レビュープレビュー：ボットは、レビュー結果のパジネートプレビューで返信します。
   • レビューダウンロード：提供されたボタンを使用して、完全なレビューレポートをPDFファイルとしてダウンロードします。

パイプラインを確認します

1. RAG ：知識ベースからベクトルデータベースを作成して、コードチャンクを関連するレビューの例に合わせます。
2. レビュー：
   • プロジェクト構造を解析します
   • 個々のファイルの構造を分析します。
   • ファイルを管理可能なチャンクに分割します。
   • RAGを使用して、モデルのプロンプトとコンテキスト情報を生成します。
   • レビューを生成してフォーマットします

パッケージ構造

• src/bot - 電報ボットコード。
• src/review - コードレビューロジック。
• • src/review/parsers -Code Chunking Logic

貢献

貢献は大歓迎です！問題を開くか、改善またはバグ修正のためのプルリクエストを送信してください。

ライセンス

mit