Class Lucene95HnswVectorsReader

    • Constructor Detail

      • Lucene95HnswVectorsReader

        Lucene95HnswVectorsReader​(SegmentReadState state)
                           throws java.io.IOException
        Throws:
        java.io.IOException
    • Method Detail

      • readMetadata

        private int readMetadata​(SegmentReadState state)
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • openDataInput

        private static IndexInput openDataInput​(SegmentReadState state,
                                                int versionMeta,
                                                java.lang.String fileExtension,
                                                java.lang.String codecName)
                                         throws java.io.IOException
        Throws:
        java.io.IOException
      • readFields

        private void readFields​(ChecksumIndexInput meta,
                                FieldInfos infos)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • readVectorEncoding

        private VectorEncoding readVectorEncoding​(DataInput input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • 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 java.io.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:
        java.io.IOException
      • search

        public void search​(java.lang.String field,
                           float[] target,
                           KnnCollector knnCollector,
                           Bits acceptDocs)
                    throws java.io.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:
        java.io.IOException
      • search

        public void search​(java.lang.String field,
                           byte[] target,
                           KnnCollector knnCollector,
                           Bits acceptDocs)
                    throws java.io.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:
        java.io.IOException
      • getGraph

        public HnswGraph getGraph​(java.lang.String field)
                           throws java.io.IOException
        Get knn graph values; used for testing
        Specified by:
        getGraph in interface HnswGraphProvider
        Parameters:
        field - the field containing the graph
        Returns:
        the HnswGraph for the given field if found
        Throws:
        java.io.IOException - when reading potentially off-heap graph fails
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException