Class Lucene91HnswVectorsReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Accountable
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Checks consistency of this reader.void
close()
Get knn graph values; used for testinggetVectorValues
(String field) Returns theVectorValues
for the givenfield
.long
Return the memory usage of this object in bytes.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
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
-
Method Details
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:Accountable
Return the memory usage of this object in bytes. Negative values are illegal. -
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
-
getVectorValues
Description copied from class:KnnVectorsReader
Returns theVectorValues
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:
getVectorValues
in classKnnVectorsReader
- Throws:
IOException
-
search
public TopDocs search(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) 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 queryk
- the number of docs to returnacceptDocs
-Bits
that represents the allowed documents to match, ornull
if they are all allowed to match.visitedLimit
- the maximum number of nodes that the search is allowed to visit- Returns:
- the k nearest neighbor documents, along with their (searchStrategy-specific) scores.
- Throws:
IOException
-
getGraph
Get knn graph values; used for testing- Throws:
IOException
-
close
- Throws:
IOException
-