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, PlainJsonSerializable, FieldSuggesterVariant, ToCopyableBuilder<PhraseSuggester.Builder,PhraseSuggester>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class PhraseSuggester
extends SuggesterBase
implements FieldSuggesterVariant, ToCopyableBuilder<PhraseSuggester.Builder,PhraseSuggester>

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 final JsonpDeserializer<PhraseSuggester>	_DESERIALIZER	Json deserializer for PhraseSuggester

Method Summary

Modifier and Type	Method	Description
FieldSuggester.Kind	_fieldSuggesterKind()	FieldSuggester variant kind.
static PhraseSuggester.Builder	builder()
final PhraseSuggestCollate	collate()	API name: collate
final Double	confidence()	API name: confidence
final List<DirectGenerator>	directGenerator()	API name: direct_generator
boolean	equals(Object o)
final Boolean	forceUnigrams()	API name: force_unigrams
final Integer	gramSize()	API name: gram_size
int	hashCode()
final PhraseSuggestHighlight	highlight()	API name: highlight
final Double	maxErrors()	API name: max_errors
static PhraseSuggester	of(Function<PhraseSuggester.Builder,ObjectBuilder<PhraseSuggester>> fn)
final Double	realWordErrorLikelihood()	API name: real_word_error_likelihood
final String	separator()	API name: separator
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPhraseSuggesterDeserializer(ObjectDeserializer<PhraseSuggester.Builder> op)
final Integer	shardSize()	API name: shard_size
final SmoothingModel	smoothing()	API name: smoothing
final String	text()	API name: text
PhraseSuggester.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.opensearch.core.search.FieldSuggesterVariant

toFieldSuggester

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PhraseSuggester> _DESERIALIZER

Json deserializer for PhraseSuggester

Method Details

of

public static PhraseSuggester of(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 Double confidence()

API name: confidence

directGenerator

@Nonnull
public final List<DirectGenerator> directGenerator()

API name: direct_generator

forceUnigrams

@Nullable
public final Boolean forceUnigrams()

API name: force_unigrams

gramSize

@Nullable
public final Integer gramSize()

API name: gram_size

highlight

@Nullable
public final PhraseSuggestHighlight highlight()

API name: highlight

maxErrors

@Nullable
public final Double maxErrors()

API name: max_errors

realWordErrorLikelihood

@Nullable
public final Double realWordErrorLikelihood()

API name: real_word_error_likelihood

separator

@Nullable
public final String separator()

API name: separator

shardSize

@Nullable
public final Integer shardSize()

API name: shard_size

smoothing

@Nullable
public final SmoothingModel smoothing()

API name: smoothing

text

@Nullable
public final String text()

API name: text

tokenLimit

@Nullable
public final Integer tokenLimit()

API name: token_limit

serializeInternal

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

Overrides:

serializeInternal in class SuggesterBase

toBuilder

@Nonnull
public PhraseSuggester.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PhraseSuggester.Builder,PhraseSuggester>

Returns:

a new builder instance.

builder

@Nonnull
public static PhraseSuggester.Builder builder()

setupPhraseSuggesterDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class SuggesterBase

equals

public boolean equals(Object o)

Overrides:

equals in class SuggesterBase