Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LexRuntime.Types.DialogAction

Description

Documentation

data DialogAction Source #

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

See: newDialogAction smart constructor.

Constructors

DialogAction'

Fields

fulfillmentState :: Maybe 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.
intentName :: Maybe Text
The name of the intent.
message :: Maybe (Sensitive Text)
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.
messageFormat :: Maybe MessageFormatType
- 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.
slotToElicit :: Maybe Text
The name of the slot that should be elicited from the user.
slots :: Maybe (Sensitive (HashMap Text Text))
Map of the slots that have been gathered and their values.
type' :: DialogActionType
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.

Instances

Instances details

FromJSON DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction Methods parseJSON :: Value -> Parser DialogAction # parseJSONList :: Value -> Parser [DialogAction] #
ToJSON DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction Methods toJSON :: DialogAction -> Value # toEncoding :: DialogAction -> Encoding # toJSONList :: [DialogAction] -> Value # toEncodingList :: [DialogAction] -> Encoding #
Generic DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction Associated Types type Rep DialogAction :: Type -> Type # Methods from :: DialogAction -> Rep DialogAction x # to :: Rep DialogAction x -> DialogAction #
Show DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction Methods showsPrec :: Int -> DialogAction -> ShowS # show :: DialogAction -> String # showList :: [DialogAction] -> ShowS #
NFData DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction Methods rnf :: DialogAction -> () #
Eq DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction Methods (==) :: DialogAction -> DialogAction -> Bool # (/=) :: DialogAction -> DialogAction -> Bool #
Hashable DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction Methods hashWithSalt :: Int -> DialogAction -> Int # hash :: DialogAction -> Int #
type Rep DialogAction Source #
Instance details Defined in Amazonka.LexRuntime.Types.DialogAction type Rep DialogAction = D1 ('MetaData "DialogAction" "Amazonka.LexRuntime.Types.DialogAction" "amazonka-lex-runtime-2.0-Hs8dyr5aBISIGW4JmDmUkW" 'False) (C1 ('MetaCons "DialogAction'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fulfillmentState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FulfillmentState)) :: (S1 ('MetaSel ('Just "intentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "messageFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageFormatType)) :: S1 ('MetaSel ('Just "slotToElicit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "slots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DialogActionType)))))

newDialogAction Source #

Arguments

:: DialogActionType	`$sel:type':DialogAction'`
-> DialogAction

Create a value of DialogAction with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fulfillmentState:DialogAction', dialogAction_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.

$sel:intentName:DialogAction', dialogAction_intentName - The name of the intent.

$sel:message:DialogAction', dialogAction_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.

$sel:messageFormat:DialogAction', dialogAction_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.

$sel:slotToElicit:DialogAction', dialogAction_slotToElicit - The name of the slot that should be elicited from the user.

$sel:slots:DialogAction', dialogAction_slots - Map of the slots that have been gathered and their values.

$sel:type':DialogAction', dialogAction_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.

dialogAction_fulfillmentState :: Lens' DialogAction (Maybe FulfillmentState) Source #

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.

dialogAction_intentName :: Lens' DialogAction (Maybe Text) Source #

The name of the intent.

dialogAction_message :: Lens' DialogAction (Maybe Text) Source #

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.

dialogAction_messageFormat :: Lens' DialogAction (Maybe MessageFormatType) Source #

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.

dialogAction_slotToElicit :: Lens' DialogAction (Maybe Text) Source #

The name of the slot that should be elicited from the user.

dialogAction_slots :: Lens' DialogAction (Maybe (HashMap Text Text)) Source #

Map of the slots that have been gathered and their values.

dialogAction_type :: Lens' DialogAction DialogActionType Source #

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.