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

Class RecognizeTextResponse

    • Method Detail

      • hasMessages

        public final boolean hasMessages()
        For responses, this returns true if the service returned a value for the Messages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • messages

        public final List<Message> messages()

        A list of messages 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMessages() method.

        Returns:
        A list of messages 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.

      • sessionState

        public final SessionState 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 may be.

        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 may be.

      • hasInterpretations

        public final boolean hasInterpretations()
        For responses, this returns true if the service returned a value for the Interpretations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • interpretations

        public final List<Interpretation> 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 now 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInterpretations() method.

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

      • hasRequestAttributes

        public final boolean hasRequestAttributes()
        For responses, this returns true if the service returned a value for the RequestAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • requestAttributes

        public final Map<String,​String> requestAttributes()

        The attributes sent in the request.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequestAttributes() method.

        Returns:
        The attributes sent in the request.

      • sessionId

        public final String sessionId()

        The identifier of the session in use.

        Returns:
        The identifier of the session in use.

      • recognizedBotMember

        public final RecognizedBotMember recognizedBotMember()

        The bot member that recognized the text.

        Returns:
        The bot member that recognized the text.

      • 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