Package org.apache.lucene.codecs.lucene99

Class Lucene99HnswVectorsReader

java.lang.Object
org.apache.lucene.codecs.KnnVectorsReader
org.apache.lucene.codecs.lucene99.Lucene99HnswVectorsReader
All Implemented Interfaces:
Closeable, AutoCloseable, HnswGraphProvider, Accountable
public final class Lucene99HnswVectorsReader extends KnnVectorsReader implements HnswGraphProvider
Reads vectors from the index segments along with index data structures supporting KNN search.
WARNING: This API is experimental and might change in incompatible ways in the next release.

  • Method Details

    • ramBytesUsed

      public long ramBytesUsed()
      Description copied from interface: Accountable
      Return the memory usage of this object in bytes. Negative values are illegal.
      Specified by:
      ramBytesUsed in interface Accountable

    • checkIntegrity

      public void checkIntegrity() throws IOException
      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 class KnnVectorsReader
      Throws:
      IOException

    • getFloatVectorValues

      public FloatVectorValues getFloatVectorValues(String field) throws IOException
      Description copied from class: KnnVectorsReader
      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.
      Specified by:
      getFloatVectorValues in class KnnVectorsReader
      Throws:
      IOException

    • getByteVectorValues

      public ByteVectorValues getByteVectorValues(String field) throws IOException
      Description copied from class: KnnVectorsReader
      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.
      Specified by:
      getByteVectorValues in class KnnVectorsReader
      Throws:
      IOException

    • 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 a ScoreDoc for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). The TotalHits contains the number of documents visited during the search. If the search stopped early because it hit visitedLimit, it is indicated through the relation TotalHits.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 never null.

      Specified by:
      search in class KnnVectorsReader
      Parameters:
      field - the vector field to search
      target - the vector-valued query
      knnCollector - a KnnResults collector and relevant settings for gathering vector results
      acceptDocs - Bits that represents the allowed documents to match, or null 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 a ScoreDoc for each nearest neighbor, in order of their similarity to the query vector (decreasing scores). The TotalHits contains the number of documents visited during the search. If the search stopped early because it hit visitedLimit, it is indicated through the relation TotalHits.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 never null.

      Specified by:
      search in class KnnVectorsReader
      Parameters:
      field - the vector field to search
      target - the vector-valued query
      knnCollector - a KnnResults collector and relevant settings for gathering vector results
      acceptDocs - Bits that represents the allowed documents to match, or null if they are all allowed to match.
      Throws:
      IOException

    • getGraph

      public HnswGraph getGraph(String field) throws IOException
      Description copied from interface: HnswGraphProvider
      Return the stored HnswGraph for the given field.
      Specified by:
      getGraph in interface HnswGraphProvider
      Parameters:
      field - the field containing the graph
      Returns:
      the HnswGraph for the given field if found
      Throws:
      IOException - when reading potentially off-heap graph fails

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException

    • getQuantizedVectorValues

      public org.apache.lucene.codecs.lucene99.QuantizedByteVectorValues getQuantizedVectorValues(String field) throws IOException
      Throws:
      IOException

    • getQuantizationState

      public ScalarQuantizer getQuantizationState(String field)