Creates an intent or replaces an existing intent.
To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent.
To create an intent or replace an existing intent, you must provide the following:
-
Intent name. For example, OrderPizza.
-
Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
-
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
-
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
-
A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
-
A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
-
A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"
If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT.
For more information, see how-it-works.
This operation requires permissions for the lex:PutIntent action.
Path parameters
Request body
Response
Success
Example response
{
"version": "$LATEST",
"name": "DocOrderPizza",
"checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6",
"conclusionStatement": {
"messages": [
{
"content": "All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.",
"contentType": "PlainText"
},
{
"content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.",
"contentType": "PlainText"
}
],
"responseCard": "foo"
},
"confirmationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?",
"contentType": "PlainText"
}
]
},
"createdDate": 1494359783.453,
"description": "Order a pizza from a local pizzeria.",
"fulfillmentActivity": {
"type": "ReturnIntent"
},
"lastUpdatedDate": 1494359783.453,
"rejectionStatement": {
"messages": [
{
"content": "Ok, I'll cancel your order.",
"contentType": "PlainText"
},
{
"content": "I cancelled your order.",
"contentType": "PlainText"
}
]
},
"sampleUtterances": [
"Order me a pizza.",
"Order me a {Type} pizza.",
"I want a {Crust} crust {Type} pizza",
"I want a {Crust} crust {Type} pizza with {Sauce} sauce."
],
"slots": [
{
"name": "Sauce",
"description": "The type of sauce to use on the pizza.",
"priority": 3,
"sampleUtterances": [
"Make it {Sauce} sauce.",
"I'd like {Sauce} sauce."
],
"slotConstraint": "Required",
"slotType": "DocPizzaSauceType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "White or red sauce?",
"contentType": "PlainText"
},
{
"content": "Garlic or tomato sauce?",
"contentType": "PlainText"
}
]
}
},
{
"name": "Type",
"description": "The type of pizza to order.",
"priority": 1,
"sampleUtterances": [
"Get me a {Type} pizza.",
"A {Type} pizza please.",
"I'd like a {Type} pizza."
],
"slotConstraint": "Required",
"slotType": "DocPizzaType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of pizza would you like?",
"contentType": "PlainText"
},
{
"content": "Vegie or cheese pizza?",
"contentType": "PlainText"
},
{
"content": "I can get you a vegie or a cheese pizza.",
"contentType": "PlainText"
}
]
}
},
{
"name": "Crust",
"description": "The type of pizza crust to order.",
"priority": 2,
"sampleUtterances": [
"Make it a {Crust} crust.",
"I'd like a {Crust} crust."
],
"slotConstraint": "Required",
"slotType": "DocPizzaCrustType",
"slotTypeVersion": "$LATEST",
"valueElicitationPrompt": {
"maxAttempts": 1,
"messages": [
{
"content": "What type of crust would you like?",
"contentType": "PlainText"
},
{
"content": "Thick or thin crust?",
"contentType": "PlainText"
}
]
}
}
]
}