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许可证获得许可的。