Ed Tech Company QA Assistant

Ed-Tech Company QA Assistant

이 프로젝트는 Ed-Tech 회사를 위해 설계된 QA (질문 응답) 어시스턴트입니다. 벡터 데이터베이스, 최신 언어 모델 및 사용자 정의 문서 임베드를 활용하여 사전 정의 된 지식 기반을 기반으로 사용자 쿼리에 대한 정확한 응답을 제공합니다.

목차

• 특징
• 설치
• 용법
• 프로젝트 구조
• 향후 향상
• 기여
• 특허

특징

• Vector Database : 지식 기반의 효율적인 유사성 검색을 위해 FAISS를 사용합니다.
• 사용자 정의 임베딩 : 문장 변환기/All-Minilm-L6-V2 모델을 사용하여 Huggingfaceembeddings로 구동.
• 대형 언어 모델 (LLM) : 컨텍스트 인식 응답을 생성하기 위해 Groq의 LLAMA3 모델 (LLAMA3-8B-8192)을 통합합니다.
• CSV 로더 : CSV 파일의 FAQ 또는 기타 구조화 된 데이터를로드하여 지식 기반을 채 웁니다.
• 간소화 인터페이스 : 질문을하고 답변을 받기위한 간단하고 대화식 UI.

설치

1. 저장소 복제 :

 git clone https : // github . com / shaadclt / Ed - Tech - Company - QA - Assistant . git
cd Ed - Tech - Company - QA - Assistant

2. 가상 환경 설정 :

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

3. 종속성 설치 :

 pip install - r requirements . txt

4. 환경 변수 : 프로젝트 루트에서 .env 파일을 만들고 Groq API 키를 추가하십시오.

 GROQ_API_KEY = your_groq_api_key_here 

용법

1. Streamlit 앱을 실행하십시오

 streamlit run main . py

2. 지식 기반 만들기 : CSV 파일에서 지식 기반을 만들려면 버튼을 클릭하십시오.

3. 질문하십시오 : 간소 한 인터페이스에 질문을 입력하면 조수는로드 된 지식 기반에 따라 상황에 맞는 정확한 응답을 제공합니다.

프로젝트 구조

• langchain_helper.py : 데이터로드, 벡터 데이터베이스 생성 및 응답 생성에 대한 논리가 포함되어 있습니다.
• main.py : 간소화 된 응용 프로그램 파일.
• FAQS.CSV : 지식 기반을 채우는 데 사용되는 샘플 CSV 파일.
• 요구 사항 .txt : 필요한 모든 Python 패키지를 나열합니다.
• .ENV : API 키와 같은 환경 변수를 저장합니다 (보안상의 이유로 저장소에 포함되지 않음).

향후 향상

• 지식 기반 확장 : 더 많은 문서 나 데이터 소스를 추가하십시오.
• 미세 조정 모델 :보다 정확한 응답을 위해 임베딩 또는 LLM을 조정하십시오.
• Advanced UI : 응답 필터링 또는 피드백 메커니즘과 같은 추가 기능을 사용하여 유선형 인터페이스를 향상시킵니다.

기여

이 저장소를 자유롭게 포크하고 기능 분기를 만들고 개선 사항 또는 버그 수정에 대한 풀 요청을 제출하십시오.

특허

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