zvec/README_CN.md at a9008b0fd27d8a4608cb25e2be1ef7272be22dfd

6.2 KiB

Raw Blame History

Zvec 是一款开源的嵌入式(进程内)向量数据库 — 轻量、极速，可直接嵌入应用程序。以极简的配置提供生产级、低延迟、可扩展的向量检索能力。

[!IMPORTANT] 🚀 v0.4.0（2026 年 5 月 9 日）

Dart/Flutter SDK：发布官方 zvec Flutter 包，提供 Dart/Flutter FFI 绑定，支持 Android（arm64-v8a）和 iOS（arm64），无需手动编译原生库。

iOS 构建支持：新增 iOS 平台构建支持，进一步扩展跨平台覆盖范围。

扩大 topK 上限：放宽 topK 结果数量上限，支持更大规模的召回场景。

修复：SQ8 量化器召回率下降问题；Windows 路径处理修复；稀疏向量索引顺序修复。

👉 查看更新日志 | 查看路线图 📍

💫 核心特性

极致性能：毫秒级响应，轻松检索数十亿级向量。
开箱即用：安装后即刻开始搜索，纯本地运行，无需服务器、无需配置、零门槛。
稠密 + 稀疏向量：支持稠密向量和稀疏向量，提供多向量联合查询的原生支持。
混合检索：向量语义搜索 + 标量条件过滤，获得精确结果。
持久化存储：WAL 预写日志保障数据持久性 — 即使进程崩溃或意外断电，数据也不会丢失。
并发访问：支持多进程同时读取同一个 Collection；写入为单进程独占模式。
进程内运行：无需单独部署服务，纯进程内运行。Notebook、高性能服务器、CLI 工具、边缘设备 — 随处可用。

📦 安装

Python

环境要求：Python 3.10 - 3.14

pip install zvec

Node.js

npm install @zvec/zvec

✅ 支持的平台

Linux (x86_64, ARM64)
macOS (ARM64)
Windows (x86_64)

🛠️ 源码构建

如需从源码构建 Zvec，请参考源码构建指南。

⚡ 一分钟上手

import zvec

# 定义 collection schema
schema = zvec.CollectionSchema(
    name="example",
    vectors=zvec.VectorSchema("embedding", zvec.DataType.VECTOR_FP32, 4),
)

# 创建 collection
collection = zvec.create_and_open(path="./zvec_example", schema=schema)

# 插入 documents
collection.insert([
    zvec.Doc(id="doc_1", vectors={"embedding": [0.1, 0.2, 0.3, 0.4]}),
    zvec.Doc(id="doc_2", vectors={"embedding": [0.2, 0.3, 0.4, 0.1]}),
])

# 向量相似度检索
results = collection.query(
    zvec.VectorQuery("embedding", vector=[0.4, 0.3, 0.3, 0.1]),
    topk=10
)

# 查询结果：按相关性排序的 {'id': str, 'score': float, ...} 列表
print(results)