Module org.apache.lucene.core
Class Lucene99ScalarQuantizedVectorsFormat
- java.lang.Object
-
- org.apache.lucene.codecs.FlatVectorsFormat
-
- org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsFormat
-
public final class Lucene99ScalarQuantizedVectorsFormat extends FlatVectorsFormat
Format supporting vector quantization, storage, and retrieval
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.lang.Float
confidenceInterval
Controls the confidence interval used to scalar quantize the vectors the default value is calculated as `1-1/(vector_dimensions + 1)`private static float
MAXIMUM_CONFIDENCE_INTERVAL
The maximum confidence interval(package private) static java.lang.String
META_CODEC_NAME
(package private) static java.lang.String
META_EXTENSION
private static float
MINIMUM_CONFIDENCE_INTERVAL
The minimum confidence interval(package private) static java.lang.String
NAME
static java.lang.String
QUANTIZED_VECTOR_COMPONENT
private static FlatVectorsFormat
rawVectorFormat
(package private) static java.lang.String
VECTOR_DATA_CODEC_NAME
(package private) static java.lang.String
VECTOR_DATA_EXTENSION
(package private) static int
VERSION_CURRENT
(package private) static int
VERSION_START
-
Constructor Summary
Constructors Constructor Description Lucene99ScalarQuantizedVectorsFormat()
Constructs a format using default graph construction parametersLucene99ScalarQuantizedVectorsFormat(java.lang.Float confidenceInterval)
Constructs a format using the given graph construction parameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) static float
calculateDefaultConfidenceInterval(int vectorDimension)
FlatVectorsReader
fieldsReader(SegmentReadState state)
Returns aKnnVectorsReader
to read the vectors from the index.FlatVectorsWriter
fieldsWriter(SegmentWriteState state)
Returns aFlatVectorsWriter
to write the vectors to the index.java.lang.String
toString()
-
-
-
Field Detail
-
QUANTIZED_VECTOR_COMPONENT
public static final java.lang.String QUANTIZED_VECTOR_COMPONENT
- See Also:
- Constant Field Values
-
NAME
static final java.lang.String NAME
- See Also:
- Constant Field Values
-
VERSION_START
static final int VERSION_START
- See Also:
- Constant Field Values
-
VERSION_CURRENT
static final int VERSION_CURRENT
- See Also:
- Constant Field Values
-
META_CODEC_NAME
static final java.lang.String META_CODEC_NAME
- See Also:
- Constant Field Values
-
VECTOR_DATA_CODEC_NAME
static final java.lang.String VECTOR_DATA_CODEC_NAME
- See Also:
- Constant Field Values
-
META_EXTENSION
static final java.lang.String META_EXTENSION
- See Also:
- Constant Field Values
-
VECTOR_DATA_EXTENSION
static final java.lang.String VECTOR_DATA_EXTENSION
- See Also:
- Constant Field Values
-
rawVectorFormat
private static final FlatVectorsFormat rawVectorFormat
-
MINIMUM_CONFIDENCE_INTERVAL
private static final float MINIMUM_CONFIDENCE_INTERVAL
The minimum confidence interval- See Also:
- Constant Field Values
-
MAXIMUM_CONFIDENCE_INTERVAL
private static final float MAXIMUM_CONFIDENCE_INTERVAL
The maximum confidence interval- See Also:
- Constant Field Values
-
confidenceInterval
final java.lang.Float confidenceInterval
Controls the confidence interval used to scalar quantize the vectors the default value is calculated as `1-1/(vector_dimensions + 1)`
-
-
Constructor Detail
-
Lucene99ScalarQuantizedVectorsFormat
public Lucene99ScalarQuantizedVectorsFormat()
Constructs a format using default graph construction parameters
-
Lucene99ScalarQuantizedVectorsFormat
public Lucene99ScalarQuantizedVectorsFormat(java.lang.Float confidenceInterval)
Constructs a format using the given graph construction parameters.- Parameters:
confidenceInterval
- the confidenceInterval for scalar quantizing the vectors, when `null` it is calculated based on the vector field dimensions.
-
-
Method Detail
-
calculateDefaultConfidenceInterval
static float calculateDefaultConfidenceInterval(int vectorDimension)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
fieldsWriter
public FlatVectorsWriter fieldsWriter(SegmentWriteState state) throws java.io.IOException
Description copied from class:FlatVectorsFormat
Returns aFlatVectorsWriter
to write the vectors to the index.- Specified by:
fieldsWriter
in classFlatVectorsFormat
- Throws:
java.io.IOException
-
fieldsReader
public FlatVectorsReader fieldsReader(SegmentReadState state) throws java.io.IOException
Description copied from class:FlatVectorsFormat
Returns aKnnVectorsReader
to read the vectors from the index.- Specified by:
fieldsReader
in classFlatVectorsFormat
- Throws:
java.io.IOException
-
-