aws-sdk-lexmodelsv2 1.38.0 → 1.40.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -210,6 +210,1267 @@ module Aws::LexModelsV2
210
210
  include Aws::Structure
211
211
  end
212
212
 
213
+ # Contains the time metric, interval, and method by which to bin the
214
+ # analytics data.
215
+ #
216
+ # @!attribute [rw] name
217
+ # Specifies the time metric by which to bin the analytics data.
218
+ # @return [String]
219
+ #
220
+ # @!attribute [rw] interval
221
+ # Specifies the interval of time by which to bin the analytics data.
222
+ # @return [String]
223
+ #
224
+ # @!attribute [rw] order
225
+ # Specifies whether to bin the analytics data in ascending or
226
+ # descending order. If this field is left blank, the default order is
227
+ # by the key of the bin in descending order.
228
+ # @return [String]
229
+ #
230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsBinBySpecification AWS API Documentation
231
+ #
232
+ class AnalyticsBinBySpecification < Struct.new(
233
+ :name,
234
+ :interval,
235
+ :order)
236
+ SENSITIVE = []
237
+ include Aws::Structure
238
+ end
239
+
240
+ # An object containing the criterion by which to bin the results and the
241
+ # value that defines that bin.
242
+ #
243
+ # @!attribute [rw] name
244
+ # The criterion by which to bin the results.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] value
248
+ # The value of the criterion that defines the bin.
249
+ # @return [Integer]
250
+ #
251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsBinKey AWS API Documentation
252
+ #
253
+ class AnalyticsBinKey < Struct.new(
254
+ :name,
255
+ :value)
256
+ SENSITIVE = []
257
+ include Aws::Structure
258
+ end
259
+
260
+ # Contains fields describing a condition by which to filter the intents.
261
+ # The expression may be understood as `name` `operator` `values`. For
262
+ # example:
263
+ #
264
+ # * `IntentName CO Book` – The intent name contains the string "Book."
265
+ #
266
+ # * `BotVersion EQ 2` – The bot version is equal to two.
267
+ #
268
+ # The operators that each filter supports are listed below:
269
+ #
270
+ # * `BotAlias` – `EQ`.
271
+ #
272
+ # * `BotVersion` – `EQ`.
273
+ #
274
+ # * `LocaleId` – `EQ`.
275
+ #
276
+ # * `Modality` – `EQ`.
277
+ #
278
+ # * `Channel` – `EQ`.
279
+ #
280
+ # * `SessionId` – `EQ`.
281
+ #
282
+ # * `OriginatingRequestId` – `EQ`.
283
+ #
284
+ # * `IntentName` – `EQ`, `CO`.
285
+ #
286
+ # * `IntentEndState` – `EQ`, `CO`.
287
+ #
288
+ # @!attribute [rw] name
289
+ # The category by which to filter the intents. The descriptions for
290
+ # each option are as follows:
291
+ #
292
+ # * `BotAlias` – The name of the bot alias.
293
+ #
294
+ # * `BotVersion` – The version of the bot.
295
+ #
296
+ # * `LocaleId` – The locale of the bot.
297
+ #
298
+ # * `Modality` – The modality of the session with the bot (audio,
299
+ # DTMF, or text).
300
+ #
301
+ # * `Channel` – The channel that the bot is integrated with.
302
+ #
303
+ # * `SessionId` – The identifier of the session with the bot.
304
+ #
305
+ # * `OriginatingRequestId` – The identifier of the first request in a
306
+ # session.
307
+ #
308
+ # * `IntentName` – The name of the intent.
309
+ #
310
+ # * `IntentEndState` – The final state of the intent.
311
+ # @return [String]
312
+ #
313
+ # @!attribute [rw] operator
314
+ # The operation by which to filter the category. The following
315
+ # operations are possible:
316
+ #
317
+ # * `CO` – Contains
318
+ #
319
+ # * `EQ` – Equals
320
+ #
321
+ # * `GT` – Greater than
322
+ #
323
+ # * `LT` – Less than
324
+ #
325
+ # The operators that each filter supports are listed below:
326
+ #
327
+ # * `BotAlias` – `EQ`.
328
+ #
329
+ # * `BotVersion` – `EQ`.
330
+ #
331
+ # * `LocaleId` – `EQ`.
332
+ #
333
+ # * `Modality` – `EQ`.
334
+ #
335
+ # * `Channel` – `EQ`.
336
+ #
337
+ # * `SessionId` – `EQ`.
338
+ #
339
+ # * `OriginatingRequestId` – `EQ`.
340
+ #
341
+ # * `IntentName` – `EQ`, `CO`.
342
+ #
343
+ # * `IntentEndState` – `EQ`, `CO`.
344
+ # @return [String]
345
+ #
346
+ # @!attribute [rw] values
347
+ # An array containing the values of the category by which to apply the
348
+ # operator to filter the results. You can provide multiple values if
349
+ # the operator is `EQ` or `CO`. If you provide multiple values, you
350
+ # filter for results that equal/contain any of the values. For
351
+ # example, if the `name`, `operator`, and `values` fields are
352
+ # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for
353
+ # results where the modality was either `Speech` or `Text`.
354
+ # @return [Array<String>]
355
+ #
356
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentFilter AWS API Documentation
357
+ #
358
+ class AnalyticsIntentFilter < Struct.new(
359
+ :name,
360
+ :operator,
361
+ :values)
362
+ SENSITIVE = []
363
+ include Aws::Structure
364
+ end
365
+
366
+ # Contains the category by which the intent analytics were grouped and a
367
+ # member of that category.
368
+ #
369
+ # @!attribute [rw] name
370
+ # A category by which the intent analytics were grouped.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] value
374
+ # A member of the category by which the intent analytics were grouped.
375
+ # @return [String]
376
+ #
377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentGroupByKey AWS API Documentation
378
+ #
379
+ class AnalyticsIntentGroupByKey < Struct.new(
380
+ :name,
381
+ :value)
382
+ SENSITIVE = []
383
+ include Aws::Structure
384
+ end
385
+
386
+ # Contains the category by which to group the intents.
387
+ #
388
+ # @!attribute [rw] name
389
+ # Specifies whether to group the intent stages by their name or their
390
+ # end state.
391
+ # @return [String]
392
+ #
393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentGroupBySpecification AWS API Documentation
394
+ #
395
+ class AnalyticsIntentGroupBySpecification < Struct.new(
396
+ :name)
397
+ SENSITIVE = []
398
+ include Aws::Structure
399
+ end
400
+
401
+ # Contains the metric and the summary statistic you want to calculate,
402
+ # and the order in which to sort the results, for the intents in the
403
+ # bot.
404
+ #
405
+ # @!attribute [rw] name
406
+ # The metric for which you want to get intent summary statistics.
407
+ #
408
+ # * `Count` – The number of times the intent was invoked.
409
+ #
410
+ # * `Success` – The number of times the intent succeeded.
411
+ #
412
+ # * `Failure` – The number of times the intent failed.
413
+ #
414
+ # * `Switched` – The number of times there was a switch to a different
415
+ # intent.
416
+ #
417
+ # * `Dropped` – The number of times the user dropped the intent.
418
+ # @return [String]
419
+ #
420
+ # @!attribute [rw] statistic
421
+ # The summary statistic to calculate.
422
+ #
423
+ # * `Sum` – The total count for the category you provide in `name`.
424
+ #
425
+ # * `Average` – The total count divided by the number of intents in
426
+ # the category you provide in `name`.
427
+ #
428
+ # * `Max` – The highest count in the category you provide in `name`.
429
+ # @return [String]
430
+ #
431
+ # @!attribute [rw] order
432
+ # Specifies whether to sort the results in ascending or descending
433
+ # order.
434
+ # @return [String]
435
+ #
436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentMetric AWS API Documentation
437
+ #
438
+ class AnalyticsIntentMetric < Struct.new(
439
+ :name,
440
+ :statistic,
441
+ :order)
442
+ SENSITIVE = []
443
+ include Aws::Structure
444
+ end
445
+
446
+ # An object containing the results for the intent metric you requested.
447
+ #
448
+ # @!attribute [rw] name
449
+ # The metric that you requested. See [Key definitions][1] for more
450
+ # details about these metrics.
451
+ #
452
+ # * `Count` – The number of times the intent was invoked.
453
+ #
454
+ # * `Success` – The number of times the intent succeeded.
455
+ #
456
+ # * `Failure` – The number of times the intent failed.
457
+ #
458
+ # * `Switched` – The number of times there was a switch to a different
459
+ # intent.
460
+ #
461
+ # * `Dropped` – The number of times the user dropped the intent.
462
+ #
463
+ #
464
+ #
465
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html
466
+ # @return [String]
467
+ #
468
+ # @!attribute [rw] statistic
469
+ # The statistic that you requested to calculate.
470
+ #
471
+ # * `Sum` – The total count for the category you provide in `name`.
472
+ #
473
+ # * `Average` – The total count divided by the number of intents in
474
+ # the category you provide in `name`.
475
+ #
476
+ # * `Max` – The highest count in the category you provide in `name`.
477
+ # @return [String]
478
+ #
479
+ # @!attribute [rw] value
480
+ # The value of the summary statistic for the metric that you
481
+ # requested.
482
+ # @return [Float]
483
+ #
484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentMetricResult AWS API Documentation
485
+ #
486
+ class AnalyticsIntentMetricResult < Struct.new(
487
+ :name,
488
+ :statistic,
489
+ :value)
490
+ SENSITIVE = []
491
+ include Aws::Structure
492
+ end
493
+
494
+ # An object containing information about the requested path.
495
+ #
496
+ # @!attribute [rw] intent_name
497
+ # The name of the intent at the end of the requested path.
498
+ # @return [String]
499
+ #
500
+ # @!attribute [rw] intent_path
501
+ # The path.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] intent_count
505
+ # The total number of sessions that follow the given path to the given
506
+ # intent.
507
+ # @return [Integer]
508
+ #
509
+ # @!attribute [rw] intent_level
510
+ # The number of intents up to and including the requested path.
511
+ # @return [Integer]
512
+ #
513
+ # @!attribute [rw] node_type
514
+ # Specifies whether the node is the end of a path (`Exit`) or not
515
+ # (`Inner`).
516
+ # @return [String]
517
+ #
518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentNodeSummary AWS API Documentation
519
+ #
520
+ class AnalyticsIntentNodeSummary < Struct.new(
521
+ :intent_name,
522
+ :intent_path,
523
+ :intent_count,
524
+ :intent_level,
525
+ :node_type)
526
+ SENSITIVE = []
527
+ include Aws::Structure
528
+ end
529
+
530
+ # An object containing the results for the intent metrics you requested
531
+ # and the bin and/or group(s) they refer to, if applicable.
532
+ #
533
+ # @!attribute [rw] bin_keys
534
+ # A list of objects containing the criteria you requested for binning
535
+ # results and the values of the bins.
536
+ # @return [Array<Types::AnalyticsBinKey>]
537
+ #
538
+ # @!attribute [rw] group_by_keys
539
+ # A list of objects containing the criteria you requested for grouping
540
+ # results and the values of the groups.
541
+ # @return [Array<Types::AnalyticsIntentGroupByKey>]
542
+ #
543
+ # @!attribute [rw] metrics_results
544
+ # A list of objects, each of which contains a metric you want to list,
545
+ # the statistic for the metric you want to return, and the method by
546
+ # which to organize the results.
547
+ # @return [Array<Types::AnalyticsIntentMetricResult>]
548
+ #
549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentResult AWS API Documentation
550
+ #
551
+ class AnalyticsIntentResult < Struct.new(
552
+ :bin_keys,
553
+ :group_by_keys,
554
+ :metrics_results)
555
+ SENSITIVE = []
556
+ include Aws::Structure
557
+ end
558
+
559
+ # Contains fields describing a condition by which to filter the intent
560
+ # stages. The expression may be understood as `name` `operator`
561
+ # `values`. For example:
562
+ #
563
+ # * `IntentName CO Book` – The intent name contains the string "Book."
564
+ #
565
+ # * `BotVersion EQ 2` – The bot version is equal to two.
566
+ #
567
+ # The operators that each filter supports are listed below:
568
+ #
569
+ # * `BotAlias` – `EQ`.
570
+ #
571
+ # * `BotVersion` – `EQ`.
572
+ #
573
+ # * `LocaleId` – `EQ`.
574
+ #
575
+ # * `Modality` – `EQ`.
576
+ #
577
+ # * `Channel` – `EQ`.
578
+ #
579
+ # * `SessionId` – `EQ`.
580
+ #
581
+ # * `OriginatingRequestId` – `EQ`.
582
+ #
583
+ # * `IntentName` – `EQ`, `CO`.
584
+ #
585
+ # * `IntentStageName` – `EQ`, `CO`.
586
+ #
587
+ # @!attribute [rw] name
588
+ # The category by which to filter the intent stages. The descriptions
589
+ # for each option are as follows:
590
+ #
591
+ # * `BotAlias` – The name of the bot alias.
592
+ #
593
+ # * `BotVersion` – The version of the bot.
594
+ #
595
+ # * `LocaleId` – The locale of the bot.
596
+ #
597
+ # * `Modality` – The modality of the session with the bot (audio,
598
+ # DTMF, or text).
599
+ #
600
+ # * `Channel` – The channel that the bot is integrated with.
601
+ #
602
+ # * `SessionId` – The identifier of the session with the bot.
603
+ #
604
+ # * `OriginatingRequestId` – The identifier of the first request in a
605
+ # session.
606
+ #
607
+ # * `IntentName` – The name of the intent.
608
+ #
609
+ # * `IntentStageName` – The stage in the intent.
610
+ # @return [String]
611
+ #
612
+ # @!attribute [rw] operator
613
+ # The operation by which to filter the category. The following
614
+ # operations are possible:
615
+ #
616
+ # * `CO` – Contains
617
+ #
618
+ # * `EQ` – Equals
619
+ #
620
+ # * `GT` – Greater than
621
+ #
622
+ # * `LT` – Less than
623
+ #
624
+ # The operators that each filter supports are listed below:
625
+ #
626
+ # * `BotAlias` – `EQ`.
627
+ #
628
+ # * `BotVersion` – `EQ`.
629
+ #
630
+ # * `LocaleId` – `EQ`.
631
+ #
632
+ # * `Modality` – `EQ`.
633
+ #
634
+ # * `Channel` – `EQ`.
635
+ #
636
+ # * `SessionId` – `EQ`.
637
+ #
638
+ # * `OriginatingRequestId` – `EQ`.
639
+ #
640
+ # * `IntentName` – `EQ`, `CO`.
641
+ #
642
+ # * `IntentStageName` – `EQ`, `CO`.
643
+ # @return [String]
644
+ #
645
+ # @!attribute [rw] values
646
+ # An array containing the values of the category by which to apply the
647
+ # operator to filter the results. You can provide multiple values if
648
+ # the operator is `EQ` or `CO`. If you provide multiple values, you
649
+ # filter for results that equal/contain any of the values. For
650
+ # example, if the `name`, `operator`, and `values` fields are
651
+ # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for
652
+ # results where the modality was either `Speech` or `Text`.
653
+ # @return [Array<String>]
654
+ #
655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageFilter AWS API Documentation
656
+ #
657
+ class AnalyticsIntentStageFilter < Struct.new(
658
+ :name,
659
+ :operator,
660
+ :values)
661
+ SENSITIVE = []
662
+ include Aws::Structure
663
+ end
664
+
665
+ # Contains the category by which the intent stage analytics and the
666
+ # values for that category were grouped.
667
+ #
668
+ # @!attribute [rw] name
669
+ # A category by which the intent stage analytics were grouped.
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] value
673
+ # A member of the category by which the intent stage analytics were
674
+ # grouped.
675
+ # @return [String]
676
+ #
677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupByKey AWS API Documentation
678
+ #
679
+ class AnalyticsIntentStageGroupByKey < Struct.new(
680
+ :name,
681
+ :value)
682
+ SENSITIVE = []
683
+ include Aws::Structure
684
+ end
685
+
686
+ # Contains the category by which to group the intent stages.
687
+ #
688
+ # @!attribute [rw] name
689
+ # Specifies whether to group the intent stages by their name or the
690
+ # intent to which the session was switched.
691
+ # @return [String]
692
+ #
693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupBySpecification AWS API Documentation
694
+ #
695
+ class AnalyticsIntentStageGroupBySpecification < Struct.new(
696
+ :name)
697
+ SENSITIVE = []
698
+ include Aws::Structure
699
+ end
700
+
701
+ # Contains the metric and the summary statistic you want to calculate,
702
+ # and the order in which to sort the results, for the intent stages
703
+ # across the user sessions with the bot.
704
+ #
705
+ # @!attribute [rw] name
706
+ # The metric for which you want to get intent stage summary
707
+ # statistics. See [Key definitions][1] for more details about these
708
+ # metrics.
709
+ #
710
+ # * `Count` – The number of times the intent stage occurred.
711
+ #
712
+ # * `Success` – The number of times the intent stage succeeded.
713
+ #
714
+ # * `Failure` – The number of times the intent stage failed.
715
+ #
716
+ # * `Dropped` – The number of times the user dropped the intent stage.
717
+ #
718
+ # * `Retry` – The number of times the bot tried to elicit a response
719
+ # from the user at this stage.
720
+ #
721
+ #
722
+ #
723
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html
724
+ # @return [String]
725
+ #
726
+ # @!attribute [rw] statistic
727
+ # The summary statistic to calculate.
728
+ #
729
+ # * `Sum` – The total count for the category you provide in `name`.
730
+ #
731
+ # * `Average` – The total count divided by the number of intent stages
732
+ # in the category you provide in `name`.
733
+ #
734
+ # * `Max` – The highest count in the category you provide in `name`.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] order
738
+ # Specifies whether to sort the results in ascending or descending
739
+ # order of the summary statistic (`value` in the response).
740
+ # @return [String]
741
+ #
742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageMetric AWS API Documentation
743
+ #
744
+ class AnalyticsIntentStageMetric < Struct.new(
745
+ :name,
746
+ :statistic,
747
+ :order)
748
+ SENSITIVE = []
749
+ include Aws::Structure
750
+ end
751
+
752
+ # An object containing the results for an intent stage metric you
753
+ # requested.
754
+ #
755
+ # @!attribute [rw] name
756
+ # The metric that you requested.
757
+ #
758
+ # * `Count` – The number of times the intent stage occurred.
759
+ #
760
+ # * `Success` – The number of times the intent stage succeeded.
761
+ #
762
+ # * `Failure` – The number of times the intent stage failed.
763
+ #
764
+ # * `Dropped` – The number of times the user dropped the intent stage.
765
+ #
766
+ # * `Retry` – The number of times the bot tried to elicit a response
767
+ # from the user at this stage.
768
+ # @return [String]
769
+ #
770
+ # @!attribute [rw] statistic
771
+ # The summary statistic that you requested to calculate.
772
+ #
773
+ # * `Sum` – The total count for the category you provide in `name`.
774
+ #
775
+ # * `Average` – The total count divided by the number of intent stages
776
+ # in the category you provide in `name`.
777
+ #
778
+ # * `Max` – The highest count in the category you provide in `name`.
779
+ # @return [String]
780
+ #
781
+ # @!attribute [rw] value
782
+ # The value of the summary statistic for the metric that you
783
+ # requested.
784
+ # @return [Float]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageMetricResult AWS API Documentation
787
+ #
788
+ class AnalyticsIntentStageMetricResult < Struct.new(
789
+ :name,
790
+ :statistic,
791
+ :value)
792
+ SENSITIVE = []
793
+ include Aws::Structure
794
+ end
795
+
796
+ # An object containing the results for the intent stage metrics you
797
+ # requested and the bin and/or group they refer to, if applicable.
798
+ #
799
+ # @!attribute [rw] bin_keys
800
+ # A list of objects containing the criteria you requested for binning
801
+ # results and the values of the bins.
802
+ # @return [Array<Types::AnalyticsBinKey>]
803
+ #
804
+ # @!attribute [rw] group_by_keys
805
+ # A list of objects containing the criteria you requested for grouping
806
+ # results and the values of the bins.
807
+ # @return [Array<Types::AnalyticsIntentStageGroupByKey>]
808
+ #
809
+ # @!attribute [rw] metrics_results
810
+ # A list of objects, each of which contains a metric you want to list,
811
+ # the statistic for the metric you want to return, and the method by
812
+ # which to organize the results.
813
+ # @return [Array<Types::AnalyticsIntentStageMetricResult>]
814
+ #
815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageResult AWS API Documentation
816
+ #
817
+ class AnalyticsIntentStageResult < Struct.new(
818
+ :bin_keys,
819
+ :group_by_keys,
820
+ :metrics_results)
821
+ SENSITIVE = []
822
+ include Aws::Structure
823
+ end
824
+
825
+ # Contains fields describing a condition by which to filter the paths.
826
+ # The expression may be understood as `name` `operator` `values`. For
827
+ # example:
828
+ #
829
+ # * `LocaleId EQ en` – The locale is "en".
830
+ #
831
+ # * `BotVersion EQ 2` – The bot version is equal to two.
832
+ #
833
+ # The operators that each filter supports are listed below:
834
+ #
835
+ # * `BotAlias` – `EQ`.
836
+ #
837
+ # * `BotVersion` – `EQ`.
838
+ #
839
+ # * `LocaleId` – `EQ`.
840
+ #
841
+ # * `Modality` – `EQ`.
842
+ #
843
+ # * `Channel` – `EQ`.
844
+ #
845
+ # @!attribute [rw] name
846
+ # The category by which to filter the intent paths. The descriptions
847
+ # for each option are as follows:
848
+ #
849
+ # * `BotAlias` – The name of the bot alias.
850
+ #
851
+ # * `BotVersion` – The version of the bot.
852
+ #
853
+ # * `LocaleId` – The locale of the bot.
854
+ #
855
+ # * `Modality` – The modality of the session with the bot (audio,
856
+ # DTMF, or text).
857
+ #
858
+ # * `Channel` – The channel that the bot is integrated with.
859
+ # @return [String]
860
+ #
861
+ # @!attribute [rw] operator
862
+ # The operation by which to filter the category. The following
863
+ # operations are possible:
864
+ #
865
+ # * `CO` – Contains
866
+ #
867
+ # * `EQ` – Equals
868
+ #
869
+ # * `GT` – Greater than
870
+ #
871
+ # * `LT` – Less than
872
+ #
873
+ # The operators that each filter supports are listed below:
874
+ #
875
+ # * `BotAlias` – `EQ`.
876
+ #
877
+ # * `BotVersion` – `EQ`.
878
+ #
879
+ # * `LocaleId` – `EQ`.
880
+ #
881
+ # * `Modality` – `EQ`.
882
+ #
883
+ # * `Channel` – `EQ`.
884
+ # @return [String]
885
+ #
886
+ # @!attribute [rw] values
887
+ # An array containing the values of the category by which to apply the
888
+ # operator to filter the results. You can provide multiple values if
889
+ # the operator is `EQ` or `CO`. If you provide multiple values, you
890
+ # filter for results that equal/contain any of the values. For
891
+ # example, if the `name`, `operator`, and `values` fields are
892
+ # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for
893
+ # results where the modality was either `Speech` or `Text`.
894
+ # @return [Array<String>]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsPathFilter AWS API Documentation
897
+ #
898
+ class AnalyticsPathFilter < Struct.new(
899
+ :name,
900
+ :operator,
901
+ :values)
902
+ SENSITIVE = []
903
+ include Aws::Structure
904
+ end
905
+
906
+ # Contains fields describing a condition by which to filter the
907
+ # sessions. The expression may be understood as `name` `operator`
908
+ # `values`. For example:
909
+ #
910
+ # * `LocaleId EQ en` – The locale is "en".
911
+ #
912
+ # * `Duration GT 200` – The duration is greater than 200 seconds.
913
+ #
914
+ # The operators that each filter supports are listed below:
915
+ #
916
+ # * `BotAlias` – `EQ`.
917
+ #
918
+ # * `BotVersion` – `EQ`.
919
+ #
920
+ # * `LocaleId` – `EQ`.
921
+ #
922
+ # * `Modality` – `EQ`.
923
+ #
924
+ # * `Channel` – `EQ`.
925
+ #
926
+ # * `Duration` – `EQ`, `GT`, `LT`.
927
+ #
928
+ # * `conversationEndState` – `EQ`, `CO`.
929
+ #
930
+ # * `SessionId` – `EQ`.
931
+ #
932
+ # * `OriginatingRequestId` – `EQ`.
933
+ #
934
+ # * `IntentPath` – `EQ`.
935
+ #
936
+ # @!attribute [rw] name
937
+ # The category by which to filter the sessions. The descriptions for
938
+ # each option are as follows:
939
+ #
940
+ # * `BotAlias` – The name of the bot alias.
941
+ #
942
+ # * `BotVersion` – The version of the bot.
943
+ #
944
+ # * `LocaleId` – The locale of the bot.
945
+ #
946
+ # * `Modality` – The modality of the session with the bot (audio,
947
+ # DTMF, or text).
948
+ #
949
+ # * `Channel` – The channel that the bot is integrated with.
950
+ #
951
+ # * `Duration` – The duration of the session.
952
+ #
953
+ # * `conversationEndState` – The final state of the session.
954
+ #
955
+ # * `SessionId` – The identifier of the session with the bot.
956
+ #
957
+ # * `OriginatingRequestId` – The identifier of the first request in a
958
+ # session.
959
+ #
960
+ # * `IntentPath` – The order of intents taken in a session.
961
+ # @return [String]
962
+ #
963
+ # @!attribute [rw] operator
964
+ # The operation by which to filter the category. The following
965
+ # operations are possible:
966
+ #
967
+ # * `CO` – Contains
968
+ #
969
+ # * `EQ` – Equals
970
+ #
971
+ # * `GT` – Greater than
972
+ #
973
+ # * `LT` – Less than
974
+ #
975
+ # The operators that each filter supports are listed below:
976
+ #
977
+ # * `BotAlias` – `EQ`.
978
+ #
979
+ # * `BotVersion` – `EQ`.
980
+ #
981
+ # * `LocaleId` – `EQ`.
982
+ #
983
+ # * `Modality` – `EQ`.
984
+ #
985
+ # * `Channel` – `EQ`.
986
+ #
987
+ # * `Duration` – `EQ`, `GT`, `LT`.
988
+ #
989
+ # * `conversationEndState` – `EQ`, `CO`.
990
+ #
991
+ # * `SessionId` – `EQ`.
992
+ #
993
+ # * `OriginatingRequestId` – `EQ`.
994
+ #
995
+ # * `IntentPath` – `EQ`.
996
+ # @return [String]
997
+ #
998
+ # @!attribute [rw] values
999
+ # An array containing the values of the category by which to apply the
1000
+ # operator to filter the results. You can provide multiple values if
1001
+ # the operator is `EQ` or `CO`. If you provide multiple values, you
1002
+ # filter for results that equal/contain any of the values. For
1003
+ # example, if the `name`, `operator`, and `values` fields are
1004
+ # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for
1005
+ # results where the modality was either `Speech` or `Text`.
1006
+ # @return [Array<String>]
1007
+ #
1008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionFilter AWS API Documentation
1009
+ #
1010
+ class AnalyticsSessionFilter < Struct.new(
1011
+ :name,
1012
+ :operator,
1013
+ :values)
1014
+ SENSITIVE = []
1015
+ include Aws::Structure
1016
+ end
1017
+
1018
+ # Contains the category by which the session analytics were grouped and
1019
+ # a member of that category.
1020
+ #
1021
+ # @!attribute [rw] name
1022
+ # The category by which the session analytics were grouped.
1023
+ # @return [String]
1024
+ #
1025
+ # @!attribute [rw] value
1026
+ # A member of the category by which the session analytics were
1027
+ # grouped.
1028
+ # @return [String]
1029
+ #
1030
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionGroupByKey AWS API Documentation
1031
+ #
1032
+ class AnalyticsSessionGroupByKey < Struct.new(
1033
+ :name,
1034
+ :value)
1035
+ SENSITIVE = []
1036
+ include Aws::Structure
1037
+ end
1038
+
1039
+ # Contains the category by which to group the sessions.
1040
+ #
1041
+ # @!attribute [rw] name
1042
+ # Specifies whether to group the session by their end state or their
1043
+ # locale.
1044
+ # @return [String]
1045
+ #
1046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionGroupBySpecification AWS API Documentation
1047
+ #
1048
+ class AnalyticsSessionGroupBySpecification < Struct.new(
1049
+ :name)
1050
+ SENSITIVE = []
1051
+ include Aws::Structure
1052
+ end
1053
+
1054
+ # Contains the metric and the summary statistic you want to calculate,
1055
+ # and the order in which to sort the results, for the user sessions with
1056
+ # the bot.
1057
+ #
1058
+ # @!attribute [rw] name
1059
+ # The metric for which you want to get session summary statistics.
1060
+ #
1061
+ # * `Count` – The number of sessions.
1062
+ #
1063
+ # * `Success` – The number of sessions that succeeded.
1064
+ #
1065
+ # * `Failure` – The number of sessions that failed.
1066
+ #
1067
+ # * `Dropped` – The number of sessions that the user dropped.
1068
+ #
1069
+ # * `Duration` – The duration of sessions.
1070
+ #
1071
+ # * `TurnsPerSession` – The number of turns in the sessions.
1072
+ #
1073
+ # * `Concurrency` – The number of sessions occurring in the same
1074
+ # period of time.
1075
+ # @return [String]
1076
+ #
1077
+ # @!attribute [rw] statistic
1078
+ # The summary statistic to calculate.
1079
+ #
1080
+ # * `Sum` – The total count for the category you provide in `name`.
1081
+ #
1082
+ # * `Average` – The total count divided by the number of sessions in
1083
+ # the category you provide in `name`.
1084
+ #
1085
+ # * `Max` – The highest count in the category you provide in `name`.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] order
1089
+ # Specifies whether to sort the results in ascending or descending
1090
+ # order.
1091
+ # @return [String]
1092
+ #
1093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionMetric AWS API Documentation
1094
+ #
1095
+ class AnalyticsSessionMetric < Struct.new(
1096
+ :name,
1097
+ :statistic,
1098
+ :order)
1099
+ SENSITIVE = []
1100
+ include Aws::Structure
1101
+ end
1102
+
1103
+ # An object containing the results for a session metric you requested.
1104
+ #
1105
+ # @!attribute [rw] name
1106
+ # The metric that you requested.
1107
+ #
1108
+ # * `Count` – The number of sessions.
1109
+ #
1110
+ # * `Success` – The number of sessions that succeeded.
1111
+ #
1112
+ # * `Failure` – The number of sessions that failed.
1113
+ #
1114
+ # * `Dropped` – The number of sessions that the user dropped.
1115
+ #
1116
+ # * `Duration` – The duration of sessions.
1117
+ #
1118
+ # * `TurnPersession` – The number of turns in the sessions.
1119
+ #
1120
+ # * `Concurrency` – The number of sessions occurring in the same
1121
+ # period of time.
1122
+ # @return [String]
1123
+ #
1124
+ # @!attribute [rw] statistic
1125
+ # The summary statistic that you requested to calculate.
1126
+ #
1127
+ # * `Sum` – The total count for the category you provide in `name`.
1128
+ #
1129
+ # * `Average` – The total count divided by the number of sessions in
1130
+ # the category you provide in `name`.
1131
+ #
1132
+ # * `Max` – The highest count in the category you provide in `name`.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] value
1136
+ # The value of the summary statistic for the metric that you
1137
+ # requested.
1138
+ # @return [Float]
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionMetricResult AWS API Documentation
1141
+ #
1142
+ class AnalyticsSessionMetricResult < Struct.new(
1143
+ :name,
1144
+ :statistic,
1145
+ :value)
1146
+ SENSITIVE = []
1147
+ include Aws::Structure
1148
+ end
1149
+
1150
+ # An object containing the results for the session metrics you requested
1151
+ # and the bin and/or group(s) they refer to, if applicable.
1152
+ #
1153
+ # @!attribute [rw] bin_keys
1154
+ # A list of objects containing the criteria you requested for binning
1155
+ # results and the values of the bins.
1156
+ # @return [Array<Types::AnalyticsBinKey>]
1157
+ #
1158
+ # @!attribute [rw] group_by_keys
1159
+ # A list of objects containing the criteria you requested for grouping
1160
+ # results and the values of the bins.
1161
+ # @return [Array<Types::AnalyticsSessionGroupByKey>]
1162
+ #
1163
+ # @!attribute [rw] metrics_results
1164
+ # A list of objects, each of which contains a metric you want to list,
1165
+ # the statistic for the metric you want to return, and the method by
1166
+ # which to organize the results.
1167
+ # @return [Array<Types::AnalyticsSessionMetricResult>]
1168
+ #
1169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionResult AWS API Documentation
1170
+ #
1171
+ class AnalyticsSessionResult < Struct.new(
1172
+ :bin_keys,
1173
+ :group_by_keys,
1174
+ :metrics_results)
1175
+ SENSITIVE = []
1176
+ include Aws::Structure
1177
+ end
1178
+
1179
+ # An object that specifies the last used intent at the time of the
1180
+ # utterance as an attribute to return.
1181
+ #
1182
+ # @!attribute [rw] name
1183
+ # An attribute to return. The only available attribute is the intent
1184
+ # that the bot mapped the utterance to.
1185
+ # @return [String]
1186
+ #
1187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceAttribute AWS API Documentation
1188
+ #
1189
+ class AnalyticsUtteranceAttribute < Struct.new(
1190
+ :name)
1191
+ SENSITIVE = []
1192
+ include Aws::Structure
1193
+ end
1194
+
1195
+ # An object containing the intent that the bot mapped the utterance to.
1196
+ #
1197
+ # @!attribute [rw] last_used_intent
1198
+ # The intent that the bot mapped the utterance to.
1199
+ # @return [String]
1200
+ #
1201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceAttributeResult AWS API Documentation
1202
+ #
1203
+ class AnalyticsUtteranceAttributeResult < Struct.new(
1204
+ :last_used_intent)
1205
+ SENSITIVE = []
1206
+ include Aws::Structure
1207
+ end
1208
+
1209
+ # Contains fields describing a condition by which to filter the
1210
+ # utterances. The expression may be understood as `name` `operator`
1211
+ # `values`. For example:
1212
+ #
1213
+ # * `LocaleId EQ Book` – The locale is the string "en".
1214
+ #
1215
+ # * `UtteranceText CO help` – The text of the utterance contains the
1216
+ # string "help".
1217
+ #
1218
+ # The operators that each filter supports are listed below:
1219
+ #
1220
+ # * `BotAlias` – `EQ`.
1221
+ #
1222
+ # * `BotVersion` – `EQ`.
1223
+ #
1224
+ # * `LocaleId` – `EQ`.
1225
+ #
1226
+ # * `Modality` – `EQ`.
1227
+ #
1228
+ # * `Channel` – `EQ`.
1229
+ #
1230
+ # * `SessionId` – `EQ`.
1231
+ #
1232
+ # * `OriginatingRequestId` – `EQ`.
1233
+ #
1234
+ # * `UtteranceState` – `EQ`.
1235
+ #
1236
+ # * `UtteranceText` – `EQ`, `CO`.
1237
+ #
1238
+ # @!attribute [rw] name
1239
+ # The category by which to filter the utterances. The descriptions for
1240
+ # each option are as follows:
1241
+ #
1242
+ # * `BotAlias` – The name of the bot alias.
1243
+ #
1244
+ # * `BotVersion` – The version of the bot.
1245
+ #
1246
+ # * `LocaleId` – The locale of the bot.
1247
+ #
1248
+ # * `Modality` – The modality of the session with the bot (audio,
1249
+ # DTMF, or text).
1250
+ #
1251
+ # * `Channel` – The channel that the bot is integrated with.
1252
+ #
1253
+ # * `SessionId` – The identifier of the session with the bot.
1254
+ #
1255
+ # * `OriginatingRequestId` – The identifier of the first request in a
1256
+ # session.
1257
+ #
1258
+ # * `UtteranceState` – The state of the utterance.
1259
+ #
1260
+ # * `UtteranceText` – The text in the utterance.
1261
+ # @return [String]
1262
+ #
1263
+ # @!attribute [rw] operator
1264
+ # The operation by which to filter the category. The following
1265
+ # operations are possible:
1266
+ #
1267
+ # * `CO` – Contains
1268
+ #
1269
+ # * `EQ` – Equals
1270
+ #
1271
+ # * `GT` – Greater than
1272
+ #
1273
+ # * `LT` – Less than
1274
+ #
1275
+ # The operators that each filter supports are listed below:
1276
+ #
1277
+ # * `BotAlias` – `EQ`.
1278
+ #
1279
+ # * `BotVersion` – `EQ`.
1280
+ #
1281
+ # * `LocaleId` – `EQ`.
1282
+ #
1283
+ # * `Modality` – `EQ`.
1284
+ #
1285
+ # * `Channel` – `EQ`.
1286
+ #
1287
+ # * `SessionId` – `EQ`.
1288
+ #
1289
+ # * `OriginatingRequestId` – `EQ`.
1290
+ #
1291
+ # * `UtteranceState` – `EQ`.
1292
+ #
1293
+ # * `UtteranceText` – `EQ`, `CO`.
1294
+ # @return [String]
1295
+ #
1296
+ # @!attribute [rw] values
1297
+ # An array containing the values of the category by which to apply the
1298
+ # operator to filter the results. You can provide multiple values if
1299
+ # the operator is `EQ` or `CO`. If you provide multiple values, you
1300
+ # filter for results that equal/contain any of the values. For
1301
+ # example, if the `name`, `operator`, and `values` fields are
1302
+ # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for
1303
+ # results where the modality was either `Speech` or `Text`.
1304
+ # @return [Array<String>]
1305
+ #
1306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceFilter AWS API Documentation
1307
+ #
1308
+ class AnalyticsUtteranceFilter < Struct.new(
1309
+ :name,
1310
+ :operator,
1311
+ :values)
1312
+ SENSITIVE = []
1313
+ include Aws::Structure
1314
+ end
1315
+
1316
+ # Contains the category by which the utterance analytics were grouped
1317
+ # and the values for that category.
1318
+ #
1319
+ # @!attribute [rw] name
1320
+ # The category by which the utterance analytics were grouped.
1321
+ # @return [String]
1322
+ #
1323
+ # @!attribute [rw] value
1324
+ # A member of the category by which the utterance analytics were
1325
+ # grouped.
1326
+ # @return [String]
1327
+ #
1328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupByKey AWS API Documentation
1329
+ #
1330
+ class AnalyticsUtteranceGroupByKey < Struct.new(
1331
+ :name,
1332
+ :value)
1333
+ SENSITIVE = []
1334
+ include Aws::Structure
1335
+ end
1336
+
1337
+ # Contains the category by which to group the utterances.
1338
+ #
1339
+ # @!attribute [rw] name
1340
+ # Specifies whether to group the utterances by their text or their
1341
+ # state.
1342
+ # @return [String]
1343
+ #
1344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupBySpecification AWS API Documentation
1345
+ #
1346
+ class AnalyticsUtteranceGroupBySpecification < Struct.new(
1347
+ :name)
1348
+ SENSITIVE = []
1349
+ include Aws::Structure
1350
+ end
1351
+
1352
+ # Contains the metric and the summary statistic you want to calculate,
1353
+ # and the order in which to sort the results, for the utterances across
1354
+ # the user sessions with the bot.
1355
+ #
1356
+ # @!attribute [rw] name
1357
+ # The metric for which you want to get utterance summary statistics.
1358
+ #
1359
+ # * `Count` – The number of utterances.
1360
+ #
1361
+ # * `Missed` – The number of utterances that Amazon Lex failed to
1362
+ # recognize.
1363
+ #
1364
+ # * `Detected` – The number of utterances that Amazon Lex managed to
1365
+ # detect.
1366
+ #
1367
+ # * `UtteranceTimestamp` – The date and time of the utterance.
1368
+ # @return [String]
1369
+ #
1370
+ # @!attribute [rw] statistic
1371
+ # The summary statistic to calculate.
1372
+ #
1373
+ # * `Sum` – The total count for the category you provide in `name`.
1374
+ #
1375
+ # * `Average` – The total count divided by the number of utterances in
1376
+ # the category you provide in `name`.
1377
+ #
1378
+ # * `Max` – The highest count in the category you provide in `name`.
1379
+ # @return [String]
1380
+ #
1381
+ # @!attribute [rw] order
1382
+ # Specifies whether to sort the results in ascending or descending
1383
+ # order.
1384
+ # @return [String]
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceMetric AWS API Documentation
1387
+ #
1388
+ class AnalyticsUtteranceMetric < Struct.new(
1389
+ :name,
1390
+ :statistic,
1391
+ :order)
1392
+ SENSITIVE = []
1393
+ include Aws::Structure
1394
+ end
1395
+
1396
+ # An object containing the results for the utterance metric you
1397
+ # requested.
1398
+ #
1399
+ # @!attribute [rw] name
1400
+ # The metric that you requested.
1401
+ #
1402
+ # * `Count` – The number of utterances.
1403
+ #
1404
+ # * `Missed` – The number of utterances that Amazon Lex failed to
1405
+ # recognize.
1406
+ #
1407
+ # * `Detected` – The number of utterances that Amazon Lex managed to
1408
+ # detect.
1409
+ #
1410
+ # * `UtteranceTimestamp` – The date and time of the utterance.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] statistic
1414
+ # The summary statistic that you requested to calculate.
1415
+ #
1416
+ # * `Sum` – The total count for the category you provide in `name`.
1417
+ #
1418
+ # * `Average` – The total count divided by the number of utterances in
1419
+ # the category you provide in `name`.
1420
+ #
1421
+ # * `Max` – The highest count in the category you provide in `name`.
1422
+ # @return [String]
1423
+ #
1424
+ # @!attribute [rw] value
1425
+ # The value of the summary statistic for the metric that you
1426
+ # requested.
1427
+ # @return [Float]
1428
+ #
1429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceMetricResult AWS API Documentation
1430
+ #
1431
+ class AnalyticsUtteranceMetricResult < Struct.new(
1432
+ :name,
1433
+ :statistic,
1434
+ :value)
1435
+ SENSITIVE = []
1436
+ include Aws::Structure
1437
+ end
1438
+
1439
+ # An object containing the results for the utterance metrics you
1440
+ # requested and the bin and/or group(s) they refer to, if applicable.
1441
+ #
1442
+ # @!attribute [rw] bin_keys
1443
+ # A list of objects containing the criteria you requested for binning
1444
+ # results and the values of the bins.
1445
+ # @return [Array<Types::AnalyticsBinKey>]
1446
+ #
1447
+ # @!attribute [rw] group_by_keys
1448
+ # A list of objects containing the criteria you requested for grouping
1449
+ # results and the values of the bins.
1450
+ # @return [Array<Types::AnalyticsUtteranceGroupByKey>]
1451
+ #
1452
+ # @!attribute [rw] metrics_results
1453
+ # A list of objects, each of which contains a metric you want to list,
1454
+ # the statistic for the metric you want to return, and the method by
1455
+ # which to organize the results.
1456
+ # @return [Array<Types::AnalyticsUtteranceMetricResult>]
1457
+ #
1458
+ # @!attribute [rw] attribute_results
1459
+ # A list of objects containing information about the last used intent
1460
+ # at the time of an utterance.
1461
+ # @return [Array<Types::AnalyticsUtteranceAttributeResult>]
1462
+ #
1463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceResult AWS API Documentation
1464
+ #
1465
+ class AnalyticsUtteranceResult < Struct.new(
1466
+ :bin_keys,
1467
+ :group_by_keys,
1468
+ :metrics_results,
1469
+ :attribute_results)
1470
+ SENSITIVE = []
1471
+ include Aws::Structure
1472
+ end
1473
+
213
1474
  # The object containing information that associates the recommended
214
1475
  # intent/slot type with a conversation.
215
1476
  #
@@ -6503,6 +7764,20 @@ module Aws::LexModelsV2
6503
7764
  include Aws::Structure
6504
7765
  end
6505
7766
 
7767
+ # An object containing the name of an intent that was invoked.
7768
+ #
7769
+ # @!attribute [rw] intent_name
7770
+ # The name of an intent that was invoked.
7771
+ # @return [String]
7772
+ #
7773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/InvokedIntentSample AWS API Documentation
7774
+ #
7775
+ class InvokedIntentSample < Struct.new(
7776
+ :intent_name)
7777
+ SENSITIVE = []
7778
+ include Aws::Structure
7779
+ end
7780
+
6506
7781
  # Provides configuration information for the `AMAZON.KendraSearchIntent`
6507
7782
  # intent. When you use this intent, Amazon Lex searches the specified
6508
7783
  # Amazon Kendra index and returns documents from the index that match
@@ -7408,70 +8683,337 @@ module Aws::LexModelsV2
7408
8683
  # @return [Integer]
7409
8684
  #
7410
8685
  # @!attribute [rw] next_token
7411
- # If the response from the `ListImports` operation contains more
7412
- # results than specified in the `maxResults` parameter, a token is
8686
+ # If the response from the `ListImports` operation contains more
8687
+ # results than specified in the `maxResults` parameter, a token is
8688
+ # returned in the response.
8689
+ #
8690
+ # Use the returned token in the `nextToken` parameter of a
8691
+ # `ListImports` request to return the next page of results. For a
8692
+ # complete set of results, call the `ListImports` operation until the
8693
+ # `nextToken` returned in the response is null.
8694
+ # @return [String]
8695
+ #
8696
+ # @!attribute [rw] locale_id
8697
+ # Specifies the locale that should be present in the list. If you
8698
+ # don't specify a resource type in the `filters` parameter, the list
8699
+ # contains both bot locales and custom vocabularies.
8700
+ # @return [String]
8701
+ #
8702
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListImportsRequest AWS API Documentation
8703
+ #
8704
+ class ListImportsRequest < Struct.new(
8705
+ :bot_id,
8706
+ :bot_version,
8707
+ :sort_by,
8708
+ :filters,
8709
+ :max_results,
8710
+ :next_token,
8711
+ :locale_id)
8712
+ SENSITIVE = []
8713
+ include Aws::Structure
8714
+ end
8715
+
8716
+ # @!attribute [rw] bot_id
8717
+ # The unique identifier assigned by Amazon Lex to the bot.
8718
+ # @return [String]
8719
+ #
8720
+ # @!attribute [rw] bot_version
8721
+ # The version of the bot that was imported. It will always be `DRAFT`.
8722
+ # @return [String]
8723
+ #
8724
+ # @!attribute [rw] import_summaries
8725
+ # Summary information for the imports that meet the filter criteria
8726
+ # specified in the request. The length of the list is specified in the
8727
+ # `maxResults` parameter. If there are more imports available, the
8728
+ # `nextToken` field contains a token to get the next page of results.
8729
+ # @return [Array<Types::ImportSummary>]
8730
+ #
8731
+ # @!attribute [rw] next_token
8732
+ # A token that indicates whether there are more results to return in a
8733
+ # response to the `ListImports` operation. If the `nextToken` field is
8734
+ # present, you send the contents as the `nextToken` parameter of a
8735
+ # `ListImports` operation request to get the next page of results.
8736
+ # @return [String]
8737
+ #
8738
+ # @!attribute [rw] locale_id
8739
+ # The locale specified in the request.
8740
+ # @return [String]
8741
+ #
8742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListImportsResponse AWS API Documentation
8743
+ #
8744
+ class ListImportsResponse < Struct.new(
8745
+ :bot_id,
8746
+ :bot_version,
8747
+ :import_summaries,
8748
+ :next_token,
8749
+ :locale_id)
8750
+ SENSITIVE = []
8751
+ include Aws::Structure
8752
+ end
8753
+
8754
+ # @!attribute [rw] bot_id
8755
+ # The identifier for the bot for which you want to retrieve intent
8756
+ # metrics.
8757
+ # @return [String]
8758
+ #
8759
+ # @!attribute [rw] start_date_time
8760
+ # The timestamp that marks the beginning of the range of time for
8761
+ # which you want to see intent metrics.
8762
+ # @return [Time]
8763
+ #
8764
+ # @!attribute [rw] end_date_time
8765
+ # The date and time that marks the end of the range of time for which
8766
+ # you want to see intent metrics.
8767
+ # @return [Time]
8768
+ #
8769
+ # @!attribute [rw] metrics
8770
+ # A list of objects, each of which contains a metric you want to list,
8771
+ # the statistic for the metric you want to return, and the order by
8772
+ # which to organize the results.
8773
+ # @return [Array<Types::AnalyticsIntentMetric>]
8774
+ #
8775
+ # @!attribute [rw] bin_by
8776
+ # A list of objects, each of which contains specifications for
8777
+ # organizing the results by time.
8778
+ # @return [Array<Types::AnalyticsBinBySpecification>]
8779
+ #
8780
+ # @!attribute [rw] group_by
8781
+ # A list of objects, each of which specifies how to group the results.
8782
+ # You can group by the following criteria:
8783
+ #
8784
+ # * `IntentName` – The name of the intent.
8785
+ #
8786
+ # * `IntentEndState` – The final state of the intent. The possible end
8787
+ # states are detailed in [Key definitions][1] in the user guide.
8788
+ #
8789
+ #
8790
+ #
8791
+ # [1]: https://docs.aws.amazon.com/analytics-key-definitions-intents
8792
+ # @return [Array<Types::AnalyticsIntentGroupBySpecification>]
8793
+ #
8794
+ # @!attribute [rw] filters
8795
+ # A list of objects, each of which describes a condition by which you
8796
+ # want to filter the results.
8797
+ # @return [Array<Types::AnalyticsIntentFilter>]
8798
+ #
8799
+ # @!attribute [rw] max_results
8800
+ # The maximum number of results to return in each page of results. If
8801
+ # there are fewer results than the maximum page size, only the actual
8802
+ # number of results are returned.
8803
+ # @return [Integer]
8804
+ #
8805
+ # @!attribute [rw] next_token
8806
+ # If the response from the ListIntentMetrics operation contains more
8807
+ # results than specified in the maxResults parameter, a token is
8808
+ # returned in the response.
8809
+ #
8810
+ # Use the returned token in the nextToken parameter of a
8811
+ # ListIntentMetrics request to return the next page of results. For a
8812
+ # complete set of results, call the ListIntentMetrics operation until
8813
+ # the nextToken returned in the response is null.
8814
+ # @return [String]
8815
+ #
8816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentMetricsRequest AWS API Documentation
8817
+ #
8818
+ class ListIntentMetricsRequest < Struct.new(
8819
+ :bot_id,
8820
+ :start_date_time,
8821
+ :end_date_time,
8822
+ :metrics,
8823
+ :bin_by,
8824
+ :group_by,
8825
+ :filters,
8826
+ :max_results,
8827
+ :next_token)
8828
+ SENSITIVE = []
8829
+ include Aws::Structure
8830
+ end
8831
+
8832
+ # @!attribute [rw] bot_id
8833
+ # The identifier for the bot for which you retrieved intent metrics.
8834
+ # @return [String]
8835
+ #
8836
+ # @!attribute [rw] results
8837
+ # The results for the intent metrics.
8838
+ # @return [Array<Types::AnalyticsIntentResult>]
8839
+ #
8840
+ # @!attribute [rw] next_token
8841
+ # If the response from the ListIntentMetrics operation contains more
8842
+ # results than specified in the maxResults parameter, a token is
8843
+ # returned in the response.
8844
+ #
8845
+ # Use the returned token in the nextToken parameter of a
8846
+ # ListIntentMetrics request to return the next page of results. For a
8847
+ # complete set of results, call the ListIntentMetrics operation until
8848
+ # the nextToken returned in the response is null.
8849
+ # @return [String]
8850
+ #
8851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentMetricsResponse AWS API Documentation
8852
+ #
8853
+ class ListIntentMetricsResponse < Struct.new(
8854
+ :bot_id,
8855
+ :results,
8856
+ :next_token)
8857
+ SENSITIVE = []
8858
+ include Aws::Structure
8859
+ end
8860
+
8861
+ # @!attribute [rw] bot_id
8862
+ # The identifier for the bot for which you want to retrieve intent
8863
+ # path metrics.
8864
+ # @return [String]
8865
+ #
8866
+ # @!attribute [rw] start_date_time
8867
+ # The date and time that marks the beginning of the range of time for
8868
+ # which you want to see intent path metrics.
8869
+ # @return [Time]
8870
+ #
8871
+ # @!attribute [rw] end_date_time
8872
+ # The date and time that marks the end of the range of time for which
8873
+ # you want to see intent path metrics.
8874
+ # @return [Time]
8875
+ #
8876
+ # @!attribute [rw] intent_path
8877
+ # The intent path for which you want to retrieve metrics. Use a
8878
+ # forward slash to separate intents in the path. For example:
8879
+ #
8880
+ # * /BookCar
8881
+ #
8882
+ # * /BookCar/BookHotel
8883
+ #
8884
+ # * /BookHotel/BookCar
8885
+ # @return [String]
8886
+ #
8887
+ # @!attribute [rw] filters
8888
+ # A list of objects, each describes a condition by which you want to
8889
+ # filter the results.
8890
+ # @return [Array<Types::AnalyticsPathFilter>]
8891
+ #
8892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentPathsRequest AWS API Documentation
8893
+ #
8894
+ class ListIntentPathsRequest < Struct.new(
8895
+ :bot_id,
8896
+ :start_date_time,
8897
+ :end_date_time,
8898
+ :intent_path,
8899
+ :filters)
8900
+ SENSITIVE = []
8901
+ include Aws::Structure
8902
+ end
8903
+
8904
+ # @!attribute [rw] node_summaries
8905
+ # A list of objects, each of which contains information about a node
8906
+ # in the intent path for which you requested metrics.
8907
+ # @return [Array<Types::AnalyticsIntentNodeSummary>]
8908
+ #
8909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentPathsResponse AWS API Documentation
8910
+ #
8911
+ class ListIntentPathsResponse < Struct.new(
8912
+ :node_summaries)
8913
+ SENSITIVE = []
8914
+ include Aws::Structure
8915
+ end
8916
+
8917
+ # @!attribute [rw] bot_id
8918
+ # The identifier for the bot for which you want to retrieve intent
8919
+ # stage metrics.
8920
+ # @return [String]
8921
+ #
8922
+ # @!attribute [rw] start_date_time
8923
+ # The date and time that marks the beginning of the range of time for
8924
+ # which you want to see intent stage metrics.
8925
+ # @return [Time]
8926
+ #
8927
+ # @!attribute [rw] end_date_time
8928
+ # The date and time that marks the end of the range of time for which
8929
+ # you want to see intent stage metrics.
8930
+ # @return [Time]
8931
+ #
8932
+ # @!attribute [rw] metrics
8933
+ # A list of objects, each of which contains a metric you want to list,
8934
+ # the statistic for the metric you want to return, and the method by
8935
+ # which to organize the results.
8936
+ # @return [Array<Types::AnalyticsIntentStageMetric>]
8937
+ #
8938
+ # @!attribute [rw] bin_by
8939
+ # A list of objects, each of which contains specifications for
8940
+ # organizing the results by time.
8941
+ # @return [Array<Types::AnalyticsBinBySpecification>]
8942
+ #
8943
+ # @!attribute [rw] group_by
8944
+ # A list of objects, each of which specifies how to group the results.
8945
+ # You can group by the following criteria:
8946
+ #
8947
+ # * `IntentStageName` – The name of the intent stage.
8948
+ #
8949
+ # * `SwitchedToIntent` – The intent to which the conversation was
8950
+ # switched (if any).
8951
+ # @return [Array<Types::AnalyticsIntentStageGroupBySpecification>]
8952
+ #
8953
+ # @!attribute [rw] filters
8954
+ # A list of objects, each of which describes a condition by which you
8955
+ # want to filter the results.
8956
+ # @return [Array<Types::AnalyticsIntentStageFilter>]
8957
+ #
8958
+ # @!attribute [rw] max_results
8959
+ # The maximum number of results to return in each page of results. If
8960
+ # there are fewer results than the maximum page size, only the actual
8961
+ # number of results are returned.
8962
+ # @return [Integer]
8963
+ #
8964
+ # @!attribute [rw] next_token
8965
+ # If the response from the ListIntentStageMetrics operation contains
8966
+ # more results than specified in the maxResults parameter, a token is
7413
8967
  # returned in the response.
7414
8968
  #
7415
- # Use the returned token in the `nextToken` parameter of a
7416
- # `ListImports` request to return the next page of results. For a
7417
- # complete set of results, call the `ListImports` operation until the
7418
- # `nextToken` returned in the response is null.
7419
- # @return [String]
7420
- #
7421
- # @!attribute [rw] locale_id
7422
- # Specifies the locale that should be present in the list. If you
7423
- # don't specify a resource type in the `filters` parameter, the list
7424
- # contains both bot locales and custom vocabularies.
8969
+ # Use the returned token in the nextToken parameter of a
8970
+ # ListIntentStageMetrics request to return the next page of results.
8971
+ # For a complete set of results, call the ListIntentStageMetrics
8972
+ # operation until the nextToken returned in the response is null.
7425
8973
  # @return [String]
7426
8974
  #
7427
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListImportsRequest AWS API Documentation
8975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentStageMetricsRequest AWS API Documentation
7428
8976
  #
7429
- class ListImportsRequest < Struct.new(
8977
+ class ListIntentStageMetricsRequest < Struct.new(
7430
8978
  :bot_id,
7431
- :bot_version,
7432
- :sort_by,
8979
+ :start_date_time,
8980
+ :end_date_time,
8981
+ :metrics,
8982
+ :bin_by,
8983
+ :group_by,
7433
8984
  :filters,
7434
8985
  :max_results,
7435
- :next_token,
7436
- :locale_id)
8986
+ :next_token)
7437
8987
  SENSITIVE = []
7438
8988
  include Aws::Structure
7439
8989
  end
7440
8990
 
7441
8991
  # @!attribute [rw] bot_id
7442
- # The unique identifier assigned by Amazon Lex to the bot.
8992
+ # The identifier for the bot for which you retrieved intent stage
8993
+ # metrics.
7443
8994
  # @return [String]
7444
8995
  #
7445
- # @!attribute [rw] bot_version
7446
- # The version of the bot that was imported. It will always be `DRAFT`.
7447
- # @return [String]
7448
- #
7449
- # @!attribute [rw] import_summaries
7450
- # Summary information for the imports that meet the filter criteria
7451
- # specified in the request. The length of the list is specified in the
7452
- # `maxResults` parameter. If there are more imports available, the
7453
- # `nextToken` field contains a token to get the next page of results.
7454
- # @return [Array<Types::ImportSummary>]
8996
+ # @!attribute [rw] results
8997
+ # The results for the intent stage metrics.
8998
+ # @return [Array<Types::AnalyticsIntentStageResult>]
7455
8999
  #
7456
9000
  # @!attribute [rw] next_token
7457
- # A token that indicates whether there are more results to return in a
7458
- # response to the `ListImports` operation. If the `nextToken` field is
7459
- # present, you send the contents as the `nextToken` parameter of a
7460
- # `ListImports` operation request to get the next page of results.
7461
- # @return [String]
9001
+ # If the response from the ListIntentStageMetrics operation contains
9002
+ # more results than specified in the maxResults parameter, a token is
9003
+ # returned in the response.
7462
9004
  #
7463
- # @!attribute [rw] locale_id
7464
- # The locale specified in the request.
9005
+ # Use the returned token in the nextToken parameter of a
9006
+ # ListIntentStageMetrics request to return the next page of results.
9007
+ # For a complete set of results, call the ListIntentStageMetrics
9008
+ # operation until the nextToken returned in the response is null.
7465
9009
  # @return [String]
7466
9010
  #
7467
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListImportsResponse AWS API Documentation
9011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentStageMetricsResponse AWS API Documentation
7468
9012
  #
7469
- class ListImportsResponse < Struct.new(
9013
+ class ListIntentStageMetricsResponse < Struct.new(
7470
9014
  :bot_id,
7471
- :bot_version,
7472
- :import_summaries,
7473
- :next_token,
7474
- :locale_id)
9015
+ :results,
9016
+ :next_token)
7475
9017
  SENSITIVE = []
7476
9018
  include Aws::Structure
7477
9019
  end
@@ -7674,6 +9216,200 @@ module Aws::LexModelsV2
7674
9216
  include Aws::Structure
7675
9217
  end
7676
9218
 
9219
+ # @!attribute [rw] bot_id
9220
+ # The identifier for the bot for which you want to retrieve session
9221
+ # analytics.
9222
+ # @return [String]
9223
+ #
9224
+ # @!attribute [rw] start_date_time
9225
+ # The date and time that marks the beginning of the range of time for
9226
+ # which you want to see session analytics.
9227
+ # @return [Time]
9228
+ #
9229
+ # @!attribute [rw] end_date_time
9230
+ # The date and time that marks the end of the range of time for which
9231
+ # you want to see session analytics.
9232
+ # @return [Time]
9233
+ #
9234
+ # @!attribute [rw] sort_by
9235
+ # An object specifying the measure and method by which to sort the
9236
+ # session analytics data.
9237
+ # @return [Types::SessionDataSortBy]
9238
+ #
9239
+ # @!attribute [rw] filters
9240
+ # A list of objects, each of which describes a condition by which you
9241
+ # want to filter the results.
9242
+ # @return [Array<Types::AnalyticsSessionFilter>]
9243
+ #
9244
+ # @!attribute [rw] max_results
9245
+ # The maximum number of results to return in each page of results. If
9246
+ # there are fewer results than the maximum page size, only the actual
9247
+ # number of results are returned.
9248
+ # @return [Integer]
9249
+ #
9250
+ # @!attribute [rw] next_token
9251
+ # If the response from the ListSessionAnalyticsData operation contains
9252
+ # more results than specified in the maxResults parameter, a token is
9253
+ # returned in the response.
9254
+ #
9255
+ # Use the returned token in the nextToken parameter of a
9256
+ # ListSessionAnalyticsData request to return the next page of results.
9257
+ # For a complete set of results, call the ListSessionAnalyticsData
9258
+ # operation until the nextToken returned in the response is null.
9259
+ # @return [String]
9260
+ #
9261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionAnalyticsDataRequest AWS API Documentation
9262
+ #
9263
+ class ListSessionAnalyticsDataRequest < Struct.new(
9264
+ :bot_id,
9265
+ :start_date_time,
9266
+ :end_date_time,
9267
+ :sort_by,
9268
+ :filters,
9269
+ :max_results,
9270
+ :next_token)
9271
+ SENSITIVE = []
9272
+ include Aws::Structure
9273
+ end
9274
+
9275
+ # @!attribute [rw] bot_id
9276
+ # The unique identifier of the bot that the sessions belong to.
9277
+ # @return [String]
9278
+ #
9279
+ # @!attribute [rw] next_token
9280
+ # If the response from the ListSessionAnalyticsData operation contains
9281
+ # more results than specified in the maxResults parameter, a token is
9282
+ # returned in the response.
9283
+ #
9284
+ # Use the returned token in the nextToken parameter of a
9285
+ # ListSessionAnalyticsData request to return the next page of results.
9286
+ # For a complete set of results, call the ListSessionAnalyticsData
9287
+ # operation until the nextToken returned in the response is null.
9288
+ # @return [String]
9289
+ #
9290
+ # @!attribute [rw] sessions
9291
+ # A list of objects, each of which contains information about a
9292
+ # session with the bot.
9293
+ # @return [Array<Types::SessionSpecification>]
9294
+ #
9295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionAnalyticsDataResponse AWS API Documentation
9296
+ #
9297
+ class ListSessionAnalyticsDataResponse < Struct.new(
9298
+ :bot_id,
9299
+ :next_token,
9300
+ :sessions)
9301
+ SENSITIVE = []
9302
+ include Aws::Structure
9303
+ end
9304
+
9305
+ # @!attribute [rw] bot_id
9306
+ # The identifier for the bot for which you want to retrieve session
9307
+ # metrics.
9308
+ # @return [String]
9309
+ #
9310
+ # @!attribute [rw] start_date_time
9311
+ # The date and time that marks the beginning of the range of time for
9312
+ # which you want to see session metrics.
9313
+ # @return [Time]
9314
+ #
9315
+ # @!attribute [rw] end_date_time
9316
+ # The date and time that marks the end of the range of time for which
9317
+ # you want to see session metrics.
9318
+ # @return [Time]
9319
+ #
9320
+ # @!attribute [rw] metrics
9321
+ # A list of objects, each of which contains a metric you want to list,
9322
+ # the statistic for the metric you want to return, and the method by
9323
+ # which to organize the results.
9324
+ # @return [Array<Types::AnalyticsSessionMetric>]
9325
+ #
9326
+ # @!attribute [rw] bin_by
9327
+ # A list of objects, each of which contains specifications for
9328
+ # organizing the results by time.
9329
+ # @return [Array<Types::AnalyticsBinBySpecification>]
9330
+ #
9331
+ # @!attribute [rw] group_by
9332
+ # A list of objects, each of which specifies how to group the results.
9333
+ # You can group by the following criteria:
9334
+ #
9335
+ # * `ConversationEndState` – The final state of the conversation. The
9336
+ # possible end states are detailed in [Key definitions][1] in the
9337
+ # user guide.
9338
+ #
9339
+ # * `LocaleId` – The unique identifier of the bot locale.
9340
+ #
9341
+ #
9342
+ #
9343
+ # [1]: https://docs.aws.amazon.com/analytics-key-definitions-conversations
9344
+ # @return [Array<Types::AnalyticsSessionGroupBySpecification>]
9345
+ #
9346
+ # @!attribute [rw] filters
9347
+ # A list of objects, each of which describes a condition by which you
9348
+ # want to filter the results.
9349
+ # @return [Array<Types::AnalyticsSessionFilter>]
9350
+ #
9351
+ # @!attribute [rw] max_results
9352
+ # The maximum number of results to return in each page of results. If
9353
+ # there are fewer results than the maximum page size, only the actual
9354
+ # number of results are returned.
9355
+ # @return [Integer]
9356
+ #
9357
+ # @!attribute [rw] next_token
9358
+ # If the response from the ListSessionMetrics operation contains more
9359
+ # results than specified in the maxResults parameter, a token is
9360
+ # returned in the response.
9361
+ #
9362
+ # Use the returned token in the nextToken parameter of a
9363
+ # ListSessionMetrics request to return the next page of results. For a
9364
+ # complete set of results, call the ListSessionMetrics operation until
9365
+ # the nextToken returned in the response is null.
9366
+ # @return [String]
9367
+ #
9368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionMetricsRequest AWS API Documentation
9369
+ #
9370
+ class ListSessionMetricsRequest < Struct.new(
9371
+ :bot_id,
9372
+ :start_date_time,
9373
+ :end_date_time,
9374
+ :metrics,
9375
+ :bin_by,
9376
+ :group_by,
9377
+ :filters,
9378
+ :max_results,
9379
+ :next_token)
9380
+ SENSITIVE = []
9381
+ include Aws::Structure
9382
+ end
9383
+
9384
+ # @!attribute [rw] bot_id
9385
+ # The identifier for the bot for which you retrieved session metrics.
9386
+ # @return [String]
9387
+ #
9388
+ # @!attribute [rw] results
9389
+ # The results for the session metrics.
9390
+ # @return [Array<Types::AnalyticsSessionResult>]
9391
+ #
9392
+ # @!attribute [rw] next_token
9393
+ # If the response from the ListSessionMetrics operation contains more
9394
+ # results than specified in the maxResults parameter, a token is
9395
+ # returned in the response.
9396
+ #
9397
+ # Use the returned token in the nextToken parameter of a
9398
+ # ListSessionMetrics request to return the next page of results. For a
9399
+ # complete set of results, call the ListSessionMetrics operation until
9400
+ # the nextToken returned in the response is null.
9401
+ # @return [String]
9402
+ #
9403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionMetricsResponse AWS API Documentation
9404
+ #
9405
+ class ListSessionMetricsResponse < Struct.new(
9406
+ :bot_id,
9407
+ :results,
9408
+ :next_token)
9409
+ SENSITIVE = []
9410
+ include Aws::Structure
9411
+ end
9412
+
7677
9413
  # @!attribute [rw] bot_id
7678
9414
  # The unique identifier of the bot that contains the slot types.
7679
9415
  # @return [String]
@@ -8035,64 +9771,271 @@ module Aws::LexModelsV2
8035
9771
  # @return [Array<Types::TestSetTurnRecord>]
8036
9772
  #
8037
9773
  # @!attribute [rw] next_token
8038
- # A token that indicates whether there are more records to return in a
8039
- # response to the ListTestSetRecords operation. If the nextToken field
8040
- # is present, you send the contents as the nextToken parameter of a
8041
- # ListTestSetRecords operation request to get the next page of
8042
- # records.
9774
+ # A token that indicates whether there are more records to return in a
9775
+ # response to the ListTestSetRecords operation. If the nextToken field
9776
+ # is present, you send the contents as the nextToken parameter of a
9777
+ # ListTestSetRecords operation request to get the next page of
9778
+ # records.
9779
+ # @return [String]
9780
+ #
9781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetRecordsResponse AWS API Documentation
9782
+ #
9783
+ class ListTestSetRecordsResponse < Struct.new(
9784
+ :test_set_records,
9785
+ :next_token)
9786
+ SENSITIVE = []
9787
+ include Aws::Structure
9788
+ end
9789
+
9790
+ # @!attribute [rw] sort_by
9791
+ # The sort order for the list of test sets.
9792
+ # @return [Types::TestSetSortBy]
9793
+ #
9794
+ # @!attribute [rw] max_results
9795
+ # The maximum number of test sets to return in each page. If there are
9796
+ # fewer results than the max page size, only the actual number of
9797
+ # results are returned.
9798
+ # @return [Integer]
9799
+ #
9800
+ # @!attribute [rw] next_token
9801
+ # If the response from the ListTestSets operation contains more
9802
+ # results than specified in the maxResults parameter, a token is
9803
+ # returned in the response. Use that token in the nextToken parameter
9804
+ # to return the next page of results.
9805
+ # @return [String]
9806
+ #
9807
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetsRequest AWS API Documentation
9808
+ #
9809
+ class ListTestSetsRequest < Struct.new(
9810
+ :sort_by,
9811
+ :max_results,
9812
+ :next_token)
9813
+ SENSITIVE = []
9814
+ include Aws::Structure
9815
+ end
9816
+
9817
+ # @!attribute [rw] test_sets
9818
+ # The selected test sets in a list of test sets.
9819
+ # @return [Array<Types::TestSetSummary>]
9820
+ #
9821
+ # @!attribute [rw] next_token
9822
+ # A token that indicates whether there are more results to return in a
9823
+ # response to the ListTestSets operation. If the nextToken field is
9824
+ # present, you send the contents as the nextToken parameter of a
9825
+ # ListTestSets operation request to get the next page of results.
9826
+ # @return [String]
9827
+ #
9828
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetsResponse AWS API Documentation
9829
+ #
9830
+ class ListTestSetsResponse < Struct.new(
9831
+ :test_sets,
9832
+ :next_token)
9833
+ SENSITIVE = []
9834
+ include Aws::Structure
9835
+ end
9836
+
9837
+ # @!attribute [rw] bot_id
9838
+ # The identifier for the bot for which you want to retrieve utterance
9839
+ # analytics.
9840
+ # @return [String]
9841
+ #
9842
+ # @!attribute [rw] start_date_time
9843
+ # The date and time that marks the beginning of the range of time for
9844
+ # which you want to see utterance analytics.
9845
+ # @return [Time]
9846
+ #
9847
+ # @!attribute [rw] end_date_time
9848
+ # The date and time that marks the end of the range of time for which
9849
+ # you want to see utterance analytics.
9850
+ # @return [Time]
9851
+ #
9852
+ # @!attribute [rw] sort_by
9853
+ # An object specifying the measure and method by which to sort the
9854
+ # utterance analytics data.
9855
+ # @return [Types::UtteranceDataSortBy]
9856
+ #
9857
+ # @!attribute [rw] filters
9858
+ # A list of objects, each of which describes a condition by which you
9859
+ # want to filter the results.
9860
+ # @return [Array<Types::AnalyticsUtteranceFilter>]
9861
+ #
9862
+ # @!attribute [rw] max_results
9863
+ # The maximum number of results to return in each page of results. If
9864
+ # there are fewer results than the maximum page size, only the actual
9865
+ # number of results are returned.
9866
+ # @return [Integer]
9867
+ #
9868
+ # @!attribute [rw] next_token
9869
+ # If the response from the ListUtteranceAnalyticsData operation
9870
+ # contains more results than specified in the maxResults parameter, a
9871
+ # token is returned in the response.
9872
+ #
9873
+ # Use the returned token in the nextToken parameter of a
9874
+ # ListUtteranceAnalyticsData request to return the next page of
9875
+ # results. For a complete set of results, call the
9876
+ # ListUtteranceAnalyticsData operation until the nextToken returned in
9877
+ # the response is null.
9878
+ # @return [String]
9879
+ #
9880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceAnalyticsDataRequest AWS API Documentation
9881
+ #
9882
+ class ListUtteranceAnalyticsDataRequest < Struct.new(
9883
+ :bot_id,
9884
+ :start_date_time,
9885
+ :end_date_time,
9886
+ :sort_by,
9887
+ :filters,
9888
+ :max_results,
9889
+ :next_token)
9890
+ SENSITIVE = []
9891
+ include Aws::Structure
9892
+ end
9893
+
9894
+ # @!attribute [rw] bot_id
9895
+ # The unique identifier of the bot that the utterances belong to.
9896
+ # @return [String]
9897
+ #
9898
+ # @!attribute [rw] next_token
9899
+ # If the response from the ListUtteranceAnalyticsData operation
9900
+ # contains more results than specified in the maxResults parameter, a
9901
+ # token is returned in the response.
9902
+ #
9903
+ # Use the returned token in the nextToken parameter of a
9904
+ # ListUtteranceAnalyticsData request to return the next page of
9905
+ # results. For a complete set of results, call the
9906
+ # ListUtteranceAnalyticsData operation until the nextToken returned in
9907
+ # the response is null.
8043
9908
  # @return [String]
8044
9909
  #
8045
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetRecordsResponse AWS API Documentation
9910
+ # @!attribute [rw] utterances
9911
+ # A list of objects, each of which contains information about an
9912
+ # utterance in a user session with your bot.
9913
+ # @return [Array<Types::UtteranceSpecification>]
8046
9914
  #
8047
- class ListTestSetRecordsResponse < Struct.new(
8048
- :test_set_records,
8049
- :next_token)
9915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceAnalyticsDataResponse AWS API Documentation
9916
+ #
9917
+ class ListUtteranceAnalyticsDataResponse < Struct.new(
9918
+ :bot_id,
9919
+ :next_token,
9920
+ :utterances)
8050
9921
  SENSITIVE = []
8051
9922
  include Aws::Structure
8052
9923
  end
8053
9924
 
8054
- # @!attribute [rw] sort_by
8055
- # The sort order for the list of test sets.
8056
- # @return [Types::TestSetSortBy]
9925
+ # @!attribute [rw] bot_id
9926
+ # The identifier for the bot for which you want to retrieve utterance
9927
+ # metrics.
9928
+ # @return [String]
9929
+ #
9930
+ # @!attribute [rw] start_date_time
9931
+ # The date and time that marks the beginning of the range of time for
9932
+ # which you want to see utterance metrics.
9933
+ # @return [Time]
9934
+ #
9935
+ # @!attribute [rw] end_date_time
9936
+ # The date and time that marks the end of the range of time for which
9937
+ # you want to see utterance metrics.
9938
+ # @return [Time]
9939
+ #
9940
+ # @!attribute [rw] metrics
9941
+ # A list of objects, each of which contains a metric you want to list,
9942
+ # the statistic for the metric you want to return, and the method by
9943
+ # which to organize the results.
9944
+ # @return [Array<Types::AnalyticsUtteranceMetric>]
9945
+ #
9946
+ # @!attribute [rw] bin_by
9947
+ # A list of objects, each of which contains specifications for
9948
+ # organizing the results by time.
9949
+ # @return [Array<Types::AnalyticsBinBySpecification>]
9950
+ #
9951
+ # @!attribute [rw] group_by
9952
+ # A list of objects, each of which specifies how to group the results.
9953
+ # You can group by the following criteria:
9954
+ #
9955
+ # * `UtteranceText` – The transcription of the utterance.
9956
+ #
9957
+ # * `UtteranceState` – The state of the utterance. The possible states
9958
+ # are detailed in [Key definitions][1] in the user guide.
9959
+ #
9960
+ #
9961
+ #
9962
+ # [1]: https://docs.aws.amazon.com/analytics-key-definitions-utterances
9963
+ # @return [Array<Types::AnalyticsUtteranceGroupBySpecification>]
9964
+ #
9965
+ # @!attribute [rw] attributes
9966
+ # A list containing attributes related to the utterance that you want
9967
+ # the response to return. The following attributes are possible:
9968
+ #
9969
+ # * `LastUsedIntent` – The last used intent at the time of the
9970
+ # utterance.
9971
+ #
9972
+ # ^
9973
+ # @return [Array<Types::AnalyticsUtteranceAttribute>]
9974
+ #
9975
+ # @!attribute [rw] filters
9976
+ # A list of objects, each of which describes a condition by which you
9977
+ # want to filter the results.
9978
+ # @return [Array<Types::AnalyticsUtteranceFilter>]
8057
9979
  #
8058
9980
  # @!attribute [rw] max_results
8059
- # The maximum number of test sets to return in each page. If there are
8060
- # fewer results than the max page size, only the actual number of
8061
- # results are returned.
9981
+ # The maximum number of results to return in each page of results. If
9982
+ # there are fewer results than the maximum page size, only the actual
9983
+ # number of results are returned.
8062
9984
  # @return [Integer]
8063
9985
  #
8064
9986
  # @!attribute [rw] next_token
8065
- # If the response from the ListTestSets operation contains more
8066
- # results than specified in the maxResults parameter, a token is
8067
- # returned in the response. Use that token in the nextToken parameter
8068
- # to return the next page of results.
9987
+ # If the response from the ListUtteranceMetrics operation contains
9988
+ # more results than specified in the maxResults parameter, a token is
9989
+ # returned in the response.
9990
+ #
9991
+ # Use the returned token in the nextToken parameter of a
9992
+ # ListUtteranceMetrics request to return the next page of results. For
9993
+ # a complete set of results, call the ListUtteranceMetrics operation
9994
+ # until the nextToken returned in the response is null.
8069
9995
  # @return [String]
8070
9996
  #
8071
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetsRequest AWS API Documentation
9997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceMetricsRequest AWS API Documentation
8072
9998
  #
8073
- class ListTestSetsRequest < Struct.new(
8074
- :sort_by,
9999
+ class ListUtteranceMetricsRequest < Struct.new(
10000
+ :bot_id,
10001
+ :start_date_time,
10002
+ :end_date_time,
10003
+ :metrics,
10004
+ :bin_by,
10005
+ :group_by,
10006
+ :attributes,
10007
+ :filters,
8075
10008
  :max_results,
8076
10009
  :next_token)
8077
10010
  SENSITIVE = []
8078
10011
  include Aws::Structure
8079
10012
  end
8080
10013
 
8081
- # @!attribute [rw] test_sets
8082
- # The selected test sets in a list of test sets.
8083
- # @return [Array<Types::TestSetSummary>]
10014
+ # @!attribute [rw] bot_id
10015
+ # The identifier for the bot for which you retrieved utterance
10016
+ # metrics.
10017
+ # @return [String]
10018
+ #
10019
+ # @!attribute [rw] results
10020
+ # The results for the utterance metrics.
10021
+ # @return [Array<Types::AnalyticsUtteranceResult>]
8084
10022
  #
8085
10023
  # @!attribute [rw] next_token
8086
- # A token that indicates whether there are more results to return in a
8087
- # response to the ListTestSets operation. If the nextToken field is
8088
- # present, you send the contents as the nextToken parameter of a
8089
- # ListTestSets operation request to get the next page of results.
10024
+ # If the response from the ListUtteranceMetrics operation contains
10025
+ # more results than specified in the maxResults parameter, a token is
10026
+ # returned in the response.
10027
+ #
10028
+ # Use the returned token in the nextToken parameter of a
10029
+ # ListUtteranceMetrics request to return the next page of results. For
10030
+ # a complete set of results, call the ListUtteranceMetrics operation
10031
+ # until the nextToken returned in the response is null.
8090
10032
  # @return [String]
8091
10033
  #
8092
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetsResponse AWS API Documentation
10034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceMetricsResponse AWS API Documentation
8093
10035
  #
8094
- class ListTestSetsResponse < Struct.new(
8095
- :test_sets,
10036
+ class ListUtteranceMetricsResponse < Struct.new(
10037
+ :bot_id,
10038
+ :results,
8096
10039
  :next_token)
8097
10040
  SENSITIVE = []
8098
10041
  include Aws::Structure
@@ -9038,6 +10981,128 @@ module Aws::LexModelsV2
9038
10981
  include Aws::Structure
9039
10982
  end
9040
10983
 
10984
+ # An object specifying the measure and method by which to sort the
10985
+ # session analytics data.
10986
+ #
10987
+ # @!attribute [rw] name
10988
+ # The measure by which to sort the session analytics data.
10989
+ #
10990
+ # * `conversationStartTime` – The date and time when the conversation
10991
+ # began. A conversation is defined as a unique combination of a
10992
+ # `sessionId` and an `originatingRequestId`.
10993
+ #
10994
+ # * `numberOfTurns` – The number of turns that the session took.
10995
+ #
10996
+ # * `conversationDurationSeconds` – The duration of the conversation
10997
+ # in seconds.
10998
+ # @return [String]
10999
+ #
11000
+ # @!attribute [rw] order
11001
+ # Specifies whether to sort the results in ascending or descending
11002
+ # order.
11003
+ # @return [String]
11004
+ #
11005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SessionDataSortBy AWS API Documentation
11006
+ #
11007
+ class SessionDataSortBy < Struct.new(
11008
+ :name,
11009
+ :order)
11010
+ SENSITIVE = []
11011
+ include Aws::Structure
11012
+ end
11013
+
11014
+ # An object containing information about a specific session.
11015
+ #
11016
+ # @!attribute [rw] bot_alias_id
11017
+ # The identifier of the alias of the bot that the session was held
11018
+ # with.
11019
+ # @return [String]
11020
+ #
11021
+ # @!attribute [rw] bot_version
11022
+ # The version of the bot that the session was held with.
11023
+ # @return [String]
11024
+ #
11025
+ # @!attribute [rw] locale_id
11026
+ # The locale of the bot that the session was held with.
11027
+ # @return [String]
11028
+ #
11029
+ # @!attribute [rw] channel
11030
+ # The channel that is integrated with the bot that the session was
11031
+ # held with.
11032
+ # @return [String]
11033
+ #
11034
+ # @!attribute [rw] session_id
11035
+ # The identifier of the session.
11036
+ # @return [String]
11037
+ #
11038
+ # @!attribute [rw] conversation_start_time
11039
+ # The date and time when the conversation began. A conversation is
11040
+ # defined as a unique combination of a `sessionId` and an
11041
+ # `originatingRequestId`.
11042
+ # @return [Time]
11043
+ #
11044
+ # @!attribute [rw] conversation_end_time
11045
+ # The date and time when the conversation ended. A conversation is
11046
+ # defined as a unique combination of a `sessionId` and an
11047
+ # `originatingRequestId`.
11048
+ # @return [Time]
11049
+ #
11050
+ # @!attribute [rw] conversation_duration_seconds
11051
+ # The duration of the conversation in seconds. A conversation is
11052
+ # defined as a unique combination of a `sessionId` and an
11053
+ # `originatingRequestId`.
11054
+ # @return [Integer]
11055
+ #
11056
+ # @!attribute [rw] conversation_end_state
11057
+ # The final state of the conversation. A conversation is defined as a
11058
+ # unique combination of a `sessionId` and an `originatingRequestId`.
11059
+ # @return [String]
11060
+ #
11061
+ # @!attribute [rw] mode
11062
+ # The mode of the session. The possible values are as follows:
11063
+ #
11064
+ # * `Speech` – The session was spoken.
11065
+ #
11066
+ # * `Text` – The session was written.
11067
+ #
11068
+ # * `DTMF` – The session used a touch-tone keypad (Dual Tone
11069
+ # Multi-Frequency).
11070
+ #
11071
+ # * `MultiMode` – The session used multiple modes.
11072
+ # @return [String]
11073
+ #
11074
+ # @!attribute [rw] number_of_turns
11075
+ # The number of turns that the session took.
11076
+ # @return [Integer]
11077
+ #
11078
+ # @!attribute [rw] invoked_intent_samples
11079
+ # A list of objects containing the name of an intent that was invoked.
11080
+ # @return [Array<Types::InvokedIntentSample>]
11081
+ #
11082
+ # @!attribute [rw] originating_request_id
11083
+ # The identifier of the first request in a session.
11084
+ # @return [String]
11085
+ #
11086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SessionSpecification AWS API Documentation
11087
+ #
11088
+ class SessionSpecification < Struct.new(
11089
+ :bot_alias_id,
11090
+ :bot_version,
11091
+ :locale_id,
11092
+ :channel,
11093
+ :session_id,
11094
+ :conversation_start_time,
11095
+ :conversation_end_time,
11096
+ :conversation_duration_seconds,
11097
+ :conversation_end_state,
11098
+ :mode,
11099
+ :number_of_turns,
11100
+ :invoked_intent_samples,
11101
+ :originating_request_id)
11102
+ SENSITIVE = []
11103
+ include Aws::Structure
11104
+ end
11105
+
9041
11106
  # Settings used when Amazon Lex successfully captures a slot value from
9042
11107
  # a user.
9043
11108
  #
@@ -12257,6 +14322,74 @@ module Aws::LexModelsV2
12257
14322
  include Aws::Structure
12258
14323
  end
12259
14324
 
14325
+ # An object that contains a response to the utterance from the bot.
14326
+ #
14327
+ # @!attribute [rw] content
14328
+ # The text of the response to the utterance from the bot.
14329
+ # @return [String]
14330
+ #
14331
+ # @!attribute [rw] content_type
14332
+ # The type of the response. The following values are possible:
14333
+ #
14334
+ # * `PlainText` – A plain text string.
14335
+ #
14336
+ # * `CustomPayload` – A response string that you can customize to
14337
+ # include data or metadata for your application.
14338
+ #
14339
+ # * `SSML` – A string that includes Speech Synthesis Markup Language
14340
+ # to customize the audio response.
14341
+ #
14342
+ # * `ImageResponseCard` – An image with buttons that the customer can
14343
+ # select. See [ImageResponseCard][1] for more information.
14344
+ #
14345
+ #
14346
+ #
14347
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html
14348
+ # @return [String]
14349
+ #
14350
+ # @!attribute [rw] image_response_card
14351
+ # A card that is shown to the user by a messaging platform. You define
14352
+ # the contents of the card, the card is displayed by the platform.
14353
+ #
14354
+ # When you use a response card, the response from the user is
14355
+ # constrained to the text associated with a button on the card.
14356
+ # @return [Types::ImageResponseCard]
14357
+ #
14358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceBotResponse AWS API Documentation
14359
+ #
14360
+ class UtteranceBotResponse < Struct.new(
14361
+ :content,
14362
+ :content_type,
14363
+ :image_response_card)
14364
+ SENSITIVE = []
14365
+ include Aws::Structure
14366
+ end
14367
+
14368
+ # An object specifying the measure and method by which to sort the
14369
+ # utterance data.
14370
+ #
14371
+ # @!attribute [rw] name
14372
+ # The measure by which to sort the utterance analytics data.
14373
+ #
14374
+ # * `Count` – The number of utterances.
14375
+ #
14376
+ # * `UtteranceTimestamp` – The date and time of the utterance.
14377
+ # @return [String]
14378
+ #
14379
+ # @!attribute [rw] order
14380
+ # Specifies whether to sort the results in ascending or descending
14381
+ # order.
14382
+ # @return [String]
14383
+ #
14384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceDataSortBy AWS API Documentation
14385
+ #
14386
+ class UtteranceDataSortBy < Struct.new(
14387
+ :name,
14388
+ :order)
14389
+ SENSITIVE = []
14390
+ include Aws::Structure
14391
+ end
14392
+
12260
14393
  # Contains information about input of an utterance.
12261
14394
  #
12262
14395
  # @!attribute [rw] text_input
@@ -12319,6 +14452,180 @@ module Aws::LexModelsV2
12319
14452
  include Aws::Structure
12320
14453
  end
12321
14454
 
14455
+ # An object containing information about a specific utterance.
14456
+ #
14457
+ # @!attribute [rw] bot_alias_id
14458
+ # The identifier of the alias of the bot that the utterance was made
14459
+ # to.
14460
+ # @return [String]
14461
+ #
14462
+ # @!attribute [rw] bot_version
14463
+ # The version of the bot that the utterance was made to.
14464
+ # @return [String]
14465
+ #
14466
+ # @!attribute [rw] locale_id
14467
+ # The locale of the bot that the utterance was made to.
14468
+ # @return [String]
14469
+ #
14470
+ # @!attribute [rw] session_id
14471
+ # The identifier of the session that the utterance was made in.
14472
+ # @return [String]
14473
+ #
14474
+ # @!attribute [rw] channel
14475
+ # The channel that is integrated with the bot that the utterance was
14476
+ # made to.
14477
+ # @return [String]
14478
+ #
14479
+ # @!attribute [rw] mode
14480
+ # The mode of the session. The possible values are as follows:
14481
+ #
14482
+ # * `Speech` – The session consisted of spoken dialogue.
14483
+ #
14484
+ # * `Text` – The session consisted of written dialogue.
14485
+ #
14486
+ # * `DTMF` – The session consisted of touch-tone keypad (Dual Tone
14487
+ # Multi-Frequency) key presses.
14488
+ #
14489
+ # * `MultiMode` – The session consisted of multiple modes.
14490
+ # @return [String]
14491
+ #
14492
+ # @!attribute [rw] conversation_start_time
14493
+ # The date and time when the conversation in which the utterance took
14494
+ # place began. A conversation is defined as a unique combination of a
14495
+ # `sessionId` and an `originatingRequestId`.
14496
+ # @return [Time]
14497
+ #
14498
+ # @!attribute [rw] conversation_end_time
14499
+ # The date and time when the conversation in which the utterance took
14500
+ # place ended. A conversation is defined as a unique combination of a
14501
+ # `sessionId` and an `originatingRequestId`.
14502
+ # @return [Time]
14503
+ #
14504
+ # @!attribute [rw] utterance
14505
+ # The text of the utterance.
14506
+ # @return [String]
14507
+ #
14508
+ # @!attribute [rw] utterance_timestamp
14509
+ # The date and time when the utterance took place.
14510
+ # @return [Time]
14511
+ #
14512
+ # @!attribute [rw] audio_voice_duration_millis
14513
+ # The duration in milliseconds of the audio associated with the
14514
+ # utterance.
14515
+ # @return [Integer]
14516
+ #
14517
+ # @!attribute [rw] utterance_understood
14518
+ # Specifies whether the bot understood the utterance or not.
14519
+ # @return [Boolean]
14520
+ #
14521
+ # @!attribute [rw] input_type
14522
+ # The input type of the utterance. The possible values are as follows:
14523
+ #
14524
+ # * PCM format: audio data must be in little-endian byte order.
14525
+ #
14526
+ # * `audio/l16; rate=16000; channels=1`
14527
+ #
14528
+ # * `audio/x-l16; sample-rate=16000; channel-count=1`
14529
+ #
14530
+ # * `audio/lpcm; sample-rate=8000; sample-size-bits=16;
14531
+ # channel-count=1; is-big-endian=false`
14532
+ #
14533
+ # * Opus format
14534
+ #
14535
+ # * `audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4`
14536
+ #
14537
+ # ^
14538
+ #
14539
+ # * Text format
14540
+ #
14541
+ # * `text/plain; charset=utf-8`
14542
+ #
14543
+ # ^
14544
+ # @return [String]
14545
+ #
14546
+ # @!attribute [rw] output_type
14547
+ # The output type of the utterance. The possible values are as
14548
+ # follows:
14549
+ #
14550
+ # * `audio/mpeg`
14551
+ #
14552
+ # * `audio/ogg`
14553
+ #
14554
+ # * `audio/pcm (16 KHz)`
14555
+ #
14556
+ # * `audio/` (defaults to `mpeg`)
14557
+ #
14558
+ # * `text/plain; charset=utf-8`
14559
+ # @return [String]
14560
+ #
14561
+ # @!attribute [rw] associated_intent_name
14562
+ # The name of the intent that the utterance is associated to.
14563
+ # @return [String]
14564
+ #
14565
+ # @!attribute [rw] associated_slot_name
14566
+ # The name of the slot that the utterance is associated to.
14567
+ # @return [String]
14568
+ #
14569
+ # @!attribute [rw] intent_state
14570
+ # The state of the intent that the utterance is associated to.
14571
+ # @return [String]
14572
+ #
14573
+ # @!attribute [rw] dialog_action_type
14574
+ # The type of dialog action that the utterance is associated to. See
14575
+ # the `type` field in [DialogAction][1] for more information.
14576
+ #
14577
+ #
14578
+ #
14579
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html
14580
+ # @return [String]
14581
+ #
14582
+ # @!attribute [rw] bot_response_audio_voice_id
14583
+ # The identifier for the audio of the bot response.
14584
+ # @return [String]
14585
+ #
14586
+ # @!attribute [rw] slots_filled_in_session
14587
+ # The slots that have been filled in the session by the time of the
14588
+ # utterance.
14589
+ # @return [String]
14590
+ #
14591
+ # @!attribute [rw] utterance_request_id
14592
+ # The identifier of the request associated with the utterance.
14593
+ # @return [String]
14594
+ #
14595
+ # @!attribute [rw] bot_responses
14596
+ # A list of objects containing information about the bot response to
14597
+ # the utterance.
14598
+ # @return [Array<Types::UtteranceBotResponse>]
14599
+ #
14600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceSpecification AWS API Documentation
14601
+ #
14602
+ class UtteranceSpecification < Struct.new(
14603
+ :bot_alias_id,
14604
+ :bot_version,
14605
+ :locale_id,
14606
+ :session_id,
14607
+ :channel,
14608
+ :mode,
14609
+ :conversation_start_time,
14610
+ :conversation_end_time,
14611
+ :utterance,
14612
+ :utterance_timestamp,
14613
+ :audio_voice_duration_millis,
14614
+ :utterance_understood,
14615
+ :input_type,
14616
+ :output_type,
14617
+ :associated_intent_name,
14618
+ :associated_slot_name,
14619
+ :intent_state,
14620
+ :dialog_action_type,
14621
+ :bot_response_audio_voice_id,
14622
+ :slots_filled_in_session,
14623
+ :utterance_request_id,
14624
+ :bot_responses)
14625
+ SENSITIVE = []
14626
+ include Aws::Structure
14627
+ end
14628
+
12322
14629
  # One of the input parameters in your request isn't valid. Check the
12323
14630
  # parameters and try your request again.
12324
14631
  #