zvec_rust_sys/
lib.rs

1//! Raw FFI bindings to the zvec C-API.
2//!
3//! This crate provides low-level Rust bindings to the zvec vector database C library.
4//! It exposes opaque pointer types, constants, and function declarations that mirror
5//! the C API exactly. For a safer, more idiomatic Rust interface, consider using the
6//! higher-level `zvec` crate which wraps these raw bindings.
7//!
8//! # Safety
9//!
10//! All functions in this crate are `unsafe` by nature as they interact with C code.
11//! Proper memory management and lifetime handling is the responsibility of the caller.
12
13#![allow(non_camel_case_types, non_upper_case_globals)]
14
15use std::os::raw::{c_char, c_int, c_void};
16
17// =============================================================================
18// Opaque Pointer Types
19// =============================================================================
20
21/// Opaque pointer to a vector collection instance.
22/// Represents an opened collection that can be used for read/write operations.
23#[repr(C)]
24pub struct zvec_collection_t {
25    _private: [u8; 0],
26}
27
28/// Opaque pointer to a collection schema definition.
29/// Defines the structure of fields and indexes in a collection.
30#[repr(C)]
31pub struct zvec_collection_schema_t {
32    _private: [u8; 0],
33}
34
35/// Opaque pointer to a field schema definition.
36/// Defines the properties of a single field including type, index, etc.
37#[repr(C)]
38pub struct zvec_field_schema_t {
39    _private: [u8; 0],
40}
41
42/// Opaque pointer to index configuration parameters.
43/// Contains settings for HNSW, IVF, or other index types.
44#[repr(C)]
45pub struct zvec_index_params_t {
46    _private: [u8; 0],
47}
48
49/// Opaque pointer to a document instance.
50/// Represents a single record with fields and values in a collection.
51#[repr(C)]
52pub struct zvec_doc_t {
53    _private: [u8; 0],
54}
55
56/// Opaque pointer to a vector query object.
57/// Configures search parameters for vector similarity queries.
58#[repr(C)]
59pub struct zvec_vector_query_t {
60    _private: [u8; 0],
61}
62
63/// Opaque pointer to a group-by vector query object.
64/// Configures grouped vector search with aggregation parameters.
65#[repr(C)]
66pub struct zvec_group_by_vector_query_t {
67    _private: [u8; 0],
68}
69
70/// Opaque pointer to collection opening options.
71/// Controls behavior like MMAP, buffer size, and read-only mode.
72#[repr(C)]
73pub struct zvec_collection_options_t {
74    _private: [u8; 0],
75}
76
77/// Opaque pointer to collection statistics data.
78/// Contains metrics like document count and index completeness.
79#[repr(C)]
80pub struct zvec_collection_stats_t {
81    _private: [u8; 0],
82}
83
84/// Opaque pointer to global configuration data.
85/// Manages memory limits, thread counts, and other system-wide settings.
86#[repr(C)]
87pub struct zvec_config_data_t {
88    _private: [u8; 0],
89}
90
91/// Opaque pointer to logging configuration.
92/// Controls log level, output type (console/file), and file rotation settings.
93#[repr(C)]
94pub struct zvec_log_config_t {
95    _private: [u8; 0],
96}
97
98/// Opaque pointer to HNSW index query parameters.
99/// Configures ef, radius, and refiner settings for HNSW searches.
100#[repr(C)]
101pub struct zvec_hnsw_query_params_t {
102    _private: [u8; 0],
103}
104
105/// Opaque pointer to IVF index query parameters.
106/// Configures nprobe, scale factor, and refiner settings for IVF searches.
107#[repr(C)]
108pub struct zvec_ivf_query_params_t {
109    _private: [u8; 0],
110}
111
112/// Opaque pointer to IVF RaBitQ index query parameters.
113/// Configures nprobe, scale factor, and refiner settings for IVF RaBitQ searches.
114#[repr(C)]
115pub struct zvec_ivf_rabitq_query_params_t {
116    _private: [u8; 0],
117}
118
119/// Opaque pointer to flat index query parameters.
120/// Configures scale factor and refiner settings for brute-force searches.
121#[repr(C)]
122pub struct zvec_flat_query_params_t {
123    _private: [u8; 0],
124}
125
126/// Opaque pointer to Vamana index query parameters.
127/// Configures ef_search, radius, and refiner settings for Vamana searches.
128#[repr(C)]
129pub struct zvec_vamana_query_params_t {
130    _private: [u8; 0],
131}
132
133/// Opaque pointer to DiskANN index query parameters.
134/// Configures list_size, radius, and refiner settings for DiskANN searches.
135#[repr(C)]
136pub struct zvec_diskann_query_params_t {
137    _private: [u8; 0],
138}
139
140/// Opaque pointer to FTS query parameters.
141/// Controls the default boolean operator for adjacent bare terms.
142#[repr(C)]
143pub struct zvec_fts_query_params_t {
144    _private: [u8; 0],
145}
146
147/// Opaque pointer to FTS query payload.
148/// Holds query_string (boolean expression) and match_string (natural-language).
149#[repr(C)]
150pub struct zvec_fts_t {
151    _private: [u8; 0],
152}
153
154/// Opaque pointer to a multi-query object.
155/// Combines multiple sub-queries with a re-ranking strategy (RRF / Weighted).
156#[repr(C)]
157pub struct zvec_multi_query_t {
158    _private: [u8; 0],
159}
160
161/// Opaque pointer to a sub-query object used inside a multi-query.
162/// Carries a per-field vector or sparse vector and index-specific parameters.
163#[repr(C)]
164pub struct zvec_sub_query_t {
165    _private: [u8; 0],
166}
167
168/// Opaque pointer to a document iterator for full collection traversal.
169/// Created by `zvec_collection_create_iterator`, released by `zvec_doc_iterator_close`.
170/// Iterates over an isolated snapshot taken at creation time.
171#[repr(C)]
172pub struct zvec_doc_iterator_t {
173    _private: [u8; 0],
174}
175
176/// Opaque pointer to document iterator options.
177/// Controls which scalar fields and whether vectors are returned.
178#[repr(C)]
179pub struct zvec_iterator_options_t {
180    _private: [u8; 0],
181}
182
183// =============================================================================
184// Type Aliases
185// =============================================================================
186
187/// Error code returned by zvec functions.
188pub type zvec_error_code_t = u32;
189/// Data type identifier for field values.
190pub type zvec_data_type_t = u32;
191/// Index algorithm type identifier.
192pub type zvec_index_type_t = u32;
193/// Distance metric type for vector similarity.
194pub type zvec_metric_type_t = u32;
195/// Quantization type for vector compression.
196pub type zvec_quantize_type_t = u32;
197/// Log severity level.
198pub type zvec_log_level_t = u32;
199/// Log output destination type.
200pub type zvec_log_type_t = u32;
201/// Document operation type (insert/update/delete).
202pub type zvec_doc_operator_t = u32;
203/// I/O backend used for DiskAnn disk reads.
204pub type zvec_io_backend_type_t = u32;
205
206// =============================================================================
207// Error Code Constants
208// =============================================================================
209
210/// Operation completed successfully.
211pub const ZVEC_OK: zvec_error_code_t = 0;
212/// Requested resource was not found.
213pub const ZVEC_ERROR_NOT_FOUND: zvec_error_code_t = 1;
214/// Resource already exists.
215pub const ZVEC_ERROR_ALREADY_EXISTS: zvec_error_code_t = 2;
216/// Invalid argument provided.
217pub const ZVEC_ERROR_INVALID_ARGUMENT: zvec_error_code_t = 3;
218/// Permission denied for the operation.
219pub const ZVEC_ERROR_PERMISSION_DENIED: zvec_error_code_t = 4;
220/// Operation failed due to unmet precondition.
221pub const ZVEC_ERROR_FAILED_PRECONDITION: zvec_error_code_t = 5;
222/// System resources exhausted.
223pub const ZVEC_ERROR_RESOURCE_EXHAUSTED: zvec_error_code_t = 6;
224/// Service is currently unavailable.
225pub const ZVEC_ERROR_UNAVAILABLE: zvec_error_code_t = 7;
226/// Internal system error occurred.
227pub const ZVEC_ERROR_INTERNAL_ERROR: zvec_error_code_t = 8;
228/// Operation is not supported.
229pub const ZVEC_ERROR_NOT_SUPPORTED: zvec_error_code_t = 9;
230/// Unknown error occurred.
231pub const ZVEC_ERROR_UNKNOWN: zvec_error_code_t = 10;
232
233// =============================================================================
234// Data Type Constants
235// =============================================================================
236
237/// Undefined data type.
238pub const ZVEC_DATA_TYPE_UNDEFINED: zvec_data_type_t = 0;
239/// Binary data type.
240pub const ZVEC_DATA_TYPE_BINARY: zvec_data_type_t = 1;
241/// String data type.
242pub const ZVEC_DATA_TYPE_STRING: zvec_data_type_t = 2;
243/// Boolean data type.
244pub const ZVEC_DATA_TYPE_BOOL: zvec_data_type_t = 3;
245/// 32-bit signed integer.
246pub const ZVEC_DATA_TYPE_INT32: zvec_data_type_t = 4;
247/// 64-bit signed integer.
248pub const ZVEC_DATA_TYPE_INT64: zvec_data_type_t = 5;
249/// 32-bit unsigned integer.
250pub const ZVEC_DATA_TYPE_UINT32: zvec_data_type_t = 6;
251/// 64-bit unsigned integer.
252pub const ZVEC_DATA_TYPE_UINT64: zvec_data_type_t = 7;
253/// 32-bit floating point.
254pub const ZVEC_DATA_TYPE_FLOAT: zvec_data_type_t = 8;
255/// 64-bit floating point.
256pub const ZVEC_DATA_TYPE_DOUBLE: zvec_data_type_t = 9;
257/// Dense vector with binary32 (float) elements.
258pub const ZVEC_DATA_TYPE_VECTOR_BINARY32: zvec_data_type_t = 20;
259/// Dense vector with binary64 (double) elements.
260pub const ZVEC_DATA_TYPE_VECTOR_BINARY64: zvec_data_type_t = 21;
261/// Dense vector with FP16 (half precision) elements.
262pub const ZVEC_DATA_TYPE_VECTOR_FP16: zvec_data_type_t = 22;
263/// Dense vector with FP32 (single precision) elements.
264pub const ZVEC_DATA_TYPE_VECTOR_FP32: zvec_data_type_t = 23;
265/// Dense vector with FP64 (double precision) elements.
266pub const ZVEC_DATA_TYPE_VECTOR_FP64: zvec_data_type_t = 24;
267/// Dense vector with INT4 quantized elements.
268pub const ZVEC_DATA_TYPE_VECTOR_INT4: zvec_data_type_t = 25;
269/// Dense vector with INT8 quantized elements.
270pub const ZVEC_DATA_TYPE_VECTOR_INT8: zvec_data_type_t = 26;
271/// Dense vector with INT16 quantized elements.
272pub const ZVEC_DATA_TYPE_VECTOR_INT16: zvec_data_type_t = 27;
273/// Dense vector with unsigned 8-bit elements (Flat reference storage).
274pub const ZVEC_DATA_TYPE_VECTOR_UINT8: zvec_data_type_t = 28;
275/// Sparse vector with FP16 elements.
276pub const ZVEC_DATA_TYPE_SPARSE_VECTOR_FP16: zvec_data_type_t = 30;
277/// Sparse vector with FP32 elements.
278pub const ZVEC_DATA_TYPE_SPARSE_VECTOR_FP32: zvec_data_type_t = 31;
279/// Array of binary values.
280pub const ZVEC_DATA_TYPE_ARRAY_BINARY: zvec_data_type_t = 40;
281/// Array of strings.
282pub const ZVEC_DATA_TYPE_ARRAY_STRING: zvec_data_type_t = 41;
283/// Array of booleans.
284pub const ZVEC_DATA_TYPE_ARRAY_BOOL: zvec_data_type_t = 42;
285/// Array of 32-bit signed integers.
286pub const ZVEC_DATA_TYPE_ARRAY_INT32: zvec_data_type_t = 43;
287/// Array of 64-bit signed integers.
288pub const ZVEC_DATA_TYPE_ARRAY_INT64: zvec_data_type_t = 44;
289/// Array of 32-bit unsigned integers.
290pub const ZVEC_DATA_TYPE_ARRAY_UINT32: zvec_data_type_t = 45;
291/// Array of 64-bit unsigned integers.
292pub const ZVEC_DATA_TYPE_ARRAY_UINT64: zvec_data_type_t = 46;
293/// Array of 32-bit floats.
294pub const ZVEC_DATA_TYPE_ARRAY_FLOAT: zvec_data_type_t = 47;
295/// Array of 64-bit doubles.
296pub const ZVEC_DATA_TYPE_ARRAY_DOUBLE: zvec_data_type_t = 48;
297
298// =============================================================================
299// Index Type Constants
300// =============================================================================
301
302/// Undefined index type.
303pub const ZVEC_INDEX_TYPE_UNDEFINED: zvec_index_type_t = 0;
304/// HNSW (Hierarchical Navigable Small World) graph index.
305pub const ZVEC_INDEX_TYPE_HNSW: zvec_index_type_t = 1;
306/// IVF (Inverted File Index) with clustering.
307pub const ZVEC_INDEX_TYPE_IVF: zvec_index_type_t = 2;
308/// Flat/brute-force index (exact search).
309pub const ZVEC_INDEX_TYPE_FLAT: zvec_index_type_t = 3;
310/// HNSW graph index with RaBitQ quantization.
311pub const ZVEC_INDEX_TYPE_HNSW_RABITQ: zvec_index_type_t = 4;
312/// DiskANN disk-based graph index.
313pub const ZVEC_INDEX_TYPE_DISKANN: zvec_index_type_t = 5;
314/// Vamana disk-based graph index.
315pub const ZVEC_INDEX_TYPE_VAMANA: zvec_index_type_t = 6;
316/// IVF index with RaBitQ quantization.
317pub const ZVEC_INDEX_TYPE_IVF_RABITQ: zvec_index_type_t = 7;
318/// Inverted index for scalar field filtering.
319pub const ZVEC_INDEX_TYPE_INVERT: zvec_index_type_t = 10;
320/// Full-text search index.
321pub const ZVEC_INDEX_TYPE_FTS: zvec_index_type_t = 11;
322
323// =============================================================================
324// Metric Type Constants
325// =============================================================================
326
327/// Undefined metric type.
328pub const ZVEC_METRIC_TYPE_UNDEFINED: zvec_metric_type_t = 0;
329/// L2 (Euclidean) distance.
330pub const ZVEC_METRIC_TYPE_L2: zvec_metric_type_t = 1;
331/// Inner product (dot product).
332pub const ZVEC_METRIC_TYPE_IP: zvec_metric_type_t = 2;
333/// Cosine similarity.
334pub const ZVEC_METRIC_TYPE_COSINE: zvec_metric_type_t = 3;
335/// MIPS converted to L2 distance.
336pub const ZVEC_METRIC_TYPE_MIPSL2: zvec_metric_type_t = 4;
337
338// =============================================================================
339// Quantize Type Constants
340// =============================================================================
341
342/// Undefined quantization type.
343pub const ZVEC_QUANTIZE_TYPE_UNDEFINED: zvec_quantize_type_t = 0;
344/// FP16 (half precision) quantization.
345pub const ZVEC_QUANTIZE_TYPE_FP16: zvec_quantize_type_t = 1;
346/// INT8 (8-bit integer) quantization.
347pub const ZVEC_QUANTIZE_TYPE_INT8: zvec_quantize_type_t = 2;
348/// INT4 (4-bit integer) quantization.
349pub const ZVEC_QUANTIZE_TYPE_INT4: zvec_quantize_type_t = 3;
350/// RaBitQ quantization.
351pub const ZVEC_QUANTIZE_TYPE_RABITQ: zvec_quantize_type_t = 4;
352
353// =============================================================================
354// Log Level Constants
355// =============================================================================
356
357/// Debug level logging (most verbose).
358pub const ZVEC_LOG_LEVEL_DEBUG: zvec_log_level_t = 0;
359/// Info level logging.
360pub const ZVEC_LOG_LEVEL_INFO: zvec_log_level_t = 1;
361/// Warning level logging.
362pub const ZVEC_LOG_LEVEL_WARN: zvec_log_level_t = 2;
363/// Error level logging.
364pub const ZVEC_LOG_LEVEL_ERROR: zvec_log_level_t = 3;
365/// Fatal level logging (least verbose, critical errors only).
366pub const ZVEC_LOG_LEVEL_FATAL: zvec_log_level_t = 4;
367
368// =============================================================================
369// Log Type Constants
370// =============================================================================
371
372/// Console output logging.
373pub const ZVEC_LOG_TYPE_CONSOLE: zvec_log_type_t = 0;
374/// File output logging.
375pub const ZVEC_LOG_TYPE_FILE: zvec_log_type_t = 1;
376
377// =============================================================================
378// Doc Operator Constants
379// =============================================================================
380
381/// Insert operation (fails if document exists).
382pub const ZVEC_DOC_OP_INSERT: zvec_doc_operator_t = 0;
383/// Update operation (fails if document doesn't exist).
384pub const ZVEC_DOC_OP_UPDATE: zvec_doc_operator_t = 1;
385/// Upsert operation (insert or update).
386pub const ZVEC_DOC_OP_UPSERT: zvec_doc_operator_t = 2;
387/// Delete operation.
388pub const ZVEC_DOC_OP_DELETE: zvec_doc_operator_t = 3;
389
390// =============================================================================
391// I/O Backend Type Constants
392// =============================================================================
393
394/// Synchronous pread(); no async I/O.
395pub const ZVEC_IO_BACKEND_TYPE_PREAD: zvec_io_backend_type_t = 0;
396/// libaio loaded at runtime via dlopen().
397pub const ZVEC_IO_BACKEND_TYPE_LIBAIO: zvec_io_backend_type_t = 1;
398/// io_uring via raw Linux kernel syscalls (zero dependency).
399pub const ZVEC_IO_BACKEND_TYPE_IO_URING: zvec_io_backend_type_t = 2;
400/// Windows overlapped I/O using per-context IOCP.
401pub const ZVEC_IO_BACKEND_TYPE_WINDOWS_OVERLAPPED: zvec_io_backend_type_t = 3;
402
403// =============================================================================
404// Non-Opaque Structures
405// =============================================================================
406
407/// A non-owning view of a string (pointer + length).
408#[repr(C)]
409pub struct zvec_string_view_t {
410    pub data: *const c_char,
411    pub length: usize,
412}
413
414/// An owning, mutable string with capacity tracking.
415#[repr(C)]
416pub struct zvec_string_t {
417    pub data: *mut c_char,
418    pub length: usize,
419    pub capacity: usize,
420}
421
422/// An array of owned strings.
423#[repr(C)]
424pub struct zvec_string_array_t {
425    pub strings: *mut zvec_string_t,
426    pub count: usize,
427}
428
429/// A view of a float array (non-owning).
430#[repr(C)]
431pub struct zvec_float_array_t {
432    pub data: *const f32,
433    pub length: usize,
434}
435
436/// A view of an int64 array (non-owning).
437#[repr(C)]
438pub struct zvec_int64_array_t {
439    pub data: *const i64,
440    pub length: usize,
441}
442
443/// A view of a byte array (non-owning).
444#[repr(C)]
445pub struct zvec_byte_array_t {
446    pub data: *const u8,
447    pub length: usize,
448}
449
450/// A mutable, owning byte array with capacity tracking.
451#[repr(C)]
452pub struct zvec_mutable_byte_array_t {
453    pub data: *mut u8,
454    pub length: usize,
455    pub capacity: usize,
456}
457
458/// Result of a write operation (insert/update/delete).
459#[repr(C)]
460pub struct zvec_write_result_t {
461    pub code: zvec_error_code_t,
462    pub message: *const c_char,
463}
464
465/// Detailed error information including source location.
466#[repr(C)]
467pub struct zvec_error_details_t {
468    pub code: zvec_error_code_t,
469    pub message: *const c_char,
470    pub file: *const c_char,
471    pub line: c_int,
472    pub function: *const c_char,
473}
474
475// =============================================================================
476// FFI Function Declarations
477// =============================================================================
478
479extern "C" {
480    // -------------------------------------------------------------------------
481    // Version
482    // Functions for retrieving library version information.
483    // -------------------------------------------------------------------------
484    pub fn zvec_get_version() -> *const c_char;
485    pub fn zvec_check_version(major: c_int, minor: c_int, patch: c_int) -> bool;
486    pub fn zvec_get_version_major() -> c_int;
487    pub fn zvec_get_version_minor() -> c_int;
488    pub fn zvec_get_version_patch() -> c_int;
489
490    // -------------------------------------------------------------------------
491    // Error
492    // Functions for error handling and retrieval.
493    // -------------------------------------------------------------------------
494    pub fn zvec_get_last_error_details(
495        error_details: *mut zvec_error_details_t,
496    ) -> zvec_error_code_t;
497    pub fn zvec_get_last_error(error_msg: *mut *mut c_char) -> zvec_error_code_t;
498    pub fn zvec_clear_error();
499    pub fn zvec_error_code_to_string(error_code: zvec_error_code_t) -> *const c_char;
500
501    // -------------------------------------------------------------------------
502    // String Management
503    // Functions for creating, manipulating, and freeing string objects.
504    // -------------------------------------------------------------------------
505    pub fn zvec_string_create(str: *const c_char) -> *mut zvec_string_t;
506    pub fn zvec_string_create_from_view(view: *const zvec_string_view_t) -> *mut zvec_string_t;
507    pub fn zvec_bin_create(data: *const u8, length: usize) -> *mut zvec_string_t;
508    pub fn zvec_string_copy(str: *const zvec_string_t) -> *mut zvec_string_t;
509    pub fn zvec_string_c_str(str: *const zvec_string_t) -> *const c_char;
510    pub fn zvec_string_length(str: *const zvec_string_t) -> usize;
511    pub fn zvec_string_compare(str1: *const zvec_string_t, str2: *const zvec_string_t) -> c_int;
512    pub fn zvec_free_string(str: *mut zvec_string_t);
513
514    // -------------------------------------------------------------------------
515    // Array Management
516    // Functions for creating and managing arrays of various types.
517    // -------------------------------------------------------------------------
518    pub fn zvec_string_array_create(count: usize) -> *mut zvec_string_array_t;
519    pub fn zvec_string_array_add(array: *mut zvec_string_array_t, idx: usize, str: *const c_char);
520    pub fn zvec_string_array_destroy(array: *mut zvec_string_array_t);
521    pub fn zvec_byte_array_create(capacity: usize) -> *mut zvec_mutable_byte_array_t;
522    pub fn zvec_byte_array_destroy(array: *mut zvec_mutable_byte_array_t);
523    pub fn zvec_float_array_create(count: usize) -> *mut zvec_float_array_t;
524    pub fn zvec_float_array_destroy(array: *mut zvec_float_array_t);
525    pub fn zvec_int64_array_create(count: usize) -> *mut zvec_int64_array_t;
526    pub fn zvec_int64_array_destroy(array: *mut zvec_int64_array_t);
527    pub fn zvec_free_uint8_array(array: *mut u8);
528
529    // -------------------------------------------------------------------------
530    // Memory
531    // Functions for memory allocation and deallocation.
532    // -------------------------------------------------------------------------
533    pub fn zvec_malloc(size: usize) -> *mut c_void;
534    pub fn zvec_free(ptr: *mut c_void);
535
536    // -------------------------------------------------------------------------
537    // Log Configuration
538    // Functions for configuring logging behavior.
539    // -------------------------------------------------------------------------
540    pub fn zvec_config_log_create_console(level: zvec_log_level_t) -> *mut zvec_log_config_t;
541    pub fn zvec_config_log_create_file(
542        level: zvec_log_level_t,
543        dir: *const c_char,
544        basename: *const c_char,
545        file_size: u32,
546        overdue_days: u32,
547    ) -> *mut zvec_log_config_t;
548    pub fn zvec_config_log_destroy(config: *mut zvec_log_config_t);
549    pub fn zvec_config_log_get_level(config: *const zvec_log_config_t) -> zvec_log_level_t;
550    pub fn zvec_config_log_set_level(
551        config: *mut zvec_log_config_t,
552        level: zvec_log_level_t,
553    ) -> zvec_error_code_t;
554    pub fn zvec_config_log_is_file_type(config: *const zvec_log_config_t) -> bool;
555    pub fn zvec_config_log_get_dir(config: *const zvec_log_config_t) -> *const c_char;
556    pub fn zvec_config_log_set_dir(
557        config: *mut zvec_log_config_t,
558        dir: *const c_char,
559    ) -> zvec_error_code_t;
560    pub fn zvec_config_log_get_basename(config: *const zvec_log_config_t) -> *const c_char;
561    pub fn zvec_config_log_set_basename(
562        config: *mut zvec_log_config_t,
563        basename: *const c_char,
564    ) -> zvec_error_code_t;
565    pub fn zvec_config_log_get_file_size(config: *const zvec_log_config_t) -> u32;
566    pub fn zvec_config_log_set_file_size(
567        config: *mut zvec_log_config_t,
568        file_size: u32,
569    ) -> zvec_error_code_t;
570    pub fn zvec_config_log_get_overdue_days(config: *const zvec_log_config_t) -> u32;
571    pub fn zvec_config_log_set_overdue_days(
572        config: *mut zvec_log_config_t,
573        days: u32,
574    ) -> zvec_error_code_t;
575
576    // -------------------------------------------------------------------------
577    // Global Configuration
578    // Functions for managing global system configuration.
579    // -------------------------------------------------------------------------
580    pub fn zvec_config_data_create() -> *mut zvec_config_data_t;
581    pub fn zvec_config_data_destroy(config: *mut zvec_config_data_t);
582    pub fn zvec_config_data_set_memory_limit(
583        config: *mut zvec_config_data_t,
584        memory_limit_bytes: u64,
585    ) -> zvec_error_code_t;
586    pub fn zvec_config_data_get_memory_limit(config: *const zvec_config_data_t) -> u64;
587    pub fn zvec_config_data_set_log_config(
588        config: *mut zvec_config_data_t,
589        log_config: *mut zvec_log_config_t,
590    ) -> zvec_error_code_t;
591    pub fn zvec_config_data_get_log_type(config: *const zvec_config_data_t) -> zvec_log_type_t;
592    pub fn zvec_config_data_set_query_thread_count(
593        config: *mut zvec_config_data_t,
594        thread_count: u32,
595    ) -> zvec_error_code_t;
596    pub fn zvec_config_data_get_query_thread_count(config: *const zvec_config_data_t) -> u32;
597    pub fn zvec_config_data_set_invert_to_forward_scan_ratio(
598        config: *mut zvec_config_data_t,
599        ratio: f32,
600    ) -> zvec_error_code_t;
601    pub fn zvec_config_data_get_invert_to_forward_scan_ratio(
602        config: *const zvec_config_data_t,
603    ) -> f32;
604    pub fn zvec_config_data_set_brute_force_by_keys_ratio(
605        config: *mut zvec_config_data_t,
606        ratio: f32,
607    ) -> zvec_error_code_t;
608    pub fn zvec_config_data_get_brute_force_by_keys_ratio(config: *const zvec_config_data_t)
609        -> f32;
610    pub fn zvec_config_data_set_fts_brute_force_by_keys_ratio(
611        config: *mut zvec_config_data_t,
612        ratio: f32,
613    ) -> zvec_error_code_t;
614    pub fn zvec_config_data_get_fts_brute_force_by_keys_ratio(
615        config: *const zvec_config_data_t,
616    ) -> f32;
617    pub fn zvec_config_data_set_optimize_thread_count(
618        config: *mut zvec_config_data_t,
619        thread_count: u32,
620    ) -> zvec_error_code_t;
621    pub fn zvec_config_data_get_optimize_thread_count(config: *const zvec_config_data_t) -> u32;
622
623    // -------------------------------------------------------------------------
624    // Initialization
625    // Functions for initializing and shutting down the library.
626    // -------------------------------------------------------------------------
627    pub fn zvec_initialize(config: *const zvec_config_data_t) -> zvec_error_code_t;
628    pub fn zvec_shutdown() -> zvec_error_code_t;
629    pub fn zvec_is_initialized() -> bool;
630
631    // -------------------------------------------------------------------------
632    // I/O Backend Introspection
633    // Reports the backend used for DiskAnn disk reads.
634    // -------------------------------------------------------------------------
635    pub fn zvec_get_io_backend_type() -> zvec_io_backend_type_t;
636    pub fn zvec_get_io_backend_type_name(backend_type: zvec_io_backend_type_t) -> *const c_char;
637    pub fn zvec_get_io_backend_description() -> *const c_char;
638
639    // -------------------------------------------------------------------------
640    // Index Parameters
641    // Functions for creating and configuring index parameters.
642    // -------------------------------------------------------------------------
643    pub fn zvec_index_params_create(index_type: zvec_index_type_t) -> *mut zvec_index_params_t;
644    pub fn zvec_index_params_destroy(params: *mut zvec_index_params_t);
645    pub fn zvec_index_params_get_type(params: *const zvec_index_params_t) -> zvec_index_type_t;
646    pub fn zvec_index_params_set_metric_type(
647        params: *mut zvec_index_params_t,
648        metric_type: zvec_metric_type_t,
649    ) -> zvec_error_code_t;
650    pub fn zvec_index_params_get_metric_type(
651        params: *const zvec_index_params_t,
652    ) -> zvec_metric_type_t;
653    pub fn zvec_index_params_set_quantize_type(
654        params: *mut zvec_index_params_t,
655        quantize_type: zvec_quantize_type_t,
656    ) -> zvec_error_code_t;
657    pub fn zvec_index_params_get_quantize_type(
658        params: *const zvec_index_params_t,
659    ) -> zvec_quantize_type_t;
660    pub fn zvec_index_params_set_quantizer_enable_rotate(
661        params: *mut zvec_index_params_t,
662        enable_rotate: bool,
663    ) -> zvec_error_code_t;
664    pub fn zvec_index_params_get_quantizer_enable_rotate(
665        params: *const zvec_index_params_t,
666    ) -> bool;
667    pub fn zvec_index_params_set_hnsw_params(
668        params: *mut zvec_index_params_t,
669        m: c_int,
670        ef_construction: c_int,
671    ) -> zvec_error_code_t;
672    pub fn zvec_index_params_get_hnsw_m(params: *const zvec_index_params_t) -> c_int;
673    pub fn zvec_index_params_get_hnsw_ef_construction(params: *const zvec_index_params_t) -> c_int;
674    pub fn zvec_index_params_set_ivf_params(
675        params: *mut zvec_index_params_t,
676        n_list: c_int,
677        n_iters: c_int,
678        use_soar: bool,
679    ) -> zvec_error_code_t;
680    pub fn zvec_index_params_get_ivf_params(
681        params: *const zvec_index_params_t,
682        out_n_list: *mut c_int,
683        out_n_iters: *mut c_int,
684        out_use_soar: *mut bool,
685    ) -> zvec_error_code_t;
686    pub fn zvec_index_params_set_vamana_params(
687        params: *mut zvec_index_params_t,
688        max_degree: c_int,
689        search_list_size: c_int,
690        alpha: f32,
691        saturate_graph: bool,
692        use_contiguous_memory: bool,
693    ) -> zvec_error_code_t;
694    pub fn zvec_index_params_get_vamana_params(
695        params: *const zvec_index_params_t,
696        out_max_degree: *mut c_int,
697        out_search_list_size: *mut c_int,
698        out_alpha: *mut f32,
699        out_saturate_graph: *mut bool,
700        out_use_contiguous_memory: *mut bool,
701    ) -> zvec_error_code_t;
702    pub fn zvec_index_params_set_vamana_two_pass_build(
703        params: *mut zvec_index_params_t,
704        two_pass_build: bool,
705    ) -> zvec_error_code_t;
706    pub fn zvec_index_params_get_vamana_two_pass_build(params: *const zvec_index_params_t) -> bool;
707    pub fn zvec_index_params_set_diskann_params(
708        params: *mut zvec_index_params_t,
709        max_degree: c_int,
710        list_size: c_int,
711        pq_chunk_num: c_int,
712    ) -> zvec_error_code_t;
713    pub fn zvec_index_params_get_diskann_max_degree(params: *const zvec_index_params_t) -> c_int;
714    pub fn zvec_index_params_get_diskann_list_size(params: *const zvec_index_params_t) -> c_int;
715    pub fn zvec_index_params_get_diskann_pq_chunk_num(params: *const zvec_index_params_t) -> c_int;
716    pub fn zvec_index_params_set_ivf_rabitq_params(
717        params: *mut zvec_index_params_t,
718        nlist: c_int,
719        total_bits: c_int,
720        sample_count: c_int,
721    ) -> zvec_error_code_t;
722    pub fn zvec_index_params_get_ivf_rabitq_params(
723        params: *const zvec_index_params_t,
724        out_nlist: *mut c_int,
725        out_total_bits: *mut c_int,
726        out_sample_count: *mut c_int,
727    ) -> zvec_error_code_t;
728    pub fn zvec_index_params_set_invert_params(
729        params: *mut zvec_index_params_t,
730        enable_range_opt: bool,
731        enable_wildcard: bool,
732    ) -> zvec_error_code_t;
733    pub fn zvec_index_params_get_invert_params(
734        params: *const zvec_index_params_t,
735        out_enable_range_opt: *mut bool,
736        out_enable_wildcard: *mut bool,
737    ) -> zvec_error_code_t;
738    pub fn zvec_index_params_set_fts_params(
739        params: *mut zvec_index_params_t,
740        tokenizer_name: *const c_char,
741        filters: *const zvec_string_array_t,
742        extra_params: *const c_char,
743    ) -> zvec_error_code_t;
744    pub fn zvec_index_params_get_fts_params(
745        params: *const zvec_index_params_t,
746        out_tokenizer_name: *mut *const c_char,
747        out_filters: *mut *mut zvec_string_array_t,
748        out_extra_params: *mut *const c_char,
749    ) -> zvec_error_code_t;
750
751    // -------------------------------------------------------------------------
752    // Field Schema
753    // Functions for creating and managing field schema definitions.
754    // -------------------------------------------------------------------------
755    pub fn zvec_field_schema_create(
756        name: *const c_char,
757        data_type: zvec_data_type_t,
758        nullable: bool,
759        dimension: u32,
760    ) -> *mut zvec_field_schema_t;
761    pub fn zvec_field_schema_destroy(schema: *mut zvec_field_schema_t);
762    pub fn zvec_field_schema_set_name(
763        schema: *mut zvec_field_schema_t,
764        name: *const c_char,
765    ) -> zvec_error_code_t;
766    pub fn zvec_field_schema_get_name(schema: *const zvec_field_schema_t) -> *const c_char;
767    pub fn zvec_field_schema_get_data_type(schema: *const zvec_field_schema_t) -> zvec_data_type_t;
768    pub fn zvec_field_schema_set_data_type(
769        schema: *mut zvec_field_schema_t,
770        data_type: zvec_data_type_t,
771    ) -> zvec_error_code_t;
772    pub fn zvec_field_schema_get_element_data_type(
773        schema: *const zvec_field_schema_t,
774    ) -> zvec_data_type_t;
775    pub fn zvec_field_schema_get_element_data_size(schema: *const zvec_field_schema_t) -> usize;
776    pub fn zvec_field_schema_is_vector_field(schema: *const zvec_field_schema_t) -> bool;
777    pub fn zvec_field_schema_is_dense_vector(schema: *const zvec_field_schema_t) -> bool;
778    pub fn zvec_field_schema_is_sparse_vector(schema: *const zvec_field_schema_t) -> bool;
779    pub fn zvec_field_schema_is_nullable(schema: *const zvec_field_schema_t) -> bool;
780    pub fn zvec_field_schema_set_nullable(
781        schema: *mut zvec_field_schema_t,
782        nullable: bool,
783    ) -> zvec_error_code_t;
784    pub fn zvec_field_schema_has_invert_index(schema: *const zvec_field_schema_t) -> bool;
785    pub fn zvec_field_schema_is_array_type(schema: *const zvec_field_schema_t) -> bool;
786    pub fn zvec_field_schema_get_dimension(schema: *const zvec_field_schema_t) -> u32;
787    pub fn zvec_field_schema_set_dimension(
788        schema: *mut zvec_field_schema_t,
789        dimension: u32,
790    ) -> zvec_error_code_t;
791    pub fn zvec_field_schema_get_index_type(
792        schema: *const zvec_field_schema_t,
793    ) -> zvec_index_type_t;
794    pub fn zvec_field_schema_has_index(schema: *const zvec_field_schema_t) -> bool;
795    pub fn zvec_field_schema_get_index_params(
796        schema: *const zvec_field_schema_t,
797    ) -> *const zvec_index_params_t;
798    pub fn zvec_field_schema_set_index_params(
799        schema: *mut zvec_field_schema_t,
800        index_params: *const zvec_index_params_t,
801    ) -> zvec_error_code_t;
802    pub fn zvec_field_schema_validate(
803        schema: *const zvec_field_schema_t,
804        error_msg: *mut *mut zvec_string_t,
805    ) -> zvec_error_code_t;
806
807    // -------------------------------------------------------------------------
808    // Collection Schema
809    // Functions for creating and managing collection schema definitions.
810    // -------------------------------------------------------------------------
811    pub fn zvec_collection_schema_create(name: *const c_char) -> *mut zvec_collection_schema_t;
812    pub fn zvec_collection_schema_destroy(schema: *mut zvec_collection_schema_t);
813    pub fn zvec_collection_schema_get_name(
814        schema: *const zvec_collection_schema_t,
815    ) -> *const c_char;
816    pub fn zvec_collection_schema_set_name(
817        schema: *mut zvec_collection_schema_t,
818        name: *const c_char,
819    ) -> zvec_error_code_t;
820    pub fn zvec_collection_schema_add_field(
821        schema: *mut zvec_collection_schema_t,
822        field: *const zvec_field_schema_t,
823    ) -> zvec_error_code_t;
824    pub fn zvec_collection_schema_alter_field(
825        schema: *mut zvec_collection_schema_t,
826        field_name: *const c_char,
827        new_field: *const zvec_field_schema_t,
828    ) -> zvec_error_code_t;
829    pub fn zvec_collection_schema_drop_field(
830        schema: *mut zvec_collection_schema_t,
831        field_name: *const c_char,
832    ) -> zvec_error_code_t;
833    pub fn zvec_collection_schema_has_field(
834        schema: *const zvec_collection_schema_t,
835        field_name: *const c_char,
836    ) -> bool;
837    pub fn zvec_collection_schema_get_field(
838        schema: *const zvec_collection_schema_t,
839        field_name: *const c_char,
840    ) -> *mut zvec_field_schema_t;
841    pub fn zvec_collection_schema_get_forward_field(
842        schema: *const zvec_collection_schema_t,
843        field_name: *const c_char,
844    ) -> *mut zvec_field_schema_t;
845    pub fn zvec_collection_schema_get_vector_field(
846        schema: *const zvec_collection_schema_t,
847        field_name: *const c_char,
848    ) -> *mut zvec_field_schema_t;
849    pub fn zvec_collection_schema_get_forward_fields(
850        schema: *const zvec_collection_schema_t,
851        fields: *mut *mut *mut zvec_field_schema_t,
852        count: *mut usize,
853    ) -> zvec_error_code_t;
854    pub fn zvec_collection_schema_get_forward_fields_with_index(
855        schema: *const zvec_collection_schema_t,
856        fields: *mut *mut *mut zvec_field_schema_t,
857        count: *mut usize,
858    ) -> zvec_error_code_t;
859    pub fn zvec_collection_schema_get_forward_field_names(
860        schema: *const zvec_collection_schema_t,
861        names: *mut *mut *const c_char,
862        count: *mut usize,
863    ) -> zvec_error_code_t;
864    pub fn zvec_collection_schema_get_forward_field_names_with_index(
865        schema: *const zvec_collection_schema_t,
866        names: *mut *mut *const c_char,
867        count: *mut usize,
868    ) -> zvec_error_code_t;
869    pub fn zvec_collection_schema_get_all_field_names(
870        schema: *const zvec_collection_schema_t,
871        names: *mut *mut *const c_char,
872        count: *mut usize,
873    ) -> zvec_error_code_t;
874    pub fn zvec_collection_schema_get_vector_fields(
875        schema: *const zvec_collection_schema_t,
876        fields: *mut *mut *mut zvec_field_schema_t,
877        count: *mut usize,
878    ) -> zvec_error_code_t;
879    pub fn zvec_collection_schema_get_max_doc_count_per_segment(
880        schema: *const zvec_collection_schema_t,
881    ) -> u64;
882    pub fn zvec_collection_schema_set_max_doc_count_per_segment(
883        schema: *mut zvec_collection_schema_t,
884        max_doc_count: u64,
885    ) -> zvec_error_code_t;
886    pub fn zvec_collection_schema_validate(
887        schema: *const zvec_collection_schema_t,
888        error_msg: *mut *mut zvec_string_t,
889    ) -> zvec_error_code_t;
890    pub fn zvec_collection_schema_add_index(
891        schema: *mut zvec_collection_schema_t,
892        field_name: *const c_char,
893        index_params: *const zvec_index_params_t,
894    ) -> zvec_error_code_t;
895    pub fn zvec_collection_schema_drop_index(
896        schema: *mut zvec_collection_schema_t,
897        field_name: *const c_char,
898    ) -> zvec_error_code_t;
899    pub fn zvec_collection_schema_has_index(
900        schema: *const zvec_collection_schema_t,
901        field_name: *const c_char,
902    ) -> bool;
903
904    // -------------------------------------------------------------------------
905    // Collection Options
906    // Functions for configuring collection opening options.
907    // -------------------------------------------------------------------------
908    pub fn zvec_collection_options_create() -> *mut zvec_collection_options_t;
909    pub fn zvec_collection_options_destroy(options: *mut zvec_collection_options_t);
910    pub fn zvec_collection_options_set_enable_mmap(
911        options: *mut zvec_collection_options_t,
912        enable: bool,
913    ) -> zvec_error_code_t;
914    pub fn zvec_collection_options_get_enable_mmap(
915        options: *const zvec_collection_options_t,
916    ) -> bool;
917    pub fn zvec_collection_options_set_max_buffer_size(
918        options: *mut zvec_collection_options_t,
919        size: usize,
920    ) -> zvec_error_code_t;
921    pub fn zvec_collection_options_get_max_buffer_size(
922        options: *const zvec_collection_options_t,
923    ) -> usize;
924    pub fn zvec_collection_options_set_read_only(
925        options: *mut zvec_collection_options_t,
926        read_only: bool,
927    ) -> zvec_error_code_t;
928    pub fn zvec_collection_options_get_read_only(options: *const zvec_collection_options_t)
929        -> bool;
930
931    // -------------------------------------------------------------------------
932    // Collection Statistics
933    // Functions for retrieving collection statistics.
934    // -------------------------------------------------------------------------
935    pub fn zvec_collection_stats_get_doc_count(stats: *const zvec_collection_stats_t) -> u64;
936    pub fn zvec_collection_stats_get_index_count(stats: *const zvec_collection_stats_t) -> usize;
937    pub fn zvec_collection_stats_get_index_name(
938        stats: *const zvec_collection_stats_t,
939        index: usize,
940    ) -> *const c_char;
941    pub fn zvec_collection_stats_get_index_completeness(
942        stats: *const zvec_collection_stats_t,
943        index: usize,
944    ) -> f32;
945    pub fn zvec_collection_stats_destroy(stats: *mut zvec_collection_stats_t);
946
947    // -------------------------------------------------------------------------
948    // Collection Management
949    // Functions for creating, opening, closing, and destroying collections.
950    // -------------------------------------------------------------------------
951    pub fn zvec_collection_create_and_open(
952        path: *const c_char,
953        schema: *const zvec_collection_schema_t,
954        options: *const zvec_collection_options_t,
955        collection: *mut *mut zvec_collection_t,
956    ) -> zvec_error_code_t;
957    pub fn zvec_collection_open(
958        path: *const c_char,
959        options: *const zvec_collection_options_t,
960        collection: *mut *mut zvec_collection_t,
961    ) -> zvec_error_code_t;
962    pub fn zvec_collection_close(collection: *mut zvec_collection_t) -> zvec_error_code_t;
963    pub fn zvec_collection_destroy(collection: *mut zvec_collection_t) -> zvec_error_code_t;
964    pub fn zvec_collection_flush(collection: *mut zvec_collection_t) -> zvec_error_code_t;
965    pub fn zvec_collection_get_schema(
966        collection: *const zvec_collection_t,
967        schema: *mut *mut zvec_collection_schema_t,
968    ) -> zvec_error_code_t;
969    pub fn zvec_collection_get_options(
970        collection: *const zvec_collection_t,
971        options: *mut *mut zvec_collection_options_t,
972    ) -> zvec_error_code_t;
973    pub fn zvec_collection_get_stats(
974        collection: *const zvec_collection_t,
975        stats: *mut *mut zvec_collection_stats_t,
976    ) -> zvec_error_code_t;
977    pub fn zvec_free_field_schema(field_schema: *mut zvec_field_schema_t);
978
979    // -------------------------------------------------------------------------
980    // Index Management
981    // Functions for creating, dropping, and optimizing indexes.
982    // -------------------------------------------------------------------------
983    pub fn zvec_collection_create_index(
984        collection: *mut zvec_collection_t,
985        field_name: *const c_char,
986        index_params: *const zvec_index_params_t,
987    ) -> zvec_error_code_t;
988    pub fn zvec_collection_drop_index(
989        collection: *mut zvec_collection_t,
990        field_name: *const c_char,
991    ) -> zvec_error_code_t;
992    pub fn zvec_collection_optimize(collection: *mut zvec_collection_t) -> zvec_error_code_t;
993
994    // -------------------------------------------------------------------------
995    // Column Management (DDL)
996    // Functions for adding, dropping, and altering columns (schema changes).
997    // -------------------------------------------------------------------------
998    pub fn zvec_collection_add_column(
999        collection: *mut zvec_collection_t,
1000        field_schema: *const zvec_field_schema_t,
1001        expression: *const c_char,
1002    ) -> zvec_error_code_t;
1003    pub fn zvec_collection_drop_column(
1004        collection: *mut zvec_collection_t,
1005        column_name: *const c_char,
1006    ) -> zvec_error_code_t;
1007    pub fn zvec_collection_alter_column(
1008        collection: *mut zvec_collection_t,
1009        column_name: *const c_char,
1010        new_name: *const c_char,
1011        new_schema: *const zvec_field_schema_t,
1012    ) -> zvec_error_code_t;
1013
1014    // -------------------------------------------------------------------------
1015    // DML
1016    // Functions for data manipulation: insert, update, upsert, and delete operations.
1017    // -------------------------------------------------------------------------
1018    pub fn zvec_collection_insert(
1019        collection: *mut zvec_collection_t,
1020        docs: *const *const zvec_doc_t,
1021        doc_count: usize,
1022        success_count: *mut usize,
1023        error_count: *mut usize,
1024    ) -> zvec_error_code_t;
1025    pub fn zvec_collection_insert_with_results(
1026        collection: *mut zvec_collection_t,
1027        docs: *const *const zvec_doc_t,
1028        doc_count: usize,
1029        results: *mut *mut zvec_write_result_t,
1030        result_count: *mut usize,
1031    ) -> zvec_error_code_t;
1032    pub fn zvec_collection_update(
1033        collection: *mut zvec_collection_t,
1034        docs: *const *const zvec_doc_t,
1035        doc_count: usize,
1036        success_count: *mut usize,
1037        error_count: *mut usize,
1038    ) -> zvec_error_code_t;
1039    pub fn zvec_collection_update_with_results(
1040        collection: *mut zvec_collection_t,
1041        docs: *const *const zvec_doc_t,
1042        doc_count: usize,
1043        results: *mut *mut zvec_write_result_t,
1044        result_count: *mut usize,
1045    ) -> zvec_error_code_t;
1046    pub fn zvec_collection_upsert(
1047        collection: *mut zvec_collection_t,
1048        docs: *const *const zvec_doc_t,
1049        doc_count: usize,
1050        success_count: *mut usize,
1051        error_count: *mut usize,
1052    ) -> zvec_error_code_t;
1053    pub fn zvec_collection_upsert_with_results(
1054        collection: *mut zvec_collection_t,
1055        docs: *const *const zvec_doc_t,
1056        doc_count: usize,
1057        results: *mut *mut zvec_write_result_t,
1058        result_count: *mut usize,
1059    ) -> zvec_error_code_t;
1060    pub fn zvec_collection_delete(
1061        collection: *mut zvec_collection_t,
1062        pks: *const *const c_char,
1063        pk_count: usize,
1064        success_count: *mut usize,
1065        error_count: *mut usize,
1066    ) -> zvec_error_code_t;
1067    pub fn zvec_collection_delete_with_results(
1068        collection: *mut zvec_collection_t,
1069        pks: *const *const c_char,
1070        pk_count: usize,
1071        results: *mut *mut zvec_write_result_t,
1072        result_count: *mut usize,
1073    ) -> zvec_error_code_t;
1074    pub fn zvec_write_results_free(results: *mut zvec_write_result_t, result_count: usize);
1075    pub fn zvec_collection_delete_by_filter(
1076        collection: *mut zvec_collection_t,
1077        filter: *const c_char,
1078    ) -> zvec_error_code_t;
1079
1080    // -------------------------------------------------------------------------
1081    // DQL
1082    // Functions for data querying: vector search and document fetch operations.
1083    // -------------------------------------------------------------------------
1084    pub fn zvec_collection_query(
1085        collection: *const zvec_collection_t,
1086        query: *const zvec_vector_query_t,
1087        results: *mut *mut *mut zvec_doc_t,
1088        result_count: *mut usize,
1089    ) -> zvec_error_code_t;
1090    pub fn zvec_collection_multi_query(
1091        collection: *const zvec_collection_t,
1092        query: *const zvec_multi_query_t,
1093        results: *mut *mut *mut zvec_doc_t,
1094        result_count: *mut usize,
1095    ) -> zvec_error_code_t;
1096    pub fn zvec_collection_fetch(
1097        collection: *mut zvec_collection_t,
1098        primary_keys: *const *const c_char,
1099        count: usize,
1100        output_fields: *const *const c_char,
1101        output_field_count: usize,
1102        include_vector: bool,
1103        documents: *mut *mut *mut zvec_doc_t,
1104        found_count: *mut usize,
1105    ) -> zvec_error_code_t;
1106
1107    // -------------------------------------------------------------------------
1108    // Document Iterator
1109    // Functions for full collection traversal over an isolated snapshot.
1110    // -------------------------------------------------------------------------
1111    pub fn zvec_iterator_options_create() -> *mut zvec_iterator_options_t;
1112    pub fn zvec_iterator_options_destroy(options: *mut zvec_iterator_options_t);
1113    pub fn zvec_iterator_options_set_output_fields(
1114        options: *mut zvec_iterator_options_t,
1115        output_fields: *const *const c_char,
1116        count: usize,
1117    ) -> zvec_error_code_t;
1118    pub fn zvec_iterator_options_set_include_vector(
1119        options: *mut zvec_iterator_options_t,
1120        include: bool,
1121    ) -> zvec_error_code_t;
1122    pub fn zvec_collection_create_iterator(
1123        collection: *mut zvec_collection_t,
1124        options: *const zvec_iterator_options_t,
1125        out_iter: *mut *mut zvec_doc_iterator_t,
1126    ) -> zvec_error_code_t;
1127    pub fn zvec_doc_iterator_next(
1128        iter: *mut zvec_doc_iterator_t,
1129        out_doc: *mut *mut zvec_doc_t,
1130    ) -> zvec_error_code_t;
1131    pub fn zvec_doc_iterator_close(iter: *mut zvec_doc_iterator_t);
1132
1133    // -------------------------------------------------------------------------
1134    // HNSW Query Parameters
1135    // Functions for creating and configuring HNSW index query parameters.
1136    // -------------------------------------------------------------------------
1137    pub fn zvec_query_params_hnsw_create(
1138        ef: c_int,
1139        radius: f32,
1140        is_linear: bool,
1141        is_using_refiner: bool,
1142    ) -> *mut zvec_hnsw_query_params_t;
1143    pub fn zvec_query_params_hnsw_destroy(params: *mut zvec_hnsw_query_params_t);
1144    pub fn zvec_query_params_hnsw_set_ef(
1145        params: *mut zvec_hnsw_query_params_t,
1146        ef: c_int,
1147    ) -> zvec_error_code_t;
1148    pub fn zvec_query_params_hnsw_get_ef(params: *const zvec_hnsw_query_params_t) -> c_int;
1149    pub fn zvec_query_params_hnsw_set_radius(
1150        params: *mut zvec_hnsw_query_params_t,
1151        radius: f32,
1152    ) -> zvec_error_code_t;
1153    pub fn zvec_query_params_hnsw_get_radius(params: *const zvec_hnsw_query_params_t) -> f32;
1154    pub fn zvec_query_params_hnsw_set_is_linear(
1155        params: *mut zvec_hnsw_query_params_t,
1156        is_linear: bool,
1157    ) -> zvec_error_code_t;
1158    pub fn zvec_query_params_hnsw_get_is_linear(params: *const zvec_hnsw_query_params_t) -> bool;
1159    pub fn zvec_query_params_hnsw_set_is_using_refiner(
1160        params: *mut zvec_hnsw_query_params_t,
1161        is_using_refiner: bool,
1162    ) -> zvec_error_code_t;
1163    pub fn zvec_query_params_hnsw_get_is_using_refiner(
1164        params: *const zvec_hnsw_query_params_t,
1165    ) -> bool;
1166
1167    // -------------------------------------------------------------------------
1168    // IVF Query Parameters
1169    // Functions for creating and configuring IVF index query parameters.
1170    // -------------------------------------------------------------------------
1171    pub fn zvec_query_params_ivf_create(
1172        nprobe: c_int,
1173        is_using_refiner: bool,
1174        scale_factor: f32,
1175    ) -> *mut zvec_ivf_query_params_t;
1176    pub fn zvec_query_params_ivf_destroy(params: *mut zvec_ivf_query_params_t);
1177    pub fn zvec_query_params_ivf_set_nprobe(
1178        params: *mut zvec_ivf_query_params_t,
1179        nprobe: c_int,
1180    ) -> zvec_error_code_t;
1181    pub fn zvec_query_params_ivf_get_nprobe(params: *const zvec_ivf_query_params_t) -> c_int;
1182    pub fn zvec_query_params_ivf_set_scale_factor(
1183        params: *mut zvec_ivf_query_params_t,
1184        scale_factor: f32,
1185    ) -> zvec_error_code_t;
1186    pub fn zvec_query_params_ivf_get_scale_factor(params: *const zvec_ivf_query_params_t) -> f32;
1187    pub fn zvec_query_params_ivf_set_radius(
1188        params: *mut zvec_ivf_query_params_t,
1189        radius: f32,
1190    ) -> zvec_error_code_t;
1191    pub fn zvec_query_params_ivf_get_radius(params: *const zvec_ivf_query_params_t) -> f32;
1192    pub fn zvec_query_params_ivf_set_is_linear(
1193        params: *mut zvec_ivf_query_params_t,
1194        is_linear: bool,
1195    ) -> zvec_error_code_t;
1196    pub fn zvec_query_params_ivf_get_is_linear(params: *const zvec_ivf_query_params_t) -> bool;
1197    pub fn zvec_query_params_ivf_set_is_using_refiner(
1198        params: *mut zvec_ivf_query_params_t,
1199        is_using_refiner: bool,
1200    ) -> zvec_error_code_t;
1201    pub fn zvec_query_params_ivf_get_is_using_refiner(
1202        params: *const zvec_ivf_query_params_t,
1203    ) -> bool;
1204
1205    // -------------------------------------------------------------------------
1206    // IVF RaBitQ Query Parameters
1207    // Functions for creating and configuring IVF RaBitQ index query parameters.
1208    // -------------------------------------------------------------------------
1209    pub fn zvec_query_params_ivf_rabitq_create(
1210        nprobe: c_int,
1211        radius: f32,
1212        is_linear: bool,
1213        is_using_refiner: bool,
1214    ) -> *mut zvec_ivf_rabitq_query_params_t;
1215    pub fn zvec_query_params_ivf_rabitq_destroy(params: *mut zvec_ivf_rabitq_query_params_t);
1216    pub fn zvec_query_params_ivf_rabitq_set_nprobe(
1217        params: *mut zvec_ivf_rabitq_query_params_t,
1218        nprobe: c_int,
1219    ) -> zvec_error_code_t;
1220    pub fn zvec_query_params_ivf_rabitq_get_nprobe(
1221        params: *const zvec_ivf_rabitq_query_params_t,
1222    ) -> c_int;
1223    pub fn zvec_query_params_ivf_rabitq_set_scale_factor(
1224        params: *mut zvec_ivf_rabitq_query_params_t,
1225        scale_factor: f32,
1226    ) -> zvec_error_code_t;
1227    pub fn zvec_query_params_ivf_rabitq_get_scale_factor(
1228        params: *const zvec_ivf_rabitq_query_params_t,
1229    ) -> f32;
1230    pub fn zvec_query_params_ivf_rabitq_set_radius(
1231        params: *mut zvec_ivf_rabitq_query_params_t,
1232        radius: f32,
1233    ) -> zvec_error_code_t;
1234    pub fn zvec_query_params_ivf_rabitq_get_radius(
1235        params: *const zvec_ivf_rabitq_query_params_t,
1236    ) -> f32;
1237    pub fn zvec_query_params_ivf_rabitq_set_is_linear(
1238        params: *mut zvec_ivf_rabitq_query_params_t,
1239        is_linear: bool,
1240    ) -> zvec_error_code_t;
1241    pub fn zvec_query_params_ivf_rabitq_get_is_linear(
1242        params: *const zvec_ivf_rabitq_query_params_t,
1243    ) -> bool;
1244    pub fn zvec_query_params_ivf_rabitq_set_is_using_refiner(
1245        params: *mut zvec_ivf_rabitq_query_params_t,
1246        is_using_refiner: bool,
1247    ) -> zvec_error_code_t;
1248    pub fn zvec_query_params_ivf_rabitq_get_is_using_refiner(
1249        params: *const zvec_ivf_rabitq_query_params_t,
1250    ) -> bool;
1251
1252    // -------------------------------------------------------------------------
1253    // Flat Query Parameters
1254    // Functions for creating and configuring flat index query parameters.
1255    // -------------------------------------------------------------------------
1256    pub fn zvec_query_params_flat_create(
1257        is_using_refiner: bool,
1258        scale_factor: f32,
1259    ) -> *mut zvec_flat_query_params_t;
1260    pub fn zvec_query_params_flat_destroy(params: *mut zvec_flat_query_params_t);
1261    pub fn zvec_query_params_flat_set_scale_factor(
1262        params: *mut zvec_flat_query_params_t,
1263        scale_factor: f32,
1264    ) -> zvec_error_code_t;
1265    pub fn zvec_query_params_flat_get_scale_factor(params: *const zvec_flat_query_params_t) -> f32;
1266    pub fn zvec_query_params_flat_set_radius(
1267        params: *mut zvec_flat_query_params_t,
1268        radius: f32,
1269    ) -> zvec_error_code_t;
1270    pub fn zvec_query_params_flat_get_radius(params: *const zvec_flat_query_params_t) -> f32;
1271    pub fn zvec_query_params_flat_set_is_linear(
1272        params: *mut zvec_flat_query_params_t,
1273        is_linear: bool,
1274    ) -> zvec_error_code_t;
1275    pub fn zvec_query_params_flat_get_is_linear(params: *const zvec_flat_query_params_t) -> bool;
1276    pub fn zvec_query_params_flat_set_is_using_refiner(
1277        params: *mut zvec_flat_query_params_t,
1278        is_using_refiner: bool,
1279    ) -> zvec_error_code_t;
1280    pub fn zvec_query_params_flat_get_is_using_refiner(
1281        params: *const zvec_flat_query_params_t,
1282    ) -> bool;
1283
1284    // -------------------------------------------------------------------------
1285    // Vamana Query Parameters
1286    // Functions for creating and configuring Vamana query parameters.
1287    // -------------------------------------------------------------------------
1288    pub fn zvec_query_params_vamana_create(
1289        ef_search: c_int,
1290        radius: f32,
1291        is_linear: bool,
1292        is_using_refiner: bool,
1293    ) -> *mut zvec_vamana_query_params_t;
1294    pub fn zvec_query_params_vamana_destroy(params: *mut zvec_vamana_query_params_t);
1295    pub fn zvec_query_params_vamana_set_ef_search(
1296        params: *mut zvec_vamana_query_params_t,
1297        ef_search: c_int,
1298    ) -> zvec_error_code_t;
1299    pub fn zvec_query_params_vamana_get_ef_search(
1300        params: *const zvec_vamana_query_params_t,
1301    ) -> c_int;
1302    pub fn zvec_query_params_vamana_set_radius(
1303        params: *mut zvec_vamana_query_params_t,
1304        radius: f32,
1305    ) -> zvec_error_code_t;
1306    pub fn zvec_query_params_vamana_get_radius(params: *const zvec_vamana_query_params_t) -> f32;
1307    pub fn zvec_query_params_vamana_set_is_linear(
1308        params: *mut zvec_vamana_query_params_t,
1309        is_linear: bool,
1310    ) -> zvec_error_code_t;
1311    pub fn zvec_query_params_vamana_get_is_linear(
1312        params: *const zvec_vamana_query_params_t,
1313    ) -> bool;
1314    pub fn zvec_query_params_vamana_set_is_using_refiner(
1315        params: *mut zvec_vamana_query_params_t,
1316        is_using_refiner: bool,
1317    ) -> zvec_error_code_t;
1318    pub fn zvec_query_params_vamana_get_is_using_refiner(
1319        params: *const zvec_vamana_query_params_t,
1320    ) -> bool;
1321
1322    // -------------------------------------------------------------------------
1323    // DiskANN Query Parameters
1324    // Functions for creating and configuring DiskANN query parameters.
1325    // -------------------------------------------------------------------------
1326    pub fn zvec_query_params_diskann_create(list_size: c_int) -> *mut zvec_diskann_query_params_t;
1327    pub fn zvec_query_params_diskann_destroy(params: *mut zvec_diskann_query_params_t);
1328    pub fn zvec_query_params_diskann_set_list_size(
1329        params: *mut zvec_diskann_query_params_t,
1330        list_size: c_int,
1331    ) -> zvec_error_code_t;
1332    pub fn zvec_query_params_diskann_get_list_size(
1333        params: *const zvec_diskann_query_params_t,
1334    ) -> c_int;
1335    pub fn zvec_query_params_diskann_set_radius(
1336        params: *mut zvec_diskann_query_params_t,
1337        radius: f32,
1338    ) -> zvec_error_code_t;
1339    pub fn zvec_query_params_diskann_get_radius(params: *const zvec_diskann_query_params_t) -> f32;
1340    pub fn zvec_query_params_diskann_set_is_linear(
1341        params: *mut zvec_diskann_query_params_t,
1342        is_linear: bool,
1343    ) -> zvec_error_code_t;
1344    pub fn zvec_query_params_diskann_get_is_linear(
1345        params: *const zvec_diskann_query_params_t,
1346    ) -> bool;
1347    pub fn zvec_query_params_diskann_set_is_using_refiner(
1348        params: *mut zvec_diskann_query_params_t,
1349        is_using_refiner: bool,
1350    ) -> zvec_error_code_t;
1351    pub fn zvec_query_params_diskann_get_is_using_refiner(
1352        params: *const zvec_diskann_query_params_t,
1353    ) -> bool;
1354
1355    // -------------------------------------------------------------------------
1356    // FTS Query Parameters
1357    // Functions for creating and configuring FTS query parameters.
1358    // -------------------------------------------------------------------------
1359    pub fn zvec_query_params_fts_create(
1360        default_operator: *const c_char,
1361    ) -> *mut zvec_fts_query_params_t;
1362    pub fn zvec_query_params_fts_destroy(params: *mut zvec_fts_query_params_t);
1363    pub fn zvec_query_params_fts_set_default_operator(
1364        params: *mut zvec_fts_query_params_t,
1365        default_operator: *const c_char,
1366    ) -> zvec_error_code_t;
1367    pub fn zvec_query_params_fts_get_default_operator(
1368        params: *const zvec_fts_query_params_t,
1369    ) -> *const c_char;
1370
1371    // -------------------------------------------------------------------------
1372    // FTS Query Payload
1373    // Functions for creating and configuring FTS query payloads.
1374    // -------------------------------------------------------------------------
1375    pub fn zvec_fts_create() -> *mut zvec_fts_t;
1376    pub fn zvec_fts_destroy(fts: *mut zvec_fts_t);
1377    pub fn zvec_fts_set_query_string(
1378        fts: *mut zvec_fts_t,
1379        query_string: *const c_char,
1380    ) -> zvec_error_code_t;
1381    pub fn zvec_fts_set_match_string(
1382        fts: *mut zvec_fts_t,
1383        match_string: *const c_char,
1384    ) -> zvec_error_code_t;
1385    pub fn zvec_fts_get_query_string(fts: *const zvec_fts_t) -> *const c_char;
1386    pub fn zvec_fts_get_match_string(fts: *const zvec_fts_t) -> *const c_char;
1387
1388    // -------------------------------------------------------------------------
1389    // Vector Query
1390    // Functions for creating and configuring vector similarity queries.
1391    // -------------------------------------------------------------------------
1392    pub fn zvec_vector_query_create() -> *mut zvec_vector_query_t;
1393    pub fn zvec_vector_query_destroy(query: *mut zvec_vector_query_t);
1394    pub fn zvec_vector_query_set_topk(
1395        query: *mut zvec_vector_query_t,
1396        topk: c_int,
1397    ) -> zvec_error_code_t;
1398    pub fn zvec_vector_query_get_topk(query: *const zvec_vector_query_t) -> c_int;
1399    pub fn zvec_vector_query_set_field_name(
1400        query: *mut zvec_vector_query_t,
1401        field_name: *const c_char,
1402    ) -> zvec_error_code_t;
1403    pub fn zvec_vector_query_get_field_name(query: *const zvec_vector_query_t) -> *const c_char;
1404    pub fn zvec_vector_query_set_query_vector(
1405        query: *mut zvec_vector_query_t,
1406        data: *const c_void,
1407        size: usize,
1408    ) -> zvec_error_code_t;
1409    pub fn zvec_vector_query_set_filter(
1410        query: *mut zvec_vector_query_t,
1411        filter: *const c_char,
1412    ) -> zvec_error_code_t;
1413    pub fn zvec_vector_query_get_filter(query: *const zvec_vector_query_t) -> *const c_char;
1414    pub fn zvec_vector_query_set_include_vector(
1415        query: *mut zvec_vector_query_t,
1416        include: bool,
1417    ) -> zvec_error_code_t;
1418    pub fn zvec_vector_query_get_include_vector(query: *const zvec_vector_query_t) -> bool;
1419    pub fn zvec_vector_query_set_include_doc_id(
1420        query: *mut zvec_vector_query_t,
1421        include: bool,
1422    ) -> zvec_error_code_t;
1423    pub fn zvec_vector_query_get_include_doc_id(query: *const zvec_vector_query_t) -> bool;
1424    pub fn zvec_vector_query_set_output_fields(
1425        query: *mut zvec_vector_query_t,
1426        fields: *const *const c_char,
1427        count: usize,
1428    ) -> zvec_error_code_t;
1429    pub fn zvec_vector_query_get_output_fields(
1430        query: *const zvec_vector_query_t,
1431        fields: *mut *mut *const c_char,
1432        count: *mut usize,
1433    ) -> zvec_error_code_t;
1434    pub fn zvec_vector_query_set_query_params(
1435        query: *mut zvec_vector_query_t,
1436        params: *mut c_void,
1437    ) -> zvec_error_code_t;
1438    pub fn zvec_vector_query_set_hnsw_params(
1439        query: *mut zvec_vector_query_t,
1440        hnsw_params: *mut zvec_hnsw_query_params_t,
1441    ) -> zvec_error_code_t;
1442    pub fn zvec_vector_query_set_ivf_params(
1443        query: *mut zvec_vector_query_t,
1444        ivf_params: *mut zvec_ivf_query_params_t,
1445    ) -> zvec_error_code_t;
1446    pub fn zvec_vector_query_set_ivf_rabitq_params(
1447        query: *mut zvec_vector_query_t,
1448        ivf_rabitq_params: *mut zvec_ivf_rabitq_query_params_t,
1449    ) -> zvec_error_code_t;
1450    pub fn zvec_vector_query_set_flat_params(
1451        query: *mut zvec_vector_query_t,
1452        flat_params: *mut zvec_flat_query_params_t,
1453    ) -> zvec_error_code_t;
1454    pub fn zvec_vector_query_set_vamana_params(
1455        query: *mut zvec_vector_query_t,
1456        vamana_params: *mut zvec_vamana_query_params_t,
1457    ) -> zvec_error_code_t;
1458    pub fn zvec_vector_query_set_diskann_params(
1459        query: *mut zvec_vector_query_t,
1460        diskann_params: *mut zvec_diskann_query_params_t,
1461    ) -> zvec_error_code_t;
1462    pub fn zvec_vector_query_set_fts_params(
1463        query: *mut zvec_vector_query_t,
1464        fts_params: *mut zvec_fts_query_params_t,
1465    ) -> zvec_error_code_t;
1466    pub fn zvec_vector_query_set_fts(
1467        query: *mut zvec_vector_query_t,
1468        fts: *const zvec_fts_t,
1469    ) -> zvec_error_code_t;
1470    pub fn zvec_vector_query_get_fts(query: *const zvec_vector_query_t) -> *const zvec_fts_t;
1471
1472    // -------------------------------------------------------------------------
1473    // Group By Vector Query
1474    // Functions for creating and configuring grouped vector queries.
1475    // -------------------------------------------------------------------------
1476    pub fn zvec_group_by_vector_query_create() -> *mut zvec_group_by_vector_query_t;
1477    pub fn zvec_group_by_vector_query_destroy(query: *mut zvec_group_by_vector_query_t);
1478    pub fn zvec_group_by_vector_query_set_field_name(
1479        query: *mut zvec_group_by_vector_query_t,
1480        field_name: *const c_char,
1481    ) -> zvec_error_code_t;
1482    pub fn zvec_group_by_vector_query_get_field_name(
1483        query: *const zvec_group_by_vector_query_t,
1484    ) -> *const c_char;
1485    pub fn zvec_group_by_vector_query_set_group_by_field_name(
1486        query: *mut zvec_group_by_vector_query_t,
1487        field_name: *const c_char,
1488    ) -> zvec_error_code_t;
1489    pub fn zvec_group_by_vector_query_get_group_by_field_name(
1490        query: *const zvec_group_by_vector_query_t,
1491    ) -> *const c_char;
1492    pub fn zvec_group_by_vector_query_set_group_count(
1493        query: *mut zvec_group_by_vector_query_t,
1494        count: u32,
1495    ) -> zvec_error_code_t;
1496    pub fn zvec_group_by_vector_query_get_group_count(
1497        query: *const zvec_group_by_vector_query_t,
1498    ) -> u32;
1499    pub fn zvec_group_by_vector_query_set_topk_per_group(
1500        query: *mut zvec_group_by_vector_query_t,
1501        topk: u32,
1502    ) -> zvec_error_code_t;
1503    pub fn zvec_group_by_vector_query_get_topk_per_group(
1504        query: *const zvec_group_by_vector_query_t,
1505    ) -> u32;
1506    pub fn zvec_group_by_vector_query_set_query_vector(
1507        query: *mut zvec_group_by_vector_query_t,
1508        data: *const c_void,
1509        size: usize,
1510    ) -> zvec_error_code_t;
1511    pub fn zvec_group_by_vector_query_set_filter(
1512        query: *mut zvec_group_by_vector_query_t,
1513        filter: *const c_char,
1514    ) -> zvec_error_code_t;
1515    pub fn zvec_group_by_vector_query_get_filter(
1516        query: *const zvec_group_by_vector_query_t,
1517    ) -> *const c_char;
1518    pub fn zvec_group_by_vector_query_set_include_vector(
1519        query: *mut zvec_group_by_vector_query_t,
1520        include: bool,
1521    ) -> zvec_error_code_t;
1522    pub fn zvec_group_by_vector_query_get_include_vector(
1523        query: *const zvec_group_by_vector_query_t,
1524    ) -> bool;
1525    pub fn zvec_group_by_vector_query_set_output_fields(
1526        query: *mut zvec_group_by_vector_query_t,
1527        fields: *const *const c_char,
1528        count: usize,
1529    ) -> zvec_error_code_t;
1530    pub fn zvec_group_by_vector_query_get_output_fields(
1531        query: *mut zvec_group_by_vector_query_t,
1532        fields: *mut *mut *const c_char,
1533        count: *mut usize,
1534    ) -> zvec_error_code_t;
1535    pub fn zvec_group_by_vector_query_set_query_params(
1536        query: *mut zvec_group_by_vector_query_t,
1537        params: *mut c_void,
1538    ) -> zvec_error_code_t;
1539    pub fn zvec_group_by_vector_query_set_hnsw_params(
1540        query: *mut zvec_group_by_vector_query_t,
1541        hnsw_params: *mut zvec_hnsw_query_params_t,
1542    ) -> zvec_error_code_t;
1543    pub fn zvec_group_by_vector_query_set_ivf_params(
1544        query: *mut zvec_group_by_vector_query_t,
1545        ivf_params: *mut zvec_ivf_query_params_t,
1546    ) -> zvec_error_code_t;
1547    pub fn zvec_group_by_vector_query_set_ivf_rabitq_params(
1548        query: *mut zvec_group_by_vector_query_t,
1549        ivf_rabitq_params: *mut zvec_ivf_rabitq_query_params_t,
1550    ) -> zvec_error_code_t;
1551    pub fn zvec_group_by_vector_query_set_flat_params(
1552        query: *mut zvec_group_by_vector_query_t,
1553        flat_params: *mut zvec_flat_query_params_t,
1554    ) -> zvec_error_code_t;
1555    pub fn zvec_group_by_vector_query_set_vamana_params(
1556        query: *mut zvec_group_by_vector_query_t,
1557        vamana_params: *mut zvec_vamana_query_params_t,
1558    ) -> zvec_error_code_t;
1559    pub fn zvec_group_by_vector_query_set_diskann_params(
1560        query: *mut zvec_group_by_vector_query_t,
1561        diskann_params: *mut zvec_diskann_query_params_t,
1562    ) -> zvec_error_code_t;
1563
1564    // -------------------------------------------------------------------------
1565    // Multi Query / Sub Query
1566    // Functions for creating and configuring multi-queries (hybrid search with
1567    // re-ranking) and their per-field sub-queries.
1568    // -------------------------------------------------------------------------
1569    pub fn zvec_multi_query_create() -> *mut zvec_multi_query_t;
1570    pub fn zvec_multi_query_destroy(query: *mut zvec_multi_query_t);
1571    pub fn zvec_multi_query_add_sub_query(
1572        query: *mut zvec_multi_query_t,
1573        sub_query: *const zvec_sub_query_t,
1574    ) -> zvec_error_code_t;
1575    pub fn zvec_multi_query_get_sub_query_count(query: *const zvec_multi_query_t) -> usize;
1576    pub fn zvec_multi_query_set_topk(
1577        query: *mut zvec_multi_query_t,
1578        topk: c_int,
1579    ) -> zvec_error_code_t;
1580    pub fn zvec_multi_query_get_topk(query: *const zvec_multi_query_t) -> c_int;
1581    pub fn zvec_multi_query_set_filter(
1582        query: *mut zvec_multi_query_t,
1583        filter: *const c_char,
1584    ) -> zvec_error_code_t;
1585    pub fn zvec_multi_query_get_filter(query: *const zvec_multi_query_t) -> *const c_char;
1586    pub fn zvec_multi_query_set_include_vector(
1587        query: *mut zvec_multi_query_t,
1588        include: bool,
1589    ) -> zvec_error_code_t;
1590    pub fn zvec_multi_query_get_include_vector(query: *const zvec_multi_query_t) -> bool;
1591    pub fn zvec_multi_query_set_output_fields(
1592        query: *mut zvec_multi_query_t,
1593        fields: *const *const c_char,
1594        count: usize,
1595    ) -> zvec_error_code_t;
1596    pub fn zvec_multi_query_get_output_fields(
1597        query: *mut zvec_multi_query_t,
1598        fields: *mut *mut *const c_char,
1599        count: *mut usize,
1600    ) -> zvec_error_code_t;
1601    pub fn zvec_multi_query_set_rerank_rrf(
1602        query: *mut zvec_multi_query_t,
1603        rank_constant: c_int,
1604    ) -> zvec_error_code_t;
1605    pub fn zvec_multi_query_set_rerank_weighted(
1606        query: *mut zvec_multi_query_t,
1607        weights: *const f64,
1608        weight_count: usize,
1609    ) -> zvec_error_code_t;
1610
1611    pub fn zvec_sub_query_create() -> *mut zvec_sub_query_t;
1612    pub fn zvec_sub_query_destroy(query: *mut zvec_sub_query_t);
1613    pub fn zvec_sub_query_set_num_candidates(
1614        query: *mut zvec_sub_query_t,
1615        num_candidates: c_int,
1616    ) -> zvec_error_code_t;
1617    pub fn zvec_sub_query_get_num_candidates(query: *const zvec_sub_query_t) -> c_int;
1618    pub fn zvec_sub_query_set_field_name(
1619        query: *mut zvec_sub_query_t,
1620        field_name: *const c_char,
1621    ) -> zvec_error_code_t;
1622    pub fn zvec_sub_query_get_field_name(query: *const zvec_sub_query_t) -> *const c_char;
1623    pub fn zvec_sub_query_set_query_vector(
1624        query: *mut zvec_sub_query_t,
1625        data: *const c_void,
1626        size: usize,
1627    ) -> zvec_error_code_t;
1628    pub fn zvec_sub_query_set_sparse_vector(
1629        query: *mut zvec_sub_query_t,
1630        indices: *const u32,
1631        values: *const f32,
1632        count: usize,
1633    ) -> zvec_error_code_t;
1634    pub fn zvec_sub_query_set_sparse_indices(
1635        query: *mut zvec_sub_query_t,
1636        indices: *const u32,
1637        count: usize,
1638    ) -> zvec_error_code_t;
1639    pub fn zvec_sub_query_set_sparse_values(
1640        query: *mut zvec_sub_query_t,
1641        values: *const f32,
1642        count: usize,
1643    ) -> zvec_error_code_t;
1644    pub fn zvec_sub_query_set_hnsw_params(
1645        query: *mut zvec_sub_query_t,
1646        hnsw_params: *mut zvec_hnsw_query_params_t,
1647    ) -> zvec_error_code_t;
1648    pub fn zvec_sub_query_set_ivf_params(
1649        query: *mut zvec_sub_query_t,
1650        ivf_params: *mut zvec_ivf_query_params_t,
1651    ) -> zvec_error_code_t;
1652    pub fn zvec_sub_query_set_ivf_rabitq_params(
1653        query: *mut zvec_sub_query_t,
1654        ivf_rabitq_params: *mut zvec_ivf_rabitq_query_params_t,
1655    ) -> zvec_error_code_t;
1656    pub fn zvec_sub_query_set_flat_params(
1657        query: *mut zvec_sub_query_t,
1658        flat_params: *mut zvec_flat_query_params_t,
1659    ) -> zvec_error_code_t;
1660    pub fn zvec_sub_query_set_vamana_params(
1661        query: *mut zvec_sub_query_t,
1662        vamana_params: *mut zvec_vamana_query_params_t,
1663    ) -> zvec_error_code_t;
1664    pub fn zvec_sub_query_set_diskann_params(
1665        query: *mut zvec_sub_query_t,
1666        diskann_params: *mut zvec_diskann_query_params_t,
1667    ) -> zvec_error_code_t;
1668    pub fn zvec_sub_query_set_fts_params(
1669        query: *mut zvec_sub_query_t,
1670        fts_params: *mut zvec_fts_query_params_t,
1671    ) -> zvec_error_code_t;
1672    pub fn zvec_sub_query_set_fts(
1673        query: *mut zvec_sub_query_t,
1674        fts: *const zvec_fts_t,
1675    ) -> zvec_error_code_t;
1676
1677    // -------------------------------------------------------------------------
1678    // Document Operations
1679    // Functions for creating, manipulating, and serializing documents.
1680    // -------------------------------------------------------------------------
1681    pub fn zvec_doc_create() -> *mut zvec_doc_t;
1682    pub fn zvec_doc_destroy(doc: *mut zvec_doc_t);
1683    pub fn zvec_doc_clear(doc: *mut zvec_doc_t);
1684    pub fn zvec_doc_add_field_by_value(
1685        doc: *mut zvec_doc_t,
1686        field_name: *const c_char,
1687        data_type: zvec_data_type_t,
1688        value: *const c_void,
1689        value_size: usize,
1690    ) -> zvec_error_code_t;
1691    pub fn zvec_doc_remove_field(
1692        doc: *mut zvec_doc_t,
1693        field_name: *const c_char,
1694    ) -> zvec_error_code_t;
1695    pub fn zvec_docs_free(documents: *mut *mut zvec_doc_t, count: usize);
1696    pub fn zvec_doc_set_pk(doc: *mut zvec_doc_t, pk: *const c_char);
1697    pub fn zvec_doc_set_doc_id(doc: *mut zvec_doc_t, doc_id: u64);
1698    pub fn zvec_doc_set_score(doc: *mut zvec_doc_t, score: f32);
1699    pub fn zvec_doc_set_operator(doc: *mut zvec_doc_t, op: zvec_doc_operator_t);
1700    pub fn zvec_doc_set_field_null(
1701        doc: *mut zvec_doc_t,
1702        field_name: *const c_char,
1703    ) -> zvec_error_code_t;
1704    pub fn zvec_doc_get_doc_id(doc: *const zvec_doc_t) -> u64;
1705    pub fn zvec_doc_get_score(doc: *const zvec_doc_t) -> f32;
1706    pub fn zvec_doc_get_operator(doc: *const zvec_doc_t) -> zvec_doc_operator_t;
1707    pub fn zvec_doc_get_field_count(doc: *const zvec_doc_t) -> usize;
1708    pub fn zvec_doc_get_pk_pointer(doc: *const zvec_doc_t) -> *const c_char;
1709    pub fn zvec_doc_get_pk_copy(doc: *const zvec_doc_t) -> *const c_char;
1710    pub fn zvec_doc_get_field_value_basic(
1711        doc: *const zvec_doc_t,
1712        field_name: *const c_char,
1713        field_type: zvec_data_type_t,
1714        value_buffer: *mut c_void,
1715        buffer_size: usize,
1716    ) -> zvec_error_code_t;
1717    pub fn zvec_doc_get_field_value_copy(
1718        doc: *const zvec_doc_t,
1719        field_name: *const c_char,
1720        field_type: zvec_data_type_t,
1721        value: *mut *mut c_void,
1722        value_size: *mut usize,
1723    ) -> zvec_error_code_t;
1724    pub fn zvec_doc_get_field_value_pointer(
1725        doc: *const zvec_doc_t,
1726        field_name: *const c_char,
1727        field_type: zvec_data_type_t,
1728        value: *mut *const c_void,
1729        value_size: *mut usize,
1730    ) -> zvec_error_code_t;
1731    pub fn zvec_doc_is_empty(doc: *const zvec_doc_t) -> bool;
1732    pub fn zvec_doc_has_field(doc: *const zvec_doc_t, field_name: *const c_char) -> bool;
1733    pub fn zvec_doc_has_field_value(doc: *const zvec_doc_t, field_name: *const c_char) -> bool;
1734    pub fn zvec_doc_is_field_null(doc: *const zvec_doc_t, field_name: *const c_char) -> bool;
1735    pub fn zvec_doc_get_field_names(
1736        doc: *const zvec_doc_t,
1737        field_names: *mut *mut *mut c_char,
1738        count: *mut usize,
1739    ) -> zvec_error_code_t;
1740    pub fn zvec_free_str_array(array: *mut *mut c_char, count: usize);
1741    pub fn zvec_doc_serialize(
1742        doc: *const zvec_doc_t,
1743        data: *mut *mut u8,
1744        size: *mut usize,
1745    ) -> zvec_error_code_t;
1746    pub fn zvec_doc_deserialize(
1747        data: *const u8,
1748        size: usize,
1749        doc: *mut *mut zvec_doc_t,
1750    ) -> zvec_error_code_t;
1751    pub fn zvec_doc_merge(doc: *mut zvec_doc_t, other: *const zvec_doc_t);
1752    pub fn zvec_doc_memory_usage(doc: *const zvec_doc_t) -> usize;
1753    pub fn zvec_doc_to_detail_string(
1754        doc: *const zvec_doc_t,
1755        detail_str: *mut *mut c_char,
1756    ) -> zvec_error_code_t;
1757
1758    // -------------------------------------------------------------------------
1759    // Utility Functions
1760    // Helper functions for converting enums to string representations.
1761    // -------------------------------------------------------------------------
1762    pub fn zvec_data_type_to_string(data_type: zvec_data_type_t) -> *const c_char;
1763    pub fn zvec_index_type_to_string(index_type: zvec_index_type_t) -> *const c_char;
1764    pub fn zvec_metric_type_to_string(metric_type: zvec_metric_type_t) -> *const c_char;
1765}
zvec_rust_sys/lib.rs

zvec_rust_sys/
lib.rs
