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

Support for document suggestion

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  CompletionTokenStream.BytesRefBuilderTermAttribute | Attribute providing access to the term builder and UTF-16 conversion

- Class Summary
  Class | Description
  --- | ---
  Completion50PostingsFormat | `CompletionPostingsFormat` for `Lucene50PostingsFormat`
  CompletionAnalyzer | Wraps an `Analyzer` to provide additional completion-only tuning (e.g.
  CompletionPostingsFormat | A `PostingsFormat` which supports document suggestion based on indexed `SuggestField`s.
  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 | Token stream which converts a provided token stream to an automaton.
  CompletionTokenStream.BytesRefBuilderTermAttributeImpl | Custom attribute implementation for completion token stream
  CompletionWeight | Expert: the Weight for CompletionQuery, used to score and explain these queries.
  ContextQuery | A `CompletionQuery` that match 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

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

Support for document suggestion

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.