Class RecognizeUtteranceRequest

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

  • Method Details

    • botId

      public final String botId()

      The identifier of the bot that should receive the request.

      Returns:
      The identifier of the bot that should receive the request.

    • botAliasId

      public final String botAliasId()

      The alias identifier in use for the bot that should receive the request.

      Returns:
      The alias identifier in use for the bot that should receive the request.

    • localeId

      public final String localeId()

      The locale where the session is in use.

      Returns:
      The locale where the session is in use.

    • sessionId

      public final String sessionId()

      The identifier of the session in use.

      Returns:
      The identifier of the session in use.

    • sessionState

      public final String sessionState()

      Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

      The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

      Returns:
      Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.

      The sessionState field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

    • requestAttributes

      public final String requestAttributes()

      Request-specific information passed between the client application and Amazon Lex V2

      The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

      The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

      Returns:
      Request-specific information passed between the client application and Amazon Lex V2

      The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.

      The requestAttributes field must be compressed using gzip and then base64 encoded before sending to Amazon Lex V2.

    • requestContentType

      public final String requestContentType()

      Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

      • PCM format, audio data must be in little-endian byte order.

        • audio/l16; rate=16000; channels=1

        • audio/x-l16; sample-rate=16000; channel-count=1

        • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

      • Opus format

        • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

      • Text format

        • text/plain; charset=utf-8

      Returns:
      Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:

      • PCM format, audio data must be in little-endian byte order.

        • audio/l16; rate=16000; channels=1

        • audio/x-l16; sample-rate=16000; channel-count=1

        • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

      • Opus format

        • audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4

      • Text format

        • text/plain; charset=utf-8

    • responseContentType

      public final String responseContentType()

      The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

      • If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

      • If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

      • If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

      • The following are the accepted values:

        • audio/mpeg

        • audio/ogg

        • audio/pcm (16 KHz)

        • audio/* (defaults to mpeg)

        • text/plain; charset=utf-8

      Returns:
      The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

      • If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

      • If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the responseContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

      • If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.

      • The following are the accepted values:

        • audio/mpeg

        • audio/ogg

        • audio/pcm (16 KHz)

        • audio/* (defaults to mpeg)

        • text/plain; charset=utf-8

    • toBuilder

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

    • builder

      public static RecognizeUtteranceRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.