Skip to main content

English | 中文

Zvec Studio

Visual management tool for the Zvec embedded vector database
Browse data, test queries, and manage schemas — without writing code.

License Version Platforms CI

Zvec Studio guided tour


📦 Installation

Option 1: pip (recommended for developers)

Requires Python 3.10 – 3.14.

pip install zvec-studio
zvec-studio

Opens http://127.0.0.1:7860 in your browser.

Need embedding & reranking? Install with the [ai] extra to enable built-in embedding & reranking functions:

pip install zvec-studio[ai]

Option 2: Desktop download (experimental)

Grab the installer for your platform from GitHub Releases:

Platform Architectures Installer
macOS Apple Silicon (arm64) .dmg
Linux x86_64, arm64 .deb / .AppImage
Windows x86_64 .msi / .exe

Double-click to run — no Python needed.

Option 3: From source

git clone https://github.com/zvec-ai/zvec-studio.git
cd zvec-studio
make install    # install Node deps + backend uv environment
make dev        # starts backend + frontend dev servers

Need embedding & reranking? make install does NOT install AI runtime dependencies (sentence-transformers, dashscope, etc.) to keep CI fast. Run make install.ai instead if you want to use built-in functions like local-dense, bm25, or dashscope.

Prerequisites: Node.js ≥ 20, pnpm ≥ 9, Python ≥ 3.10, uv, Rust (desktop only). See Contributing for the full dev setup guide.

⚡ Quick Start

  1. Create a collection — Collections → Create. Define vector and scalar fields.
  2. Insert data — Paste JSON documents in the Write tab.
  3. Vector search — Paste a query vector in the Query tab, set TopK, hit Search.
  4. AI search — Register an embedding model, then search by typing text directly.

Full walkthrough → Getting Started

📖 Documentation

Getting Started 10-minute walkthrough from install to first search
Architecture Request flow, module map, code index
API Reference REST endpoints, request/response formats, error codes
Testing Test strategy, self-verification loop, performance baselines
Packaging PyInstaller + Tauri cross-platform packaging
Contributing Dev setup, code style, commit workflow

🗺️ Roadmap

Version Focus
v0.1.x (current) Collection CRUD, schema evolution, document ops, vector search, AI extension, i18n, desktop app
v0.2.x Data import/export, virtual scrolling, batch operations, advanced search
v0.3.x Vector visualization (UMAP/t-SNE), clustering, AI Agent, SDK code generation
v0.4.x VS Code extension, API Playground, webhooks & notifications

🤝 Contributing

Contributions welcome! See CONTRIBUTING.md for details.

make dev        # Start dev servers
make verify     # Lint + typecheck + tests

📄 License

Apache License 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zvec_studio-0.1.14-py3-none-any.whl (259.5 kB view details)

Uploaded Python 3

File details

Details for the file zvec_studio-0.1.14-py3-none-any.whl.

File metadata

  • Download URL: zvec_studio-0.1.14-py3-none-any.whl
  • Upload date:
  • Size: 259.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.10.20

File hashes

Hashes for zvec_studio-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 bdd1cda152134db3e41cadcb2d49e0fe93070b3cc9060af5678d745c8c02dd2e
MD5 7f866c9ebf01b8cafe1c3759ad0d08eb
BLAKE2b-256 9082a66e9611993e706537b23debe42642c2caba7dd90cceb036cd4043770a64

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.15

1 file

This release

0.1.14 This release

1 file

0.1.12

1 file

0.1.11

1 file

0.1.10

1 file

0.1.9

1 file

0.1.8

1 file

0.1.4

1 file

0.1.3

1 file

0.1.2

1 file

0.1.1

1 file

0.1.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page