Interface DialogAction.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DialogAction.Builder,
,DialogAction> SdkBuilder<DialogAction.Builder,
,DialogAction> SdkPojo
- Enclosing class:
DialogAction
-
Method Summary
Modifier and TypeMethodDescriptionfulfillmentState
(String fulfillmentState) The fulfillment state of the intent.fulfillmentState
(FulfillmentState fulfillmentState) The fulfillment state of the intent.intentName
(String intentName) The name of the intent.The message that should be shown to the user.messageFormat
(String messageFormat) messageFormat
(MessageFormatType messageFormat) Map of the slots that have been gathered and their values.slotToElicit
(String slotToElicit) The name of the slot that should be elicited from the user.The next action that the bot should take in its interaction with the user.type
(DialogActionType type) The next action that the bot should take in its interaction with the user.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
type
The next action that the bot should take in its interaction with the user. The possible values are:
-
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?" -
Close
- Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response. -
Delegate
- The next action is determined by Amazon Lex. -
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill. -
ElicitSlot
- The next action is to elicit a slot value from the user.
- Parameters:
type
- The next action that the bot should take in its interaction with the user. The possible values are:-
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?" -
Close
- Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response. -
Delegate
- The next action is determined by Amazon Lex. -
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill. -
ElicitSlot
- The next action is to elicit a slot value from the user.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
type
The next action that the bot should take in its interaction with the user. The possible values are:
-
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?" -
Close
- Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response. -
Delegate
- The next action is determined by Amazon Lex. -
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill. -
ElicitSlot
- The next action is to elicit a slot value from the user.
- Parameters:
type
- The next action that the bot should take in its interaction with the user. The possible values are:-
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?" -
Close
- Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response. -
Delegate
- The next action is determined by Amazon Lex. -
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill. -
ElicitSlot
- The next action is to elicit a slot value from the user.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
intentName
The name of the intent.
- Parameters:
intentName
- The name of the intent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
slots
Map of the slots that have been gathered and their values.
- Parameters:
slots
- Map of the slots that have been gathered and their values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
slotToElicit
The name of the slot that should be elicited from the user.
- Parameters:
slotToElicit
- The name of the slot that should be elicited from the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fulfillmentState
The fulfillment state of the intent. The possible values are:
-
Failed
- The Lambda function associated with the intent failed to fulfill the intent. -
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent. -
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
- Parameters:
fulfillmentState
- The fulfillment state of the intent. The possible values are:-
Failed
- The Lambda function associated with the intent failed to fulfill the intent. -
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent. -
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
fulfillmentState
The fulfillment state of the intent. The possible values are:
-
Failed
- The Lambda function associated with the intent failed to fulfill the intent. -
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent. -
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
- Parameters:
fulfillmentState
- The fulfillment state of the intent. The possible values are:-
Failed
- The Lambda function associated with the intent failed to fulfill the intent. -
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent. -
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
message
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
- Parameters:
message
- The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageFormat
-
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. For more information, see Message Groups.
- Parameters:
messageFormat
-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. For more information, see Message Groups.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
messageFormat
-
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. For more information, see Message Groups.
- Parameters:
messageFormat
-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. For more information, see Message Groups.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-