Class DenseVectorFieldMapper.DenseVectorIndexOptions

java.lang.Object
org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.DenseVectorIndexOptions
All Implemented Interfaces:
IndexOptions, ToXContent
Direct Known Subclasses:
DenseVectorFieldMapper.BBQHnswIndexOptions, DenseVectorFieldMapper.Int4HnswIndexOptions, DenseVectorFieldMapper.Int8HnswIndexOptions
Enclosing class:
DenseVectorFieldMapper

public abstract static class DenseVectorFieldMapper.DenseVectorIndexOptions extends Object implements IndexOptions
  • Method Details

    • validate

      public boolean validate(DenseVectorFieldMapper.ElementType elementType, int dim, boolean throwOnError)
    • validateElementType

      public boolean validateElementType(DenseVectorFieldMapper.ElementType elementType)
    • updatableTo

      public abstract boolean updatableTo(DenseVectorFieldMapper.DenseVectorIndexOptions update)
    • validateDimension

      public boolean validateDimension(int dim)
    • validateDimension

      public boolean validateDimension(int dim, boolean throwOnError)
    • getType

    • equals

      public final boolean equals(Object other)
      Overrides:
      equals in class Object
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • isFlat

      public abstract boolean isFlat()
      Indicates whether the underlying vector search is performed using a flat (exhaustive) approach.

      When true, it means the search does not use any approximate nearest neighbor (ANN) acceleration structures such as HNSW or IVF. Instead, it performs a brute-force comparison against all candidate vectors. This information can be used by higher-level components to decide whether additional acceleration or optimization is necessary.

      Returns:
      true if the vector search is flat (exhaustive), false if it uses ANN structures