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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SpellCorrectionConfiguration.Builder,SpellCorrectionConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.