文档聊天机器人：GPT × Pinecone × LangChain

功能特性

• 创建多个主题进行对话
• 为每个主题存储任意数量的文件
• 为每个主题创建任意数量的聊天窗口
• 在浏览器内直接上传文件、将其转换为嵌入向量、将向量存储到命名空间并上传至 Pinecone，以及删除 Pinecone 命名空间
• 使用本地存储自动保存并检索所有聊天记录
• 支持 .pdf、.docx 和 .txt 格式

+ LangChain 和 Pinecone

注意：如果您希望使用 Google 身份验证和 MongoDB 来部署（而不是无身份验证和本地存储），请查看此分支：mongodb-and-auth。不过，该仓库比本仓库落后几个重要提交，并且缺少某些功能，请您知悉。

主聊天区域

---

设置页面

---

本地搭建与开发

如果您想在本地运行并部署自己的版本，请按照以下步骤操作。

克隆仓库

git clone https://github.com/dissorial/doc-chatbot.git

---

Pinecone 设置

API 密钥

在 Pinecone 上创建一个账户。进入 Indexes 并点击 Create index。输入任意名称，将 Dimensions 设置为 1536，其余保持默认。然后转到 API keys 并创建 API 密钥。

索引名称

顾名思义

Pinecone 环境

就在您的索引名称旁边，例如 us-west2-rkw。

---

安装依赖包

yarn install

---

配置 .env 文件

• 将 .env.example 重命名为 .env
• 您的 .env 文件应如下所示：

NODE_ENV=development

Node 环境

• 默认为开发环境。在生产环境中，请将其设置为 'production'（不带引号）。

其他

• 在 utils/makechain.ts 中，根据您的实际用例调整 QA_PROMPT。如果拥有 GPT-4 的访问权限，请将 new OpenAI 中的 modelName 更改为 gpt-4。

---

部署

在您的 .env 文件中添加以下内容：

NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=
JWT_SECRET=

NextAuth Secret

• 您可以通过在 Git Bash 中运行 openssl rand -base64 32 来生成。

JWT Secret

• 同样可以通过在 Git Bash 中运行 openssl rand -base64 32 来生成。

NextAuth URL

• 默认值为 http://localhost:3000。在生产环境中，应设置为您已部署应用的 URL。

---

运行应用

npm run dev

---

故障排除

一般错误

• 确保您使用的是最新版本的 Node.js。可通过运行 node -v 来检查版本。
• 如果遇到特定文件的问题，可以先尝试将其转换为文本格式，或更换其他文件。可能是文件损坏、扫描件，或者需要 OCR 技术才能转换为文本。
• 请确认您使用的 LangChain 和 Pinecone 版本与本仓库一致。

Pinecone 错误

• 确认您已将向量维度设置为 1536。
• 请注意，Pinecone Starter（免费）计划的用户索引在 7 天无活动后会被删除。为避免这种情况，请在 7 天前向 Pinecone 发送 API 请求以重置计数器。
• 如果问题仍然存在，建议从头开始，创建一个新的 Pinecone 项目、索引，并克隆新的仓库。

---

致谢

本仓库最初是基于 mayooear 的 GPT-4 & LangChain 仓库的分支，但在本仓库中经历了许多重大改动。

本项目的前端设计灵感来源于 ChatGPT。

doc-chatbot 快速上手指南

doc-chatbot 是一个基于 GPT、Pinecone 和 LangChain 的开源文档聊天机器人。它允许你创建多个主题，上传 PDF、DOCX 或 TXT 文件，并在浏览器中直接与这些文档内容进行对话。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• Node.js: 建议安装最新稳定版 (LTS)。可通过 node -v 检查版本。
• 包管理器: 推荐使用 yarn (项目原生支持) 或 npm。
• Pinecone 账号: 需要注册 Pinecone 账号以获取向量数据库服务。
• OpenAI API Key: 需要有效的 OpenAI API 密钥。

安装步骤

1. 克隆项目

git clone https://github.com/dissorial/doc-chatbot.git
cd doc-chatbot

2. 安装依赖

推荐使用 yarn 进行安装：

yarn install

(若使用 npm，可运行 npm install)

3. 配置 Pinecone

1. 登录 Pinecone 控制台，进入 Indexes 页面并点击 Create index。
2. Index Name: 自定义名称（后续需填入配置文件）。
3. Dimensions: 必须设置为 1536。
4. 其余选项保持默认，创建完成后进入 API Keys 页面生成新的 API Key。
5. 记录你的 Environment 名称（位于 Index 名称旁边，例如 us-west2-rkw）。

4. 配置环境变量

1. 将示例配置文件重命名为 .env：

   mv .env.example .env
   

2. 编辑 .env 文件，填入以下关键信息（参考原文结构补充缺失的关键 Key）：

   NODE_ENV=development
   
   # OpenAI 配置
   OPENAI_API_KEY=你的_OpenAI_API_Key
   
   # Pinecone 配置
   PINECONE_API_KEY=你的_Pinecone_API_Key
   PINECONE_ENVIRONMENT=你的_Pinecone_环境名 (如 us-west2-rkw)
   PINECONE_INDEX_NAME=你的_Index_名称
   
   # 认证相关 (本地开发可生成随机字符串)
   NEXTAUTH_URL=http://localhost:3000
   NEXTAUTH_SECRET=运行_openssl_rand_-base64_32_生成的字符串
   JWT_SECRET=运行_openssl_rand_-base64_32_生成的字符串
   

   提示: 生成秘密密钥的方法：在终端运行 openssl rand -base64 32。

5. (可选) 自定义模型与提示词

如果需要更改默认行为，可编辑 utils/makechain.ts 文件：

• 修改 QA_PROMPT 以适应特定场景。
• 若有 GPT-4 权限，可将 modelName 改为 gpt-4。

基本使用

启动应用

在终端运行以下命令启动开发服务器：

npm run dev

(如果你使用的是 yarn，也可以运行 yarn dev)

操作流程

1. 访问界面: 打开浏览器访问 http://localhost:3000。
2. 创建主题: 在侧边栏或主界面创建一个新话题（Topic）。
3. 上传文档: 在该话题下上传 .pdf, .docx 或 .txt 文件。
   • 系统会自动将文件转换为向量嵌入 (Embeddings) 并存储到 Pinecone 命名空间中。
4. 开始对话: 文件处理完成后，直接在聊天窗口提问。系统将基于你上传的文档内容回答，并自动在本地存储中保存聊天记录。
5. 多窗口管理: 你可以为同一个话题创建多个独立的聊天窗口，互不干扰。