Class SlowCompositeCodecReaderWrapper.SlowCompositeKnnVectorsReaderWrapper
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Enclosing class:
SlowCompositeCodecReaderWrapper
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) class
(package private) class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final CodecReader[]
private final int[]
private final KnnVectorsReader[]
-
Constructor Summary
ConstructorsConstructorDescriptionSlowCompositeKnnVectorsReaderWrapper
(CodecReader[] codecReaders, int[] docStarts) -
Method Summary
Modifier and TypeMethodDescriptionprivate static int
binarySearchStarts
(int[] starts, int ord, int from, int to) void
Checks consistency of this reader.void
close()
private static int
findSub
(int ord, int lastSubIndex, int[] starts) getByteVectorValues
(String field) Returns theByteVectorValues
for the givenfield
.getFloatVectorValues
(String field) Returns theFloatVectorValues
for the givenfield
.void
search
(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs) Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.void
search
(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs) Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.Methods inherited from class org.apache.lucene.codecs.KnnVectorsReader
finishMerge, getMergeInstance
-
Field Details
-
codecReaders
-
readers
-
docStarts
private final int[] docStarts
-
-
Constructor Details
-
SlowCompositeKnnVectorsReaderWrapper
SlowCompositeKnnVectorsReaderWrapper(CodecReader[] codecReaders, int[] docStarts)
-
-
Method Details
-
close
- Throws:
IOException
-
checkIntegrity
Description copied from class:KnnVectorsReader
Checks 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:
checkIntegrity
in classKnnVectorsReader
- Throws:
IOException
-
getFloatVectorValues
Description copied from class:KnnVectorsReader
Returns theFloatVectorValues
for 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:
getFloatVectorValues
in classKnnVectorsReader
- Throws:
IOException
-
getByteVectorValues
Description copied from class:KnnVectorsReader
Returns theByteVectorValues
for 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:
getByteVectorValues
in classKnnVectorsReader
- Throws:
IOException
-
findSub
private static int findSub(int ord, int lastSubIndex, int[] starts) -
binarySearchStarts
private static int binarySearchStarts(int[] starts, int ord, int from, int to) -
search
public void search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs) throws IOException Description copied from class:KnnVectorsReader
Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function. The score of each document is derived from the vector similarity in a way that ensures scores are positive and that a larger score corresponds to a higher ranking.The search is allowed to be approximate, meaning the results are not guaranteed to be the true k closest neighbors. For large values of k (for example when k is close to the total number of documents), the search may also retrieve fewer than k documents.
The returned
TopDocs
will contain aScoreDoc
for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). TheTotalHits
contains the number of documents visited during the search. If the search stopped early because it hitvisitedLimit
, it is indicated through the relationTotalHits.Relation.GREATER_THAN_OR_EQUAL_TO
.The behavior is undefined if the given field doesn't have KNN vectors enabled on its
FieldInfo
. The return value is nevernull
.- Specified by:
search
in classKnnVectorsReader
- Parameters:
field
- the vector field to searchtarget
- the vector-valued queryknnCollector
- a KnnResults collector and relevant settings for gathering vector resultsacceptDocs
-Bits
that represents the allowed documents to match, ornull
if they are all allowed to match.- Throws:
IOException
-
search
public void search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs) throws IOException Description copied from class:KnnVectorsReader
Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function. The score of each document is derived from the vector similarity in a way that ensures scores are positive and that a larger score corresponds to a higher ranking.The search is allowed to be approximate, meaning the results are not guaranteed to be the true k closest neighbors. For large values of k (for example when k is close to the total number of documents), the search may also retrieve fewer than k documents.
The returned
TopDocs
will contain aScoreDoc
for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). TheTotalHits
contains the number of documents visited during the search. If the search stopped early because it hitvisitedLimit
, it is indicated through the relationTotalHits.Relation.GREATER_THAN_OR_EQUAL_TO
.The behavior is undefined if the given field doesn't have KNN vectors enabled on its
FieldInfo
. The return value is nevernull
.- Specified by:
search
in classKnnVectorsReader
- Parameters:
field
- the vector field to searchtarget
- the vector-valued queryknnCollector
- a KnnResults collector and relevant settings for gathering vector resultsacceptDocs
-Bits
that represents the allowed documents to match, ornull
if they are all allowed to match.- Throws:
IOException
-