ContextQMD
Back to Zvec

README CN

README_CN.md

0.3.26.2 KB
Original Source
<p align="right"> <a href="./README.md">English</a> | 中文 </p> <div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://zvec.oss-cn-hongkong.aliyuncs.com/logo/github_log_2.svg" /> </picture> </div> <p align="center"> <a href="https://codecov.io/github/alibaba/zvec"></a> <a href="https://github.com/alibaba/zvec/actions/workflows/01-ci-pipeline.yml"></a> <a href="https://github.com/alibaba/zvec/blob/main/LICENSE"></a> <a href="https://pypi.org/project/zvec/"></a> <a href="https://pypi.org/project/zvec/"></a> <a href="https://www.npmjs.com/package/@zvec/zvec"></a> </p> <p align="center"> <a href="https://trendshift.io/repositories/20830" target="_blank"></a> </p> <p align="center"> <a href="https://zvec.org/zh/docs/db/quickstart/">🚀 <strong>快速开始</strong> </a> | <a href="https://zvec.org/zh/">🏠 <strong>主页</strong> </a> | <a href="https://zvec.org/zh/docs/db/">📚 <strong>文档</strong> </a> | <a href="https://zvec.org/zh/docs/db/benchmarks/">📊 <strong>性能报告</strong> </a> | <a href="https://deepwiki.com/alibaba/zvec">🔎 <strong>DeepWiki</strong> </a> | <a href="https://discord.gg/rKddFBBu9z">🎮 <strong>Discord</strong> </a> | <a href="https://x.com/ZvecAI">🐦 <strong>X (Twitter)</strong> </a> </p>

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

[!IMPORTANT] 🚀 v0.3.1 （2026 年 4 月 17 日）

  • 放宽 Collection 路径限制；改进 Windows 上的路径处理。

🚀 v0.3.0 （2026 年 4 月 3 日）

  • 新平台支持：支持 Windows (MSVC) 和 Android。发布了官方 Windows Python 和 Node.js 安装包。
  • 性能优化：集成 RabitQ 量化以及 CPU 指令集自适应检测，优化 SIMD 执行。
  • 生态集成：提供 C-API 用于多种编程语言绑定，以及 MCP / Skill 集成。

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

💫 核心特性

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

📦 安装

Python

环境要求：Python 3.10 - 3.14

bash
pip install zvec

Node.js

bash
npm install @zvec/zvec

✅ 支持的平台

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

🛠️ 源码构建

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

⚡ 一分钟上手

python
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)

📈 极致性能

Zvec 提供极致的速度和效率，能够轻松应对高要求的生产环境负载。

有关具体的测试方法、配置及完整结果，请参阅性能报告。

🤝 加入社区

<div align="center">
💬 钉钉群📱 微信群🎮 DiscordX (Twitter)
扫码加入扫码加入点击加入点击关注
</div>

❤️ 参与贡献

非常欢迎来自社区的每一份贡献！无论是修复 Bug、新增功能，还是完善文档，都将让 Zvec 变得更好。

请查阅我们的贡献指南开始参与！