CollegeChatbot

대학 Q & A 챗봇

이 프로젝트는 대형 언어 모델 (LLMS), 텍스트-예정된 생성 (RAG) 및 신속한 엔지니어링 기술의 조합을 사용하여 GAT (Global Academy of Technology) 와 관련된 질문에 답변하도록 설계된 Q & A 챗봇입니다. 챗봇은 텍스트 및 오디오 입력을 모두 처리하여 대화 기록 및 사전로드 된 문서를 기반으로 관련 답변을 제공 할 수 있습니다.

특징

• 텍스트 및 오디오 입력 : 텍스트 입력 또는 음성 녹음을 통해 사용자 쿼리를 허용합니다.
• RAG (Reviewal-Augmented Generation) : 사전로드 된 문서에서 검색된 관련 정보를 사용하여 응답을 향상시킵니다.
• 맥락 인식 응답 : 대화 기록을 활용하여 일관되고 문맥 적으로 적절한 답변을 제공합니다.
• 간소화 인터페이스 : 후속 모드 및 검색 깊이 사용자 정의를위한 옵션을 갖춘 간소로 구축 된 사용자 친화적 인 인터페이스.

설치

1. 저장소를 복제하십시오

   git clone https://github.com/mahadev0811/CollegeChatbot.git
   cd CollegeChatbot

2. 가상 환경을 만듭니다

   python -m venv venv
   source venv/bin/activate   # On Windows use `venvScriptsactivate`

3. 종속성을 설치하십시오

   pip install -r requirements.txt

4. API 키를 구성합니다

   • Google API 키를 사용하여 루트 디렉토리에서 config.json 파일을 만듭니다.

   {
     "google_api_key" : " YOUR_GOOGLE_API_KEY "
   }

용법

1. 응용 프로그램을 실행하십시오

   streamlit run st_app.py

2. 챗봇과 상호 작용하십시오

   • 텍스트 입력 상자 또는 오디오 레코더를 사용하여 쿼리를 제출하십시오.
   • 사이드 바 옵션을 사용하여 설정을 조정하십시오.
     • 후속 질문 모드 : 응답을 위해 대화 기록을 사용하도록 전환합니다.
     • 검색 깊이 : 관련 정보에 대한 문서에서 검색 할 단락 수를 조정하십시오.

프로젝트 구조

• st_app.py : 메인 응용 프로그램 스크립트.
• embedding_generator.py : 데이터 파일에서 임베딩을 생성하기위한 스크립트.
• Webscrapper.ipynb : URL에서 텍스트 데이터를 긁어 내기위한 Jupyter 노트북으로 원시 데이터 파일을 생성합니다.
• config.json : API 키의 구성 파일.
• 요구 사항 .txt : 필요한 파이썬 패키지 목록.
• data_generation/gat_raw.txt : GAT에 대한 정보가 포함 된 원시 스크랩 된 데이터.
• data_generation/gat_refined.txt : 원시 데이터의 인간 감독 및 편집 버전.
• gat_embeddings.pkl : 사전로드 된 문서의 사전 계산 내장.

데이터 생성

초기 원시 데이터 파일 ( gat_raw.txt )을 생성하려면 webscrapper.ipynb 노트북을 사용하십시오. 이 노트북은 주어진 URL에서 텍스트 내용을 긁어 내고 적절하게 형식을 형식화합니다.

임베딩 생성

데이터 파일에서 임베딩을 생성하려면 embedding_generator.py 스크립트를 사용하십시오. 이 스크립트는 데이터가 포함 된 텍스트 파일을 읽고, 플래그 딩 모델을 사용하여 임베딩을 생성하며, 임베딩을 피클 파일로 저장합니다.

임베딩 생성기 실행

데이터 파일을 준비하십시오

• 데이터 파일 (예 : data_generation/gat_refined.txt)이 올바른 형식인지 확인하십시오. 단락은 이중 최신 라인 ( n n)으로 구분됩니다.

스크립트를 실행하십시오

• 인수로 데이터 파일의 경로를 사용하여 indedding_generator.py 스크립트를 실행하십시오.

  python embedding_generator.py --data_file data_generation/gat_refined.txt

• 스크립트는 데이터 파일의 단락에 대한 임베딩을 생성하고 피클 파일 ( gat_embeddings.pkl )으로 저장합니다.

스크린 샷

• 이 비디오는 챗봇이 작동하여 GAT에 대한 질문에 대답합니다.

기록 .mp4

크레딧

• FLAGEMBEDDING : 인코딩 쿼리에 사용되는 사용자 정의 임베딩 모델.
• 간소 : ML 및 데이터 과학 프로젝트를위한 오픈 소스 앱 프레임 워크.
• 포옹 페이스 트랜스포머 : 최신 NLP 모델을위한 라이브러리.
• Google Cloud Speech-to-Text API : 음성을 텍스트로 변환하기위한 서비스.
• Google 생성 AI : 응답 생성에 사용됩니다.

특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 라이센스 파일을 참조하십시오.