chatpdf-gpt

ChatPDF-GPT 项目介绍

ChatPDF-GPT 是一个创新项目，利用 LangChain 框架的强大功能，结合 OpenAI 的语言模型，为 PDF 文档打造了一个互动聊天界面。该项目的核心在于，将语言模型与其他数据源连接，允许用户与环境进行互动，从而体现了 LangChain 框架的核心理念。

主要功能

1. 上传 PDF 文档：用户可以上传 PDF 文档，系统会将其存储在 Pinecone 向量数据库和 Supabase 存储中。

2. 与 PDF 聊天：应用程序会处理 PDF 的内容，并允许用户使用 OpenAI API 与文档进行交流，让用户与内容进行有意义的对话。

3. PDF 预览：用户可以使用强大的 React 组件包 @react-pdf-viewer 预览正在交互的 PDF 文档。

4. PDF 文档列表：应用程序提供了一个列表，列出所有存储在 Supabase 数据库中的上传 PDF 文档。

5. 删除 PDF 文档：用户可以从数据库中删除不需要的文档。

6. 引用来源：AI 聊天界面在每次回复时提供 PDF 的引用来源，便于用户直接导航到 PDF 中的对应参考位置。

使用示例

ChatPDF-GPT 提供了多个使用示例，帮助用户理解其操作：

• 使用 Pinecone 进行互动，如保存嵌入向量、删除记录等。
• 上传文件到 Supabase 存储或删除文件。
• 列出现有的 Supabase 数据库文档。
• 使用 @react-pdf-viewer 预览 PDF。
• 在 PDF 中直接导航到 AI 回复的来源。

快速测试

若要使用该项目的演示功能进行快速测试，用户需要自行提供 OpenAI、Supabase 和 Pinecone 的凭据。以下是设置 Supabase 所需的步骤指南：

OpenAI 凭据

用户可以参考 OpenAI 的官方文档获取凭据。

Supabase 凭据

1. 在 Supabase 创建新项目：浏览器访问 Supabase，然后创建新项目。
2. 获取数据库连接 URL：在项目页面中，在设置栏获取数据库连接字符串。
3. 获取连接池连接字符串：同样在设置栏获取连接池连接字符串。
4. 检索存储密钥：在设置栏的 API 选项中找到 SUPABASE_URL 和 SUPABASE_KEY。
5. 设置 Supabase 存储桶：在项目页面的存储部分创建新存储桶。
6. 在应用程序中设置环境变量：添加所需的 Supabase 变量到应用程序的环境配置中。

对于 Pinecone 的设置，用户可以参考其官方文档进行配置。

安装和设置

用户可以通过以下步骤在本地机器上安装和运行 ChatPDF-GPT：

1. 克隆项目源码：

   git clone https://github.com/anis-marrouchi/chatpdf-gpt.git
   

2. 进入项目目录并使用 pnpm 安装依赖：

   cd chatpdf-gpt
   pnpm install
   

3. 创建 .env 文件并填入 OpenAI、Pinecone 和 Supabase 的相关凭据。
4. 使用 Prisma 创建数据库架构：

   npx prisma migrate dev --name init
   

5. 启动服务器：

   npm run dev
   

贡献

ChatPDF-GPT 是一个开源项目，欢迎社区贡献者共同参与。贡献者可以参考我们的贡献指南，详细了解如何开始。

感谢

这个项目得以实现，离不开开源社区提供的大量库、框架和工具。特别感谢 LangChain、OpenAI、Supabase、Pinecone、Next.js、Vercel、shadcn、Radix UI 和 @react-pdf-viewer 等平台的支持。

许可证

ChatPDF-GPT 是基于 MIT 许可证的开放源代码软件，欢迎任何人使用和贡献。