Class Lucene99FlatVectorsReader
java.lang.Object
org.apache.lucene.codecs.KnnVectorsReader
org.apache.lucene.codecs.hnsw.FlatVectorsReader
org.apache.lucene.codecs.lucene99.Lucene99FlatVectorsReader
- All Implemented Interfaces:
Closeable,AutoCloseable,Accountable
Reads vectors from the index segments.
- 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
vectorScorerFields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidChecks consistency of this reader.voidclose()voidOptional: reset or close merge resources used in the readergetByteVectorValues(String field) Returns theByteVectorValuesfor the givenfield.getFloatVectorValues(String field) Returns theFloatVectorValuesfor the givenfield.Returns an instance optimized for merging.getRandomVectorScorer(String field, byte[] target) Returns aRandomVectorScorerfor the given field and target vector.getRandomVectorScorer(String field, float[] target) Returns aRandomVectorScorerfor the given field and target vector.longReturn the memory usage of this object in bytes.Methods inherited from class org.apache.lucene.codecs.hnsw.FlatVectorsReader
getFlatVectorScorer, search, searchMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Constructor Details
-
Lucene99FlatVectorsReader
public Lucene99FlatVectorsReader(SegmentReadState state, FlatVectorsScorer scorer) throws IOException - Throws:
IOException
-
-
Method Details
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal. -
checkIntegrity
Description 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
-
getMergeInstance
Description copied from class:FlatVectorsReaderReturns an instance optimized for merging. This instance may only be consumed in the thread that calledFlatVectorsReader.getMergeInstance().The default implementation returns
this- Overrides:
getMergeInstancein classFlatVectorsReader
-
getFloatVectorValues
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
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
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
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.
-
finishMerge
Description copied from class:KnnVectorsReaderOptional: reset or close merge resources used in the readerThe default implementation is empty
- Overrides:
finishMergein classKnnVectorsReader- Throws:
IOException
-
close
- Throws:
IOException
-