[!IMPORTANT] 本仓库和项目已不再由 Mintplex Labs 积极维护。我们希望有一天能够壮大团队，重新为该项目提供专门的支持与更新。

新的 issue 和 PR 可能 会被评审，但我们的主要重心已转向 AnythingLLM。该应用仍然可以自行部署，并且在大多数提供商上按原样运行，不过这些提供商的任何更改都可能导致兼容性问题。

我们不会归档或删除此仓库，以便将来某天能够再次回到它。 此致， Tim。

用于大规模管理向量数据库的通用 UI 和工具套件。

|

用于大规模管理向量数据库的通用 UI 和工具套件。

| PostHog——一个开源的遥测数据收集平台。

VectorAdmin 快速上手指南

⚠️ 重要提示：本项目目前由 Mintplex Labs 暂停主动维护，团队重心已转移至 AnythingLLM。虽然项目仍可自托管并适用于大多数提供商，但上游提供商的变更可能导致部分功能失效。本项目未被归档，未来可能会恢复更新。

VectorAdmin 是一套用于大规模管理向量数据库的通用 UI 和工具套件。它允许你直观地查看、更新、删除嵌入文本块，迁移数据，并管理多个向量数据库实例（支持 Pinecone 和 ChromaDB）。

环境准备

在开始之前，请确保你的系统满足以下要求：

系统要求

• 操作系统：Linux 或 macOS（开发模式暂不支持 Windows）
• Node.js & Yarn：需安装 node 和 yarn
• Python：版本需为 3.9+（用于文档处理模块）

前置依赖与账号

• OpenAI API Key：如果你计划更新嵌入或上传新文档，必须拥有有效的 OpenAI API 密钥。
• 向量数据库：
  • Pinecone.io 免费账号，或
  • 本地运行的 ChromaDB 实例。

安装步骤

推荐初学者使用 Docker 方式部署，这是最简单且跨平台兼容的方案。若需进行二次开发，可选择“开发环境部署”。

方案一：Docker 部署（推荐）

这是最快捷的启动方式，只需一条命令即可运行整个架构。

1. 克隆项目并进入 docker 目录（具体细节请参考项目内 docker/DOCKER.md 文档）。
2. 配置 .env 文件（填入 OpenAI Key 和数据库凭证）。
3. 启动容器：

   docker compose up -d
   

4. 访问浏览器打开默认端口（通常为 http://localhost:3000），首次访问将引导你创建管理员账号和组织。

方案二：开发环境部署

注意：以下命令在 Windows 上无法直接运行，建议使用 WSL2 或 Linux/macOS 环境。

1. 初始化项目依赖 在项目根目录执行：

   yarn dev:setup
   

2. 配置 Python 虚拟环境 进入文档处理器目录并安装依赖：

   cd document-processor && python3.9 -m virtual-env v-env && source v-env/bin/activate && pip install -r requirements.txt
   

3. 启动服务 你需要打开四个独立的终端窗口，分别从项目根目录执行以下命令：

   终端 1 (后端服务器):

   yarn prisma:setup
   yarn dev:server
   

   终端 2 (前端界面):

   yarn dev:frontend
   

   终端 3 (后台任务工人):

   yarn dev:workers
   

   终端 4 (文档处理器):

   cd document-processor && flask run --host '0.0.0.0' --port 8888
   

4. 初始化配置 启动完成后，在浏览器访问前端地址。系统将自动重定向至设置页面，请按指引创建主管理员账户、组织信息以及向量数据库连接配置。

基本使用

启动成功后，你将进入 VectorAdmin 的管理控制台。以下是核心操作流程：

1. 连接数据库 在初始化向导或设置页面中，输入你的 Pinecone API Key/Index 名称，或 ChromaDB 的连接地址，完成数据库绑定。

2. 上传与嵌入文档

   • 点击"Upload"或类似功能按钮。
   • 选择本地文档（支持多种格式）。
   • 系统会自动调用 OpenAI 进行分块（Chunking）和嵌入（Embedding），并存入向量数据库。
   • 优势：VectorAdmin 会缓存处理结果，避免对大文档重复付费嵌入。

3. 管理向量数据

   • 原子化操作：你可以直接浏览数据库中的单个文本块（Text Chunks），对其进行查看、编辑或删除，无需通过代码调用 API。
   • 数据迁移：支持将整个命名空间（Namespace）或集合（Collection）的数据复制到另一个数据库实例，无需重新计算嵌入向量。
   • 多库管理：可在同一界面切换和管理多个不同的向量数据库实例。

4. 权限与监控

   • 创建多用户账户并分配数据访问权限。
   • 查看系统运行状态及嵌入质量回归测试报告（如已启用）。

关闭遥测：如果你希望禁用匿名使用情况收集，请在服务器或 Docker 的 .env 文件中设置：

DISABLE_TELEMETRY="true"