public static interface PostTextResponse.Builder extends LexRuntimeResponse.Builder, SdkPojo, CopyableBuilder<PostTextResponse.Builder,PostTextResponse>
| Modifier and Type | Method and Description |
|---|---|
PostTextResponse.Builder |
dialogState(DialogState dialogState)
Identifies the current state of the user interaction.
|
PostTextResponse.Builder |
dialogState(String dialogState)
Identifies the current state of the user interaction.
|
PostTextResponse.Builder |
intentName(String intentName)
The current user intent that Amazon Lex is aware of.
|
PostTextResponse.Builder |
message(String message)
The message to convey to the user.
|
PostTextResponse.Builder |
messageFormat(MessageFormatType messageFormat)
The format of the response message.
|
PostTextResponse.Builder |
messageFormat(String messageFormat)
The format of the response message.
|
default PostTextResponse.Builder |
responseCard(Consumer<ResponseCard.Builder> responseCard)
Represents the options that the user has to respond to the current prompt.
|
PostTextResponse.Builder |
responseCard(ResponseCard responseCard)
Represents the options that the user has to respond to the current prompt.
|
PostTextResponse.Builder |
sessionAttributes(Map<String,String> sessionAttributes)
A map of key-value pairs representing the session-specific context information.
|
PostTextResponse.Builder |
slots(Map<String,String> slots)
The intent slots that Amazon Lex detected from the user input in the conversation.
|
PostTextResponse.Builder |
slotToElicit(String slotToElicit)
If the
dialogState value is ElicitSlot, returns the name of the slot for which
Amazon Lex is eliciting a value. |
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponsecopyapplyMutation, buildPostTextResponse.Builder intentName(String intentName)
The current user intent that Amazon Lex is aware of.
intentName - The current user intent that Amazon Lex is aware of.PostTextResponse.Builder slots(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.
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.
PostTextResponse.Builder sessionAttributes(Map<String,String> sessionAttributes)
A map of key-value pairs representing the session-specific context information.
sessionAttributes - A map of key-value pairs representing the session-specific context information.PostTextResponse.Builder message(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.
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.
PostTextResponse.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 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.
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.
MessageFormatType,
MessageFormatTypePostTextResponse.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 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.
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.
MessageFormatType,
MessageFormatTypePostTextResponse.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 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.
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.
DialogState,
DialogStatePostTextResponse.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 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.
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.
DialogState,
DialogStatePostTextResponse.Builder slotToElicit(String slotToElicit)
If the dialogState value is ElicitSlot, returns the name of the slot for which
Amazon Lex is eliciting a value.
slotToElicit - If the dialogState value is ElicitSlot, returns the name of the slot for
which Amazon Lex is eliciting a value.PostTextResponse.Builder responseCard(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).
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).default PostTextResponse.Builder responseCard(Consumer<ResponseCard.Builder> 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).
This is a convenience that creates an instance of theResponseCard.Builder avoiding the need to
create one manually via ResponseCard.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to responseCard(ResponseCard).responseCard - a consumer that will call methods on ResponseCard.BuilderresponseCard(ResponseCard)Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.