Expand description
Raw FFI bindings to the zvec C-API.
This crate provides low-level Rust bindings to the zvec vector database C library.
It exposes opaque pointer types, constants, and function declarations that mirror
the C API exactly. For a safer, more idiomatic Rust interface, consider using the
higher-level zvec crate which wraps these raw bindings.
§Safety
All functions in this crate are unsafe by nature as they interact with C code.
Proper memory management and lifetime handling is the responsibility of the caller.
Structs§
- zvec_
byte_ array_ t - A view of a byte array (non-owning).
- zvec_
collection_ options_ t - Opaque pointer to collection opening options. Controls behavior like MMAP, buffer size, and read-only mode.
- zvec_
collection_ schema_ t - Opaque pointer to a collection schema definition. Defines the structure of fields and indexes in a collection.
- zvec_
collection_ stats_ t - Opaque pointer to collection statistics data. Contains metrics like document count and index completeness.
- zvec_
collection_ t - Opaque pointer to a vector collection instance. Represents an opened collection that can be used for read/write operations.
- zvec_
config_ data_ t - Opaque pointer to global configuration data. Manages memory limits, thread counts, and other system-wide settings.
- zvec_
diskann_ query_ params_ t - Opaque pointer to DiskANN index query parameters. Configures list_size, radius, and refiner settings for DiskANN searches.
- zvec_
doc_ t - Opaque pointer to a document instance. Represents a single record with fields and values in a collection.
- zvec_
error_ details_ t - Detailed error information including source location.
- zvec_
field_ schema_ t - Opaque pointer to a field schema definition. Defines the properties of a single field including type, index, etc.
- zvec_
flat_ query_ params_ t - Opaque pointer to flat index query parameters. Configures scale factor and refiner settings for brute-force searches.
- zvec_
float_ array_ t - A view of a float array (non-owning).
- zvec_
fts_ query_ params_ t - Opaque pointer to FTS query parameters. Controls the default boolean operator for adjacent bare terms.
- zvec_
fts_ t - Opaque pointer to FTS query payload. Holds query_string (boolean expression) and match_string (natural-language).
- zvec_
group_ by_ vector_ query_ t - Opaque pointer to a group-by vector query object. Configures grouped vector search with aggregation parameters.
- zvec_
hnsw_ query_ params_ t - Opaque pointer to HNSW index query parameters. Configures ef, radius, and refiner settings for HNSW searches.
- zvec_
index_ params_ t - Opaque pointer to index configuration parameters. Contains settings for HNSW, IVF, or other index types.
- zvec_
int64_ array_ t - A view of an int64 array (non-owning).
- zvec_
ivf_ query_ params_ t - Opaque pointer to IVF index query parameters. Configures nprobe, scale factor, and refiner settings for IVF searches.
- zvec_
log_ config_ t - Opaque pointer to logging configuration. Controls log level, output type (console/file), and file rotation settings.
- zvec_
multi_ query_ t - Opaque pointer to a multi-query object. Combines multiple sub-queries with a re-ranking strategy (RRF / Weighted).
- zvec_
mutable_ byte_ array_ t - A mutable, owning byte array with capacity tracking.
- zvec_
string_ array_ t - An array of owned strings.
- zvec_
string_ t - An owning, mutable string with capacity tracking.
- zvec_
string_ view_ t - A non-owning view of a string (pointer + length).
- zvec_
sub_ query_ t - Opaque pointer to a sub-query object used inside a multi-query. Carries a per-field vector or sparse vector and index-specific parameters.
- zvec_
vamana_ query_ params_ t - Opaque pointer to Vamana index query parameters. Configures ef_search, radius, and refiner settings for Vamana searches.
- zvec_
vector_ query_ t - Opaque pointer to a vector query object. Configures search parameters for vector similarity queries.
- zvec_
write_ result_ t - Result of a write operation (insert/update/delete).
Constants§
- ZVEC_
DATA_ TYPE_ ARRAY_ BINARY - Array of binary values.
- ZVEC_
DATA_ TYPE_ ARRAY_ BOOL - Array of booleans.
- ZVEC_
DATA_ TYPE_ ARRAY_ DOUBLE - Array of 64-bit doubles.
- ZVEC_
DATA_ TYPE_ ARRAY_ FLOAT - Array of 32-bit floats.
- ZVEC_
DATA_ TYPE_ ARRAY_ INT32 - Array of 32-bit signed integers.
- ZVEC_
DATA_ TYPE_ ARRAY_ INT64 - Array of 64-bit signed integers.
- ZVEC_
DATA_ TYPE_ ARRAY_ STRING - Array of strings.
- ZVEC_
DATA_ TYPE_ ARRAY_ UINT32 - Array of 32-bit unsigned integers.
- ZVEC_
DATA_ TYPE_ ARRAY_ UINT64 - Array of 64-bit unsigned integers.
- ZVEC_
DATA_ TYPE_ BINARY - Binary data type.
- ZVEC_
DATA_ TYPE_ BOOL - Boolean data type.
- ZVEC_
DATA_ TYPE_ DOUBLE - 64-bit floating point.
- ZVEC_
DATA_ TYPE_ FLOAT - 32-bit floating point.
- ZVEC_
DATA_ TYPE_ INT32 - 32-bit signed integer.
- ZVEC_
DATA_ TYPE_ INT64 - 64-bit signed integer.
- ZVEC_
DATA_ TYPE_ SPARSE_ VECTOR_ FP16 - Sparse vector with FP16 elements.
- ZVEC_
DATA_ TYPE_ SPARSE_ VECTOR_ FP32 - Sparse vector with FP32 elements.
- ZVEC_
DATA_ TYPE_ STRING - String data type.
- ZVEC_
DATA_ TYPE_ UINT32 - 32-bit unsigned integer.
- ZVEC_
DATA_ TYPE_ UINT64 - 64-bit unsigned integer.
- ZVEC_
DATA_ TYPE_ UNDEFINED - Undefined data type.
- ZVEC_
DATA_ TYPE_ VECTOR_ BINAR Y32 - Dense vector with binary32 (float) elements.
- ZVEC_
DATA_ TYPE_ VECTOR_ BINAR Y64 - Dense vector with binary64 (double) elements.
- ZVEC_
DATA_ TYPE_ VECTOR_ FP16 - Dense vector with FP16 (half precision) elements.
- ZVEC_
DATA_ TYPE_ VECTOR_ FP32 - Dense vector with FP32 (single precision) elements.
- ZVEC_
DATA_ TYPE_ VECTOR_ FP64 - Dense vector with FP64 (double precision) elements.
- ZVEC_
DATA_ TYPE_ VECTOR_ INT4 - Dense vector with INT4 quantized elements.
- ZVEC_
DATA_ TYPE_ VECTOR_ INT8 - Dense vector with INT8 quantized elements.
- ZVEC_
DATA_ TYPE_ VECTOR_ INT16 - Dense vector with INT16 quantized elements.
- ZVEC_
DOC_ OP_ DELETE - Delete operation.
- ZVEC_
DOC_ OP_ INSERT - Insert operation (fails if document exists).
- ZVEC_
DOC_ OP_ UPDATE - Update operation (fails if document doesn’t exist).
- ZVEC_
DOC_ OP_ UPSERT - Upsert operation (insert or update).
- ZVEC_
ERROR_ ALREADY_ EXISTS - Resource already exists.
- ZVEC_
ERROR_ FAILED_ PRECONDITION - Operation failed due to unmet precondition.
- ZVEC_
ERROR_ INTERNAL_ ERROR - Internal system error occurred.
- ZVEC_
ERROR_ INVALID_ ARGUMENT - Invalid argument provided.
- ZVEC_
ERROR_ NOT_ FOUND - Requested resource was not found.
- ZVEC_
ERROR_ NOT_ SUPPORTED - Operation is not supported.
- ZVEC_
ERROR_ PERMISSION_ DENIED - Permission denied for the operation.
- ZVEC_
ERROR_ RESOURCE_ EXHAUSTED - System resources exhausted.
- ZVEC_
ERROR_ UNAVAILABLE - Service is currently unavailable.
- ZVEC_
ERROR_ UNKNOWN - Unknown error occurred.
- ZVEC_
INDEX_ TYPE_ DISKANN - DiskANN disk-based graph index.
- ZVEC_
INDEX_ TYPE_ FLAT - Flat/brute-force index (exact search).
- ZVEC_
INDEX_ TYPE_ FTS - Full-text search index.
- ZVEC_
INDEX_ TYPE_ HNSW - HNSW (Hierarchical Navigable Small World) graph index.
- ZVEC_
INDEX_ TYPE_ HNSW_ RABITQ - HNSW graph index with RaBitQ quantization.
- ZVEC_
INDEX_ TYPE_ INVERT - Inverted index for scalar field filtering.
- ZVEC_
INDEX_ TYPE_ IVF - IVF (Inverted File Index) with clustering.
- ZVEC_
INDEX_ TYPE_ UNDEFINED - Undefined index type.
- ZVEC_
INDEX_ TYPE_ VAMANA - Vamana disk-based graph index.
- ZVEC_
LOG_ LEVEL_ DEBUG - Debug level logging (most verbose).
- ZVEC_
LOG_ LEVEL_ ERROR - Error level logging.
- ZVEC_
LOG_ LEVEL_ FATAL - Fatal level logging (least verbose, critical errors only).
- ZVEC_
LOG_ LEVEL_ INFO - Info level logging.
- ZVEC_
LOG_ LEVEL_ WARN - Warning level logging.
- ZVEC_
LOG_ TYPE_ CONSOLE - Console output logging.
- ZVEC_
LOG_ TYPE_ FILE - File output logging.
- ZVEC_
METRIC_ TYPE_ COSINE - Cosine similarity.
- ZVEC_
METRIC_ TYPE_ IP - Inner product (dot product).
- ZVEC_
METRIC_ TYPE_ L2 - L2 (Euclidean) distance.
- ZVEC_
METRIC_ TYPE_ MIPS L2 - MIPS converted to L2 distance.
- ZVEC_
METRIC_ TYPE_ UNDEFINED - Undefined metric type.
- ZVEC_OK
- Operation completed successfully.
- ZVEC_
QUANTIZE_ TYPE_ FP16 - FP16 (half precision) quantization.
- ZVEC_
QUANTIZE_ TYPE_ INT4 - INT4 (4-bit integer) quantization.
- ZVEC_
QUANTIZE_ TYPE_ INT8 - INT8 (8-bit integer) quantization.
- ZVEC_
QUANTIZE_ TYPE_ UNDEFINED - Undefined quantization type.
Functions§
- zvec_
bin_ ⚠create - zvec_
byte_ ⚠array_ create - zvec_
byte_ ⚠array_ destroy - zvec_
check_ ⚠version - zvec_
clear_ ⚠error - zvec_
collection_ ⚠add_ column - zvec_
collection_ ⚠alter_ column - zvec_
collection_ ⚠close - zvec_
collection_ ⚠create_ and_ open - zvec_
collection_ ⚠create_ index - zvec_
collection_ ⚠delete - zvec_
collection_ ⚠delete_ by_ filter - zvec_
collection_ ⚠delete_ with_ results - zvec_
collection_ ⚠destroy - zvec_
collection_ ⚠drop_ column - zvec_
collection_ ⚠drop_ index - zvec_
collection_ ⚠fetch - zvec_
collection_ ⚠flush - zvec_
collection_ ⚠get_ options - zvec_
collection_ ⚠get_ schema - zvec_
collection_ ⚠get_ stats - zvec_
collection_ ⚠insert - zvec_
collection_ ⚠insert_ with_ results - zvec_
collection_ ⚠multi_ query - zvec_
collection_ ⚠open - zvec_
collection_ ⚠optimize - zvec_
collection_ ⚠options_ create - zvec_
collection_ ⚠options_ destroy - zvec_
collection_ ⚠options_ get_ enable_ mmap - zvec_
collection_ ⚠options_ get_ max_ buffer_ size - zvec_
collection_ ⚠options_ get_ read_ only - zvec_
collection_ ⚠options_ set_ enable_ mmap - zvec_
collection_ ⚠options_ set_ max_ buffer_ size - zvec_
collection_ ⚠options_ set_ read_ only - zvec_
collection_ ⚠query - zvec_
collection_ ⚠schema_ add_ field - zvec_
collection_ ⚠schema_ add_ index - zvec_
collection_ ⚠schema_ alter_ field - zvec_
collection_ ⚠schema_ create - zvec_
collection_ ⚠schema_ destroy - zvec_
collection_ ⚠schema_ drop_ field - zvec_
collection_ ⚠schema_ drop_ index - zvec_
collection_ ⚠schema_ get_ all_ field_ names - zvec_
collection_ ⚠schema_ get_ field - zvec_
collection_ ⚠schema_ get_ forward_ field - zvec_
collection_ ⚠schema_ get_ forward_ field_ names - zvec_
collection_ ⚠schema_ get_ forward_ field_ names_ with_ index - zvec_
collection_ ⚠schema_ get_ forward_ fields - zvec_
collection_ ⚠schema_ get_ forward_ fields_ with_ index - zvec_
collection_ ⚠schema_ get_ max_ doc_ count_ per_ segment - zvec_
collection_ ⚠schema_ get_ name - zvec_
collection_ ⚠schema_ get_ vector_ field - zvec_
collection_ ⚠schema_ get_ vector_ fields - zvec_
collection_ ⚠schema_ has_ field - zvec_
collection_ ⚠schema_ has_ index - zvec_
collection_ ⚠schema_ set_ max_ doc_ count_ per_ segment - zvec_
collection_ ⚠schema_ set_ name - zvec_
collection_ ⚠schema_ validate - zvec_
collection_ ⚠stats_ destroy - zvec_
collection_ ⚠stats_ get_ doc_ count - zvec_
collection_ ⚠stats_ get_ index_ completeness - zvec_
collection_ ⚠stats_ get_ index_ count - zvec_
collection_ ⚠stats_ get_ index_ name - zvec_
collection_ ⚠update - zvec_
collection_ ⚠update_ with_ results - zvec_
collection_ ⚠upsert - zvec_
collection_ ⚠upsert_ with_ results - zvec_
config_ ⚠data_ create - zvec_
config_ ⚠data_ destroy - zvec_
config_ ⚠data_ get_ brute_ force_ by_ keys_ ratio - zvec_
config_ ⚠data_ get_ fts_ brute_ force_ by_ keys_ ratio - zvec_
config_ ⚠data_ get_ invert_ to_ forward_ scan_ ratio - zvec_
config_ ⚠data_ get_ log_ type - zvec_
config_ ⚠data_ get_ memory_ limit - zvec_
config_ ⚠data_ get_ optimize_ thread_ count - zvec_
config_ ⚠data_ get_ query_ thread_ count - zvec_
config_ ⚠data_ set_ brute_ force_ by_ keys_ ratio - zvec_
config_ ⚠data_ set_ fts_ brute_ force_ by_ keys_ ratio - zvec_
config_ ⚠data_ set_ invert_ to_ forward_ scan_ ratio - zvec_
config_ ⚠data_ set_ log_ config - zvec_
config_ ⚠data_ set_ memory_ limit - zvec_
config_ ⚠data_ set_ optimize_ thread_ count - zvec_
config_ ⚠data_ set_ query_ thread_ count - zvec_
config_ ⚠log_ create_ console - zvec_
config_ ⚠log_ create_ file - zvec_
config_ ⚠log_ destroy - zvec_
config_ ⚠log_ get_ basename - zvec_
config_ ⚠log_ get_ dir - zvec_
config_ ⚠log_ get_ file_ size - zvec_
config_ ⚠log_ get_ level - zvec_
config_ ⚠log_ get_ overdue_ days - zvec_
config_ ⚠log_ is_ file_ type - zvec_
config_ ⚠log_ set_ basename - zvec_
config_ ⚠log_ set_ dir - zvec_
config_ ⚠log_ set_ file_ size - zvec_
config_ ⚠log_ set_ level - zvec_
config_ ⚠log_ set_ overdue_ days - zvec_
data_ ⚠type_ to_ string - zvec_
doc_ ⚠add_ field_ by_ value - zvec_
doc_ ⚠clear - zvec_
doc_ ⚠create - zvec_
doc_ ⚠deserialize - zvec_
doc_ ⚠destroy - zvec_
doc_ ⚠get_ doc_ id - zvec_
doc_ ⚠get_ field_ count - zvec_
doc_ ⚠get_ field_ names - zvec_
doc_ ⚠get_ field_ value_ basic - zvec_
doc_ ⚠get_ field_ value_ copy - zvec_
doc_ ⚠get_ field_ value_ pointer - zvec_
doc_ ⚠get_ operator - zvec_
doc_ ⚠get_ pk_ copy - zvec_
doc_ ⚠get_ pk_ pointer - zvec_
doc_ ⚠get_ score - zvec_
doc_ ⚠has_ field - zvec_
doc_ ⚠has_ field_ value - zvec_
doc_ ⚠is_ empty - zvec_
doc_ ⚠is_ field_ null - zvec_
doc_ ⚠memory_ usage - zvec_
doc_ ⚠merge - zvec_
doc_ ⚠remove_ field - zvec_
doc_ ⚠serialize - zvec_
doc_ ⚠set_ doc_ id - zvec_
doc_ ⚠set_ field_ null - zvec_
doc_ ⚠set_ operator - zvec_
doc_ ⚠set_ pk - zvec_
doc_ ⚠set_ score - zvec_
doc_ ⚠to_ detail_ string - zvec_
doc_ ⚠validate - zvec_
docs_ ⚠free - zvec_
error_ ⚠code_ to_ string - zvec_
field_ ⚠schema_ create - zvec_
field_ ⚠schema_ destroy - zvec_
field_ ⚠schema_ get_ data_ type - zvec_
field_ ⚠schema_ get_ dimension - zvec_
field_ ⚠schema_ get_ element_ data_ size - zvec_
field_ ⚠schema_ get_ element_ data_ type - zvec_
field_ ⚠schema_ get_ index_ params - zvec_
field_ ⚠schema_ get_ index_ type - zvec_
field_ ⚠schema_ get_ name - zvec_
field_ ⚠schema_ has_ index - zvec_
field_ ⚠schema_ has_ invert_ index - zvec_
field_ ⚠schema_ is_ array_ type - zvec_
field_ ⚠schema_ is_ dense_ vector - zvec_
field_ ⚠schema_ is_ nullable - zvec_
field_ ⚠schema_ is_ sparse_ vector - zvec_
field_ ⚠schema_ is_ vector_ field - zvec_
field_ ⚠schema_ set_ data_ type - zvec_
field_ ⚠schema_ set_ dimension - zvec_
field_ ⚠schema_ set_ index_ params - zvec_
field_ ⚠schema_ set_ name - zvec_
field_ ⚠schema_ set_ nullable - zvec_
field_ ⚠schema_ validate - zvec_
float_ ⚠array_ create - zvec_
float_ ⚠array_ destroy - zvec_
free ⚠ - zvec_
free_ ⚠field_ schema - zvec_
free_ ⚠str_ array - zvec_
free_ ⚠string - zvec_
free_ ⚠uint8_ array - zvec_
fts_ ⚠create - zvec_
fts_ ⚠destroy - zvec_
fts_ ⚠get_ match_ string - zvec_
fts_ ⚠get_ query_ string - zvec_
fts_ ⚠set_ match_ string - zvec_
fts_ ⚠set_ query_ string - zvec_
get_ ⚠last_ error - zvec_
get_ ⚠last_ error_ details - zvec_
get_ ⚠version - zvec_
get_ ⚠version_ major - zvec_
get_ ⚠version_ minor - zvec_
get_ ⚠version_ patch - zvec_
group_ ⚠by_ vector_ query_ create - zvec_
group_ ⚠by_ vector_ query_ destroy - zvec_
group_ ⚠by_ vector_ query_ get_ field_ name - zvec_
group_ ⚠by_ vector_ query_ get_ filter - zvec_
group_ ⚠by_ vector_ query_ get_ group_ by_ field_ name - zvec_
group_ ⚠by_ vector_ query_ get_ group_ count - zvec_
group_ ⚠by_ vector_ query_ get_ include_ vector - zvec_
group_ ⚠by_ vector_ query_ get_ output_ fields - zvec_
group_ ⚠by_ vector_ query_ get_ topk_ per_ group - zvec_
group_ ⚠by_ vector_ query_ set_ diskann_ params - zvec_
group_ ⚠by_ vector_ query_ set_ field_ name - zvec_
group_ ⚠by_ vector_ query_ set_ filter - zvec_
group_ ⚠by_ vector_ query_ set_ flat_ params - zvec_
group_ ⚠by_ vector_ query_ set_ group_ by_ field_ name - zvec_
group_ ⚠by_ vector_ query_ set_ group_ count - zvec_
group_ ⚠by_ vector_ query_ set_ hnsw_ params - zvec_
group_ ⚠by_ vector_ query_ set_ include_ vector - zvec_
group_ ⚠by_ vector_ query_ set_ ivf_ params - zvec_
group_ ⚠by_ vector_ query_ set_ output_ fields - zvec_
group_ ⚠by_ vector_ query_ set_ query_ params - zvec_
group_ ⚠by_ vector_ query_ set_ query_ vector - zvec_
group_ ⚠by_ vector_ query_ set_ topk_ per_ group - zvec_
group_ ⚠by_ vector_ query_ set_ vamana_ params - zvec_
index_ ⚠params_ create - zvec_
index_ ⚠params_ destroy - zvec_
index_ ⚠params_ get_ diskann_ list_ size - zvec_
index_ ⚠params_ get_ diskann_ max_ degree - zvec_
index_ ⚠params_ get_ diskann_ pq_ chunk_ num - zvec_
index_ ⚠params_ get_ fts_ params - zvec_
index_ ⚠params_ get_ hnsw_ ef_ construction - zvec_
index_ ⚠params_ get_ hnsw_ m - zvec_
index_ ⚠params_ get_ invert_ params - zvec_
index_ ⚠params_ get_ ivf_ params - zvec_
index_ ⚠params_ get_ metric_ type - zvec_
index_ ⚠params_ get_ quantize_ type - zvec_
index_ ⚠params_ get_ type - zvec_
index_ ⚠params_ get_ vamana_ params - zvec_
index_ ⚠params_ set_ diskann_ params - zvec_
index_ ⚠params_ set_ fts_ params - zvec_
index_ ⚠params_ set_ hnsw_ params - zvec_
index_ ⚠params_ set_ invert_ params - zvec_
index_ ⚠params_ set_ ivf_ params - zvec_
index_ ⚠params_ set_ metric_ type - zvec_
index_ ⚠params_ set_ quantize_ type - zvec_
index_ ⚠params_ set_ vamana_ params - zvec_
index_ ⚠type_ to_ string - zvec_
initialize ⚠ - zvec_
int64_ ⚠array_ create - zvec_
int64_ ⚠array_ destroy - zvec_
is_ ⚠initialized - zvec_
malloc ⚠ - zvec_
metric_ ⚠type_ to_ string - zvec_
multi_ ⚠query_ add_ sub_ query - zvec_
multi_ ⚠query_ create - zvec_
multi_ ⚠query_ destroy - zvec_
multi_ ⚠query_ get_ filter - zvec_
multi_ ⚠query_ get_ include_ vector - zvec_
multi_ ⚠query_ get_ output_ fields - zvec_
multi_ ⚠query_ get_ sub_ query_ count - zvec_
multi_ ⚠query_ get_ topk - zvec_
multi_ ⚠query_ set_ filter - zvec_
multi_ ⚠query_ set_ include_ vector - zvec_
multi_ ⚠query_ set_ output_ fields - zvec_
multi_ ⚠query_ set_ rerank_ rrf - zvec_
multi_ ⚠query_ set_ rerank_ weighted - zvec_
multi_ ⚠query_ set_ topk - zvec_
query_ ⚠params_ diskann_ create - zvec_
query_ ⚠params_ diskann_ destroy - zvec_
query_ ⚠params_ diskann_ get_ is_ linear - zvec_
query_ ⚠params_ diskann_ get_ is_ using_ refiner - zvec_
query_ ⚠params_ diskann_ get_ list_ size - zvec_
query_ ⚠params_ diskann_ get_ radius - zvec_
query_ ⚠params_ diskann_ set_ is_ linear - zvec_
query_ ⚠params_ diskann_ set_ is_ using_ refiner - zvec_
query_ ⚠params_ diskann_ set_ list_ size - zvec_
query_ ⚠params_ diskann_ set_ radius - zvec_
query_ ⚠params_ flat_ create - zvec_
query_ ⚠params_ flat_ destroy - zvec_
query_ ⚠params_ flat_ get_ is_ linear - zvec_
query_ ⚠params_ flat_ get_ is_ using_ refiner - zvec_
query_ ⚠params_ flat_ get_ radius - zvec_
query_ ⚠params_ flat_ get_ scale_ factor - zvec_
query_ ⚠params_ flat_ set_ is_ linear - zvec_
query_ ⚠params_ flat_ set_ is_ using_ refiner - zvec_
query_ ⚠params_ flat_ set_ radius - zvec_
query_ ⚠params_ flat_ set_ scale_ factor - zvec_
query_ ⚠params_ fts_ create - zvec_
query_ ⚠params_ fts_ destroy - zvec_
query_ ⚠params_ fts_ get_ default_ operator - zvec_
query_ ⚠params_ fts_ set_ default_ operator - zvec_
query_ ⚠params_ hnsw_ create - zvec_
query_ ⚠params_ hnsw_ destroy - zvec_
query_ ⚠params_ hnsw_ get_ ef - zvec_
query_ ⚠params_ hnsw_ get_ is_ linear - zvec_
query_ ⚠params_ hnsw_ get_ is_ using_ refiner - zvec_
query_ ⚠params_ hnsw_ get_ radius - zvec_
query_ ⚠params_ hnsw_ set_ ef - zvec_
query_ ⚠params_ hnsw_ set_ is_ linear - zvec_
query_ ⚠params_ hnsw_ set_ is_ using_ refiner - zvec_
query_ ⚠params_ hnsw_ set_ radius - zvec_
query_ ⚠params_ ivf_ create - zvec_
query_ ⚠params_ ivf_ destroy - zvec_
query_ ⚠params_ ivf_ get_ is_ linear - zvec_
query_ ⚠params_ ivf_ get_ is_ using_ refiner - zvec_
query_ ⚠params_ ivf_ get_ nprobe - zvec_
query_ ⚠params_ ivf_ get_ radius - zvec_
query_ ⚠params_ ivf_ get_ scale_ factor - zvec_
query_ ⚠params_ ivf_ set_ is_ linear - zvec_
query_ ⚠params_ ivf_ set_ is_ using_ refiner - zvec_
query_ ⚠params_ ivf_ set_ nprobe - zvec_
query_ ⚠params_ ivf_ set_ radius - zvec_
query_ ⚠params_ ivf_ set_ scale_ factor - zvec_
query_ ⚠params_ vamana_ create - zvec_
query_ ⚠params_ vamana_ destroy - zvec_
query_ ⚠params_ vamana_ get_ ef_ search - zvec_
query_ ⚠params_ vamana_ get_ is_ linear - zvec_
query_ ⚠params_ vamana_ get_ is_ using_ refiner - zvec_
query_ ⚠params_ vamana_ get_ radius - zvec_
query_ ⚠params_ vamana_ set_ ef_ search - zvec_
query_ ⚠params_ vamana_ set_ is_ linear - zvec_
query_ ⚠params_ vamana_ set_ is_ using_ refiner - zvec_
query_ ⚠params_ vamana_ set_ radius - zvec_
shutdown ⚠ - zvec_
string_ ⚠array_ add - zvec_
string_ ⚠array_ create - zvec_
string_ ⚠array_ destroy - zvec_
string_ ⚠c_ str - zvec_
string_ ⚠compare - zvec_
string_ ⚠copy - zvec_
string_ ⚠create - zvec_
string_ ⚠create_ from_ view - zvec_
string_ ⚠length - zvec_
sub_ ⚠query_ create - zvec_
sub_ ⚠query_ destroy - zvec_
sub_ ⚠query_ get_ field_ name - zvec_
sub_ ⚠query_ get_ num_ candidates - zvec_
sub_ ⚠query_ set_ diskann_ params - zvec_
sub_ ⚠query_ set_ field_ name - zvec_
sub_ ⚠query_ set_ flat_ params - zvec_
sub_ ⚠query_ set_ fts - zvec_
sub_ ⚠query_ set_ fts_ params - zvec_
sub_ ⚠query_ set_ hnsw_ params - zvec_
sub_ ⚠query_ set_ ivf_ params - zvec_
sub_ ⚠query_ set_ num_ candidates - zvec_
sub_ ⚠query_ set_ query_ vector - zvec_
sub_ ⚠query_ set_ sparse_ indices - zvec_
sub_ ⚠query_ set_ sparse_ values - zvec_
sub_ ⚠query_ set_ sparse_ vector - zvec_
sub_ ⚠query_ set_ vamana_ params - zvec_
vector_ ⚠query_ create - zvec_
vector_ ⚠query_ destroy - zvec_
vector_ ⚠query_ get_ field_ name - zvec_
vector_ ⚠query_ get_ filter - zvec_
vector_ ⚠query_ get_ fts - zvec_
vector_ ⚠query_ get_ include_ doc_ id - zvec_
vector_ ⚠query_ get_ include_ vector - zvec_
vector_ ⚠query_ get_ output_ fields - zvec_
vector_ ⚠query_ get_ topk - zvec_
vector_ ⚠query_ set_ diskann_ params - zvec_
vector_ ⚠query_ set_ field_ name - zvec_
vector_ ⚠query_ set_ filter - zvec_
vector_ ⚠query_ set_ flat_ params - zvec_
vector_ ⚠query_ set_ fts - zvec_
vector_ ⚠query_ set_ fts_ params - zvec_
vector_ ⚠query_ set_ hnsw_ params - zvec_
vector_ ⚠query_ set_ include_ doc_ id - zvec_
vector_ ⚠query_ set_ include_ vector - zvec_
vector_ ⚠query_ set_ ivf_ params - zvec_
vector_ ⚠query_ set_ output_ fields - zvec_
vector_ ⚠query_ set_ query_ params - zvec_
vector_ ⚠query_ set_ query_ vector - zvec_
vector_ ⚠query_ set_ topk - zvec_
vector_ ⚠query_ set_ vamana_ params - zvec_
write_ ⚠results_ free
Type Aliases§
- zvec_
data_ type_ t - Data type identifier for field values.
- zvec_
doc_ operator_ t - Document operation type (insert/update/delete).
- zvec_
error_ code_ t - Error code returned by zvec functions.
- zvec_
index_ type_ t - Index algorithm type identifier.
- zvec_
log_ level_ t - Log severity level.
- zvec_
log_ type_ t - Log output destination type.
- zvec_
metric_ type_ t - Distance metric type for vector similarity.
- zvec_
quantize_ type_ t - Quantization type for vector compression.