Module org.elasticsearch.server
Class DenseVectorFieldMapper.BBQHnswIndexOptions
java.lang.Object
org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.DenseVectorIndexOptions
org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.BBQHnswIndexOptions
- All Implemented Interfaces:
IndexOptions,ToXContent
- Enclosing class:
DenseVectorFieldMapper
public static class DenseVectorFieldMapper.BBQHnswIndexOptions
extends DenseVectorFieldMapper.DenseVectorIndexOptions
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionBBQHnswIndexOptions(int m, int efConstruction, DenseVectorFieldMapper.RescoreVector rescoreVector) -
Method Summary
Modifier and TypeMethodDescriptionbooleanisFlat()Indicates whether the underlying vector search is performed using a flat (exhaustive) approach.toXContent(XContentBuilder builder, ToXContent.Params params) booleanbooleanvalidateDimension(int dim, boolean throwOnError) Methods inherited from class org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.DenseVectorIndexOptions
equals, getType, hashCode, validate, validateDimension, validateElementTypeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContent
isFragment
-
Constructor Details
-
BBQHnswIndexOptions
public BBQHnswIndexOptions(int m, int efConstruction, DenseVectorFieldMapper.RescoreVector rescoreVector)
-
-
Method Details
-
updatableTo
- Specified by:
updatableToin classDenseVectorFieldMapper.DenseVectorIndexOptions
-
isFlat
public boolean isFlat()Description copied from class:DenseVectorFieldMapper.DenseVectorIndexOptionsIndicates 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.- Specified by:
isFlatin classDenseVectorFieldMapper.DenseVectorIndexOptions- Returns:
trueif the vector search is flat (exhaustive),falseif it uses ANN structures
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Throws:
IOException
-
validateDimension
public boolean validateDimension(int dim, boolean throwOnError) - Overrides:
validateDimensionin classDenseVectorFieldMapper.DenseVectorIndexOptions
-