org.elasticsearch.search.suggest

Class SuggestBuilder.SuggestionBuilder<T>

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

CompletionSuggestionBuilder, CompletionSuggestionFuzzyBuilder, PhraseSuggestionBuilder, TermSuggestionBuilder

Enclosing class:

SuggestBuilder

public abstract static class SuggestBuilder.SuggestionBuilder<T>
extends ToXContentToBytes

Nested Class Summary

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
SuggestBuilder.SuggestionBuilder(String name, String suggester)

Method Summary

Methods

Modifier and Type	Method and Description
T	addCategory(String name, CharSequence... categories) Setup a Category for suggestions.
T	addCategory(String name, Iterable<? extends CharSequence> categories) Setup a Category for suggestions.
T	addContextField(String name, CharSequence... fieldvalues) Setup a Context Field for suggestions.
T	addContextField(String name, Iterable<? extends CharSequence> fieldvalues) Setup a Context Field for suggestions.
T	addGeoLocation(String name, double lat, double lon, int... precisions) Setup a Geolocation for suggestions.
T	addGeoLocation(String name, String geohash) Setup a Geolocation for suggestions.
T	addGeoLocationWithPrecision(String name, double lat, double lon, String... precisions) Setup a Geolocation for suggestions.
T	analyzer(String analyzer) Sets the analyzer to analyse to suggest text with.
T	field(String field) Sets from what field to fetch the candidate suggestions from.
protected abstract XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)
T	shardSize(Integer shardSize) Sets the maximum number of suggested term to be retrieved from each individual shard.
T	size(int size) Sets the maximum suggestions to be returned per suggest text term.
T	text(String text) Same as in SuggestBuilder.setText(String), but in the suggestion scope.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

SuggestBuilder.SuggestionBuilder

public SuggestBuilder.SuggestionBuilder(String name,
                                String suggester)

Method Detail

addGeoLocation

public T addGeoLocation(String name,
               double lat,
               double lon,
               int... precisions)

Setup a Geolocation for suggestions. See GeolocationContextMapping.

Parameters:

lat - Latitude of the location

lon - Longitude of the Location

Returns:

this

addGeoLocationWithPrecision

public T addGeoLocationWithPrecision(String name,
                            double lat,
                            double lon,
                            String... precisions)

Setup a Geolocation for suggestions. See GeolocationContextMapping.

Parameters:

lat - Latitude of the location

lon - Longitude of the Location

precisions - precisions as string var-args

Returns:

this

addGeoLocation

public T addGeoLocation(String name,
               String geohash)

Setup a Geolocation for suggestions. See GeolocationContextMapping.

Parameters:

geohash - Geohash of the location

Returns:

this

addCategory

public T addCategory(String name,
            CharSequence... categories)

Setup a Category for suggestions. See CategoryContextMapping.

Parameters:

categories - name of the category

Returns:

this

addCategory

public T addCategory(String name,
            Iterable<? extends CharSequence> categories)

Setup a Category for suggestions. See CategoryContextMapping.

Parameters:

categories - name of the category

Returns:

this

addContextField

public T addContextField(String name,
                CharSequence... fieldvalues)

Setup a Context Field for suggestions. See CategoryContextMapping.

Parameters:

fieldvalues - name of the category

Returns:

this

addContextField

public T addContextField(String name,
                Iterable<? extends CharSequence> fieldvalues)

Setup a Context Field for suggestions. See CategoryContextMapping.

Parameters:

fieldvalues - name of the category

Returns:

this

text

public T text(String text)

Same as in SuggestBuilder.setText(String), but in the suggestion scope.

toXContent

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

Throws:

IOException

innerToXContent

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

Throws:

IOException

field

public T field(String field)

Sets from what field to fetch the candidate suggestions from. This is an required option and needs to be set via this setter or field(String) method

analyzer

public T analyzer(String analyzer)

Sets the analyzer to analyse to suggest text with. Defaults to the search analyzer of the suggest field.

size

public T size(int size)

Sets the maximum suggestions to be returned per suggest text term.

shardSize

public T shardSize(Integer shardSize)

Sets the maximum number of suggested term to be retrieved from each individual shard. During the reduce phase the only the top N suggestions are returned based on the size option. Defaults to the size option.

Setting this to a value higher than the `size` can be useful in order to get a more accurate document frequency for suggested terms. Due to the fact that terms are partitioned amongst shards, the shard level document frequencies of suggestions may not be precise. Increasing this will make these document frequencies more precise.