PhraseSuggestionBuilder (server 6.3.2 API)

java.lang.Object
- org.elasticsearch.search.suggest.SuggestionBuilder<PhraseSuggestionBuilder>
- - org.elasticsearch.search.suggest.phrase.PhraseSuggestionBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment
```
public class PhraseSuggestionBuilder
extends SuggestionBuilder<PhraseSuggestionBuilder>
```
Defines the actual suggest command for phrase suggestions ( phrase).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PhraseSuggestionBuilder.CandidateGenerator
PhraseSuggestionBuilder.CandidateGenerator interface.
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Nested Classes
Modifier and Type	Class	Description
`static interface`	`PhraseSuggestionBuilder.CandidateGenerator`	`PhraseSuggestionBuilder.CandidateGenerator` interface.

Field Summary

Fields
Modifier and Type	Field	Description
`protected static ParseField`	`COLLATE_FIELD`
`protected static ParseField`	`COLLATE_QUERY_FIELD`
`protected static ParseField`	`COLLATE_QUERY_PARAMS`
`protected static ParseField`	`COLLATE_QUERY_PRUNE`
`protected static ParseField`	`CONFIDENCE_FIELD`
`protected static ParseField`	`FORCE_UNIGRAM_FIELD`
`protected static ParseField`	`GRAMSIZE_FIELD`
`protected static ParseField`	`HIGHLIGHT_FIELD`
`protected static ParseField`	`MAXERRORS_FIELD`
`protected static ParseField`	`POST_TAG_FIELD`
`protected static ParseField`	`PRE_TAG_FIELD`
`protected static ParseField`	`RWE_LIKELIHOOD_FIELD`
`protected static ParseField`	`SEPARATOR_FIELD`
`protected static ParseField`	`SMOOTHING_MODEL_FIELD`
`protected static ParseField`	`TOKEN_LIMIT_FIELD`

Fields inherited from class org.elasticsearch.search.suggest.SuggestionBuilder
analyzer, ANALYZER_FIELD, field, FIELDNAME_FIELD, prefix, PREFIX_FIELD, regex, REGEX_FIELD, shardSize, SHARDSIZE_FIELD, size, SIZE_FIELD, text, TEXT_FIELD

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS

Constructor Summary

Constructors
Constructor Description

PhraseSuggestionBuilder(java.lang.String field)

PhraseSuggestionBuilder(StreamInput in)
Read from a stream.

Constructors
Constructor	Description
`PhraseSuggestionBuilder(java.lang.String field)`
`PhraseSuggestionBuilder(StreamInput in)`	Read from a stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PhraseSuggestionBuilder`	`addCandidateGenerator(PhraseSuggestionBuilder.CandidateGenerator generator)`	Adds a `PhraseSuggestionBuilder.CandidateGenerator` to this suggester.
`SuggestionSearchContext.SuggestionContext`	`build(QueryShardContext context)`
`PhraseSuggestionBuilder`	`clearCandidateGenerators()`	Clear the candidate generators.
`java.util.Map<java.lang.String,java.lang.Object>`	`collateParams()`	gets additional params for collate script
`PhraseSuggestionBuilder`	`collateParams(java.util.Map<java.lang.String,java.lang.Object> collateParams)`	Adds additional parameters for collate scripts.
`java.lang.Boolean`	`collatePrune()`	Gets whether to prune suggestions after collation
`PhraseSuggestionBuilder`	`collatePrune(boolean collatePrune)`	Sets whether to prune suggestions after collation
`Script`	`collateQuery()`	gets the query used for filtering out suggested phrases (collation).
`PhraseSuggestionBuilder`	`collateQuery(java.lang.String collateQuery)`	Sets a query used for filtering out suggested phrases (collation).
`PhraseSuggestionBuilder`	`collateQuery(Script collateQueryTemplate)`	Sets a query used for filtering out suggested phrases (collation).
`java.lang.Float`	`confidence()`	get the `confidence()` parameter
`PhraseSuggestionBuilder`	`confidence(float confidence)`	Sets the confidence level for this suggester.
`protected boolean`	`doEquals(PhraseSuggestionBuilder other)`	Indicates whether some other `SuggestionBuilder` of the same type is "equal to" this one.
`protected int`	`doHashCode()`	HashCode for the subclass of `SuggestionBuilder` to implement.
`void`	`doWriteTo(StreamOutput out)`
`java.lang.Boolean`	`forceUnigrams()`	get the setting for `forceUnigrams()`
`PhraseSuggestionBuilder`	`forceUnigrams(boolean forceUnigrams)`	If set to `true` the phrase suggester will fail if the analyzer only produces ngrams.
`static PhraseSuggestionBuilder`	`fromXContent(XContentParser parser)`
`java.lang.String`	`getWriteableName()`	Returns the name of the writeable object
`java.lang.Integer`	`gramSize()`	get the `gramSize(int)` parameter
`PhraseSuggestionBuilder`	`gramSize(int gramSize)`	Sets the gram size for the n-gram model used for this suggester.
`PhraseSuggestionBuilder`	`highlight(java.lang.String preTag, java.lang.String postTag)`	Setup highlighting for suggestions.
`XContentBuilder`	`innerToXContent(XContentBuilder builder, ToXContent.Params params)`
`java.lang.Float`	`maxErrors()`	get the maxErrors setting
`PhraseSuggestionBuilder`	`maxErrors(float maxErrors)`	Sets the maximum percentage of the terms that at most considered to be misspellings in order to form a correction.
`java.lang.String`	`postTag()`	get the post-tag for the highlighter set with `highlight(String, String)`
`java.lang.String`	`preTag()`	get the pre-tag for the highlighter set with `highlight(String, String)`
`java.lang.Float`	`realWordErrorLikelihood()`	get the `realWordErrorLikelihood(float)` parameter
`PhraseSuggestionBuilder`	`realWordErrorLikelihood(float realWordErrorLikelihood)`	Sets the likelihood of a term being a misspelled even if the term exists in the dictionary.
`java.lang.String`	`separator()`	get the separator that is used to separate terms in the bigram field.
`PhraseSuggestionBuilder`	`separator(java.lang.String separator)`	Sets the separator that is used to separate terms in the bigram field.
`SmoothingModel`	`smoothingModel()`	Gets the `SmoothingModel`
`PhraseSuggestionBuilder`	`smoothingModel(SmoothingModel model)`	Sets an explicit smoothing model used for this suggester.
`java.lang.Integer`	`tokenLimit()`	get the `tokenLimit(int)` parameter
`PhraseSuggestionBuilder`	`tokenLimit(int tokenLimit)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.elasticsearch.search.suggest.SuggestionBuilder
analyzer, analyzer, equals, field, hashCode, populateCommonFields, prefix, prefix, regex, regex, shardSize, shardSize, size, size, text, text, toXContent, writeTo

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment

- Field Detail
  - MAXERRORS_FIELD
```
protected static final ParseField MAXERRORS_FIELD
```
  - RWE_LIKELIHOOD_FIELD
```
protected static final ParseField RWE_LIKELIHOOD_FIELD
```
  - SEPARATOR_FIELD
```
protected static final ParseField SEPARATOR_FIELD
```
  - CONFIDENCE_FIELD
```
protected static final ParseField CONFIDENCE_FIELD
```
  - GRAMSIZE_FIELD
```
protected static final ParseField GRAMSIZE_FIELD
```
  - SMOOTHING_MODEL_FIELD
```
protected static final ParseField SMOOTHING_MODEL_FIELD
```
  - FORCE_UNIGRAM_FIELD
```
protected static final ParseField FORCE_UNIGRAM_FIELD
```
  - TOKEN_LIMIT_FIELD
```
protected static final ParseField TOKEN_LIMIT_FIELD
```
  - HIGHLIGHT_FIELD
```
protected static final ParseField HIGHLIGHT_FIELD
```
  - PRE_TAG_FIELD
```
protected static final ParseField PRE_TAG_FIELD
```
  - POST_TAG_FIELD
```
protected static final ParseField POST_TAG_FIELD
```
  - COLLATE_FIELD
```
protected static final ParseField COLLATE_FIELD
```
  - COLLATE_QUERY_FIELD
```
protected static final ParseField COLLATE_QUERY_FIELD
```
  - COLLATE_QUERY_PARAMS
```
protected static final ParseField COLLATE_QUERY_PARAMS
```
  - COLLATE_QUERY_PRUNE
```
protected static final ParseField COLLATE_QUERY_PRUNE
```
- Constructor Detail
  - PhraseSuggestionBuilder
```
public PhraseSuggestionBuilder(java.lang.String field)
```
  - PhraseSuggestionBuilder
```
public PhraseSuggestionBuilder(StreamInput in)
                        throws java.io.IOException
```
    Read from a stream.
    
    Throws:
    
    java.io.IOException
- Method Detail
  - doWriteTo
```
public void doWriteTo(StreamOutput out)
               throws java.io.IOException
```
    Specified by:
    
    doWriteTo in class SuggestionBuilder<PhraseSuggestionBuilder>
    
    Throws:
    
    java.io.IOException
  - gramSize
```
public PhraseSuggestionBuilder gramSize(int gramSize)
```
    Sets the gram size for the n-gram model used for this suggester. The default value is 1 corresponding to unigrams. Use 2 for bigrams and 3 for trigrams.
  - gramSize
```
public java.lang.Integer gramSize()
```
    get the gramSize(int) parameter
  - maxErrors
```
public PhraseSuggestionBuilder maxErrors(float maxErrors)
```
    Sets the maximum percentage of the terms that at most considered to be misspellings in order to form a correction. This method accepts a float value in the range [0..1) as a fraction of the actual query terms a number >=1 as an absolute number of query terms. The default is set to 1.0 which corresponds to that only corrections with at most 1 misspelled term are returned.
  - maxErrors
```
public java.lang.Float maxErrors()
```
    get the maxErrors setting
  - separator
```
public PhraseSuggestionBuilder separator(java.lang.String separator)
```
    Sets the separator that is used to separate terms in the bigram field. If not set the whitespace character is used as a separator.
  - separator
```
public java.lang.String separator()
```
    get the separator that is used to separate terms in the bigram field.
  - realWordErrorLikelihood
```
public PhraseSuggestionBuilder realWordErrorLikelihood(float realWordErrorLikelihood)
```
    Sets the likelihood of a term being a misspelled even if the term exists in the dictionary. The default it 0.95 corresponding to 5% or the real words are misspelled.
  - realWordErrorLikelihood
```
public java.lang.Float realWordErrorLikelihood()
```
    get the realWordErrorLikelihood(float) parameter
  - confidence
```
public PhraseSuggestionBuilder confidence(float confidence)
```
    Sets the confidence level for this suggester. The confidence level defines a factor applied to the input phrases score which is used as a threshold for other suggest candidates. Only candidates that score higher than the threshold will be included in the result. For instance a confidence level of 1.0 will only return suggestions that score higher than the input phrase. If set to 0.0 the top N candidates are returned. The default is 1.0
  - confidence
```
public java.lang.Float confidence()
```
    get the confidence() parameter
  - addCandidateGenerator
```
public PhraseSuggestionBuilder addCandidateGenerator(PhraseSuggestionBuilder.CandidateGenerator generator)
```
    Adds a PhraseSuggestionBuilder.CandidateGenerator to this suggester. The PhraseSuggestionBuilder.CandidateGenerator is used to draw candidates for each individual phrase term before the candidates are scored.
  - clearCandidateGenerators
```
public PhraseSuggestionBuilder clearCandidateGenerators()
```
    Clear the candidate generators.
  - forceUnigrams
```
public PhraseSuggestionBuilder forceUnigrams(boolean forceUnigrams)
```
    If set to true the phrase suggester will fail if the analyzer only produces ngrams. the default it true.
  - forceUnigrams
```
public java.lang.Boolean forceUnigrams()
```
    get the setting for forceUnigrams()
  - smoothingModel
```
public PhraseSuggestionBuilder smoothingModel(SmoothingModel model)
```
    Sets an explicit smoothing model used for this suggester. The default is StupidBackoff.
  - smoothingModel
```
public SmoothingModel smoothingModel()
```
    Gets the SmoothingModel
  - tokenLimit
```
public PhraseSuggestionBuilder tokenLimit(int tokenLimit)
```
  - tokenLimit
```
public java.lang.Integer tokenLimit()
```
    get the tokenLimit(int) parameter
  - highlight
```
public PhraseSuggestionBuilder highlight(java.lang.String preTag,
                                         java.lang.String postTag)
```
    Setup highlighting for suggestions. If this is called a highlight field is returned with suggestions wrapping changed tokens with preTag and postTag.
  - preTag
```
public java.lang.String preTag()
```
    get the pre-tag for the highlighter set with highlight(String, String)
  - postTag
```
public java.lang.String postTag()
```
    get the post-tag for the highlighter set with highlight(String, String)
  - collateQuery
```
public PhraseSuggestionBuilder collateQuery(java.lang.String collateQuery)
```
    Sets a query used for filtering out suggested phrases (collation).
  - collateQuery
```
public PhraseSuggestionBuilder collateQuery(Script collateQueryTemplate)
```
    Sets a query used for filtering out suggested phrases (collation).
  - collateQuery
```
public Script collateQuery()
```
    gets the query used for filtering out suggested phrases (collation).
  - collateParams
```
public PhraseSuggestionBuilder collateParams(java.util.Map<java.lang.String,java.lang.Object> collateParams)
```
    Adds additional parameters for collate scripts. Previously added parameters on the same builder will be overwritten.
  - collateParams
```
public java.util.Map<java.lang.String,java.lang.Object> collateParams()
```
    gets additional params for collate script
  - collatePrune
```
public PhraseSuggestionBuilder collatePrune(boolean collatePrune)
```
    Sets whether to prune suggestions after collation
  - collatePrune
```
public java.lang.Boolean collatePrune()
```
    Gets whether to prune suggestions after collation
  - innerToXContent
```
public XContentBuilder innerToXContent(XContentBuilder builder,
                                       ToXContent.Params params)
                                throws java.io.IOException
```
    Specified by:
    
    innerToXContent in class SuggestionBuilder<PhraseSuggestionBuilder>
    
    Throws:
    
    java.io.IOException
  - fromXContent
```
public static PhraseSuggestionBuilder fromXContent(XContentParser parser)
                                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - build
```
public SuggestionSearchContext.SuggestionContext build(QueryShardContext context)
                                                throws java.io.IOException
```
    Specified by:
    
    build in class SuggestionBuilder<PhraseSuggestionBuilder>
    
    Throws:
    
    java.io.IOException
  - getWriteableName
```
public java.lang.String getWriteableName()
```
    Description copied from interface: NamedWriteable
    
    Returns the name of the writeable object
  - doEquals
```
protected boolean doEquals(PhraseSuggestionBuilder other)
```
    Description copied from class: SuggestionBuilder
    
    Indicates whether some other SuggestionBuilder of the same type is "equal to" this one.
    
    Specified by:
    
    doEquals in class SuggestionBuilder<PhraseSuggestionBuilder>
  - doHashCode
```
protected int doHashCode()
```
    Description copied from class: SuggestionBuilder
    
    HashCode for the subclass of SuggestionBuilder to implement.
    
    Specified by:
    
    doHashCode in class SuggestionBuilder<PhraseSuggestionBuilder>

Class PhraseSuggestionBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Field Summary

Fields inherited from class org.elasticsearch.search.suggest.SuggestionBuilder

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.elasticsearch.search.suggest.SuggestionBuilder

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

Field Detail

MAXERRORS_FIELD

RWE_LIKELIHOOD_FIELD

SEPARATOR_FIELD

CONFIDENCE_FIELD

GRAMSIZE_FIELD

SMOOTHING_MODEL_FIELD

FORCE_UNIGRAM_FIELD

TOKEN_LIMIT_FIELD

HIGHLIGHT_FIELD

PRE_TAG_FIELD

POST_TAG_FIELD

COLLATE_FIELD

COLLATE_QUERY_FIELD

COLLATE_QUERY_PARAMS

COLLATE_QUERY_PRUNE

Constructor Detail

PhraseSuggestionBuilder

PhraseSuggestionBuilder

Method Detail

doWriteTo

gramSize

gramSize

maxErrors

maxErrors

separator

separator

realWordErrorLikelihood

realWordErrorLikelihood

confidence

confidence

addCandidateGenerator

clearCandidateGenerators

forceUnigrams

forceUnigrams

smoothingModel

smoothingModel

tokenLimit

tokenLimit

highlight

preTag

postTag

collateQuery

collateQuery

collateQuery

collateParams

collateParams

collatePrune

collatePrune

innerToXContent

fromXContent

build

getWriteableName

doEquals

doHashCode