chat_with_your_docs

標題	表情符號	顏色	科洛特	SDK	sdk_version	app_file	固定	執照
與您的文檔聊天		藍色的	灰色的	Gradio	4.41.0	app.py	錯誤的	麻省理工學院

與您的文檔聊天

介紹

---

ChatWithYourDocs聊天應用程序是一個Python應用程序，可讓您與PDF，網頁和YouTube視頻等多個文檔格式聊天。您可以使用自然語言詢問有關PDF的問題，並且該應用程序將根據文檔的內容提供相關的答复。該應用程序利用語言模型為查詢生成準確的答案。請注意，該應用只會回答與已加載文檔有關的問題。

它如何工作

---

該應用程序遵循以下步驟，以提供對您的問題的回答：

1. DOC加載：該應用程序讀取多種DOC類型並提取其文本內容。

2. 文本塊：提取的文本分為可以有效處理的較小塊。

3. 語言模型：該應用程序利用語言模型來生成文本塊的向量表示（嵌入）。

4. 相似性匹配：當您提出一個問題時，該應用程序將其與文本塊進行比較，並標識最相似的文本。

5. 響應生成：所選塊傳遞給語言模型，該模型基於文檔的相關內容生成響應。

依賴項和安裝

---

要使用您的文檔應用程序安裝聊天，請按照以下步驟操作：

1. 下載Ollama圖書館

    curl https://ollama.ai/install.sh | sh
   

2. 拉我們將使用的聊天模型，在這種情況下，我們將使用Llama2，Mistral和Gemma

    ollama pull llama2
   

    ollama pull mistral
   

    ollama pull gemma
   

3. 使用Python 3.9創建新環境並激活它，在這種情況下，我們將使用Conda

    conda create -n cwd python=3.9
   

    conda activate cwd
   

4. 將存儲庫克隆到您的本地計算機。

    git clone https://github.com/jorge-armando-navarro-flores/chat_with_your_docs.git
   

    cd chat_with_your_docs
   

5. 通過運行以下命令來安裝所需的依賴項：

    pip install -r requirements.txt
   

6. 為YouTube視頻安裝FFMPEG：

    sudo apt-get install ffmpeg
   

用法

---

要使用與文檔應用程序的聊天，請按照以下步驟：

1. 使用簡化的CLI運行main.py文件。執行以下命令：

    python3 main.py
   

2. 該應用程序將在您的默認Web瀏覽器中啟動，以顯示用戶界面。

建築學

課程：

• LLM：此抽像類是不同LLM實現的藍圖。它具有諸如OllamaModel ， OpenAIModel和HFModel之類的子類，可處理特定的LLM提供商（Ollama，Openai和Hugging Face）。
• 文檔：此類管理文檔從PDF，網頁和YouTube視頻等各種來源加載。
• 矢量站：此類使用LLM嵌入式創建文檔的向量表示，以有效檢索。
• 鏈：此類定義了聊天機器人的處理管道。它可以是一個簡單的鏈，用於基本問題回答或根據對話歷史記錄搜索文檔的檢索鏈。
• 聊天機器人：此類處理用戶互動，維護對話歷史記錄，並調用適當的鏈方法來生成響應。
• ChatBotController：此類是用戶的主要接口。它允許設置LLM模型，文檔源和檢索選項。它還處理用戶查詢並與聊天機器人實例進行交互。

功能：

1. 設定:

   • 用戶從下拉菜單中選擇LLM提供商（Ollama，OpenAI或HuggingFace）和型號。可選地，某些提供商可能需要一個API密鑰。
   • 用戶可以選擇用於檢索任務的文檔（PDF，網頁URL或YouTube視頻URL）。

2. 加工：

   • 根據所選的LLM和文檔（如果有），控制器配置了處理鏈。
   • 一個簡單的鏈條用於基本問題回答，而無需檢索文件。
   • 檢索鏈涉及：
     • 使用LLM的嵌入來創建文檔的向量表示。
     • 定義提示根據對話歷史記錄生成搜索查詢。
     • 根據生成的查詢檢索相關文檔。
     • 使用檢索的文檔回答用戶的問題。

3. 相互作用：

   • 用戶在聊天界面中鍵入他們的問題。
   • 控制器調用聊天機器人的predict方法，傳遞用戶的查詢和對話歷史記錄（如果啟用了檢索）。
   • 聊天機器人根據所選鏈配置檢索適當的響應。

其他功能：

• 該界麵包含“撤消”和“清晰”對話歷史記錄的按鈕。

總體而言，此代碼為聊天機器人展示了一個結構良好的體系結構，該體系結構可以利用不同的LLMS並結合文檔檢索以提高功能。