Package software.amazon.awssdk.services.lexruntime.model

Class PostTextResponse

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

  • Method Details

    • intentName

      public final String intentName()

      The current user intent that Amazon Lex is aware of.

      Returns:
      The current user intent that Amazon Lex is aware of.

    • nluIntentConfidence

      public final IntentConfidence nluIntentConfidence()

      Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores.

      The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.

      Returns:
      Provides a score that indicates how confident Amazon Lex is that the returned intent is the one that matches the user's intent. The score is between 0.0 and 1.0. For more information, see Confidence Scores.

      The score is a relative score, not an absolute score. The score may change based on improvements to Amazon Lex.

    • hasAlternativeIntents

      public final boolean hasAlternativeIntents()
      For responses, this returns true if the service returned a value for the AlternativeIntents 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.

    • alternativeIntents

      public final List<PredictedIntent> alternativeIntents()

      One to four alternative intents that may be applicable to the user's intent.

      Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.

      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 hasAlternativeIntents() method.

      Returns:
      One to four alternative intents that may be applicable to the user's intent.

      Each alternative includes a score that indicates how confident Amazon Lex is that the intent matches the user's intent. The intents are sorted by the confidence score.

    • hasSlots

      public final boolean hasSlots()
      For responses, this returns true if the service returned a value for the Slots 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.

    • slots

      public final Map<String,String> slots()

      The intent slots that Amazon Lex detected from the user input in the conversation.

      Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

      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 hasSlots() method.

      Returns:
      The intent slots that Amazon Lex detected from the user input in the conversation.

      Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

    • hasSessionAttributes

      public final boolean hasSessionAttributes()
      For responses, this returns true if the service returned a value for the SessionAttributes 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.

    • sessionAttributes

      public final Map<String,String> sessionAttributes()

      A map of key-value pairs representing the session-specific context information.

      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 hasSessionAttributes() method.

      Returns:
      A map of key-value pairs representing the session-specific context information.

    • message

      public final String message()

      The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

      If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

      When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

      If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

      Returns:
      The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

      If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

      When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

      If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

    • sentimentResponse

      public final SentimentResponse sentimentResponse()

      The sentiment expressed in and utterance.

      When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

      Returns:
      The sentiment expressed in and utterance.

      When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.

    • messageFormat

      public final MessageFormatType messageFormat()

      The format of the response message. One of the following values:

      • PlainText - The message contains plain UTF-8 text.

      • CustomPayload - The message is a custom format defined by the Lambda function.

      • SSML - The message contains text formatted for voice output.

      • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

      If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

      Returns:
      The format of the response message. One of the following values:

      • PlainText - The message contains plain UTF-8 text.

      • CustomPayload - The message is a custom format defined by the Lambda function.

      • SSML - The message contains text formatted for voice output.

      • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

      See Also:

    • messageFormatAsString

      public final String messageFormatAsString()

      The format of the response message. One of the following values:

      • PlainText - The message contains plain UTF-8 text.

      • CustomPayload - The message is a custom format defined by the Lambda function.

      • SSML - The message contains text formatted for voice output.

      • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

      If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

      Returns:
      The format of the response message. One of the following values:

      • PlainText - The message contains plain UTF-8 text.

      • CustomPayload - The message is a custom format defined by the Lambda function.

      • SSML - The message contains text formatted for voice output.

      • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

      See Also:

    • dialogState

      public final DialogState dialogState()

      Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

      • ElicitIntent - Amazon Lex wants to elicit user intent.

        For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

        For example, Amazon Lex wants user confirmation before fulfilling an intent.

        Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting a slot value for the current intent.

        For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

      • Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.

      • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

      • Failed - Conveys that the conversation with the user failed.

        This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.

      If the service returns an enum value that is not available in the current SDK version, dialogState will return DialogState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogStateAsString().

      Returns:
      Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

      • ElicitIntent - Amazon Lex wants to elicit user intent.

        For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

        For example, Amazon Lex wants user confirmation before fulfilling an intent.

        Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting a slot value for the current intent.

        For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

      • Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.

      • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

      • Failed - Conveys that the conversation with the user failed.

        This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.

      See Also:

    • dialogStateAsString

      public final String dialogStateAsString()

      Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

      • ElicitIntent - Amazon Lex wants to elicit user intent.

        For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

        For example, Amazon Lex wants user confirmation before fulfilling an intent.

        Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting a slot value for the current intent.

        For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

      • Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.

      • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

      • Failed - Conveys that the conversation with the user failed.

        This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.

      If the service returns an enum value that is not available in the current SDK version, dialogState will return DialogState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogStateAsString().

      Returns:
      Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

      • ElicitIntent - Amazon Lex wants to elicit user intent.

        For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.

        For example, Amazon Lex wants user confirmation before fulfilling an intent.

        Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting a slot value for the current intent.

        For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.

      • Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.

      • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

      • Failed - Conveys that the conversation with the user failed.

        This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.

      See Also:

    • slotToElicit

      public final String slotToElicit()

      If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

      Returns:
      If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

    • responseCard

      public final ResponseCard responseCard()

      Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).

      Returns:
      Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).

    • sessionId

      public final String sessionId()

      A unique identifier for the session.

      Returns:
      A unique identifier for the session.

    • botVersion

      public final String botVersion()

      The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.

      Returns:
      The version of the bot that responded to the conversation. You can use this information to help determine if one version of a bot is performing better than another version.

    • hasActiveContexts

      public final boolean hasActiveContexts()
      For responses, this returns true if the service returned a value for the ActiveContexts 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.

    • activeContexts

      public final List<ActiveContext> activeContexts()

      A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

      You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

      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 hasActiveContexts() method.

      Returns:
      A list of active contexts for the session. A context can be set when an intent is fulfilled or by calling the PostContent, PostText, or PutSession operation.

      You can use a context to control the intents that can follow up an intent, or to modify the operation of your application.

    • toBuilder

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

    • builder

      public static PostTextResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PostTextResponse.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.