Package software.amazon.awssdk.services.lexruntimev2.model

Class Interpretation

java.lang.Object
software.amazon.awssdk.services.lexruntimev2.model.Interpretation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Interpretation.Builder,Interpretation>
@Generated("software.amazon.awssdk:codegen") public final class Interpretation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Interpretation.Builder,Interpretation>

An object containing information about an intent that Amazon Lex V2 determined might satisfy the user's utterance. The intents are ordered by the confidence score.

See Also:

  • Method Details

    • nluConfidence

      public final ConfidenceScore nluConfidence()

      Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

      Returns:
      Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

    • sentimentResponse

      public final SentimentResponse sentimentResponse()

      The sentiment expressed in an utterance.

      When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

      Returns:
      The sentiment expressed in an utterance.

      When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

    • intent

      public final Intent intent()

      A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

      Returns:
      A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

    • interpretationSource

      public final InterpretationSource interpretationSource()

      Specifies the service that interpreted the input.

      If the service returns an enum value that is not available in the current SDK version, interpretationSource will return InterpretationSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interpretationSourceAsString().

      Returns:
      Specifies the service that interpreted the input.
      See Also:

    • interpretationSourceAsString

      public final String interpretationSourceAsString()

      Specifies the service that interpreted the input.

      If the service returns an enum value that is not available in the current SDK version, interpretationSource will return InterpretationSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interpretationSourceAsString().

      Returns:
      Specifies the service that interpreted the input.
      See Also:

    • toBuilder

      public Interpretation.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<Interpretation.Builder,Interpretation>
      Returns:
      a builder for type T

    • builder

      public static Interpretation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Interpretation.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.