« blib/lib/Paws/LexModelsV2/CreateBotAliasResponse.pm
↑ Summary
blib/lib/Paws/LexModelsV2/CreateBotLocaleResponse.pm »
| 1 | |||
| 2 | package Paws::LexModelsV2::CreateBotLocale; | ||
| 3 | use Moose; | ||
| 4 | has BotId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botId', required => 1); | ||
| 5 | has BotVersion => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'botVersion', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 7 | has LocaleId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'localeId', required => 1); | ||
| 8 | has NluIntentConfidenceThreshold => (is => 'ro', isa => 'Num', traits => ['NameInRequest'], request_name => 'nluIntentConfidenceThreshold', required => 1); | ||
| 9 | has VoiceSettings => (is => 'ro', isa => 'Paws::LexModelsV2::VoiceSettings', traits => ['NameInRequest'], request_name => 'voiceSettings'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBotLocale'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/{botId}/botversions/{botVersion}/botlocales/'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModelsV2::CreateBotLocaleResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::LexModelsV2::CreateBotLocale - Arguments for method CreateBotLocale on L<Paws::LexModelsV2> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateBotLocale on the | ||
| 28 | L<Amazon Lex Model Building V2|Paws::LexModelsV2> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateBotLocale. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBotLocale. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $models-v2-lex = Paws->service('LexModelsV2'); | ||
| 36 | my $CreateBotLocaleResponse = $models - v2 -lex->CreateBotLocale( | ||
| 37 | BotId => 'MyId', | ||
| 38 | BotVersion => 'MyDraftBotVersion', | ||
| 39 | LocaleId => 'MyLocaleId', | ||
| 40 | NluIntentConfidenceThreshold => 1, | ||
| 41 | Description => 'MyDescription', # OPTIONAL | ||
| 42 | VoiceSettings => { | ||
| 43 | VoiceId => 'MyVoiceId', | ||
| 44 | |||
| 45 | }, # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $BotId = $CreateBotLocaleResponse->BotId; | ||
| 50 | my $BotLocaleStatus = $CreateBotLocaleResponse->BotLocaleStatus; | ||
| 51 | my $BotVersion = $CreateBotLocaleResponse->BotVersion; | ||
| 52 | my $CreationDateTime = $CreateBotLocaleResponse->CreationDateTime; | ||
| 53 | my $Description = $CreateBotLocaleResponse->Description; | ||
| 54 | my $LocaleId = $CreateBotLocaleResponse->LocaleId; | ||
| 55 | my $LocaleName = $CreateBotLocaleResponse->LocaleName; | ||
| 56 | my $NluIntentConfidenceThreshold = | ||
| 57 | $CreateBotLocaleResponse->NluIntentConfidenceThreshold; | ||
| 58 | my $VoiceSettings = $CreateBotLocaleResponse->VoiceSettings; | ||
| 59 | |||
| 60 | # Returns a L<Paws::LexModelsV2::CreateBotLocaleResponse> object. | ||
| 61 | |||
| 62 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/models-v2-lex/CreateBotLocale> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> BotId => Str | ||
| 69 | |||
| 70 | The identifier of the bot to create the locale for. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> BotVersion => Str | ||
| 75 | |||
| 76 | The version of the bot to create the locale for. This can only be the | ||
| 77 | draft version of the bot. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 Description => Str | ||
| 82 | |||
| 83 | A description of the bot locale. Use this to help identify the bot | ||
| 84 | locale in lists. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> LocaleId => Str | ||
| 89 | |||
| 90 | The identifier of the language and locale that the bot will be used in. | ||
| 91 | The string must match one of the supported locales. All of the intents, | ||
| 92 | slot types, and slots used in the bot must have the same locale. For | ||
| 93 | more information, see Supported languages | ||
| 94 | (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 B<REQUIRED> NluIntentConfidenceThreshold => Num | ||
| 99 | |||
| 100 | Determines the threshold where Amazon Lex will insert the | ||
| 101 | C<AMAZON.FallbackIntent>, C<AMAZON.KendraSearchIntent>, or both when | ||
| 102 | returning alternative intents. C<AMAZON.FallbackIntent> and | ||
| 103 | C<AMAZON.KendraSearchIntent> are only inserted if they are configured | ||
| 104 | for the bot. | ||
| 105 | |||
| 106 | For example, suppose a bot is configured with the confidence threshold | ||
| 107 | of 0.80 and the C<AMAZON.FallbackIntent>. Amazon Lex returns three | ||
| 108 | alternative intents with the following confidence scores: IntentA | ||
| 109 | (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText | ||
| 110 | operation would be: | ||
| 111 | |||
| 112 | =over | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | AMAZON.FallbackIntent | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | IntentA | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | IntentB | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | IntentC | ||
| 129 | |||
| 130 | =back | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 VoiceSettings => L<Paws::LexModelsV2::VoiceSettings> | ||
| 136 | |||
| 137 | The Amazon Polly voice ID that Amazon Lex uses for voice interaction | ||
| 138 | with the user. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method CreateBotLocale in L<Paws::LexModelsV2> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |