Package org.opensearch.client.opensearch.core.search

Class PhraseSuggester

java.lang.Object

org.opensearch.client.opensearch.core.search.SuggesterBase

org.opensearch.client.opensearch.core.search.PhraseSuggester

All Implemented Interfaces:

JsonpSerializable, FieldSuggesterVariant

@JsonpDeserializable
public class PhraseSuggester
extends SuggesterBase
implements FieldSuggesterVariant

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.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

Method Summary

Modifier and Type	Method	Description
FieldSuggester.Kind	_fieldSuggesterKind()	FieldSuggester variant kind.
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
static PhraseSuggester	of(java.util.function.Function<PhraseSuggester.Builder,ObjectBuilder<PhraseSuggester>> fn)
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(ObjectDeserializer<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 org.opensearch.client.opensearch.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 org.opensearch.client.opensearch.core.search.FieldSuggesterVariant

_toFieldSuggester

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<PhraseSuggester> _DESERIALIZER

Json deserializer for PhraseSuggester

Method Detail

of

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

_fieldSuggesterKind

public FieldSuggester.Kind _fieldSuggesterKind()

FieldSuggester variant kind.

Specified by:

_fieldSuggesterKind in interface FieldSuggesterVariant

collate

@Nullable
public final PhraseSuggestCollate collate()

API name: collate

confidence

@Nullable
public final java.lang.Double confidence()

API name: confidence

directGenerator

public final java.util.List<DirectGenerator> directGenerator()

API name: direct_generator

forceUnigrams

@Nullable
public final java.lang.Boolean forceUnigrams()

API name: force_unigrams

gramSize

@Nullable
public final java.lang.Integer gramSize()

API name: gram_size

highlight

@Nullable
public final PhraseSuggestHighlight highlight()

API name: highlight

maxErrors

@Nullable
public final java.lang.Double maxErrors()

API name: max_errors

realWordErrorLikelihood

@Nullable
public final java.lang.Double realWordErrorLikelihood()

API name: real_word_error_likelihood

separator

@Nullable
public final java.lang.String separator()

API name: separator

shardSize

@Nullable
public final java.lang.Integer shardSize()

API name: shard_size

smoothing

@Nullable
public final SmoothingModel smoothing()

API name: smoothing

text

@Nullable
public final java.lang.String text()

API name: text

tokenLimit

@Nullable
public final 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(ObjectDeserializer<PhraseSuggester.Builder> op)