File Coverage

blib/lib/Paws/LexModels/PutBot.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::LexModels::PutBot;
3 1     1   549 use Moose;
  1         3  
  1         8  
4             has AbortStatement => (is => 'ro', isa => 'Paws::LexModels::Statement');
5             has Checksum => (is => 'ro', isa => 'Str');
6             has ChildDirected => (is => 'ro', isa => 'Bool', required => 1);
7             has ClarificationPrompt => (is => 'ro', isa => 'Paws::LexModels::Prompt');
8             has Description => (is => 'ro', isa => 'Str');
9             has IdleSessionTTLInSeconds => (is => 'ro', isa => 'Int');
10             has Intents => (is => 'ro', isa => 'ArrayRef[Paws::LexModels::Intent]');
11             has Locale => (is => 'ro', isa => 'Str', required => 1);
12             has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name' , required => 1);
13             has ProcessBehavior => (is => 'ro', isa => 'Str');
14             has VoiceId => (is => 'ro', isa => 'Str');
15              
16 1     1   6649 use MooseX::ClassAttribute;
  1         3  
  1         9  
17              
18             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutBot');
19             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/{name}/versions/$LATEST');
20             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
21             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModels::PutBotResponse');
22             class_has _result_key => (isa => 'Str', is => 'ro');
23             1;
24              
25             ### main pod documentation begin ###
26              
27             =head1 NAME
28              
29             Paws::LexModels::PutBot - Arguments for method PutBot on Paws::LexModels
30              
31             =head1 DESCRIPTION
32              
33             This class represents the parameters used for calling the method PutBot on the
34             Amazon Lex Model Building Service service. Use the attributes of this class
35             as arguments to method PutBot.
36              
37             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutBot.
38              
39             As an example:
40              
41             $service_obj->PutBot(Att1 => $value1, Att2 => $value2, ...);
42              
43             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.
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 AbortStatement => L<Paws::LexModels::Statement>
49              
50             When Amazon Lex can't understand the user's input in context, it tries
51             to elicit the information a few times. After that, Amazon Lex sends the
52             message defined in C<abortStatement> to the user, and then aborts the
53             conversation. To set the number of retries, use the
54             C<valueElicitationPrompt> field for the slot type.
55              
56             For example, in a pizza ordering bot, Amazon Lex might ask a user "What
57             type of crust would you like?" If the user's response is not one of the
58             expected responses (for example, "thin crust, "deep dish," etc.),
59             Amazon Lex tries to elicit a correct response a few more times.
60              
61             For example, in a pizza ordering application, C<OrderPizza> might be
62             one of the intents. This intent might require the C<CrustType> slot.
63             You specify the C<valueElicitationPrompt> field when you create the
64             C<CrustType> slot.
65              
66              
67              
68             =head2 Checksum => Str
69              
70             Identifies a specific revision of the C<$LATEST> version.
71              
72             When you create a new bot, leave the C<checksum> field blank. If you
73             specify a checksum you get a C<BadRequestException> exception.
74              
75             When you want to update a bot, set the C<checksum> field to the
76             checksum of the most recent revision of the C<$LATEST> version. If you
77             don't specify the C< checksum> field, or if the checksum does not match
78             the C<$LATEST> version, you get a C<PreconditionFailedException>
79             exception.
80              
81              
82              
83             =head2 B<REQUIRED> ChildDirected => Bool
84              
85             For each Amazon Lex bot created with the Amazon Lex Model Building
86             Service, you must specify whether your use of Amazon Lex is related to
87             a website, program, or other application that is directed or targeted,
88             in whole or in part, to children under age 13 and subject to the
89             Children's Online Privacy Protection Act (COPPA) by specifying C<true>
90             or C<false> in the C<childDirected> field. By specifying C<true> in the
91             C<childDirected> field, you confirm that your use of Amazon Lex B<is>
92             related to a website, program, or other application that is directed or
93             targeted, in whole or in part, to children under age 13 and subject to
94             COPPA. By specifying C<false> in the C<childDirected> field, you
95             confirm that your use of Amazon Lex B<is not> related to a website,
96             program, or other application that is directed or targeted, in whole or
97             in part, to children under age 13 and subject to COPPA. You may not
98             specify a default value for the C<childDirected> field that does not
99             accurately reflect whether your use of Amazon Lex is related to a
100             website, program, or other application that is directed or targeted, in
101             whole or in part, to children under age 13 and subject to COPPA.
102              
103             If your use of Amazon Lex relates to a website, program, or other
104             application that is directed in whole or in part, to children under age
105             13, you must obtain any required verifiable parental consent under
106             COPPA. For information regarding the use of Amazon Lex in connection
107             with websites, programs, or other applications that are directed or
108             targeted, in whole or in part, to children under age 13, see the Amazon
109             Lex FAQ.
110              
111              
112              
113             =head2 ClarificationPrompt => L<Paws::LexModels::Prompt>
114              
115             When Amazon Lex doesn't understand the user's intent, it uses this
116             message to get clarification. To specify how many times Amazon Lex
117             should repeate the clarification prompt, use the C<maxAttempts> field.
118             If Amazon Lex still doesn't understand, it sends the message in the
119             C<abortStatement> field.
120              
121             When you create a clarification prompt, make sure that it suggests the
122             correct response from the user. for example, for a bot that orders
123             pizza and drinks, you might create this clarification prompt: "What
124             would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
125              
126              
127              
128             =head2 Description => Str
129              
130             A description of the bot.
131              
132              
133              
134             =head2 IdleSessionTTLInSeconds => Int
135              
136             The maximum time in seconds that Amazon Lex retains the data gathered
137             in a conversation.
138              
139             A user interaction session remains active for the amount of time
140             specified. If no conversation occurs during this time, the session
141             expires and Amazon Lex deletes any data provided before the timeout.
142              
143             For example, suppose that a user chooses the OrderPizza intent, but
144             gets sidetracked halfway through placing an order. If the user doesn't
145             complete the order within the specified time, Amazon Lex discards the
146             slot information that it gathered, and the user must start over.
147              
148             If you don't include the C<idleSessionTTLInSeconds> element in a
149             C<PutBot> operation request, Amazon Lex uses the default value. This is
150             also true if the request replaces an existing bot.
151              
152             The default is 300 seconds (5 minutes).
153              
154              
155              
156             =head2 Intents => ArrayRef[L<Paws::LexModels::Intent>]
157              
158             An array of C<Intent> objects. Each intent represents a command that a
159             user can express. For example, a pizza ordering bot might support an
160             OrderPizza intent. For more information, see how-it-works.
161              
162              
163              
164             =head2 B<REQUIRED> Locale => Str
165              
166             Specifies the target locale for the bot. Any intent used in the bot
167             must be compatible with the locale of the bot.
168              
169             The default is C<en-US>.
170              
171             Valid values are: C<"en-US">
172              
173             =head2 B<REQUIRED> Name => Str
174              
175             The name of the bot. The name is I<not> case sensitive.
176              
177              
178              
179             =head2 ProcessBehavior => Str
180              
181             If you set the C<processBehavior> element to C<Build>, Amazon Lex
182             builds the bot so that it can be run. If you set the element to
183             C<Save>Amazon Lex saves the bot, but doesn't build it.
184              
185             If you don't specify this value, the default value is C<Save>.
186              
187             Valid values are: C<"SAVE">, C<"BUILD">
188              
189             =head2 VoiceId => Str
190              
191             The Amazon Polly voice ID that you want Amazon Lex to use for voice
192             interactions with the user. The locale configured for the voice must
193             match the locale of the bot. For more information, see Available Voices
194             in the I<Amazon Polly Developer Guide>.
195              
196              
197              
198              
199             =head1 SEE ALSO
200              
201             This class forms part of L<Paws>, documenting arguments for method PutBot in L<Paws::LexModels>
202              
203             =head1 BUGS and CONTRIBUTIONS
204              
205             The source code is located here: https://github.com/pplu/aws-sdk-perl
206              
207             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
208              
209             =cut
210