Package software.amazon.awssdk.services.kendra.model

Class SpellCorrectionConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.SpellCorrectionConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SpellCorrectionConfiguration.Builder,SpellCorrectionConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class SpellCorrectionConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SpellCorrectionConfiguration.Builder,SpellCorrectionConfiguration>

Provides the configuration information for suggested query spell corrections.

Suggested spell corrections are based on words that appear in your indexed documents and how closely a corrected word matches a misspelled word.

This feature is designed with certain defaults or limits. For information on the current limits and how to request more support for some limits, see the Spell Checker documentation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpellCorrectionConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SpellCorrectionConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeQuerySpellCheckSuggestions()	TRUE to suggest spell corrections for queries.
List<SdkField<?>>	sdkFields()
static Class<? extends SpellCorrectionConfiguration.Builder>	serializableBuilderClass()
SpellCorrectionConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

includeQuerySpellCheckSuggestions

public final Boolean includeQuerySpellCheckSuggestions()

TRUE to suggest spell corrections for queries.

Returns:

TRUE to suggest spell corrections for queries.

toBuilder

public SpellCorrectionConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpellCorrectionConfiguration.Builder,SpellCorrectionConfiguration>

builder

public static SpellCorrectionConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SpellCorrectionConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo