Class Lucene99ScalarQuantizedVectorsReader
- java.lang.Object
-
- org.apache.lucene.codecs.KnnVectorsReader
-
- org.apache.lucene.codecs.hnsw.FlatVectorsReader
-
- org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsReader
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Accountable,QuantizedVectorsReader
public final class Lucene99ScalarQuantizedVectorsReader extends FlatVectorsReader implements QuantizedVectorsReader
Reads Scalar Quantized vectors from the index segments along with index data structures.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.codecs.hnsw.FlatVectorsReader
vectorScorer
-
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
-
Constructor Summary
Constructors Constructor Description Lucene99ScalarQuantizedVectorsReader(SegmentReadState state, FlatVectorsReader rawVectorsReader, FlatVectorsScorer scorer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcheckIntegrity()Checks consistency of this reader.voidclose()ByteVectorValuesgetByteVectorValues(String field)Returns theByteVectorValuesfor the givenfield.FloatVectorValuesgetFloatVectorValues(String field)Returns theFloatVectorValuesfor the givenfield.ScalarQuantizergetQuantizationState(String fieldName)QuantizedByteVectorValuesgetQuantizedVectorValues(String fieldName)RandomVectorScorergetRandomVectorScorer(String field, byte[] target)Returns aRandomVectorScorerfor the given field and target vector.RandomVectorScorergetRandomVectorScorer(String field, float[] target)Returns aRandomVectorScorerfor the given field and target vector.longramBytesUsed()Return the memory usage of this object in bytes.-
Methods inherited from class org.apache.lucene.codecs.hnsw.FlatVectorsReader
getFlatVectorScorer, search, search
-
Methods inherited from class org.apache.lucene.codecs.KnnVectorsReader
getMergeInstance
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
-
-
-
Constructor Detail
-
Lucene99ScalarQuantizedVectorsReader
public Lucene99ScalarQuantizedVectorsReader(SegmentReadState state, FlatVectorsReader rawVectorsReader, FlatVectorsScorer scorer) throws IOException
- Throws:
IOException
-
-
Method Detail
-
checkIntegrity
public void checkIntegrity() throws IOExceptionDescription copied from class:KnnVectorsReaderChecks consistency of this reader.Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.
- Specified by:
checkIntegrityin classKnnVectorsReader- Throws:
IOException
-
getFloatVectorValues
public FloatVectorValues getFloatVectorValues(String field) throws IOException
Description copied from class:KnnVectorsReaderReturns theFloatVectorValuesfor the givenfield. The behavior is undefined if the given field doesn't have KNN vectors enabled on itsFieldInfo. The return value is nevernull.- Specified by:
getFloatVectorValuesin classKnnVectorsReader- Throws:
IOException
-
getByteVectorValues
public ByteVectorValues getByteVectorValues(String field) throws IOException
Description copied from class:KnnVectorsReaderReturns theByteVectorValuesfor the givenfield. The behavior is undefined if the given field doesn't have KNN vectors enabled on itsFieldInfo. The return value is nevernull.- Specified by:
getByteVectorValuesin classKnnVectorsReader- Throws:
IOException
-
getRandomVectorScorer
public RandomVectorScorer getRandomVectorScorer(String field, float[] target) throws IOException
Description copied from class:FlatVectorsReaderReturns aRandomVectorScorerfor the given field and target vector.- Specified by:
getRandomVectorScorerin classFlatVectorsReader- Parameters:
field- the field to searchtarget- the target vector- Returns:
- a
RandomVectorScorerfor the given field and target vector. - Throws:
IOException- if an I/O error occurs when reading from the index.
-
getRandomVectorScorer
public RandomVectorScorer getRandomVectorScorer(String field, byte[] target) throws IOException
Description copied from class:FlatVectorsReaderReturns aRandomVectorScorerfor the given field and target vector.- Specified by:
getRandomVectorScorerin classFlatVectorsReader- Parameters:
field- the field to searchtarget- the target vector- Returns:
- a
RandomVectorScorerfor the given field and target vector. - Throws:
IOException- if an I/O error occurs when reading from the index.
-
close
public void close() throws IOException- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Throws:
IOException
-
ramBytesUsed
public long ramBytesUsed()
Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal.- Specified by:
ramBytesUsedin interfaceAccountable
-
getQuantizedVectorValues
public QuantizedByteVectorValues getQuantizedVectorValues(String fieldName) throws IOException
- Specified by:
getQuantizedVectorValuesin interfaceQuantizedVectorsReader- Throws:
IOException
-
getQuantizationState
public ScalarQuantizer getQuantizationState(String fieldName)
- Specified by:
getQuantizationStatein interfaceQuantizedVectorsReader
-
-