AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the PutBot operation.
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create
or update a bot you are only required to specify a name, a locale, and whether the
bot is directed toward children under age 13. You can use this to add intents later,
or to remove intents from an existing bot. When you create a bot with the minimum
information, the bot is created or updated but Amazon Lex returns the response
FAILED
. You can build the bot after you add one or more intents. For more information
about Amazon Lex bots, see how-it-works.
If you specify the name of an existing bot, the fields in the request replace the
existing values in the $LATEST
version of the bot. Amazon Lex removes any fields
that you don't provide values for in the request, except for the idleTTLInSeconds
and privacySettings
fields, which are set to their default values. If you don't
specify values for required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutBot
action. For more information,
see security-iam.
Namespace: Amazon.LexModelBuildingService.Model
Assembly: AWSSDK.LexModelBuildingService.dll
Version: 3.x.y.z
public class PutBotRequest : AmazonLexModelBuildingServiceRequest IAmazonWebServiceRequest
The PutBotRequest type exposes the following members
Name | Description | |
---|---|---|
PutBotRequest() |
Name | Type | Description | |
---|---|---|---|
AbortStatement | Amazon.LexModelBuildingService.Model.Statement |
Gets and sets the property AbortStatement.
When Amazon Lex can't understand the user's input in context, it tries to elicit the
information a few times. After that, Amazon Lex sends the message defined in For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex tries to elicit a correct response a few more times.
For example, in a pizza ordering application, If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent. |
|
Checksum | System.String |
Gets and sets the property Checksum.
Identifies a specific revision of the
When you create a new bot, leave the
When you want to update a bot, set the |
|
ChildDirected | System.Boolean |
Gets and sets the property ChildDirected.
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must
specify whether your use of Amazon Lex is related to a website, program, or other
application that is directed or targeted, in whole or in part, to children under age
13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. |
|
ClarificationPrompt | Amazon.LexModelBuildingService.Model.Prompt |
Gets and sets the property ClarificationPrompt.
When Amazon Lex doesn't understand the user's intent, it uses this message to get
clarification. To specify how many times Amazon Lex should repeat the clarification
prompt, use the When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
If you have defined a fallback intent, it will be invoked if the clarification prompt
is repeated the number of times defined in the If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases:
|
|
CreateVersion | System.Boolean |
Gets and sets the property CreateVersion.
When set to |
|
Description | System.String |
Gets and sets the property Description. A description of the bot. |
|
DetectSentiment | System.Boolean |
Gets and sets the property DetectSentiment.
When set to |
|
EnableModelImprovements | System.Boolean |
Gets and sets the property EnableModelImprovements.
Set to
When you set the
You can only set the
The Regions where you can set the
In other Regions, the |
|
IdleSessionTTLInSeconds | System.Int32 |
Gets and sets the property IdleSessionTTLInSeconds. The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout. For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.
If you don't include the The default is 300 seconds (5 minutes). |
|
Intents | System.Collections.Generic.List<Amazon.LexModelBuildingService.Model.Intent> |
Gets and sets the property Intents.
An array of |
|
Locale | Amazon.LexModelBuildingService.Locale |
Gets and sets the property Locale. Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.
The default is |
|
Name | System.String |
Gets and sets the property Name. The name of the bot. The name is not case sensitive. |
|
NluIntentConfidenceThreshold | System.Double |
Gets and sets the property NluIntentConfidenceThreshold.
Determines the threshold where Amazon Lex will insert the
You must set the
In other Regions, the
For example, suppose a bot is configured with the confidence threshold of 0.80 and
the
|
|
ProcessBehavior | Amazon.LexModelBuildingService.ProcessBehavior |
Gets and sets the property ProcessBehavior.
If you set the
If you don't specify this value, the default value is |
|
Tags | System.Collections.Generic.List<Amazon.LexModelBuildingService.Model.Tag> |
Gets and sets the property Tags.
A list of tags to add to the bot. You can only add tags when you create a bot, you
can't use the |
|
VoiceId | System.String |
Gets and sets the property VoiceId. The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Voices in Amazon Polly in the Amazon Polly Developer Guide. |
This example shows how to create a bot for ordering pizzas.
var client = new AmazonLexModelBuildingServiceClient(); var response = client.PutBot(new PutBotRequest { Name = "DocOrderPizzaBot", AbortStatement = new Statement { Messages = new List<Message> { new Message { Content = "I don't understand. Can you try again?", ContentType = "PlainText" }, new Message { Content = "I'm sorry, I don't understand.", ContentType = "PlainText" } } }, ChildDirected = true, ClarificationPrompt = new Prompt { MaxAttempts = 1, Messages = new List<Message> { new Message { Content = "I'm sorry, I didn't hear that. Can you repeat what you just said?", ContentType = "PlainText" }, new Message { Content = "Can you say that again?", ContentType = "PlainText" } } }, Description = "Orders a pizza from a local pizzeria.", IdleSessionTTLInSeconds = 300, Intents = new List<Intent> { new Intent { IntentName = "DocOrderPizza", IntentVersion = "$LATEST" } }, Locale = "en-US", ProcessBehavior = "SAVE" }); string version = response.Version; string name = response.Name; Statement abortStatement = response.AbortStatement; string checksum = response.Checksum; bool childDirected = response.ChildDirected; Prompt clarificationPrompt = response.ClarificationPrompt; DateTime createdDate = response.CreatedDate; string description = response.Description; int idleSessionTTLInSeconds = response.IdleSessionTTLInSeconds; List<Intent> intents = response.Intents; DateTime lastUpdatedDate = response.LastUpdatedDate; string locale = response.Locale; string status = response.Status;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5