VectorIndexKind enum

Which FAISS-style index implementation should back a VectorIndexSpec. See the corresponding index class for parameter semantics.

Inheritance
Available extensions

Values

flat → const VectorIndexKind

Brute-force exhaustive scan (FlatIndex). Exact but O(N·d) per query — useful as ground truth and for small tables.

hnsw → const VectorIndexKind

Hierarchical Navigable Small World graph (HnswIndex).

ivf → const VectorIndexKind

Inverted-file cell-probe index (IvfFlatIndex).

lsh → const VectorIndexKind

Sign-projection Locality-Sensitive Hashing (LshIndex). Ranks by Hamming distance between projected bit codes; extremely cheap memory-wise (nbits/8 bytes per vector) at the cost of recall.

pq → const VectorIndexKind

Product-Quantization index (PqIndex). Each vector is compressed to m bytes via subspace k-means codebooks; search uses asymmetric distance computation (ADC). 4×–32× smaller than Flat.

ivfPq → const VectorIndexKind

IVF + PQ composite (IvfPqIndex). Coarse k-means quantizer partitions space into nlist cells; PQ codebooks compress the residual x - centroid_c in each cell to m bytes. FAISS's billion-scale workhorse: nprobe cells scanned × ADC lookup per code = sub-linear search in a tiny memory footprint.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<VectorIndexKind>
A constant List of the values in this enum, in order of their declaration.