Interface PostContentResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<PostContentResponse.Builder,PostContentResponse>, LexRuntimeResponse.Builder, SdkBuilder<PostContentResponse.Builder,PostContentResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
PostContentResponse

public static interface PostContentResponse.Builder extends LexRuntimeResponse.Builder, SdkPojo, CopyableBuilder<PostContentResponse.Builder,PostContentResponse>
  • Method Details

    • contentType

      PostContentResponse.Builder contentType(String contentType)

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

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

      PostContentResponse.Builder intentName(String intentName)

      Current user intent that Amazon Lex is aware of.

      Parameters:
      intentName - Current user intent that Amazon Lex is aware of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nluIntentConfidence

      PostContentResponse.Builder nluIntentConfidence(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.

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

      PostContentResponse.Builder alternativeIntents(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.

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

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

      PostContentResponse.Builder sessionAttributes(String sessionAttributes)

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

      Parameters:
      sessionAttributes - Map of key/value pairs representing the session-specific context information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sentimentResponse

      PostContentResponse.Builder sentimentResponse(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.

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

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

      PostContentResponse.Builder encodedMessage(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.

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

      PostContentResponse.Builder messageFormat(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • messageFormat

      PostContentResponse.Builder messageFormat(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • dialogState

      PostContentResponse.Builder dialogState(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • dialogState

      PostContentResponse.Builder dialogState(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • slotToElicit

      PostContentResponse.Builder slotToElicit(String slotToElicit)

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

      Parameters:
      slotToElicit - If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • inputTranscript

      @Deprecated PostContentResponse.Builder inputTranscript(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.

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

      PostContentResponse.Builder encodedInputTranscript(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.

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

      PostContentResponse.Builder botVersion(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.

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

      PostContentResponse.Builder sessionId(String sessionId)

      The unique identifier for the session.

      Parameters:
      sessionId - The unique identifier for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • activeContexts

      PostContentResponse.Builder activeContexts(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.

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