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许可获得许可。有关详细信息，请参见许可证文件。