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

Interface RecognizeUtteranceResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<RecognizeUtteranceResponse.Builder,RecognizeUtteranceResponse>, LexRuntimeV2Response.Builder, SdkBuilder<RecognizeUtteranceResponse.Builder,RecognizeUtteranceResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
RecognizeUtteranceResponse
public static interface RecognizeUtteranceResponse.Builder extends LexRuntimeV2Response.Builder, SdkPojo, CopyableBuilder<RecognizeUtteranceResponse.Builder,RecognizeUtteranceResponse>

  • Method Details

    • inputMode

      RecognizeUtteranceResponse.Builder inputMode(String inputMode)

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

      Parameters:
      inputMode - Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentType

      RecognizeUtteranceResponse.Builder contentType(String contentType)

      Content type as specified in the responseContentType in the request.

      Parameters:
      contentType - Content type as specified in the responseContentType in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messages

      RecognizeUtteranceResponse.Builder messages(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.

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

    • interpretations

      RecognizeUtteranceResponse.Builder interpretations(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.

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

    • sessionState

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

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

    • requestAttributes

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

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

    • sessionId

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

    • inputTranscript

      RecognizeUtteranceResponse.Builder inputTranscript(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.

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

    • recognizedBotMember

      RecognizeUtteranceResponse.Builder recognizedBotMember(String recognizedBotMember)

      The bot member that recognized the utterance.

      Parameters:
      recognizedBotMember - The bot member that recognized the utterance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.