Module org.apache.lucene.suggest
Package org.apache.lucene.search.suggest.document
package org.apache.lucene.search.suggest.document
Support for document suggestion
-
ClassDescription
CompletionPostingsFormatfororg.apache.lucene.backward_codecs.lucene50.Lucene50PostingsFormat.CompletionPostingsFormatfororg.apache.lucene.backward_codecs.lucene84.Lucene84PostingsFormat.CompletionPostingsFormatfororg.apache.lucene.backward_codecs.lucene90.Lucene90PostingsFormat.Wraps anAnalyzerto provide additional completion-only tuning (e.g.Weighted FSTs for any indexedSuggestFieldis built onCompletionFieldsConsumer.write(Fields,NormsProducer).Completion index (.cmp) is opened and read at instantiation to read inSuggestFieldnumbers and their FST offsets in the Completion dictionary (.lkp).APostingsFormatwhich supports document suggestion based on indexedSuggestFields.An enum that allows to control if suggester FSTs are loaded into memory or read off-heapAbstractQuerythat 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 fieldWrappedTermsused bySuggestFieldandContextSuggestFieldto access corresponding suggester and their attributesAConcatenateGraphFilterbut we can set the payload and provide access to config options.Expert: the Weight for CompletionQuery, used to score and explain these queries.ACompletionQuerythat matches documents specified by a wrappedCompletionQuerysupporting boosting and/or filtering by specified contexts.Holder for context value meta dataSuggestFieldwhich additionally takes in a set of contexts.TheContextSuggestField.PrefixTokenFilterwraps aTokenStreamand adds a set prefixes ahead.ACompletionQuerythat match documents containing terms within an edit distance of the specified prefix.NRTSuggester executes Top N search on a weighted FST specified by aCompletionScorerHelper to encode/decode payload (surface + PAYLOAD_SEP + docID) outputCompares partial completion paths usingCompletionScorer.score(float, float), breaks ties comparing path inputsBuilder forNRTSuggesterACompletionQuerywhich takes anAnalyzerto analyze the prefix of the query term.ACompletionQuerywhich 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.SuggestScoreDocs.ScoreDocwith an additional CharSequence keyCollectorthat collects completion and score, along with document id