Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.vectors

Class DenseVectorFieldMapper.BBQIVFIndexOptions

java.lang.Object

org.elasticsearch.index.mapper.vectors.IndexOptions

org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.DenseVectorIndexOptions

org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.BBQIVFIndexOptions

All Implemented Interfaces:

ToXContent, ToXContentObject

Enclosing class:

DenseVectorFieldMapper

public static class DenseVectorFieldMapper.BBQIVFIndexOptions
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

Constructors

Constructor	Description
BBQIVFIndexOptions(int clusterSize, int flatIndexThreshold, double defaultVisitPercentage, boolean onDiskRescore, DenseVectorFieldMapper.RescoreVector rescoreVector, IndexVersion indexVersionCreated, boolean doPrecondition, int bits, boolean experimentalFeaturesEnabled)

Method Summary

Modifier and Type	Method	Description
Float	confidenceInterval()
boolean	doPrecondition()
int	getBits()
int	getClusterSize()
double	getDefaultVisitPercentage()
int	getFlatIndexThreshold()
boolean	isFlat()	Indicates whether the underlying vector search is performed using a flat (exhaustive) approach.
boolean	isOnDiskRescore()
DenseVectorFieldMapper.RescoreVector	rescoreVector()
void	toXContentFragment(XContentBuilder builder, ToXContent.Params params)
boolean	updatableTo(DenseVectorFieldMapper.DenseVectorIndexOptions update)

Methods inherited from class org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.DenseVectorIndexOptions

equals, getType, hashCode, validate, validateDimension, validateDimension, validateElementType

Methods inherited from class org.elasticsearch.index.mapper.vectors.IndexOptions

toXContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

BBQIVFIndexOptions

public BBQIVFIndexOptions(int clusterSize,
 int flatIndexThreshold,
 double defaultVisitPercentage,
 boolean onDiskRescore,
 DenseVectorFieldMapper.RescoreVector rescoreVector,
 IndexVersion indexVersionCreated,
 boolean doPrecondition,
 int bits,
 boolean experimentalFeaturesEnabled)

Method Details

updatableTo

public boolean updatableTo(DenseVectorFieldMapper.DenseVectorIndexOptions update)

Specified by:

updatableTo in class DenseVectorFieldMapper.DenseVectorIndexOptions

isFlat

public boolean isFlat()

Description copied from class: DenseVectorFieldMapper.DenseVectorIndexOptions

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.

Specified by:

isFlat in class DenseVectorFieldMapper.DenseVectorIndexOptions

Returns:

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

toXContentFragment

public void toXContentFragment(XContentBuilder builder,
 ToXContent.Params params)
                        throws IOException

Specified by:

toXContentFragment in class IndexOptions

Throws:

IOException

getClusterSize

public int getClusterSize()

getFlatIndexThreshold

public int getFlatIndexThreshold()

getDefaultVisitPercentage

public double getDefaultVisitPercentage()

isOnDiskRescore

public boolean isOnDiskRescore()

doPrecondition

public boolean doPrecondition()

getBits

public int getBits()

confidenceInterval

public Float confidenceInterval()

rescoreVector

public DenseVectorFieldMapper.RescoreVector rescoreVector()