chatpdflike

chatpdflike

使用大語言模型API的端到端文檔提問應用程序。

注意：此項目與CHATPDF隸屬或認可。這是一個獨立的項目，試圖複製類似的功能。

概述

類似CHATPDF的Web應用程序是一個Web應用程序，允許用戶使用自然語言查詢上傳PDF文檔並與它們進行交互。該應用程序利用OpenAI的GPT-3.5 Turbo等大型語言模型（LLM）來了解PDF的內容，並為用戶問題提供簡潔明了的答案。

特徵

• PDF文檔上傳：上傳本地PDF文件或向PDF文檔提供URL。
• 自然語言互動：在自然語言中詢問有關PDF內容的問題。
• 相關答案：根據文檔的內容接收簡潔的答案。
• 來源參考：查看來源（PDF的部分）用於生成答案。
• 多個LLM提供商：對OpenAI和Ollama車型的支持。
• Web界面：使用燒瓶和JavaScript構建的簡單和直觀的Web界面。

它如何工作

該應用程序遵循以下主要步驟：

1. 文本提取和處理：

   • 使用PyPDF2解析PDF。
   • 文本是從每個頁面中提取的，大量文本被分為可管理的塊。

2. 嵌入一​​代：

   • 對於每個文本塊，使用選定的嵌入模型（例如OpenAI的text-embedding-ada-002 ）生成嵌入向量。
   • 這些嵌入代表文本塊的語義含義，並存儲以進行相似性計算。

3. 用戶查詢處理：

   • 當用戶提出問題時，使用相同的嵌入模型生成了查詢的嵌入向量。

4. 相似性搜索：

   • 該應用程序計算查詢嵌入與文本塊嵌入之間的餘弦相似性。
   • 最相關的文本塊是根據最高相似性分數選擇的。

5. 及時施工：

   • 為語言模型創建了一個提示，並結合了用戶的問題和最相關的文本塊。

6. 答案生成：

   • 提示發送到語言模型（例如OpenAI的GPT-3.5 Turbo）。
   • 該模型基於提供的上下文生成了用戶問題的答案。

7. 響應顯示：

   • 答案顯示給Web界面中的用戶。
   • 還提供了對源文本塊的引用，以供透明度。

入門

先決條件

• Python ：需要3.6版或更高版本。
• API鍵：
  • OpenAI API密鑰：需要使用OpenAI的型號進行嵌入和答案。
  • Ollama API鍵：可選。如果您想使用Ollama型號，則需要。

安裝

1. 克隆存儲庫

   git clone https://github.com/Ulov888/chatpdflike.git
   cd chatpdflike

2. 安裝依賴項

   使用pip安裝所需的軟件包：

   pip install -r requirements.txt

API鍵

使用Openai的API：

1. 在Openai註冊API鍵。

2. 設置OPENAI_API_KEY環境變量：

    export OPENAI_API_KEY= " your_openai_api_key "

使用Ollama的API（如果需要）：

1. 從Ollama獲取API鍵。

2. 設置OLLAMA_API_KEY環境變量：

    export OLLAMA_API_KEY= " your_ollama_api_key " 

用法

1. 啟動應用程序

   運行燒瓶應用程序：

   python run.py

   默認情況下，服務器在http://0.0.0.0:8080上運行。

2. 訪問Web界面

   打開Web瀏覽器並導航到http://localhost:8080 。

3. 上傳PDF文檔

   您可以：

   • 單擊“上傳PDF”以從計算機中選擇和上傳PDF文件。
   • 輸入PDF文檔的URL，然後單擊“提交”。

4. 與PDF互動

   • 處理PDF後，您可以使用屏幕右側的聊天接口詢問有關其內容的問題。
   • 在輸入框中輸入您的問題，然後按“發送”。

5. 查看答案

   • 該應用程序的回復將出現在您的問題下。
   • 為上下文提供了源參考（例如，頁碼和摘錄）。

定制

迅速的策略

可以通過修改generate_embedding.py中的提示策略，特別是在Chatbot機器人類的create_prompt方法中來定制語言模型的行為。

策略包括：

• 論文：總結科學論文。
• 手冊：總結財務手冊（中文答案）。
• 合同：了解合同（中文答案）。
• 默認值：通用策略（中文的答案）。

要選擇策略，您可以在調用create_prompt時修改strategy參數。

語言和輸出

目前，該應用程序配置為為某些策略提供中文的答案。您可以修改提示以更改語言或調整模型的行為。

限制

• OpenAI API成本：使用OpenAI的API將根據使用而產生成本。確保監視您的API使用情況，以避免出現意外費用。
• PDF解析：應用程序使用PyPDF2 ，可能無法完美處理所有PDF。具有異常格式的複雜PDF可能無法正確解析。
• 嵌入限制：嵌入的最大令牌極限可能限製文本塊的大小或提示的最大長度。
• 模型響應：答案的質量和準確性取決於語言模型的性能以及檢索到的文本塊的相關性。

貢獻

歡迎捐款！如果您有任何建議或改進，請隨時提交問題或提取請求。

執照

該項目是根據Apache許可證獲得許可的。