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

Interface RecognizeUtteranceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>, LexRuntimeV2Request.Builder, SdkBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RecognizeUtteranceRequest
public static interface RecognizeUtteranceRequest.Builder extends LexRuntimeV2Request.Builder, SdkPojo, CopyableBuilder<RecognizeUtteranceRequest.Builder,RecognizeUtteranceRequest>

  • Method Details

    • botId

      RecognizeUtteranceRequest.Builder botId(String botId)

      The identifier of the bot that should receive the request.

      Parameters:
      botId - The identifier of the bot that should receive the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • botAliasId

      RecognizeUtteranceRequest.Builder botAliasId(String botAliasId)

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

      Parameters:
      botAliasId - The alias identifier in use for the bot that should receive the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • localeId

      RecognizeUtteranceRequest.Builder localeId(String localeId)

      The locale where the session is in use.

      Parameters:
      localeId - The locale where the session is in use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      RecognizeUtteranceRequest.Builder sessionId(String sessionId)

      The identifier of the session in use.

      Parameters:
      sessionId - The identifier of the session in use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionState

      RecognizeUtteranceRequest.Builder sessionState(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • requestAttributes

      RecognizeUtteranceRequest.Builder requestAttributes(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • requestContentType

      RecognizeUtteranceRequest.Builder requestContentType(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • responseContentType

      RecognizeUtteranceRequest.Builder responseContentType(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      RecognizeUtteranceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RecognizeUtteranceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.