API Reference¶
Complete reference for every class, method, and constant in the Zvec Ruby gem.
Core Classes¶
| Class | Description |
|---|---|
| FieldSchema | Defines a single field's name, type, dimension, and index |
| CollectionSchema | Groups fields into a collection schema |
| Doc | Typed key-value container for a single record |
| Collection | Persistent on-disk collection with CRUD and query operations |
Index and Query Parameters¶
| Class | Description |
|---|---|
| Index Parameters | HNSW, IVF, Flat, and Inverted index configuration |
| Query Parameters | Search-time tuning for HNSW, IVF, and Flat indexes |
| VectorQuery | Full-featured vector query builder |
| CollectionOptions | Options for opening collections |
Status and Configuration¶
| Class | Description |
|---|---|
| Status and Errors | Status codes and exception hierarchy |
| Global Configuration | Memory, threading, and logging settings |
| Enums | DataType, IndexType, MetricType, QuantizeType, StatusCode, Operator |