evrz hackathon

Telegram Review Bot

아카이브 파일을 처리하고, 프로젝트 구조를 추출하고, 코드를 구문 분석하고, 제공된 지식 기반을 기반으로 검토 보고서를 생성하는 Python Telegram Bot.

특징

• 파일 지원 : 다양한 파일 형식을 수락합니다.
• 아카이브 지원 : RAR, Zip 및 7Z 아카이브 형식을 허용합니다.
• 검토 미리보기 : 검토 결과의 페이지 진화민 미리보기를 보냅니다.
• 검토 다운로드 : 전체 검토 보고서를 PDF 파일로 다운로드 할 수있는 버튼을 제공합니다.
• RAG : RAG를 사용하여 모델의 컨텍스트를 제공합니다.
• Small LLM : 20GB 미만의 VRAM이 필요한 포괄적 인 검토를 제공하기 위해 Mistral-Nemo 12B 모델을 사용합니다.

설정

전제 조건

• 파이썬 3.11+
• 의존성 관리를위한 시 . 시의 공식 사이트에서 설치하십시오
• 미리 할당 된 URL에 대한 DNS 레코드가 장착 된 Minio Server (자격 증명은 별도로 제공됩니다)
• 시스템 종속성 :
  • RAR 추출을 위해 unrar 시스템에 설치되어 있는지 확인하십시오.
    • 우분투 : 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
• 또는 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 자격 증명은 관리자 및 Cloud Drive 문서를 통해 제공됩니다.

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 - Telegram Bot Code.
• src/review - 코드 검토 논리.
• • src/review/parsers 코드 청킹 로직

기여

기부금을 환영합니다! 개선 또는 버그 수정에 대한 문제를 열거 나 풀 요청을 제출하십시오.

특허

MIT