vector-admin

项目介绍：VectorAdmin

背景介绍

VectorAdmin 是一个通用的用户界面和工具套件，旨在大规模管理向量数据库。通过提供直观和高效的界面，VectorAdmin 旨在简化用户对向量数据的管理，避免繁琐的 API 调用，让用户轻松掌握其 Pinecone 或 Chroma 向量数据库中的信息。

项目定位

作为全球最强大的向量数据库管理图形用户界面（GUI），VectorAdmin 提供了全面的控制，帮助用户管理易于处理却常常棘手的向量数据。这款产品支持多用户，可以在本地通过 Docker 运行，也可以远程托管，同时管理多个向量数据库。

核心功能

• 多用户实例支持与监督：支持多用户同时处理不同的数据库实例。
• 文本嵌入的增删改查：可以对嵌入的文本数据进行原子级别的查看、更新和删除。
• 无重复嵌入的复制功能：可以复制整个文档或命名空间而无需重新嵌入。
• 新文档上传与嵌入：直接将新文档上传并嵌入至向量数据库中。
• 数据库迁移：迁移整个向量数据库至另一种类型或实例（功能开发中）。
• 并发数据库管理：同时管理多个正在运行的向量数据库。
• 数据权限管理：控制数据的访问权限。
• 云部署就绪：完全支持云端部署。
• 自动化回归测试：在命名空间或集合更新文档时进行测试，确保响应质量（开发中）。
• 广泛的 API 和工具集成：支持 API、JavaScript 和 Python 独立客户端以及 LangChain 集成（开发中）。
• 高效的成本节约措施：有效管理大型文档或转录，不会重复支付嵌入费用。

技术概览

VectorAdmin 项目分为几个主要部分：

• document-processor：一个 Flask 应用，用于轻松解析和嵌入文档。
• frontend：基于 viteJS 和 React 的前端，用于创作和管理内容。
• backend：基于 nodeJS 和 express 的后端，负责向量数据库的所有交互。
• workers：InngestJS 实例，用于处理长时间运行的后台任务。
• docker：可以通过单个命令运行整个架构，推荐使用此方法。

启动指南

Docker 简单设置

通过 Docker 可以在几分钟内完成设置。

开发环境设置

不支持 Windows 环境，需要在项目根目录执行以下步骤：

1. yarn dev:setup 初始化项目。
2. 切换到 document-processor 目录并设置 Python 虚拟环境：

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

在两个不同的终端窗口中，从项目根目录执行以下命令：

• yarn prisma:setup 来创建数据库迁移和客户端，然后运行 yarn dev:server
• yarn dev:frontend
• yarn dev:workers
• 切换到 document-processor 并运行 flask 服务器：

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

首次启动并访问主页时，会自动重定向以创建管理员帐户、组织和数据库连接。

贡献指南

1. 创建问题（issue）。
2. 按 <issue number>-<short name> 格式创建分支并提交 PR。
3. 合并代码。

遥测功能

VectorAdmin 包含一个遥测功能，用于收集匿名使用信息，以帮助优化产品性能和稳定性。用户可以通过在 server 或 docker 的 .env 文件中设置 DISABLE_TELEMETRY="true" 来选择退出。

以上是 VectorAdmin 的主要内容介绍。这个工具如您所见，提供了一整套丰富的功能和灵活的管理能力，让用户轻松管理复杂的向量数据。