Ed Tech Company QA Assistant

ED-Tech Company QA助理

該項目是為ED-Tech公司設計的QA（提問）助理。它利用矢量數據庫，最先進的語言模型和自定義文檔嵌入方式，以基於預定義的知識庫對用戶查詢提供準確的響應。

目錄

• 特徵
• 安裝
• 用法
• 項目結構
• 未來的增強
• 貢獻
• 執照

特徵

• 向量數據庫：利用Faiss在整個知識庫中進行有效的相似性搜索。
• 自定義嵌入式：使用句子轉換器/全米尼-L6-V2型號由擁抱面式的嵌入式。
• 大型語言模型（LLM） ：集成了Groq的Llama3模型（Llama3-8B-8192），以生成上下文感知的響應。
• CSV加載程序：從CSV文件加載常見問題解答或其他結構化數據以填充知識庫。
• 簡化接口：一個簡單且交互式的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. 環境變量：在項目root中創建.ENV文件，並添加您的GROQ API密鑰：

 GROQ_API_KEY = your_groq_api_key_here 

用法

1. 運行簡化應用程序

 streamlit run main . py

2. 創建知識庫：要從CSV文件創建知識庫，請單擊“按鈕創建知識庫”

3. 提出問題：在簡化接口中輸入問題，助手將根據加載的知識庫提供上下文準確的回答。

項目結構

• langchain_helper.py ：包含用於加載數據，創建向量數據庫和生成響應的邏輯。
• main.py ：簡化應用程序文件。
• FAQS.CSV ：用於填充知識庫的示例CSV文件。
• 需求.txt ：列出所有必需的Python軟件包。
• .ENV ：存儲像API鍵之類的環境變量（出於安全原因，存儲庫中未包含）。

未來的增強

• 擴展知識庫：添加更多文檔或數據源。
• 微調模型：調整嵌入式或LLM以獲得更準確的響應。
• 高級UI：通過其他功能（例如響應過濾或反饋機制）改進流線接口。

貢獻

隨意訂購此存儲庫，創建功能分支，並提交任何增強功能或錯誤修復的拉請請求。

執照

該項目已根據MIT許可獲得許可。有關詳細信息，請參見許可證文件。