Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.vectors

Class DenseVectorFieldMapper.Int4HnswIndexOptions

java.lang.Object

org.elasticsearch.index.mapper.vectors.IndexOptions

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

org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.Int4HnswIndexOptions

All Implemented Interfaces:

ToXContent, ToXContentObject

Enclosing class:

DenseVectorFieldMapper

public static class DenseVectorFieldMapper.Int4HnswIndexOptions
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
Int4HnswIndexOptions(int m, int efConstruction, boolean onDiskRescore, DenseVectorFieldMapper.RescoreVector rescoreVector, int flatIndexThreshold)
Int4HnswIndexOptions(int m, int efConstruction, boolean onDiskRescore, DenseVectorFieldMapper.RescoreVector rescoreVector, int flatIndexThreshold, Float confidenceInterval)

Method Summary

Modifier and Type	Method	Description
Float	confidenceInterval()
boolean	doEquals(DenseVectorFieldMapper.DenseVectorIndexOptions o)
int	doHashCode()
int	flatIndexThreshold()
org.apache.lucene.codecs.KnnVectorsFormat	getVectorsFormat(DenseVectorFieldMapper.ElementType elementType, ExecutorService mergingExecutorService, int numMergeWorkers)
boolean	isFlat()	Indicates whether the underlying vector search is performed using a flat (exhaustive) approach.
DenseVectorFieldMapper.RescoreVector	rescoreVector()
String	toString()
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, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

Int4HnswIndexOptions

public Int4HnswIndexOptions(int m,
 int efConstruction,
 boolean onDiskRescore,
 DenseVectorFieldMapper.RescoreVector rescoreVector,
 int flatIndexThreshold)

Int4HnswIndexOptions

public Int4HnswIndexOptions(int m,
 int efConstruction,
 boolean onDiskRescore,
 DenseVectorFieldMapper.RescoreVector rescoreVector,
 int flatIndexThreshold,
 Float confidenceInterval)

Method Details

getVectorsFormat

public org.apache.lucene.codecs.KnnVectorsFormat getVectorsFormat(DenseVectorFieldMapper.ElementType elementType,
 ExecutorService mergingExecutorService,
 int numMergeWorkers)

toXContentFragment

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

Specified by:

toXContentFragment in class IndexOptions

Throws:

IOException

doEquals

public boolean doEquals(DenseVectorFieldMapper.DenseVectorIndexOptions o)

doHashCode

public int doHashCode()

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

flatIndexThreshold

public int flatIndexThreshold()

toString

public String toString()

Overrides:

toString in class Object

updatableTo

public boolean updatableTo(DenseVectorFieldMapper.DenseVectorIndexOptions update)

Specified by:

updatableTo in class DenseVectorFieldMapper.DenseVectorIndexOptions

confidenceInterval

public Float confidenceInterval()

rescoreVector

public DenseVectorFieldMapper.RescoreVector rescoreVector()