Uses of Class
org.apache.lucene.search.TopDocs
Packages that use TopDocs
Package
Description
Lucene 9.0 file format.
Lucene 9.1 file format.
Lucene 9.2 file format.
Uses already seen data (the indexed documents) to classify an input ( can be simple text or a
structured document).
Uses already seen data (the indexed documents) to classify new documents.
Codecs API: API for customization of the encoding and structure of the index.
Lucene 9.3 file format.
Postings format that can delegate to different formats per-field.
Simpletext Codec: writes human readable postings.
Code to maintain and access indices.
High-performance single-document main memory Apache Lucene fulltext search index.
Misc search implementations.
This package contains a flexible graph-based proximity query, TermAutomatonQuery, and geospatial
queries.
Code to search indices.
Highlighting search terms.
This package contains several components useful to build a highlighter on top of the
Matches
API.Support for document suggestion
The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term
vectors, or analysis.
-
Uses of TopDocs in org.apache.lucene.backward_codecs.lucene90
Methods in org.apache.lucene.backward_codecs.lucene90 that return TopDocs -
Uses of TopDocs in org.apache.lucene.backward_codecs.lucene91
Methods in org.apache.lucene.backward_codecs.lucene91 that return TopDocs -
Uses of TopDocs in org.apache.lucene.backward_codecs.lucene92
Methods in org.apache.lucene.backward_codecs.lucene92 that return TopDocs -
Uses of TopDocs in org.apache.lucene.classification
Methods in org.apache.lucene.classification that return TopDocsMethods in org.apache.lucene.classification with parameters of type TopDocsModifier and TypeMethodDescriptionprivate List<ClassificationResult<BytesRef>>
KNearestFuzzyClassifier.buildListFromTopDocs
(TopDocs topDocs) build a list of classification results from search resultsprotected List<ClassificationResult<BytesRef>>
KNearestNeighborClassifier.buildListFromTopDocs
(TopDocs topDocs) build a list of classification results from search resultsprotected ClassificationResult<BytesRef>
KNearestNeighborClassifier.classifyFromTopDocs
(TopDocs knnResults) TODO -
Uses of TopDocs in org.apache.lucene.classification.document
Methods in org.apache.lucene.classification.document that return TopDocs -
Uses of TopDocs in org.apache.lucene.codecs
Methods in org.apache.lucene.codecs that return TopDocsModifier and TypeMethodDescriptionabstract TopDocs
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. -
Uses of TopDocs in org.apache.lucene.codecs.lucene94
Methods in org.apache.lucene.codecs.lucene94 that return TopDocs -
Uses of TopDocs in org.apache.lucene.codecs.perfield
Methods in org.apache.lucene.codecs.perfield that return TopDocs -
Uses of TopDocs in org.apache.lucene.codecs.simpletext
Methods in org.apache.lucene.codecs.simpletext that return TopDocs -
Uses of TopDocs in org.apache.lucene.index
Methods in org.apache.lucene.index that return TopDocsModifier and TypeMethodDescriptionfinal TopDocs
CodecReader.searchNearestVectors
(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) DocValuesLeafReader.searchNearestVectors
(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) ExitableDirectoryReader.ExitableFilterAtomicReader.searchNearestVectors
(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) FilterLeafReader.searchNearestVectors
(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) abstract TopDocs
LeafReader.searchNearestVectors
(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) 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.ParallelLeafReader.searchNearestVectors
(String fieldName, float[] target, int k, Bits acceptDocs, int visitedLimit) -
Uses of TopDocs in org.apache.lucene.index.memory
Methods in org.apache.lucene.index.memory that return TopDocsModifier and TypeMethodDescriptionMemoryIndex.MemoryIndexReader.searchNearestVectors
(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) -
Uses of TopDocs in org.apache.lucene.misc.search
Methods in org.apache.lucene.misc.search that return TopDocsModifier and TypeMethodDescriptionprotected TopDocs
DiversifiedTopDocsCollector.newTopDocs
(ScoreDoc[] results, int start) -
Uses of TopDocs in org.apache.lucene.sandbox.search
Methods in org.apache.lucene.sandbox.search that return TopDocsModifier and TypeMethodDescriptionprotected TopDocs
LargeNumHitsTopDocsCollector.newTopDocs
(ScoreDoc[] results) Returns aTopDocs
instance containing the given results.LargeNumHitsTopDocsCollector.topDocs()
Returns the top docs that were collected by this collector.LargeNumHitsTopDocsCollector.topDocs
(int howMany) Returns the top docs that were collected by this collector. -
Uses of TopDocs in org.apache.lucene.search
Subclasses of TopDocs in org.apache.lucene.searchModifier and TypeClassDescriptionclass
Represents hits returned byIndexSearcher.search(Query,int,Sort)
.Fields in org.apache.lucene.search declared as TopDocsModifier and TypeFieldDescriptionstatic final TopDocs
TopDocsCollector.EMPTY_TOPDOCS
This is used in case topDocs() is called with illegal parameters, or there simply aren't (enough) results.private static final TopDocs
KnnVectorQuery.NO_RESULTS
Methods in org.apache.lucene.search that return TopDocsModifier and TypeMethodDescriptionprivate TopDocs
KnnVectorQuery.approximateSearch
(LeafReaderContext context, Bits acceptDocs, int visitedLimit) protected TopDocs
KnnVectorQuery.exactSearch
(LeafReaderContext context, DocIdSetIterator acceptIterator) static TopDocs
Same asmerge(int, TopDocs[])
but also ignores the topstart
top docs.static TopDocs
TopDocs.merge
(int start, int topN, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker) Same as above, but accepts the passed in tie breakerstatic TopDocs
Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.private static TopDocs
TopDocs.mergeAux
(Sort sort, int start, int size, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker) Auxiliary method used by themerge(int, org.apache.lucene.search.TopDocs[])
impls.protected TopDocs
TopDocsCollector.newTopDocs
(ScoreDoc[] results, int start) Returns aTopDocs
instance containing the given results.protected TopDocs
TopFieldCollector.newTopDocs
(ScoreDoc[] results, int start) protected TopDocs
TopScoreDocCollector.newTopDocs
(ScoreDoc[] results, int start) protected TopDocs
TopScoreDocCollector.PagingTopScoreDocCollector.newTopDocs
(ScoreDoc[] results, int start) QueryRescorer.rescore
(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN) static TopDocs
QueryRescorer.rescore
(IndexSearcher searcher, TopDocs topDocs, Query query, double weight, int topN) Sugar API, calling {#rescore} using a simple linear combination of firstPassScore + weight * secondPassScoreabstract TopDocs
Rescorer.rescore
(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN) Rescore an initial first-passTopDocs
.SortRescorer.rescore
(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN) Finds the topn
hits forquery
.IndexSearcher.searchAfter
(ScoreDoc after, Query query, int numHits) Finds the topn
hits forquery
where all results are after a previous result (after
).IndexSearcher.searchAfter
(ScoreDoc after, Query query, int n, Sort sort) Finds the topn
hits forquery
where all results are after a previous result (after
).private TopDocs
KnnVectorQuery.searchLeaf
(LeafReaderContext ctx, Weight filterWeight) TopDocsCollector.topDocs()
Returns the top docs that were collected by this collector.TopDocsCollector.topDocs
(int start) Returns the documents in the range [start ..TopDocsCollector.topDocs
(int start, int howMany) Returns the documents in the range [start ..Methods in org.apache.lucene.search that return types with arguments of type TopDocsModifier and TypeMethodDescriptionTopScoreDocCollector.createSharedManager
(int numHits, ScoreDoc after, int totalHitsThreshold) Create a CollectorManager which uses a shared hit counter to maintain number of hits and a sharedMaxScoreAccumulator
to propagate the minimum score accross segmentsMethods in org.apache.lucene.search with parameters of type TopDocsModifier and TypeMethodDescriptionprivate Query
KnnVectorQuery.createRewrittenQuery
(IndexReader reader, TopDocs topK) static TopDocs
Same asmerge(int, TopDocs[])
but also ignores the topstart
top docs.static TopDocs
TopDocs.merge
(int start, int topN, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker) Same as above, but accepts the passed in tie breakerstatic TopDocs
Returns a new TopDocs, containing topN results across the provided TopDocs, sorting by score.private static TopDocs
TopDocs.mergeAux
(Sort sort, int start, int size, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker) Auxiliary method used by themerge(int, org.apache.lucene.search.TopDocs[])
impls.QueryRescorer.rescore
(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN) static TopDocs
QueryRescorer.rescore
(IndexSearcher searcher, TopDocs topDocs, Query query, double weight, int topN) Sugar API, calling {#rescore} using a simple linear combination of firstPassScore + weight * secondPassScoreabstract TopDocs
Rescorer.rescore
(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN) Rescore an initial first-passTopDocs
.SortRescorer.rescore
(IndexSearcher searcher, TopDocs firstPassTopDocs, int topN) Constructors in org.apache.lucene.search with parameters of type TopDocsModifierConstructorDescriptionMergeSortQueue
(Sort sort, TopDocs[] shardHits, Comparator<ScoreDoc> tieBreaker) ScoreMergeSortQueue
(TopDocs[] shardHits, Comparator<ScoreDoc> tieBreakerComparator) -
Uses of TopDocs in org.apache.lucene.search.highlight
Methods in org.apache.lucene.search.highlight that return TopDocsModifier and TypeMethodDescriptionTermVectorLeafReader.searchNearestVectors
(String field, float[] target, int k, Bits acceptDocs, int visitedLimit) -
Uses of TopDocs in org.apache.lucene.search.matchhighlight
Methods in org.apache.lucene.search.matchhighlight with parameters of type TopDocsModifier and TypeMethodDescriptionvoid
MatchRegionRetriever.highlightDocuments
(TopDocs topDocs, MatchRegionRetriever.MatchOffsetsConsumer consumer) -
Uses of TopDocs in org.apache.lucene.search.suggest.document
Subclasses of TopDocs in org.apache.lucene.search.suggest.documentModifier and TypeClassDescriptionclass
-
Uses of TopDocs in org.apache.lucene.search.uhighlight
Methods in org.apache.lucene.search.uhighlight with parameters of type TopDocsModifier and TypeMethodDescriptionString[]
Highlights the top passages from a single field.String[]
Highlights the top-N passages from a single field.UnifiedHighlighter.highlightFields
(String[] fields, Query query, TopDocs topDocs) Highlights the top passages from multiple fields.UnifiedHighlighter.highlightFields
(String[] fields, Query query, TopDocs topDocs, int[] maxPassages) Highlights the top-N passages from multiple fields.