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 |
Creates an intent.
To define the interaction between the user and your bot, you define one
or more intents. For example, for a pizza ordering bot you would create
an OrderPizza
intent.
When you create an intent, you must provide a name. You can optionally provide the following:
- Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
- Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
- How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
- A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
- A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
- A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
Synopsis
- data CreateIntent = CreateIntent' {
- description :: Maybe Text
- dialogCodeHook :: Maybe DialogCodeHookSettings
- fulfillmentCodeHook :: Maybe FulfillmentCodeHookSettings
- initialResponseSetting :: Maybe InitialResponseSetting
- inputContexts :: Maybe [InputContext]
- intentClosingSetting :: Maybe IntentClosingSetting
- intentConfirmationSetting :: Maybe IntentConfirmationSetting
- kendraConfiguration :: Maybe KendraConfiguration
- outputContexts :: Maybe [OutputContext]
- parentIntentSignature :: Maybe Text
- sampleUtterances :: Maybe [SampleUtterance]
- intentName :: Text
- botId :: Text
- botVersion :: Text
- localeId :: Text
- newCreateIntent :: Text -> Text -> Text -> Text -> CreateIntent
- createIntent_description :: Lens' CreateIntent (Maybe Text)
- createIntent_dialogCodeHook :: Lens' CreateIntent (Maybe DialogCodeHookSettings)
- createIntent_fulfillmentCodeHook :: Lens' CreateIntent (Maybe FulfillmentCodeHookSettings)
- createIntent_initialResponseSetting :: Lens' CreateIntent (Maybe InitialResponseSetting)
- createIntent_inputContexts :: Lens' CreateIntent (Maybe [InputContext])
- createIntent_intentClosingSetting :: Lens' CreateIntent (Maybe IntentClosingSetting)
- createIntent_intentConfirmationSetting :: Lens' CreateIntent (Maybe IntentConfirmationSetting)
- createIntent_kendraConfiguration :: Lens' CreateIntent (Maybe KendraConfiguration)
- createIntent_outputContexts :: Lens' CreateIntent (Maybe [OutputContext])
- createIntent_parentIntentSignature :: Lens' CreateIntent (Maybe Text)
- createIntent_sampleUtterances :: Lens' CreateIntent (Maybe [SampleUtterance])
- createIntent_intentName :: Lens' CreateIntent Text
- createIntent_botId :: Lens' CreateIntent Text
- createIntent_botVersion :: Lens' CreateIntent Text
- createIntent_localeId :: Lens' CreateIntent Text
- data CreateIntentResponse = CreateIntentResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- dialogCodeHook :: Maybe DialogCodeHookSettings
- fulfillmentCodeHook :: Maybe FulfillmentCodeHookSettings
- initialResponseSetting :: Maybe InitialResponseSetting
- inputContexts :: Maybe [InputContext]
- intentClosingSetting :: Maybe IntentClosingSetting
- intentConfirmationSetting :: Maybe IntentConfirmationSetting
- intentId :: Maybe Text
- intentName :: Maybe Text
- kendraConfiguration :: Maybe KendraConfiguration
- localeId :: Maybe Text
- outputContexts :: Maybe [OutputContext]
- parentIntentSignature :: Maybe Text
- sampleUtterances :: Maybe [SampleUtterance]
- httpStatus :: Int
- newCreateIntentResponse :: Int -> CreateIntentResponse
- createIntentResponse_botId :: Lens' CreateIntentResponse (Maybe Text)
- createIntentResponse_botVersion :: Lens' CreateIntentResponse (Maybe Text)
- createIntentResponse_creationDateTime :: Lens' CreateIntentResponse (Maybe UTCTime)
- createIntentResponse_description :: Lens' CreateIntentResponse (Maybe Text)
- createIntentResponse_dialogCodeHook :: Lens' CreateIntentResponse (Maybe DialogCodeHookSettings)
- createIntentResponse_fulfillmentCodeHook :: Lens' CreateIntentResponse (Maybe FulfillmentCodeHookSettings)
- createIntentResponse_initialResponseSetting :: Lens' CreateIntentResponse (Maybe InitialResponseSetting)
- createIntentResponse_inputContexts :: Lens' CreateIntentResponse (Maybe [InputContext])
- createIntentResponse_intentClosingSetting :: Lens' CreateIntentResponse (Maybe IntentClosingSetting)
- createIntentResponse_intentConfirmationSetting :: Lens' CreateIntentResponse (Maybe IntentConfirmationSetting)
- createIntentResponse_intentId :: Lens' CreateIntentResponse (Maybe Text)
- createIntentResponse_intentName :: Lens' CreateIntentResponse (Maybe Text)
- createIntentResponse_kendraConfiguration :: Lens' CreateIntentResponse (Maybe KendraConfiguration)
- createIntentResponse_localeId :: Lens' CreateIntentResponse (Maybe Text)
- createIntentResponse_outputContexts :: Lens' CreateIntentResponse (Maybe [OutputContext])
- createIntentResponse_parentIntentSignature :: Lens' CreateIntentResponse (Maybe Text)
- createIntentResponse_sampleUtterances :: Lens' CreateIntentResponse (Maybe [SampleUtterance])
- createIntentResponse_httpStatus :: Lens' CreateIntentResponse Int
Creating a Request
data CreateIntent Source #
See: newCreateIntent
smart constructor.
CreateIntent' | |
|
Instances
Create a value of CreateIntent
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:
CreateIntent
, createIntent_description
- A description of the intent. Use the description to help identify the
intent in lists.
CreateIntent
, createIntent_dialogCodeHook
- Specifies that Amazon Lex invokes the alias Lambda function for each
user input. You can invoke this Lambda function to personalize user
interaction.
For example, suppose that your bot determines that the user's name is
John. You Lambda function might retrieve John's information from a
backend database and prepopulate some of the values. For example, if you
find that John is gluten intolerant, you might set the corresponding
intent slot, glutenIntolerant
to true
. You might find John's phone
number and set the corresponding session attribute.
CreateIntent
, createIntent_fulfillmentCodeHook
- Specifies that Amazon Lex invokes the alias Lambda function when the
intent is ready for fulfillment. You can invoke this function to
complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
CreateIntent
, createIntent_initialResponseSetting
- Configuration settings for the response that is sent to the user at the
beginning of a conversation, before eliciting slot values.
CreateIntent
, createIntent_inputContexts
- A list of contexts that must be active for this intent to be considered
by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the outputContexts
property or it can be set at runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
CreateIntent
, createIntent_intentClosingSetting
- Sets the response that Amazon Lex sends to the user when the intent is
closed.
CreateIntent
, createIntent_intentConfirmationSetting
- Provides prompts that Amazon Lex sends to the user to confirm the
completion of an intent. If the user answers "no," the settings
contain a statement that is sent to the user to end the intent.
CreateIntent
, createIntent_kendraConfiguration
- Configuration information required to use the
AMAZON.KendraSearchIntent
intent to connect to an Amazon Kendra index.
The AMAZON.KendraSearchIntent
intent is called when Amazon Lex can't
determine another intent to invoke.
CreateIntent
, createIntent_outputContexts
- A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the outputContextsList
property, all of the contexts
specified in the list are activated when the intent is fulfilled. You
can set up to 10 output contexts. You can also set the number of
conversation turns that the context should be active, or the length of
time that the context should be active.
CreateIntent
, createIntent_parentIntentSignature
- A unique identifier for the built-in intent to base this intent on.
CreateIntent
, createIntent_sampleUtterances
- An array of strings that a user might say to signal the intent. For
example, "I want a pizza", or "I want a {PizzaSize} pizza".
In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
CreateIntent
, createIntent_intentName
- The name of the intent. Intent names must be unique in the locale that
contains the intent and cannot match the name of any built-in intent.
CreateIntent
, createIntent_botId
- The identifier of the bot associated with this intent.
CreateIntent
, createIntent_botVersion
- The identifier of the version of the bot associated with this intent.
CreateIntent
, createIntent_localeId
- The identifier of the language and locale where this intent is used. All
of the bots, slot types, and slots used by the intent must have the same
locale. For more information, see
Supported languages.
Request Lenses
createIntent_description :: Lens' CreateIntent (Maybe Text) Source #
A description of the intent. Use the description to help identify the intent in lists.
createIntent_dialogCodeHook :: Lens' CreateIntent (Maybe DialogCodeHookSettings) Source #
Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is
John. You Lambda function might retrieve John's information from a
backend database and prepopulate some of the values. For example, if you
find that John is gluten intolerant, you might set the corresponding
intent slot, glutenIntolerant
to true
. You might find John's phone
number and set the corresponding session attribute.
createIntent_fulfillmentCodeHook :: Lens' CreateIntent (Maybe FulfillmentCodeHookSettings) Source #
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
createIntent_initialResponseSetting :: Lens' CreateIntent (Maybe InitialResponseSetting) Source #
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
createIntent_inputContexts :: Lens' CreateIntent (Maybe [InputContext]) Source #
A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the outputContexts
property or it can be set at runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
createIntent_intentClosingSetting :: Lens' CreateIntent (Maybe IntentClosingSetting) Source #
Sets the response that Amazon Lex sends to the user when the intent is closed.
createIntent_intentConfirmationSetting :: Lens' CreateIntent (Maybe IntentConfirmationSetting) Source #
Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
createIntent_kendraConfiguration :: Lens' CreateIntent (Maybe KendraConfiguration) Source #
Configuration information required to use the
AMAZON.KendraSearchIntent
intent to connect to an Amazon Kendra index.
The AMAZON.KendraSearchIntent
intent is called when Amazon Lex can't
determine another intent to invoke.
createIntent_outputContexts :: Lens' CreateIntent (Maybe [OutputContext]) Source #
A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the outputContextsList
property, all of the contexts
specified in the list are activated when the intent is fulfilled. You
can set up to 10 output contexts. You can also set the number of
conversation turns that the context should be active, or the length of
time that the context should be active.
createIntent_parentIntentSignature :: Lens' CreateIntent (Maybe Text) Source #
A unique identifier for the built-in intent to base this intent on.
createIntent_sampleUtterances :: Lens' CreateIntent (Maybe [SampleUtterance]) Source #
An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".
In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
createIntent_intentName :: Lens' CreateIntent Text Source #
The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
createIntent_botId :: Lens' CreateIntent Text Source #
The identifier of the bot associated with this intent.
createIntent_botVersion :: Lens' CreateIntent Text Source #
The identifier of the version of the bot associated with this intent.
createIntent_localeId :: Lens' CreateIntent Text Source #
The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.
Destructuring the Response
data CreateIntentResponse Source #
See: newCreateIntentResponse
smart constructor.
CreateIntentResponse' | |
|
Instances
newCreateIntentResponse Source #
Create a value of CreateIntentResponse
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:
CreateIntent
, createIntentResponse_botId
- The identifier of the bot associated with the intent.
CreateIntent
, createIntentResponse_botVersion
- The identifier of the version of the bot associated with the intent.
CreateIntentResponse
, createIntentResponse_creationDateTime
- A timestamp of the date and time that the intent was created.
CreateIntent
, createIntentResponse_description
- The description specified for the intent.
CreateIntent
, createIntentResponse_dialogCodeHook
- The dialog Lambda function specified for the intent.
CreateIntent
, createIntentResponse_fulfillmentCodeHook
- The fulfillment Lambda function specified for the intent.
CreateIntent
, createIntentResponse_initialResponseSetting
- Configuration settings for the response that is sent to the user at the
beginning of a conversation, before eliciting slot values.
CreateIntent
, createIntentResponse_inputContexts
- The list of input contexts specified for the intent.
CreateIntent
, createIntentResponse_intentClosingSetting
- The closing setting specified for the intent.
CreateIntent
, createIntentResponse_intentConfirmationSetting
- The confirmation setting specified for the intent.
CreateIntentResponse
, createIntentResponse_intentId
- A unique identifier for the intent.
CreateIntent
, createIntentResponse_intentName
- The name specified for the intent.
CreateIntent
, createIntentResponse_kendraConfiguration
- Configuration for searching a Amazon Kendra index specified for the
intent.
CreateIntent
, createIntentResponse_localeId
- The locale that the intent is specified to use.
CreateIntent
, createIntentResponse_outputContexts
- The list of output contexts specified for the intent.
CreateIntent
, createIntentResponse_parentIntentSignature
- The signature of the parent intent specified for the intent.
CreateIntent
, createIntentResponse_sampleUtterances
- The sample utterances specified for the intent.
$sel:httpStatus:CreateIntentResponse'
, createIntentResponse_httpStatus
- The response's http status code.
Response Lenses
createIntentResponse_botId :: Lens' CreateIntentResponse (Maybe Text) Source #
The identifier of the bot associated with the intent.
createIntentResponse_botVersion :: Lens' CreateIntentResponse (Maybe Text) Source #
The identifier of the version of the bot associated with the intent.
createIntentResponse_creationDateTime :: Lens' CreateIntentResponse (Maybe UTCTime) Source #
A timestamp of the date and time that the intent was created.
createIntentResponse_description :: Lens' CreateIntentResponse (Maybe Text) Source #
The description specified for the intent.
createIntentResponse_dialogCodeHook :: Lens' CreateIntentResponse (Maybe DialogCodeHookSettings) Source #
The dialog Lambda function specified for the intent.
createIntentResponse_fulfillmentCodeHook :: Lens' CreateIntentResponse (Maybe FulfillmentCodeHookSettings) Source #
The fulfillment Lambda function specified for the intent.
createIntentResponse_initialResponseSetting :: Lens' CreateIntentResponse (Maybe InitialResponseSetting) Source #
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
createIntentResponse_inputContexts :: Lens' CreateIntentResponse (Maybe [InputContext]) Source #
The list of input contexts specified for the intent.
createIntentResponse_intentClosingSetting :: Lens' CreateIntentResponse (Maybe IntentClosingSetting) Source #
The closing setting specified for the intent.
createIntentResponse_intentConfirmationSetting :: Lens' CreateIntentResponse (Maybe IntentConfirmationSetting) Source #
The confirmation setting specified for the intent.
createIntentResponse_intentId :: Lens' CreateIntentResponse (Maybe Text) Source #
A unique identifier for the intent.
createIntentResponse_intentName :: Lens' CreateIntentResponse (Maybe Text) Source #
The name specified for the intent.
createIntentResponse_kendraConfiguration :: Lens' CreateIntentResponse (Maybe KendraConfiguration) Source #
Configuration for searching a Amazon Kendra index specified for the intent.
createIntentResponse_localeId :: Lens' CreateIntentResponse (Maybe Text) Source #
The locale that the intent is specified to use.
createIntentResponse_outputContexts :: Lens' CreateIntentResponse (Maybe [OutputContext]) Source #
The list of output contexts specified for the intent.
createIntentResponse_parentIntentSignature :: Lens' CreateIntentResponse (Maybe Text) Source #
The signature of the parent intent specified for the intent.
createIntentResponse_sampleUtterances :: Lens' CreateIntentResponse (Maybe [SampleUtterance]) Source #
The sample utterances specified for the intent.
createIntentResponse_httpStatus :: Lens' CreateIntentResponse Int Source #
The response's http status code.