Back to Zvec

README

README.md

0.3.26.5 KB
Original Source
<p align="right"> English | <a href="./README_CN.md">中文</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/en/docs/db/quickstart/">🚀 <strong>Quickstart</strong> </a> | <a href="https://zvec.org/en/">🏠 <strong>Home</strong> </a> | <a href="https://zvec.org/en/docs/db/">📚 <strong>Docs</strong> </a> | <a href="https://zvec.org/en/docs/db/benchmarks/">📊 <strong>Benchmarks</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 is an open-source, in-process vector database — lightweight, lightning-fast, and designed to embed directly into applications. Battle-tested within Alibaba Group, it delivers production-grade, low-latency and scalable similarity search with minimal setup.

[!Important] 🚀 v0.3.1 (Apr 17, 2026)

  • Relaxed collection path restrictions and improved Windows path handling.

🚀 v0.3.0 (April 3, 2026)

  • New Platforms: Initial Windows (MSVC) and Android support. Published official Windows Python and Node.js packages.
  • Efficiency: RabitQ quantization and CPU Auto-Dispatch for optimized SIMD execution.
  • Ecosystem: C-API for custom language bindings and MCP / Skill integration for AI Agents.

👉 Read the Release Notes | View Roadmap 📍

💫 Features

  • Blazing Fast: Searches billions of vectors in milliseconds.
  • Simple, Just Works: Install and start searching in seconds. Pure local, no servers, no config, no fuss.
  • Dense + Sparse Vectors: Work with both dense and sparse embeddings, with native support for multi-vector queries in a single call.
  • Hybrid Search: Combine semantic similarity with structured filters for precise results.
  • Durable Storage: Write-ahead logging (WAL) guarantees persistence — data is never lost, even on process crash or power failure.
  • Concurrent Access: Multiple processes can read the same collection simultaneously; writes are single-process exclusive.
  • Runs Anywhere: As an in-process library, Zvec runs wherever your code runs — notebooks, servers, CLI tools, or even edge devices.

📦 Installation

Python

Requirements: Python 3.10 - 3.14

bash
pip install zvec

Node.js

bash
npm install @zvec/zvec

✅ Supported Platforms

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

🛠️ Building from Source

If you prefer to build Zvec from source, please check the Building from Source guide.

⚡ One-Minute Example

python
import zvec

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

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

# Insert 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]}),
])

# Search by vector similarity
results = collection.query(
    zvec.VectorQuery("embedding", vector=[0.4, 0.3, 0.3, 0.1]),
    topk=10
)

# Results: list of {'id': str, 'score': float, ...}, sorted by relevance
print(results)

📈 Performance at Scale

Zvec delivers exceptional speed and efficiency, making it ideal for demanding production workloads.

For detailed benchmark methodology, configurations, and complete results, please see our Benchmarks documentation.

🤝 Join Our Community

<div align="center"> <div align="center">
💬 DingTalk📱 WeChat🎮 DiscordX (Twitter)
Scan to joinScan to joinClick to joinClick to follow
</div> </div>

❤️ Contributing

We welcome and appreciate contributions from the community! Whether you're fixing a bug, adding a feature, or improving documentation, your help makes Zvec better for everyone.

Check out our Contributing Guide to get started!