« blib/lib/Paws/LexModels/GetBotChannelAssociationsResponse.pm
↑ Summary
blib/lib/Paws/LexModels/GetBotVersions.pm »
| 1 | |||
| 2 | package Paws::LexModels::GetBotResponse; | ||
| 3 | use Moose; | ||
| 4 | has AbortStatement => (is => 'ro', isa => 'Paws::LexModels::Statement', traits => ['NameInRequest'], request_name => 'abortStatement'); | ||
| 5 | has Checksum => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'checksum'); | ||
| 6 | has ChildDirected => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'childDirected'); | ||
| 7 | has ClarificationPrompt => (is => 'ro', isa => 'Paws::LexModels::Prompt', traits => ['NameInRequest'], request_name => 'clarificationPrompt'); | ||
| 8 | has CreatedDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'createdDate'); | ||
| 9 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 10 | has DetectSentiment => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'detectSentiment'); | ||
| 11 | has EnableModelImprovements => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableModelImprovements'); | ||
| 12 | has FailureReason => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'failureReason'); | ||
| 13 | has IdleSessionTTLInSeconds => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'idleSessionTTLInSeconds'); | ||
| 14 | has Intents => (is => 'ro', isa => 'ArrayRef[Paws::LexModels::Intent]', traits => ['NameInRequest'], request_name => 'intents'); | ||
| 15 | has LastUpdatedDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'lastUpdatedDate'); | ||
| 16 | has Locale => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'locale'); | ||
| 17 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 18 | has NluIntentConfidenceThreshold => (is => 'ro', isa => 'Num', traits => ['NameInRequest'], request_name => 'nluIntentConfidenceThreshold'); | ||
| 19 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status'); | ||
| 20 | has Version => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'version'); | ||
| 21 | has VoiceId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'voiceId'); | ||
| 22 | |||
| 23 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 24 | 1; | ||
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::LexModels::GetBotResponse | ||
| 31 | |||
| 32 | =head1 ATTRIBUTES | ||
| 33 | |||
| 34 | |||
| 35 | =head2 AbortStatement => L<Paws::LexModels::Statement> | ||
| 36 | |||
| 37 | The message that Amazon Lex returns when the user elects to end the | ||
| 38 | conversation without completing it. For more information, see PutBot. | ||
| 39 | |||
| 40 | |||
| 41 | =head2 Checksum => Str | ||
| 42 | |||
| 43 | Checksum of the bot used to identify a specific revision of the bot's | ||
| 44 | C<$LATEST> version. | ||
| 45 | |||
| 46 | |||
| 47 | =head2 ChildDirected => Bool | ||
| 48 | |||
| 49 | For each Amazon Lex bot created with the Amazon Lex Model Building | ||
| 50 | Service, you must specify whether your use of Amazon Lex is related to | ||
| 51 | a website, program, or other application that is directed or targeted, | ||
| 52 | in whole or in part, to children under age 13 and subject to the | ||
| 53 | Children's Online Privacy Protection Act (COPPA) by specifying C<true> | ||
| 54 | or C<false> in the C<childDirected> field. By specifying C<true> in the | ||
| 55 | C<childDirected> field, you confirm that your use of Amazon Lex B<is> | ||
| 56 | related to a website, program, or other application that is directed or | ||
| 57 | targeted, in whole or in part, to children under age 13 and subject to | ||
| 58 | COPPA. By specifying C<false> in the C<childDirected> field, you | ||
| 59 | confirm that your use of Amazon Lex B<is not> related to a website, | ||
| 60 | program, or other application that is directed or targeted, in whole or | ||
| 61 | in part, to children under age 13 and subject to COPPA. You may not | ||
| 62 | specify a default value for the C<childDirected> field that does not | ||
| 63 | accurately reflect whether your use of Amazon Lex is related to a | ||
| 64 | website, program, or other application that is directed or targeted, in | ||
| 65 | whole or in part, to children under age 13 and subject to COPPA. | ||
| 66 | |||
| 67 | If your use of Amazon Lex relates to a website, program, or other | ||
| 68 | application that is directed in whole or in part, to children under age | ||
| 69 | 13, you must obtain any required verifiable parental consent under | ||
| 70 | COPPA. For information regarding the use of Amazon Lex in connection | ||
| 71 | with websites, programs, or other applications that are directed or | ||
| 72 | targeted, in whole or in part, to children under age 13, see the Amazon | ||
| 73 | Lex FAQ. (https://aws.amazon.com/lex/faqs#data-security) | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ClarificationPrompt => L<Paws::LexModels::Prompt> | ||
| 77 | |||
| 78 | The message Amazon Lex uses when it doesn't understand the user's | ||
| 79 | request. For more information, see PutBot. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 CreatedDate => Str | ||
| 83 | |||
| 84 | The date that the bot was created. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Description => Str | ||
| 88 | |||
| 89 | A description of the bot. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 DetectSentiment => Bool | ||
| 93 | |||
| 94 | Indicates whether user utterances should be sent to Amazon Comprehend | ||
| 95 | for sentiment analysis. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 EnableModelImprovements => Bool | ||
| 99 | |||
| 100 | Indicates whether the bot uses accuracy improvements. C<true> indicates | ||
| 101 | that the bot is using the improvements, otherwise, C<false>. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 FailureReason => Str | ||
| 105 | |||
| 106 | If C<status> is C<FAILED>, Amazon Lex explains why it failed to build | ||
| 107 | the bot. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 IdleSessionTTLInSeconds => Int | ||
| 111 | |||
| 112 | The maximum time in seconds that Amazon Lex retains the data gathered | ||
| 113 | in a conversation. For more information, see PutBot. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 Intents => ArrayRef[L<Paws::LexModels::Intent>] | ||
| 117 | |||
| 118 | An array of C<intent> objects. For more information, see PutBot. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 LastUpdatedDate => Str | ||
| 122 | |||
| 123 | The date that the bot was updated. When you create a resource, the | ||
| 124 | creation date and last updated date are the same. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 Locale => Str | ||
| 128 | |||
| 129 | The target locale for the bot. | ||
| 130 | |||
| 131 | Valid values are: C<"de-DE">, C<"en-AU">, C<"en-GB">, C<"en-US">, C<"es-419">, C<"es-ES">, C<"es-US">, C<"fr-FR">, C<"fr-CA">, C<"it-IT">, C<"ja-JP"> | ||
| 132 | =head2 Name => Str | ||
| 133 | |||
| 134 | The name of the bot. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 NluIntentConfidenceThreshold => Num | ||
| 138 | |||
| 139 | The score that determines where Amazon Lex inserts the | ||
| 140 | C<AMAZON.FallbackIntent>, C<AMAZON.KendraSearchIntent>, or both when | ||
| 141 | returning alternative intents in a PostContent | ||
| 142 | (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html) | ||
| 143 | or PostText | ||
| 144 | (https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html) | ||
| 145 | response. C<AMAZON.FallbackIntent> is inserted if the confidence score | ||
| 146 | for all intents is below this value. C<AMAZON.KendraSearchIntent> is | ||
| 147 | only inserted if it is configured for the bot. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 Status => Str | ||
| 151 | |||
| 152 | The status of the bot. | ||
| 153 | |||
| 154 | When the status is C<BUILDING> Amazon Lex is building the bot for | ||
| 155 | testing and use. | ||
| 156 | |||
| 157 | If the status of the bot is C<READY_BASIC_TESTING>, you can test the | ||
| 158 | bot using the exact utterances specified in the bot's intents. When the | ||
| 159 | bot is ready for full testing or to run, the status is C<READY>. | ||
| 160 | |||
| 161 | If there was a problem with building the bot, the status is C<FAILED> | ||
| 162 | and the C<failureReason> field explains why the bot did not build. | ||
| 163 | |||
| 164 | If the bot was saved but not built, the status is C<NOT_BUILT>. | ||
| 165 | |||
| 166 | Valid values are: C<"BUILDING">, C<"READY">, C<"READY_BASIC_TESTING">, C<"FAILED">, C<"NOT_BUILT"> | ||
| 167 | =head2 Version => Str | ||
| 168 | |||
| 169 | The version of the bot. For a new bot, the version is always | ||
| 170 | C<$LATEST>. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 VoiceId => Str | ||
| 174 | |||
| 175 | The Amazon Polly voice ID that Amazon Lex uses for voice interaction | ||
| 176 | with the user. For more information, see PutBot. | ||
| 177 | |||
| 178 | |||
| 179 | =head2 _request_id => Str | ||
| 180 | |||
| 181 | |||
| 182 | =cut | ||
| 183 |