Class PostContentResponse

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.PostContentResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PostContentResponse.Builder,PostContentResponse>
@Generated("software.amazon.awssdk:codegen") public final class PostContentResponse extends LexRuntimeResponse implements ToCopyableBuilder<PostContentResponse.Builder,PostContentResponse>

  • Method Details

    • contentType

      public final String contentType()

      Content type as specified in the Accept HTTP header in the request.

      Returns:
      Content type as specified in the Accept HTTP header in the request.

    • intentName

      public final String intentName()

      Current user intent that Amazon Lex is aware of.

      Returns:
      Current user intent that Amazon Lex is aware of.

    • nluIntentConfidence

      public final String 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.

      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.

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

    • alternativeIntents

      public final String 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.

      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.

    • slots

      public final String slots()

      Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.

      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.

      Returns:
      Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.

      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.

    • sessionAttributes

      public final String sessionAttributes()

      Map of key/value pairs representing the session-specific context information.

      Returns:
      Map of key/value pairs representing the session-specific context information.

    • sentimentResponse

      public final String sentimentResponse()

      The sentiment expressed in an 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 an utterance.

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

    • message

      @Deprecated public final String message()
      Deprecated.
      The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.

      You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

      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 in 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:
      You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

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

    • encodedMessage

      public final String encodedMessage()

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

      The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

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

      The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

    • 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 for the client.

      • 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 for the client.

      • 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 for the client.

      • 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 for the client.

      • 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 the user's intent. Consider the following examples:

        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 dialog state.

      • 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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting the value of a slot 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 has successfully fulfilled the intent.

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

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

        This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the user's intent. Consider the following examples:

        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 dialog state.

      • 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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting the value of a slot 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 has successfully fulfilled the intent.

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

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

        This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the user's intent. Consider the following examples:

        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 dialog state.

      • 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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting the value of a slot 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 has successfully fulfilled the intent.

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

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

        This can happen for various reasons, including that the user does 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 if the Lambda function fails 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 the user's intent. Consider the following examples:

        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 dialog state.

      • 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" response, a user might respond with additional information. For example, "yes, but make it a 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 or change the intent from OrderPizza to OrderDrink).

      • ElicitSlot - Amazon Lex is expecting the value of a slot 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 has successfully fulfilled the intent.

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

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

        This can happen for various reasons, including that the user does 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 if the Lambda function fails 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.

    • inputTranscript

      @Deprecated public final String inputTranscript()
      Deprecated.
      The inputTranscript field is deprecated, use the encodedInputTranscript field instead. The inputTranscript field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.

      The text used to process the request.

      You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the inputTranscript field is null. You should use the encodedInputTranscript field instead.

      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 is correctly processing the audio that you send.

      Returns:
      The text used to process the request.

      You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the inputTranscript field is null. You should use the encodedInputTranscript field instead.

      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 is correctly processing the audio that you send.

    • encodedInputTranscript

      public final String encodedInputTranscript()

      The text used to process the request.

      If the input was an audio stream, the encodedInputTranscript 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 is correctly processing the audio that you send.

      The encodedInputTranscript field is base-64 encoded. You must decode the field before you can use the value.

      Returns:
      The text used to process the request.

      If the input was an audio stream, the encodedInputTranscript 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 is correctly processing the audio that you send.

      The encodedInputTranscript field is base-64 encoded. You must decode the field before you can use the value.

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

    • sessionId

      public final String sessionId()

      The unique identifier for the session.

      Returns:
      The unique identifier for the session.

    • activeContexts

      public final String 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.

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

    • builder

      public static PostContentResponse.Builder builder()

    • serializableBuilderClass

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