PutBotResponse Class | AWS SDK for .NET V3

This is the response object from the PutBot operation.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.LexModelBuildingService.Model.PutBotResponse

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

Syntax

public class PutBotResponse : AmazonWebServiceResponse

The PutBotResponse type exposes the following members

Constructors

	Name	Description
	PutBotResponse()

Properties

Name	Type	Description
AbortStatement	Amazon.LexModelBuildingService.Model.Statement	Gets and sets the property AbortStatement. The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
Checksum	System.String	Gets and sets the property Checksum. Checksum of the bot that you created.
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.
ClarificationPrompt	Amazon.LexModelBuildingService.Model.Prompt	Gets and sets the property ClarificationPrompt. The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
CreatedDate	System.DateTime	Gets and sets the property CreatedDate. The date that the bot was created.
CreateVersion	System.Boolean	Gets and sets the property CreateVersion. `True` if a new version of the bot was created. If the `createVersion` field was not specified in the request, the `createVersion` field is set to false in the response.
Description	System.String	Gets and sets the property Description. A description of the bot.
DetectSentiment	System.Boolean	Gets and sets the property DetectSentiment. `true` if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the `detectSentiment` field was not specified in the request, the `detectSentiment` field is `false` in the response.
EnableModelImprovements	System.Boolean	Gets and sets the property EnableModelImprovements. Indicates whether the bot uses accuracy improvements. `true` indicates that the bot is using the improvements, otherwise, `false`.
FailureReason	System.String	Gets and sets the property FailureReason. If `status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
IdleSessionTTLInSeconds	System.Int32	Gets and sets the property IdleSessionTTLInSeconds. The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
Intents	System.Collections.Generic.List<Amazon.LexModelBuildingService.Model.Intent>	Gets and sets the property Intents. An array of `Intent` objects. For more information, see PutBot.
LastUpdatedDate	System.DateTime	Gets and sets the property LastUpdatedDate. The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
Locale	Amazon.LexModelBuildingService.Locale	Gets and sets the property Locale. The target locale for the bot.
Name	System.String	Gets and sets the property Name. The name of the bot.
NluIntentConfidenceThreshold	System.Double	Gets and sets the property NluIntentConfidenceThreshold. The score that determines where Amazon Lex inserts the `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when returning alternative intents in a PostContent or PostText response. `AMAZON.FallbackIntent` is inserted if the confidence score for all intents is below this value. `AMAZON.KendraSearchIntent` is only inserted if it is configured for the bot.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Status	Amazon.LexModelBuildingService.Status	Gets and sets the property Status. When you send a request to create a bot with `processBehavior` set to `BUILD`, Amazon Lex sets the `status` response element to `BUILDING`. In the `READY_BASIC_TESTING` state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types. If Amazon Lex can't build the bot, Amazon Lex sets `status` to `FAILED`. Amazon Lex returns the reason for the failure in the `failureReason` response element. When you set `processBehavior` to `SAVE`, Amazon Lex sets the status code to `NOT BUILT`. When the bot is in the `READY` state you can test and publish the bot.
Tags	System.Collections.Generic.List<Amazon.LexModelBuildingService.Model.Tag>	Gets and sets the property Tags. A list of tags associated with the bot.
Version	System.String	Gets and sets the property Version. The version of the bot. For a new bot, the version is always `$LATEST`.
VoiceId	System.String	Gets and sets the property VoiceId. The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

Examples

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

To create a bot


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;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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