Package co.elastic.clients.elasticsearch.core.search

Class PhraseSuggester

java.lang.Object

co.elastic.clients.elasticsearch.core.search.SuggesterBase

co.elastic.clients.elasticsearch.core.search.PhraseSuggester

All Implemented Interfaces:

SuggestVariant, JsonpSerializable, UnionVariant

@JsonpDeserializable
public final class PhraseSuggester
extends SuggesterBase
implements SuggestVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PhraseSuggester.Builder	Builder for PhraseSuggester.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.core.search.SuggesterBase

SuggesterBase.AbstractBuilder<BuilderT extends SuggesterBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<PhraseSuggester>	_DESERIALIZER	Json deserializer for PhraseSuggester

Constructor Summary

Constructors

Constructor	Description
PhraseSuggester(PhraseSuggester.Builder builder)
PhraseSuggester(java.util.function.Function<PhraseSuggester.Builder,PhraseSuggester.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	_variantType()	Suggest variant type
PhraseSuggestCollate	collate()	API name: collate
java.lang.Double	confidence()	API name: confidence
java.util.List<DirectGenerator>	directGenerator()	API name: direct_generator
java.lang.Boolean	forceUnigrams()	API name: force_unigrams
java.lang.Integer	gramSize()	API name: gram_size
PhraseSuggestHighlight	highlight()	API name: highlight
java.lang.Double	maxErrors()	API name: max_errors
java.lang.Double	realWordErrorLikelihood()	API name: real_word_error_likelihood
java.lang.String	separator()	API name: separator
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPhraseSuggesterDeserializer(DelegatingDeserializer<PhraseSuggester.Builder> op)
java.lang.Integer	shardSize()	API name: shard_size
SmoothingModel	smoothing()	API name: smoothing
java.lang.String	text()	API name: text
java.lang.Integer	tokenLimit()	API name: token_limit

Methods inherited from class co.elastic.clients.elasticsearch.core.search.SuggesterBase

analyzer, field, serialize, setupSuggesterBaseDeserializer, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch.core.search.SuggestVariant

_toSuggest

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PhraseSuggester> _DESERIALIZER

Json deserializer for PhraseSuggester

Constructor Details

PhraseSuggester

public PhraseSuggester(PhraseSuggester.Builder builder)

PhraseSuggester

public PhraseSuggester(java.util.function.Function<PhraseSuggester.Builder,PhraseSuggester.Builder> fn)

Method Details

_variantType

public java.lang.String _variantType()

Suggest variant type

Specified by:

_variantType in interface UnionVariant

collate

@Nullable
public PhraseSuggestCollate collate()

API name: collate

confidence

@Nullable
public java.lang.Double confidence()

API name: confidence

directGenerator

@Nullable
public java.util.List<DirectGenerator> directGenerator()

API name: direct_generator

forceUnigrams

@Nullable
public java.lang.Boolean forceUnigrams()

API name: force_unigrams

gramSize

@Nullable
public java.lang.Integer gramSize()

API name: gram_size

highlight

@Nullable
public PhraseSuggestHighlight highlight()

API name: highlight

maxErrors

@Nullable
public java.lang.Double maxErrors()

API name: max_errors

realWordErrorLikelihood

@Nullable
public java.lang.Double realWordErrorLikelihood()

API name: real_word_error_likelihood

separator

@Nullable
public java.lang.String separator()

API name: separator

shardSize

@Nullable
public java.lang.Integer shardSize()

API name: shard_size

smoothing

@Nullable
public SmoothingModel smoothing()

API name: smoothing

text

@Nullable
public java.lang.String text()

API name: text

tokenLimit

@Nullable
public java.lang.Integer tokenLimit()

API name: token_limit

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)

Overrides:

serializeInternal in class SuggesterBase

setupPhraseSuggesterDeserializer

protected static void setupPhraseSuggesterDeserializer(DelegatingDeserializer<PhraseSuggester.Builder> op)