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

zvec_rust_sys/
lib.rs
