Zvec Logo

Quickstart

Want to explore the code examples interactively? Check out our Jupyter Notebook walkthrough that demonstrates Zvec in action — including a hands-on multi-modal image search example.

Install the Library

Install the library
pip install zvec

Create a Collection

A collection stores your documents. Each document contains scalar fields and vector embeddings.

First, define a schema — then create a collection:

Add Documents

Insert documents with scalar fields and vector embeddings:

Optimize a Collection

Optimize a collection to improve performance:

Retrieve a Document by ID

Fetch a document directly by its id:

Search with Vectors

Use query() to find documents most similar to a given vector embedding:

Results are ranked by similarity score.

Combine vector search with conditional filters:

Only matching documents are considered during search.

View Collection Info

View the collection's schema:

View the collection's statistics:

Remove a Document

Remove a document by its ID:

Remove documents by filter condition:


✨ You're all set to store, retrieve, and search vector data with Zvec!

💙 Thank you for your interest in Zvec! We hope you enjoy exploring what Zvec can do!