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

Interface PutSessionResponse.Builder

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

  • Method Details

    • contentType

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

      PutSessionResponse.Builder intentName(String intentName)

      The name of the current intent.

      Parameters:
      intentName - The name of the current intent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • slots

      PutSessionResponse.Builder slots(String slots)

      Map of zero or more intent slots Amazon Lex detected from the user input during 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.

      Parameters:
      slots - Map of zero or more intent slots Amazon Lex detected from the user input during 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.

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

    • sessionAttributes

      PutSessionResponse.Builder sessionAttributes(String sessionAttributes)

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

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

    • message

      @Deprecated PutSessionResponse.Builder message(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.

      The next message that should be presented to the user.

      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.

      Parameters:
      message - The next message that should be presented to the user.

      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.

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

    • encodedMessage

      PutSessionResponse.Builder encodedMessage(String encodedMessage)

      The next message that should be presented to the user.

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

      Parameters:
      encodedMessage - The next message that should be presented to the user.

      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

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

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

      PutSessionResponse.Builder dialogState(String dialogState)

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

      • ElicitIntent - Amazon Lex wants to elicit the user's intent.

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

      • Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

      • Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

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

      Parameters:
      dialogState -

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

      • ElicitIntent - Amazon Lex wants to elicit the user's intent.

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

      • Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

      • Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

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

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

    • dialogState

      PutSessionResponse.Builder dialogState(DialogState dialogState)

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

      • ElicitIntent - Amazon Lex wants to elicit the user's intent.

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

      • Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

      • Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

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

      Parameters:
      dialogState -

      • ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

      • ElicitIntent - Amazon Lex wants to elicit the user's intent.

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

      • Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

      • Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

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

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

    • slotToElicit

      PutSessionResponse.Builder slotToElicit(String slotToElicit)

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

      Parameters:
      slotToElicit - If the dialogState 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.

    • sessionId

      PutSessionResponse.Builder sessionId(String sessionId)

      A unique identifier for the session.

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

    • activeContexts

      PutSessionResponse.Builder activeContexts(String activeContexts)

      A list of active contexts for the session.

      Parameters:
      activeContexts - A list of active contexts for the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.