# Package org.apache.lucene.search.suggest.document

package org.apache.lucene.search.suggest.document
Support for document suggestion

Related Packages
Package
Description
org.apache.lucene.search.suggest
Support for Autocomplete/Autosuggest
org.apache.lucene.search.suggest.analyzing
Analyzer based autosuggest.
org.apache.lucene.search.suggest.fst
Finite-state based autosuggest.
org.apache.lucene.search.suggest.tst
Ternary Search Tree based autosuggest.
Class
Description
Completion50PostingsFormat
`CompletionPostingsFormat` for `org.apache.lucene.backward_codecs.lucene50.Lucene50PostingsFormat`.
Completion84PostingsFormat
`CompletionPostingsFormat` for `org.apache.lucene.backward_codecs.lucene84.Lucene84PostingsFormat`.
Completion90PostingsFormat
`CompletionPostingsFormat` for `org.apache.lucene.backward_codecs.lucene90.Lucene90PostingsFormat`.
Completion912PostingsFormat
`CompletionPostingsFormat` for `Lucene912PostingsFormat`
Completion99PostingsFormat
`CompletionPostingsFormat` for `org.apache.lucene.backward_codecs.lucene99.Lucene99PostingsFormat`.
CompletionAnalyzer
Wraps an `Analyzer` to provide additional completion-only tuning (e.g.
CompletionPostingsFormat
A `PostingsFormat` which supports document suggestion based on indexed `SuggestField`s.
CompletionPostingsFormat.FSTLoadMode
An enum that allows to control if suggester FSTs are loaded into memory or read off-heap
CompletionQuery
Abstract `Query` that match documents containing terms with a specified prefix filtered by `BitsProducer`.
CompletionScorer
Expert: Responsible for executing the query against an appropriate suggester and collecting the results via a collector.
CompletionsTermsReader
Holder for suggester and field-level info for a suggest field
CompletionTerms
Wrapped `Terms` used by `SuggestField` and `ContextSuggestField` to access corresponding suggester and their attributes
CompletionTokenStream
A `ConcatenateGraphFilter` but we can set the payload and provide access to config options.
CompletionWeight
Expert: the Weight for CompletionQuery, used to score and explain these queries.
ContextQuery
A `CompletionQuery` that matches documents specified by a wrapped `CompletionQuery` supporting boosting and/or filtering by specified contexts.
ContextSuggestField
`SuggestField` which additionally takes in a set of contexts.
FuzzyCompletionQuery
A `CompletionQuery` that match documents containing terms within an edit distance of the specified prefix.
NRTSuggester
NRTSuggester executes Top N search on a weighted FST specified by a `CompletionScorer`
PrefixCompletionQuery
A `CompletionQuery` which takes an `Analyzer` to analyze the prefix of the query term.
RegexCompletionQuery
A `CompletionQuery` which takes a regular expression as the prefix of the query term.
SuggestField
Field that indexes a string value and a weight as a weighted completion against a named suggester.
SuggestIndexSearcher
Adds document suggest capabilities to IndexSearcher.
TopSuggestDocs
`TopDocs` wrapper with an additional CharSequence key per `ScoreDoc`
TopSuggestDocs.SuggestScoreDoc
`ScoreDoc` with an additional CharSequence key
TopSuggestDocsCollector
`Collector` that collects completion and score, along with document id