Class AbstractKnnVectorQuery

    • Field Detail

      • NO_RESULTS

        private static final TopDocs NO_RESULTS
      • field

        protected final java.lang.String field
      • k

        protected final int k
      • filter

        private final Query filter
    • Constructor Detail

      • AbstractKnnVectorQuery

        public AbstractKnnVectorQuery​(java.lang.String field,
                                      int k,
                                      Query filter)
    • Method Detail

      • rewrite

        public Query rewrite​(IndexSearcher indexSearcher)
                      throws java.io.IOException
        Description copied from class: Query
        Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

        Callers are expected to call rewrite multiple times if necessary, until the rewritten query is the same as the original query.

        The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.

        However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.

        Overrides:
        rewrite in class Query
        Throws:
        java.io.IOException
        See Also:
        IndexSearcher.rewrite(Query)
      • createBitSet

        private BitSet createBitSet​(DocIdSetIterator iterator,
                                    Bits liveDocs,
                                    int maxDoc)
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • mergeLeafResults

        protected TopDocs mergeLeafResults​(TopDocs[] perLeafResults)
        Merges all segment-level kNN results to get the index-level kNN results.

        The default implementation delegates to TopDocs.merge(int, TopDocs[]) to find the overall top k, which requires input results to be sorted.

        This method is useful for reading and / or modifying the final results as needed.

        Parameters:
        perLeafResults - array of segment-level kNN results.
        Returns:
        index-level kNN results (no constraint on their ordering).
      • findSegmentStarts

        static int[] findSegmentStarts​(IndexReader reader,
                                       int[] docs)
      • visit

        public void visit​(QueryVisitor visitor)
        Description copied from class: Query
        Recurse through the query tree, visiting any child queries.
        Specified by:
        visit in class Query
        Parameters:
        visitor - a QueryVisitor to be called by each query in the tree
      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from class: Query
        Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly.

        Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical to those of the other instance. Utility methods are provided for certain repetitive code.

        Specified by:
        equals in class Query
        See Also:
        Query.sameClassAs(Object), Query.classHash()
      • hashCode

        public int hashCode()
        Description copied from class: Query
        Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.
        Specified by:
        hashCode in class Query
        See Also:
        Query.equals(Object)
      • getField

        public java.lang.String getField()
        Returns:
        the knn vector field where the knn vector search happens.
      • getK

        public int getK()
        Returns:
        the max number of results the KnnVector search returns.
      • getFilter

        public Query getFilter()
        Returns:
        the filter that is executed before the KnnVector search happens. Only the results accepted by this filter are returned by the KnnVector search.