Package org.opensearch.client.opensearch._global.search

Class PhraseSuggester

java.lang.Object

org.opensearch.client.opensearch._global.search.SuggesterBase

org.opensearch.client.opensearch._global.search.PhraseSuggester

All Implemented Interfaces:

ToJsonp

public final class PhraseSuggester
extends SuggesterBase

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._global.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

Modifier	Constructor	Description
protected	PhraseSuggester(PhraseSuggester.Builder builder)

Method Summary

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

Methods inherited from class org.opensearch.client.opensearch._global.search.SuggesterBase

analyzer, field, setupSuggesterBaseDeserializer, size, toJsonp

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<PhraseSuggester> DESERIALIZER

Json deserializer for PhraseSuggester

Constructor Details

PhraseSuggester

protected PhraseSuggester(PhraseSuggester.Builder builder)

Method Details

collate

@Nullable public PhraseSuggestCollate collate()

API name: collate

confidence

@Nullable public java.lang.Number 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.Number gramSize()

API name: gram_size

highlight

@Nullable public PhraseSuggestHighlight highlight()

API name: highlight

maxErrors

@Nullable public java.lang.Number maxErrors()

API name: max_errors

realWordErrorLikelihood

@Nullable public java.lang.Number realWordErrorLikelihood()

API name: real_word_error_likelihood

separator

@Nullable public java.lang.String separator()

API name: separator

shardSize

@Nullable public java.lang.Number shardSize()

API name: shard_size

smoothing

@Nullable public SmoothingModelContainer smoothing()

API name: smoothing

text

@Nullable public java.lang.String text()

API name: text

tokenLimit

@Nullable public java.lang.Number tokenLimit()

API name: token_limit

toJsonpInternal

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

Overrides:

toJsonpInternal in class SuggesterBase

setupPhraseSuggesterDeserializer

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