Module org.elasticsearch.server

Package org.elasticsearch.index.codec.vectors.es93

Class ES93ScalarQuantizedVectorsFormat

java.lang.Object

org.apache.lucene.codecs.KnnVectorsFormat

org.elasticsearch.index.codec.vectors.es93.ES93ScalarQuantizedVectorsFormat

All Implemented Interfaces:

org.apache.lucene.util.NamedSPILoader.NamedSPI

public class ES93ScalarQuantizedVectorsFormat
extends org.apache.lucene.codecs.KnnVectorsFormat

Field Summary

Fields

Modifier and Type	Field	Description
final Float	confidenceInterval	Controls the confidence interval used to scalar quantize the vectors the default value is calculated as `1-1/(vector_dimensions + 1)`

Fields inherited from class org.apache.lucene.codecs.KnnVectorsFormat

DEFAULT_MAX_DIMENSIONS, EMPTY

Constructor Summary

Constructors

Constructor	Description
ES93ScalarQuantizedVectorsFormat()
ES93ScalarQuantizedVectorsFormat(DenseVectorFieldMapper.ElementType elementType)
ES93ScalarQuantizedVectorsFormat(DenseVectorFieldMapper.ElementType elementType, Float confidenceInterval, int bits, boolean compress)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.codecs.KnnVectorsReader	fieldsReader(org.apache.lucene.index.SegmentReadState state)
org.apache.lucene.codecs.KnnVectorsWriter	fieldsWriter(org.apache.lucene.index.SegmentWriteState state)
int	getMaxDimensions(String fieldName)
String	toString()

Methods inherited from class org.apache.lucene.codecs.KnnVectorsFormat

availableKnnVectorsFormats, forName, getName, reloadKnnVectorsFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

confidenceInterval

public final Float confidenceInterval

Controls the confidence interval used to scalar quantize the vectors the default value is calculated as `1-1/(vector_dimensions + 1)`

Constructor Details

ES93ScalarQuantizedVectorsFormat

public ES93ScalarQuantizedVectorsFormat()

ES93ScalarQuantizedVectorsFormat

public ES93ScalarQuantizedVectorsFormat(DenseVectorFieldMapper.ElementType elementType)

ES93ScalarQuantizedVectorsFormat

public ES93ScalarQuantizedVectorsFormat(DenseVectorFieldMapper.ElementType elementType,
 Float confidenceInterval,
 int bits,
 boolean compress)

Method Details

fieldsWriter

public org.apache.lucene.codecs.KnnVectorsWriter fieldsWriter(org.apache.lucene.index.SegmentWriteState state)
                                                       throws IOException

Specified by:

fieldsWriter in class org.apache.lucene.codecs.KnnVectorsFormat

Throws:

IOException

fieldsReader

public org.apache.lucene.codecs.KnnVectorsReader fieldsReader(org.apache.lucene.index.SegmentReadState state)
                                                       throws IOException

Specified by:

fieldsReader in class org.apache.lucene.codecs.KnnVectorsFormat

Throws:

IOException

getMaxDimensions

public int getMaxDimensions(String fieldName)

Specified by:

getMaxDimensions in class org.apache.lucene.codecs.KnnVectorsFormat

toString

public String toString()

Overrides:

toString in class Object