zvec library

Dart SDK for Zvec — a lightweight, lightning-fast, in-process vector database by Alibaba.

import 'package:zvec/zvec.dart';

void main() {
  Zvec.initialize();

  final schema = CollectionSchema(name: 'demo', fields: [
    VectorSchema('embedding', 4, indexParams: HnswIndexParams()),
    FieldSchema(name: 'title', dataType: DataType.string),
  ]);

  final collection = Collection.createAndOpen('/tmp/demo', schema);
  // ... insert, query, fetch ...
  collection.close();

  Zvec.shutdown();
}

Classes

Collection
A vector collection in the Zvec database.
CollectionOptions
Options for opening or creating a collection.
CollectionSchema
Schema definition for a collection, containing one or more fields.
CollectionStats
Statistics for a collection.
ConfigData
Global configuration data for the Zvec library.
Doc
A document in a Zvec collection.
FieldSchema
Schema definition for a single field in a collection.
FlatIndexParams
Flat (brute-force) index parameters.
FlatQueryParams
Flat query parameters.
FtsIndexParams
FTS (Full-Text Search) index parameters.
FtsQuery
A full-text search (FTS) query payload.
FtsQueryParams
FTS query parameters.
GroupByVectorQuery
A grouped vector similarity query.
HnswIndexParams
HNSW index parameters.
HnswQueryParams
HNSW query parameters.
IndexParams
Base class for index parameters.
InvertIndexParams
Inverted index parameters (for scalar fields).
IVFIndexParams
IVF index parameters.
IVFQueryParams
IVF query parameters.
LogConfig
Log configuration for the Zvec library.
MultiQuery
A multi-query that combines multiple sub-queries with reranking.
QueryParams
Base class for query-time parameters.
RerankStrategy
Rerank strategy for multi-query result fusion.
RrfRerank
Reciprocal Rank Fusion (RRF) rerank strategy.
SubQuery
A sub-query component for MultiQuery.
VectorQuery
A vector similarity query.
VectorSchema
Convenience class for creating vector field schemas.
WeightedRerank
Weighted score fusion rerank strategy.
WriteResult
Result of a batch write operation (insert/update/upsert/delete).
WriteStatus
Per-input status returned by detailed batch write operations.
Zvec
Top-level Zvec library lifecycle management.

Enums

DataType
Column/field data types — mirrors zvec_data_type_t constants in C API.
IndexType
Index algorithm types — mirrors zvec_index_type_t constants.
LogLevel
Log levels — mirrors zvec_log_level_t.
LogType
Log output types — mirrors zvec_log_type_t.
MetricType
Distance metric types — mirrors zvec_metric_type_t constants.
QuantizeType
Quantization types — mirrors zvec_quantize_type_t constants.
ZvecErrorCode
Error codes returned by the Zvec C API.

Functions

checkError(zvec_error_code_t code) → void
Check the return code from a C API call and throw ZvecException on error.

Exceptions / Errors

ZvecException
Exception thrown when a Zvec C API call fails.