evrz hackathon

Telegram Review Bot

Um bot do Python Telegram que processa arquivos de arquivos, extrai estruturas de projetos, analisa o código e gera relatório de revisão com base na base de conhecimento fornecida.

Características

• Suporte ao arquivo: aceita vários formatos de arquivo.
• Suporte ao arquivo: aceita formatos de arquivo rar, zip e 7z.
• Visualização de revisão: envia uma visualização paginada dos resultados da revisão.
• Download de revisão: fornece um botão para baixar o relatório de revisão completo como um arquivo PDF.
• Rag: usa o RAG para fornecer contexto para o modelo.
• Small LLM: usa o modelo Mistral-Nemo 12b para fornecer uma revisão abrangente que exige menos de 20 GB de VRAM.

Configurar

Pré -requisitos

• Python 3.11+
• Poesia para gerenciamento de dependência. Instale no site oficial da Poetry
• Servidor minio com registro DNS para URLs pré-atribuídos (as credenciais serão fornecidas separadamente)
• Dependências do sistema :
  • Para extração RAR, verifique se unrar está instalado em seu sistema:
    • Ubuntu: sudo apt-get install unrar
    • MacOS (com homebrew): brew install unrar
    • Windows: não é suportado devido à falta de bibliotecas suportadas.

Nota importante para o desenvolvimento local

Se estiver executando o bot localmente (fora do Docker), você precisará lidar com a instalação do Pytorch separadamente:

• RUN: pip install torch==2.1.2 --index-url https://download.pytorch.org/whl/cpu
• Ou descomamento A dependência torch no pyproject.toml e tente instalá -la, mas pode falhar .

Instalação

1. Clone o repositório

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

2. Configurar variáveis ​​de ambiente Crie um arquivo .env com as seguintes variáveis ​​necessárias:

    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
   

   NOTA: As credenciais Minio serão fornecidas via Manager e Cloud Drive Document.

3. Escolha o seu método de instalação

   Docker (recomendado) :

   docker-compose up -d

   Isso iniciará os contêineres de bot e minio.

   Instalação local :

   poetry install
   poetry run telegram-review-bot

Uso

1. Inicie o bot

   Telegrama aberto e procure seu bot. Inicie uma conversa enviando /start .

2. 2.1 Envie um arquivo

   Envie um arquivo para o bot.

   2.2 Envie um arquivo

   Ou você pode enviar um arquivo de arquivo (rar, zip, 7z) para o bot.

3. Receber saídas

   • Visualização de revisão: O bot responderá com a visualização paginada dos resultados da revisão.
   • Download da revisão: use o botão fornecido para baixar o relatório de revisão completo como um arquivo PDF.

Pipeline de revisão

1. RAG : Crie um banco de dados vetorial a partir da base de conhecimento para alinhar pedaços de código com exemplos de revisão relevantes.
2. Análise :
   • Estrutura do projeto de análise
   • Analisar a estrutura de arquivos individuais.
   • Divida os arquivos em pedaços gerenciáveis.
   • Use RAG para gerar prompts e informações contextuais para o modelo.
   • Gerar e formatar a revisão

Estrutura de pacotes

• src/bot - Código de Bot Telegram.
• src/review - Lógica de revisão de código.
• • src/review/parsers - Lógica de Chunking de Código

Contribuindo

As contribuições são bem -vindas! Abra um problema ou envie uma solicitação de tração para obter melhorias ou correções de bug.

Licença

Mit