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許可證獲得許可的 - 有關詳細信息，請參見許可證文件。