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

Class RecognizeUtteranceResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.lexruntimev2.model.LexRuntimeV2Response
software.amazon.awssdk.services.lexruntimev2.model.RecognizeUtteranceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RecognizeUtteranceResponse.Builder,RecognizeUtteranceResponse>
@Generated("software.amazon.awssdk:codegen") public final class RecognizeUtteranceResponse extends LexRuntimeV2Response implements ToCopyableBuilder<RecognizeUtteranceResponse.Builder,RecognizeUtteranceResponse>

  • Method Details

    • inputMode

      public final String inputMode()

      Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.

      Returns:
      Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.

    • contentType

      public final String contentType()

      Content type as specified in the responseContentType in the request.

      Returns:
      Content type as specified in the responseContentType in the request.

    • messages

      public final String messages()

      A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

      The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

      Returns:
      A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

      The messages field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • interpretations

      public final String interpretations()

      A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

      Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

      The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

      Returns:
      A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

      Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

      The interpretations field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • sessionState

      public final String sessionState()

      Represents the current state of the dialog between the user and the bot.

      Use this to determine the progress of the conversation and what the next action might be.

      The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

      Returns:
      Represents the current state of the dialog between the user and the bot.

      Use this to determine the progress of the conversation and what the next action might be.

      The sessionState field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • requestAttributes

      public final String requestAttributes()

      The attributes sent in the request.

      The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.

      Returns:
      The attributes sent in the request.

      The requestAttributes field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents.

    • sessionId

      public final String sessionId()

      The identifier of the session in use.

      Returns:
      The identifier of the session in use.

    • inputTranscript

      public final String inputTranscript()

      The text used to process the request.

      If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.

      The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

      Returns:
      The text used to process the request.

      If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex V2 is correctly processing the audio that you send.

      The inputTranscript field is compressed with gzip and then base64 encoded. Before you can use the contents of the field, you must decode and decompress the contents. See the example for a simple function to decode and decompress the contents.

    • recognizedBotMember

      public final String recognizedBotMember()

      The bot member that recognized the utterance.

      Returns:
      The bot member that recognized the utterance.

    • toBuilder

      public RecognizeUtteranceResponse.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<RecognizeUtteranceResponse.Builder,RecognizeUtteranceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static RecognizeUtteranceResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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