AWS SDK Version 3 for .NET
API Reference

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. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, 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 auth-and-access-control.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.LexModelBuildingService.AmazonLexModelBuildingServiceRequest
      Amazon.LexModelBuildingService.Model.PutBotRequest

Namespace: Amazon.LexModelBuildingService.Model
Assembly: AWSSDK.LexModelBuildingService.dll
Version: 3.x.y.z

Syntax

C#
public class PutBotRequest : AmazonLexModelBuildingServiceRequest
         IAmazonWebServiceRequest

The PutBotRequest type exposes the following members

Constructors

NameDescription
Public Method PutBotRequest()

Properties

NameTypeDescription
Public Property 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 abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type.

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, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot.

Public Property Checksum System.String

Gets and sets the property Checksum.

Identifies a specific revision of the $LATEST version.

When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

Public Property 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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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 COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 COPPA. You may not specify a default value for the childDirected field that does not accurately reflect 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 COPPA.

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.

Public Property 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 repeate the clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field.

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.'"

Public Property Description System.String

Gets and sets the property Description.

A description of the bot.

Public Property 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 idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.

The default is 300 seconds (5 minutes).

Public Property Intents System.Collections.Generic.List<Amazon.LexModelBuildingService.Model.Intent>

Gets and sets the property Intents.

An array of Intent objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.

Public Property 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 en-US.

Public Property Name System.String

Gets and sets the property Name.

The name of the bot. The name is not case sensitive.

Public Property ProcessBehavior Amazon.LexModelBuildingService.ProcessBehavior

Gets and sets the property ProcessBehavior.

If you set the processBehavior element to Build, Amazon Lex builds the bot so that it can be run. If you set the element to SaveAmazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is Save.

Public Property 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 Available Voices in the Amazon Polly Developer Guide.

Examples

This example shows how to create a bot for ordering pizzas.

To create a bot


var response = client.PutBot(new PutBotRequest 
{
    Name = "DocOrderPizzaBot",
    AbortStatement = new Statement { Messages = new List {
        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 {
            new Message {
                Content = "I'm sorry, I didn't hear that. Can you repeate 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 {
        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;
integer idleSessionTTLInSeconds = response.IdleSessionTTLInSeconds;
List intents = response.Intents;
DateTime lastUpdatedDate = response.LastUpdatedDate;
string locale = response.Locale;
string status = response.Status;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms