CollegeChatbot

大学问答聊天机器人

该项目是一个问答聊天机器人，旨在通过大型语言模型（LLMS），文本插件，检索提升生成（RAG）和及时的工程技术的组合来回答与全球技术学院（GAT）有关的问题。聊天机器人可以同时处理文本和音频输入，从而根据对话历史记录和预加载文档提供相关答案。

特征

• 文本和音频输入：通过文本输入或语音记录接受用户查询。
• 检索授权生成（RAG） ：使用预装文件中检索的相关信息增强响应。
• 上下文感知的响应：利用对话历史提供连贯且上下文适当的答案。
• 简化界面：使用流线构建的用户友好界面，采用可用于后续模式和搜索深度自定义的选项。

安装

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 ：所需的Python软件包列表。
• 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）隔开。

运行脚本

• 将embedding_generator.py脚本运行，并带有数据文件的路径作为参数：

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

• 该脚本将生成数据文件中这些段落的嵌入，并将其保存为泡菜文件（ gat_embeddings.pkl ）。

屏幕截图

• 该视频显示了聊天机器人的行动，回答了有关GAT的问题：

recordings.mp4

学分

• FlageMbedding：用于编码查询的自定义嵌入模型。
• 简化：用于ML和数据科学项目的开源应用程序框架。
• 拥抱面孔变压器：最先进的NLP模型的库。
• Google云语音到文本API：用于将语音转换为文本的服务。
• Google Generative AI：用于生成响应。

执照

该项目是根据MIT许可证获得许可的 - 有关详细信息，请参见许可证文件。