Module org.apache.lucene.suggest
Package org.apache.lucene.search.suggest.document
package org.apache.lucene.search.suggest.document
Support for document suggestion
-
ClassDescription
CompletionPostingsFormat
fororg.apache.lucene.backward_codecs.lucene50.Lucene50PostingsFormat
.CompletionPostingsFormat
fororg.apache.lucene.backward_codecs.lucene84.Lucene84PostingsFormat
.Wraps anAnalyzer
to provide additional completion-only tuning (e.g.Weighted FSTs for any indexedSuggestField
is built onCompletionFieldsConsumer.write(Fields,NormsProducer)
.Completion index (.cmp) is opened and read at instantiation to read inSuggestField
numbers and their FST offsets in the Completion dictionary (.lkp).APostingsFormat
which supports document suggestion based on indexedSuggestField
s.An enum that allows to control if suggester FSTs are loaded into memory or read off-heapAbstractQuery
that match documents containing terms with a specified prefix filtered byBitsProducer
.Expert: Responsible for executing the query against an appropriate suggester and collecting the results via a collector.Holder for suggester and field-level info for a suggest fieldWrappedTerms
used bySuggestField
andContextSuggestField
to access corresponding suggester and their attributesAConcatenateGraphFilter
but we can set the payload and provide access to config options.Expert: the Weight for CompletionQuery, used to score and explain these queries.ACompletionQuery
that matches documents specified by a wrappedCompletionQuery
supporting boosting and/or filtering by specified contexts.Holder for context value meta dataSuggestField
which additionally takes in a set of contexts.TheContextSuggestField.PrefixTokenFilter
wraps aTokenStream
and adds a set prefixes ahead.ACompletionQuery
that match documents containing terms within an edit distance of the specified prefix.NRTSuggester executes Top N search on a weighted FST specified by aCompletionScorer
Helper to encode/decode payload (surface + PAYLOAD_SEP + docID) outputCompares partial completion paths usingCompletionScorer.score(float, float)
, breaks ties comparing path inputsBuilder forNRTSuggester
ACompletionQuery
which takes anAnalyzer
to analyze the prefix of the query term.ACompletionQuery
which takes a regular expression as the prefix of the query term.Field that indexes a string value and a weight as a weighted completion against a named suggester.Adds document suggest capabilities to IndexSearcher.Bounded priority queue forTopSuggestDocs.SuggestScoreDoc
s.ScoreDoc
with an additional CharSequence keyCollector
that collects completion and score, along with document id