org.elasticsearch.search.suggest.phrase

Class PhraseSuggestionBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder<PhraseSuggestionBuilder>

org.elasticsearch.search.suggest.phrase.PhraseSuggestionBuilder

All Implemented Interfaces:

ToXContent

public final class PhraseSuggestionBuilder
extends SuggestBuilder.SuggestionBuilder<PhraseSuggestionBuilder>

Defines the actual suggest command for phrase suggestions ( phrase).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhraseSuggestionBuilder.CandidateGenerator CandidateGenerator base class.
static class	PhraseSuggestionBuilder.DirectCandidateGenerator
static class	PhraseSuggestionBuilder.Laplace An additive smoothing model.
static class	PhraseSuggestionBuilder.LinearInterpolation Linear interpolation smoothing model.
static class	PhraseSuggestionBuilder.SmoothingModel
static class	PhraseSuggestionBuilder.StupidBackoff A "stupid-backoff" smoothing model simialr to Katz's Backoff.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
PhraseSuggestionBuilder(String name)

Method Summary

Methods

Modifier and Type	Method and Description
PhraseSuggestionBuilder	addCandidateGenerator(PhraseSuggestionBuilder.CandidateGenerator generator) Adds a CandidateGenerator to this suggester.
static PhraseSuggestionBuilder.DirectCandidateGenerator	candidateGenerator(String field) Creates a new DirectCandidateGenerator
PhraseSuggestionBuilder	clearCandidateGenerators() Clear the candidate generators.
PhraseSuggestionBuilder	collateParams(Map<String,Object> collateParams) Sets additional params for collate script
PhraseSuggestionBuilder	collatePrune(boolean collatePrune) Sets whether to prune suggestions after collation
PhraseSuggestionBuilder	collateQuery(String collateQuery) Sets a query used for filtering out suggested phrases (collation).
PhraseSuggestionBuilder	collateQuery(Template collateQueryTemplate) Sets a query used for filtering out suggested phrases (collation).
PhraseSuggestionBuilder	confidence(Float confidence) Sets the confidence level for this suggester.
PhraseSuggestionBuilder	forceUnigrams(boolean forceUnigrams) If set to true the phrase suggester will fail if the analyzer only produces ngrams.
PhraseSuggestionBuilder	gramSize(int gramSize) Sets the gram size for the n-gram model used for this suggester.
PhraseSuggestionBuilder	highlight(String preTag, String postTag) Setup highlighting for suggestions.
XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)
PhraseSuggestionBuilder	maxErrors(Float maxErrors) Sets the maximum percentage of the terms that at most considered to be misspellings in order to form a correction.
PhraseSuggestionBuilder	realWordErrorLikelihood(Float realWordErrorLikelihood) Sets the likelihood of a term being a misspelled even if the term exists in the dictionary.
PhraseSuggestionBuilder	separator(String separator) Sets the separator that is used to separate terms in the bigram field.
PhraseSuggestionBuilder	smoothingModel(PhraseSuggestionBuilder.SmoothingModel model) Sets an explicit smoothing model used for this suggester.
PhraseSuggestionBuilder	tokenLimit(int tokenLimit)

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

addCategory, addCategory, addContextField, addContextField, addGeoLocation, addGeoLocation, addGeoLocationWithPrecision, analyzer, field, shardSize, size, text, toXContent

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PhraseSuggestionBuilder

public PhraseSuggestionBuilder(String name)

Method Detail

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.

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 absolut number of query terms. The default is set to 1.0 which corresponds to that only corrections with at most 1 missspelled term are returned.

separator

public PhraseSuggestionBuilder separator(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.

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.

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

addCandidateGenerator

public PhraseSuggestionBuilder addCandidateGenerator(PhraseSuggestionBuilder.CandidateGenerator generator)

Adds a CandidateGenerator to this suggester. The 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.

smoothingModel

public PhraseSuggestionBuilder smoothingModel(PhraseSuggestionBuilder.SmoothingModel model)

Sets an explicit smoothing model used for this suggester. The default is PhraseSuggestionBuilder.StupidBackoff.

tokenLimit

public PhraseSuggestionBuilder tokenLimit(int tokenLimit)

highlight

public PhraseSuggestionBuilder highlight(String preTag,
                                String postTag)

Setup highlighting for suggestions. If this is called a highlight field is returned with suggestions wrapping changed tokens with preTag and postTag.

collateQuery

public PhraseSuggestionBuilder collateQuery(String collateQuery)

Sets a query used for filtering out suggested phrases (collation).

collateQuery

public PhraseSuggestionBuilder collateQuery(Template collateQueryTemplate)

Sets a query used for filtering out suggested phrases (collation).

collateParams

public PhraseSuggestionBuilder collateParams(Map<String,Object> collateParams)

Sets additional params for collate script

collatePrune

public PhraseSuggestionBuilder collatePrune(boolean collatePrune)

Sets whether to prune suggestions after collation

innerToXContent

public XContentBuilder innerToXContent(XContentBuilder builder,
                              ToXContent.Params params)
                                throws IOException

Specified by:

innerToXContent in class SuggestBuilder.SuggestionBuilder<PhraseSuggestionBuilder>

Throws:

IOException

candidateGenerator

public static PhraseSuggestionBuilder.DirectCandidateGenerator candidateGenerator(String field)

Creates a new DirectCandidateGenerator

Parameters:

field - the field this candidate generator operates on.