How zvec-ai/zvec-studio works
Zvec Studio is a visual management application for the embedded Zvec vector database. The main user workflow is to create or open a collection, define its schema, insert or import documents, and browse or search its data; AI functions enable text-based embedding and reranking. The frontend calls a FastAPI backend, which routes collection, document, and search operations to Zvec storage. Snapshot import/export and persistent AI and recent-collection configuration are additional capabilities. Edges reflect README statements and indexed source references; unsampled wiring is left unasserted.
Main entry points: main.py FastAPI app · collections.py Collection operations · documents.py Document operations · api-client.ts API client
Components 22
Studio interface
- Frontend app
apps/frontend/src/App.tsx - Feature routes
apps/frontend/src/router/routes.tsx - Collection workspace
apps/frontend/src/pages/collections/QueryTab.tsx - AI functions UI
apps/frontend/src/pages/ai/AiFunctionsPage.tsx - API client
apps/frontend/src/lib/api-client.ts
Backend API
- API schemas
apps/backend/zvec_studio/schemas/collection.py - FastAPI app
apps/backend/zvec_studio/main.py - Collection operations
apps/backend/zvec_studio/routers/collections.py - Document operations
apps/backend/zvec_studio/routers/documents.py - Search operations
apps/backend/zvec_studio/routers/searches.py - Filesystem access
apps/backend/zvec_studio/routers/fs.py
Collection storage
- Zvec backend
apps/backend/zvec_studio/storage/sdk.py - Snapshot exchange
apps/backend/zvec_studio/storage/snapshot.py - Document formats
apps/backend/zvec_studio/storage/formats.py - Recent collections
apps/backend/zvec_studio/config_store.py
AI extensions
- AI runtime
apps/backend/zvec_studio/ai_service.py - AI function registry
apps/backend/zvec_studio/ai_store.py
Application runtime
- Desktop shell
apps/desktop/src-tauri/src/lib.rs - Backend sidecar
apps/desktop/src-tauri/src/sidecar.rs - Request middleware
apps/backend/zvec_studio/middleware/logging.py
Other components
- Studio user
- Zvec SDK
Connections 24
- Studio user → Frontend app: uses
README.md - Studio user → Desktop shell: runs
README.md - Desktop shell → Backend sidecar: manages
apps/desktop/src-tauri/src/lib.rs - Frontend app → Feature routes: renders
apps/frontend/src/App.tsx - Frontend app → API client: configures
apps/frontend/src/App.tsx - Collection workspace → API client: requests data
- AI functions UI → API client: requests AI
- API client → FastAPI app: sends requests
- FastAPI app → Collection operations: registers routes
apps/backend/zvec_studio/main.py - FastAPI app → Document operations: registers routes
apps/backend/zvec_studio/main.py - FastAPI app → Search operations: registers routes
apps/backend/zvec_studio/main.py - FastAPI app → Filesystem access: registers routes
apps/backend/zvec_studio/main.py - FastAPI app → Request middleware: configures
apps/backend/zvec_studio/main.py - Collection operations → Zvec backend: manages collections
apps/backend/zvec_studio/routers/collections.py - Collection operations → Recent collections: updates recents
apps/backend/zvec_studio/routers/collections.py - Collection operations → Snapshot exchange: exchanges snapshots
apps/backend/zvec_studio/routers/collections.py - Collection operations → Document formats: uses formats
apps/backend/zvec_studio/routers/collections.py - Document operations → Zvec backend: operates on data
apps/backend/zvec_studio/routers/documents.py - Document operations → Document formats: imports documents
apps/backend/zvec_studio/routers/documents.py - Document operations → Snapshot exchange: exchanges snapshots
apps/backend/zvec_studio/routers/documents.py - Search operations → Zvec backend: queries collections
apps/backend/zvec_studio/routers/searches.py - Search operations → AI runtime: embeds or reranks
apps/backend/zvec_studio/routers/searches.py - AI runtime → AI function registry: loads functions
apps/backend/zvec_studio/ai_service.py - Zvec backend → Zvec SDK: persists collections
apps/backend/zvec_studio/storage/sdk.py