KnnVectorsReader

Reads vectors from an index.

Inheritors

Properties

Link copied to clipboard

Functions

Link copied to clipboard
abstract fun checkIntegrity()

Checks consistency of this reader.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
open fun finishMerge()

Optional: reset or close merge resources used in the reader

Link copied to clipboard

Returns the ByteVectorValues for the given field. The behavior is undefined if the given field doesn't have KNN vectors enabled on its FieldInfo. The return value is never null.

Link copied to clipboard

Returns the FloatVectorValues for the given field. The behavior is undefined if the given field doesn't have KNN vectors enabled on its FieldInfo. The return value is never null.

Link copied to clipboard
abstract fun search(field: String, target: ByteArray, knnCollector: KnnCollector, acceptDocs: Bits?)
abstract fun search(field: String, target: FloatArray, knnCollector: KnnCollector, acceptDocs: Bits?)

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.