blib/lib/Paws/LexModelsV2/CreateIntent.pm untested

filter: Statementstmt 0.0% 0 / 38 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 40 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::LexModelsV2::CreateIntent;
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 DialogCodeHook => (is => 'ro', isa => 'Paws::LexModelsV2::DialogCodeHookSettings', traits => ['NameInRequest'], request_name => 'dialogCodeHook');
8 has FulfillmentCodeHook => (is => 'ro', isa => 'Paws::LexModelsV2::FulfillmentCodeHookSettings', traits => ['NameInRequest'], request_name => 'fulfillmentCodeHook');
9 has InputContexts => (is => 'ro', isa => 'ArrayRef[Paws::LexModelsV2::InputContext]', traits => ['NameInRequest'], request_name => 'inputContexts');
10 has IntentClosingSetting => (is => 'ro', isa => 'Paws::LexModelsV2::IntentClosingSetting', traits => ['NameInRequest'], request_name => 'intentClosingSetting');
11 has IntentConfirmationSetting => (is => 'ro', isa => 'Paws::LexModelsV2::IntentConfirmationSetting', traits => ['NameInRequest'], request_name => 'intentConfirmationSetting');
12 has IntentName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'intentName', required => 1);
13 has KendraConfiguration => (is => 'ro', isa => 'Paws::LexModelsV2::KendraConfiguration', traits => ['NameInRequest'], request_name => 'kendraConfiguration');
14 has LocaleId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'localeId', required => 1);
15 has OutputContexts => (is => 'ro', isa => 'ArrayRef[Paws::LexModelsV2::OutputContext]', traits => ['NameInRequest'], request_name => 'outputContexts');
16 has ParentIntentSignature => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'parentIntentSignature');
17 has SampleUtterances => (is => 'ro', isa => 'ArrayRef[Paws::LexModelsV2::SampleUtterance]', traits => ['NameInRequest'], request_name => 'sampleUtterances');
18  
19 use MooseX::ClassAttribute;
20  
21 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIntent');
22 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/');
23 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
24 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModelsV2::CreateIntentResponse');
25 1;
26  
27 ### main pod documentation begin ###
28  
29 =head1 NAME
30  
31 Paws::LexModelsV2::CreateIntent - Arguments for method CreateIntent on L<Paws::LexModelsV2>
32  
33 =head1 DESCRIPTION
34  
35 This class represents the parameters used for calling the method CreateIntent on the
36 L<Amazon Lex Model Building V2|Paws::LexModelsV2> service. Use the attributes of this class
37 as arguments to method CreateIntent.
38  
39 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIntent.
40  
41 =head1 SYNOPSIS
42  
43 my $models-v2-lex = Paws->service('LexModelsV2');
44 my $CreateIntentResponse = $models - v2 -lex->CreateIntent(
45 BotId => 'MyId',
46 BotVersion => 'MyDraftBotVersion',
47 IntentName => 'MyName',
48 LocaleId => 'MyLocaleId',
49 Description => 'MyDescription', # OPTIONAL
50 DialogCodeHook => {
51 Enabled => 1,
52  
53 }, # OPTIONAL
54 FulfillmentCodeHook => {
55 Enabled => 1,
56  
57 }, # OPTIONAL
58 InputContexts => [
59 {
60 Name => 'MyName', # min: 1, max: 100
61  
62 },
63 ...
64 ], # OPTIONAL
65 IntentClosingSetting => {
66 ClosingResponse => {
67 MessageGroups => [
68 {
69 Message => {
70 CustomPayload => {
71 Value => 'MyCustomPayloadValue', # min: 1, max: 1000
72  
73 }, # OPTIONAL
74 ImageResponseCard => {
75 Title => 'MyAttachmentTitle', # min: 1, max: 250
76 Buttons => [
77 {
78 Text => 'MyButtonText', # min: 1, max: 50
79 Value => 'MyButtonValue', # min: 1, max: 50
80  
81 },
82 ...
83 ], # max: 5; OPTIONAL
84 ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
85 Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
86 }, # OPTIONAL
87 PlainTextMessage => {
88 Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
89  
90 }, # OPTIONAL
91 SsmlMessage => {
92 Value => 'MySSMLMessageValue', # min: 1, max: 1000
93  
94 }, # OPTIONAL
95 },
96 Variations => [
97 {
98 CustomPayload => {
99 Value => 'MyCustomPayloadValue', # min: 1, max: 1000
100  
101 }, # OPTIONAL
102 ImageResponseCard => {
103 Title => 'MyAttachmentTitle', # min: 1, max: 250
104 Buttons => [
105 {
106 Text => 'MyButtonText', # min: 1, max: 50
107 Value => 'MyButtonValue', # min: 1, max: 50
108  
109 },
110 ...
111 ], # max: 5; OPTIONAL
112 ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
113 Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
114 }, # OPTIONAL
115 PlainTextMessage => {
116 Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
117  
118 }, # OPTIONAL
119 SsmlMessage => {
120 Value => 'MySSMLMessageValue', # min: 1, max: 1000
121  
122 }, # OPTIONAL
123 },
124 ...
125 ], # max: 2; OPTIONAL
126 },
127 ...
128 ], # min: 1, max: 5
129 AllowInterrupt => 1, # OPTIONAL
130 },
131  
132 }, # OPTIONAL
133 IntentConfirmationSetting => {
134 DeclinationResponse => {
135 MessageGroups => [
136 {
137 Message => {
138 CustomPayload => {
139 Value => 'MyCustomPayloadValue', # min: 1, max: 1000
140  
141 }, # OPTIONAL
142 ImageResponseCard => {
143 Title => 'MyAttachmentTitle', # min: 1, max: 250
144 Buttons => [
145 {
146 Text => 'MyButtonText', # min: 1, max: 50
147 Value => 'MyButtonValue', # min: 1, max: 50
148  
149 },
150 ...
151 ], # max: 5; OPTIONAL
152 ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
153 Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
154 }, # OPTIONAL
155 PlainTextMessage => {
156 Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
157  
158 }, # OPTIONAL
159 SsmlMessage => {
160 Value => 'MySSMLMessageValue', # min: 1, max: 1000
161  
162 }, # OPTIONAL
163 },
164 Variations => [
165 {
166 CustomPayload => {
167 Value => 'MyCustomPayloadValue', # min: 1, max: 1000
168  
169 }, # OPTIONAL
170 ImageResponseCard => {
171 Title => 'MyAttachmentTitle', # min: 1, max: 250
172 Buttons => [
173 {
174 Text => 'MyButtonText', # min: 1, max: 50
175 Value => 'MyButtonValue', # min: 1, max: 50
176  
177 },
178 ...
179 ], # max: 5; OPTIONAL
180 ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
181 Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
182 }, # OPTIONAL
183 PlainTextMessage => {
184 Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
185  
186 }, # OPTIONAL
187 SsmlMessage => {
188 Value => 'MySSMLMessageValue', # min: 1, max: 1000
189  
190 }, # OPTIONAL
191 },
192 ...
193 ], # max: 2; OPTIONAL
194 },
195 ...
196 ], # min: 1, max: 5
197 AllowInterrupt => 1, # OPTIONAL
198 },
199 PromptSpecification => {
200 MaxRetries => 1, # max: 5
201 MessageGroups => [
202 {
203 Message => {
204 CustomPayload => {
205 Value => 'MyCustomPayloadValue', # min: 1, max: 1000
206  
207 }, # OPTIONAL
208 ImageResponseCard => {
209 Title => 'MyAttachmentTitle', # min: 1, max: 250
210 Buttons => [
211 {
212 Text => 'MyButtonText', # min: 1, max: 50
213 Value => 'MyButtonValue', # min: 1, max: 50
214  
215 },
216 ...
217 ], # max: 5; OPTIONAL
218 ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
219 Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
220 }, # OPTIONAL
221 PlainTextMessage => {
222 Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
223  
224 }, # OPTIONAL
225 SsmlMessage => {
226 Value => 'MySSMLMessageValue', # min: 1, max: 1000
227  
228 }, # OPTIONAL
229 },
230 Variations => [
231 {
232 CustomPayload => {
233 Value => 'MyCustomPayloadValue', # min: 1, max: 1000
234  
235 }, # OPTIONAL
236 ImageResponseCard => {
237 Title => 'MyAttachmentTitle', # min: 1, max: 250
238 Buttons => [
239 {
240 Text => 'MyButtonText', # min: 1, max: 50
241 Value => 'MyButtonValue', # min: 1, max: 50
242  
243 },
244 ...
245 ], # max: 5; OPTIONAL
246 ImageUrl => 'MyAttachmentUrl', # min: 1, max: 250; OPTIONAL
247 Subtitle => 'MyAttachmentTitle', # min: 1, max: 250
248 }, # OPTIONAL
249 PlainTextMessage => {
250 Value => 'MyPlainTextMessageValue', # min: 1, max: 1000
251  
252 }, # OPTIONAL
253 SsmlMessage => {
254 Value => 'MySSMLMessageValue', # min: 1, max: 1000
255  
256 }, # OPTIONAL
257 },
258 ...
259 ], # max: 2; OPTIONAL
260 },
261 ...
262 ], # min: 1, max: 5
263 AllowInterrupt => 1, # OPTIONAL
264 },
265  
266 }, # OPTIONAL
267 KendraConfiguration => {
268 KendraIndex => 'MyKendraIndexArn', # min: 32, max: 2048
269 QueryFilterString =>
270 'MyQueryFilterString', # min: 1, max: 5000; OPTIONAL
271 QueryFilterStringEnabled => 1,
272 }, # OPTIONAL
273 OutputContexts => [
274 {
275 Name => 'MyName', # min: 1, max: 100
276 TimeToLiveInSeconds => 1, # min: 5, max: 86400
277 TurnsToLive => 1, # min: 1, max: 20
278  
279 },
280 ...
281 ], # OPTIONAL
282 ParentIntentSignature => 'MyIntentSignature', # OPTIONAL
283 SampleUtterances => [
284 {
285 Utterance => 'MyUtterance',
286  
287 },
288 ...
289 ], # OPTIONAL
290 );
291  
292 # Results:
293 my $BotId = $CreateIntentResponse->BotId;
294 my $BotVersion = $CreateIntentResponse->BotVersion;
295 my $CreationDateTime = $CreateIntentResponse->CreationDateTime;
296 my $Description = $CreateIntentResponse->Description;
297 my $DialogCodeHook = $CreateIntentResponse->DialogCodeHook;
298 my $FulfillmentCodeHook = $CreateIntentResponse->FulfillmentCodeHook;
299 my $InputContexts = $CreateIntentResponse->InputContexts;
300 my $IntentClosingSetting = $CreateIntentResponse->IntentClosingSetting;
301 my $IntentConfirmationSetting =
302 $CreateIntentResponse->IntentConfirmationSetting;
303 my $IntentId = $CreateIntentResponse->IntentId;
304 my $IntentName = $CreateIntentResponse->IntentName;
305 my $KendraConfiguration = $CreateIntentResponse->KendraConfiguration;
306 my $LocaleId = $CreateIntentResponse->LocaleId;
307 my $OutputContexts = $CreateIntentResponse->OutputContexts;
308 my $ParentIntentSignature = $CreateIntentResponse->ParentIntentSignature;
309 my $SampleUtterances = $CreateIntentResponse->SampleUtterances;
310  
311 # Returns a L<Paws::LexModelsV2::CreateIntentResponse> object.
312  
313 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.
314 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/models-v2-lex/CreateIntent>
315  
316 =head1 ATTRIBUTES
317  
318  
319 =head2 B<REQUIRED> BotId => Str
320  
321 The identifier of the bot associated with this intent.
322  
323  
324  
325 =head2 B<REQUIRED> BotVersion => Str
326  
327 The identifier of the version of the bot associated with this intent.
328  
329  
330  
331 =head2 Description => Str
332  
333 A description of the intent. Use the description to help identify the
334 intent in lists.
335  
336  
337  
338 =head2 DialogCodeHook => L<Paws::LexModelsV2::DialogCodeHookSettings>
339  
340 Specifies that Amazon Lex invokes the alias Lambda function for each
341 user input. You can invoke this Lambda function to personalize user
342 interaction.
343  
344 For example, suppose that your bot determines that the user's name is
345 John. You Lambda function might retrieve John's information from a
346 backend database and prepopulate some of the values. For example, if
347 you find that John is gluten intolerant, you might set the
348 corresponding intent slot, C<glutenIntolerant> to C<true>. You might
349 find John's phone number and set the corresponding session attribute.
350  
351  
352  
353 =head2 FulfillmentCodeHook => L<Paws::LexModelsV2::FulfillmentCodeHookSettings>
354  
355 Specifies that Amazon Lex invokes the alias Lambda function when the
356 intent is ready for fulfillment. You can invoke this function to
357 complete the bot's transaction with the user.
358  
359 For example, in a pizza ordering bot, the Lambda function can look up
360 the closest pizza restaurant to the customer's location and then place
361 an order on the customer's behalf.
362  
363  
364  
365 =head2 InputContexts => ArrayRef[L<Paws::LexModelsV2::InputContext>]
366  
367 A list of contexts that must be active for this intent to be considered
368 by Amazon Lex.
369  
370 When an intent has an input context list, Amazon Lex only considers
371 using the intent in an interaction with the user when the specified
372 contexts are included in the active context list for the session. If
373 the contexts are not active, then Amazon Lex will not use the intent.
374  
375 A context can be automatically activated using the C<outputContexts>
376 property or it can be set at runtime.
377  
378 For example, if there are two intents with different input contexts
379 that respond to the same utterances, only the intent with the active
380 context will respond.
381  
382 An intent may have up to 5 input contexts. If an intent has multiple
383 input contexts, all of the contexts must be active to consider the
384 intent.
385  
386  
387  
388 =head2 IntentClosingSetting => L<Paws::LexModelsV2::IntentClosingSetting>
389  
390 Sets the response that Amazon Lex sends to the user when the intent is
391 closed.
392  
393  
394  
395 =head2 IntentConfirmationSetting => L<Paws::LexModelsV2::IntentConfirmationSetting>
396  
397 Provides prompts that Amazon Lex sends to the user to confirm the
398 completion of an intent. If the user answers "no," the settings contain
399 a statement that is sent to the user to end the intent.
400  
401  
402  
403 =head2 B<REQUIRED> IntentName => Str
404  
405 The name of the intent. Intent names must be unique in the locale that
406 contains the intent and cannot match the name of any built-in intent.
407  
408  
409  
410 =head2 KendraConfiguration => L<Paws::LexModelsV2::KendraConfiguration>
411  
412 Configuration information required to use the
413 C<AMAZON.KendraSearchIntent> intent to connect to an Amazon Kendra
414 index. The C<AMAZON.KendraSearchIntent> intent is called when Amazon
415 Lex can't determine another intent to invoke.
416  
417  
418  
419 =head2 B<REQUIRED> LocaleId => Str
420  
421 The identifier of the language and locale where this intent is used.
422 All of the bots, slot types, and slots used by the intent must have the
423 same locale. For more information, see Supported languages
424 (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
425  
426  
427  
428 =head2 OutputContexts => ArrayRef[L<Paws::LexModelsV2::OutputContext>]
429  
430 A lists of contexts that the intent activates when it is fulfilled.
431  
432 You can use an output context to indicate the intents that Amazon Lex
433 should consider for the next turn of the conversation with a customer.
434  
435 When you use the C<outputContextsList> property, all of the contexts
436 specified in the list are activated when the intent is fulfilled. You
437 can set up to 10 output contexts. You can also set the number of
438 conversation turns that the context should be active, or the length of
439 time that the context should be active.
440  
441  
442  
443 =head2 ParentIntentSignature => Str
444  
445 A unique identifier for the built-in intent to base this intent on.
446  
447  
448  
449 =head2 SampleUtterances => ArrayRef[L<Paws::LexModelsV2::SampleUtterance>]
450  
451 An array of strings that a user might say to signal the intent. For
452 example, "I want a pizza", or "I want a {PizzaSize} pizza".
453  
454 In an utterance, slot names are enclosed in curly braces ("{", "}") to
455 indicate where they should be displayed in the utterance shown to the
456 user..
457  
458  
459  
460  
461 =head1 SEE ALSO
462  
463 This class forms part of L<Paws>, documenting arguments for method CreateIntent in L<Paws::LexModelsV2>
464  
465 =head1 BUGS and CONTRIBUTIONS
466  
467 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
468  
469 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
470  
471 =cut
472