aws-sdk 2.1415.0 → 2.1417.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -475,6 +475,30 @@ declare class LexModelsV2 extends Service {
475
475
  * Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
476
476
  */
477
477
  listImports(callback?: (err: AWSError, data: LexModelsV2.Types.ListImportsResponse) => void): Request<LexModelsV2.Types.ListImportsResponse, AWSError>;
478
+ /**
479
+ * Retrieves summary metrics for the intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can specify only one order in a given request.
480
+ */
481
+ listIntentMetrics(params: LexModelsV2.Types.ListIntentMetricsRequest, callback?: (err: AWSError, data: LexModelsV2.Types.ListIntentMetricsResponse) => void): Request<LexModelsV2.Types.ListIntentMetricsResponse, AWSError>;
482
+ /**
483
+ * Retrieves summary metrics for the intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can specify only one order in a given request.
484
+ */
485
+ listIntentMetrics(callback?: (err: AWSError, data: LexModelsV2.Types.ListIntentMetricsResponse) => void): Request<LexModelsV2.Types.ListIntentMetricsResponse, AWSError>;
486
+ /**
487
+ * Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order. Use the optional filters field to filter the results.
488
+ */
489
+ listIntentPaths(params: LexModelsV2.Types.ListIntentPathsRequest, callback?: (err: AWSError, data: LexModelsV2.Types.ListIntentPathsResponse) => void): Request<LexModelsV2.Types.ListIntentPathsResponse, AWSError>;
490
+ /**
491
+ * Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order. Use the optional filters field to filter the results.
492
+ */
493
+ listIntentPaths(callback?: (err: AWSError, data: LexModelsV2.Types.ListIntentPathsResponse) => void): Request<LexModelsV2.Types.ListIntentPathsResponse, AWSError>;
494
+ /**
495
+ * Retrieves summary metrics for the intent stages in your bot. The following fields are required: metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can only specify one order in a given request.
496
+ */
497
+ listIntentStageMetrics(params: LexModelsV2.Types.ListIntentStageMetricsRequest, callback?: (err: AWSError, data: LexModelsV2.Types.ListIntentStageMetricsResponse) => void): Request<LexModelsV2.Types.ListIntentStageMetricsResponse, AWSError>;
498
+ /**
499
+ * Retrieves summary metrics for the intent stages in your bot. The following fields are required: metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. You can only specify one order in a given request.
500
+ */
501
+ listIntentStageMetrics(callback?: (err: AWSError, data: LexModelsV2.Types.ListIntentStageMetricsResponse) => void): Request<LexModelsV2.Types.ListIntentStageMetricsResponse, AWSError>;
478
502
  /**
479
503
  * Get a list of intents that meet the specified criteria.
480
504
  */
@@ -491,6 +515,22 @@ declare class LexModelsV2 extends Service {
491
515
  * Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.
492
516
  */
493
517
  listRecommendedIntents(callback?: (err: AWSError, data: LexModelsV2.Types.ListRecommendedIntentsResponse) => void): Request<LexModelsV2.Types.ListRecommendedIntentsResponse, AWSError>;
518
+ /**
519
+ * Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.
520
+ */
521
+ listSessionAnalyticsData(params: LexModelsV2.Types.ListSessionAnalyticsDataRequest, callback?: (err: AWSError, data: LexModelsV2.Types.ListSessionAnalyticsDataResponse) => void): Request<LexModelsV2.Types.ListSessionAnalyticsDataResponse, AWSError>;
522
+ /**
523
+ * Retrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.
524
+ */
525
+ listSessionAnalyticsData(callback?: (err: AWSError, data: LexModelsV2.Types.ListSessionAnalyticsDataResponse) => void): Request<LexModelsV2.Types.ListSessionAnalyticsDataResponse, AWSError>;
526
+ /**
527
+ * Retrieves summary metrics for the user sessions with your bot. The following fields are required: metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.
528
+ */
529
+ listSessionMetrics(params: LexModelsV2.Types.ListSessionMetricsRequest, callback?: (err: AWSError, data: LexModelsV2.Types.ListSessionMetricsResponse) => void): Request<LexModelsV2.Types.ListSessionMetricsResponse, AWSError>;
530
+ /**
531
+ * Retrieves summary metrics for the user sessions with your bot. The following fields are required: metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.
532
+ */
533
+ listSessionMetrics(callback?: (err: AWSError, data: LexModelsV2.Types.ListSessionMetricsResponse) => void): Request<LexModelsV2.Types.ListSessionMetricsResponse, AWSError>;
494
534
  /**
495
535
  * Gets a list of slot types that match the specified criteria.
496
536
  */
@@ -547,6 +587,22 @@ declare class LexModelsV2 extends Service {
547
587
  * The list of the test sets
548
588
  */
549
589
  listTestSets(callback?: (err: AWSError, data: LexModelsV2.Types.ListTestSetsResponse) => void): Request<LexModelsV2.Types.ListTestSetsResponse, AWSError>;
590
+ /**
591
+ * Retrieves a list of metadata for individual user utterances to your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.
592
+ */
593
+ listUtteranceAnalyticsData(params: LexModelsV2.Types.ListUtteranceAnalyticsDataRequest, callback?: (err: AWSError, data: LexModelsV2.Types.ListUtteranceAnalyticsDataResponse) => void): Request<LexModelsV2.Types.ListUtteranceAnalyticsDataResponse, AWSError>;
594
+ /**
595
+ * Retrieves a list of metadata for individual user utterances to your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.
596
+ */
597
+ listUtteranceAnalyticsData(callback?: (err: AWSError, data: LexModelsV2.Types.ListUtteranceAnalyticsDataResponse) => void): Request<LexModelsV2.Types.ListUtteranceAnalyticsDataResponse, AWSError>;
598
+ /**
599
+ * Retrieves summary metrics for the utterances in your bot. The following fields are required: metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.
600
+ */
601
+ listUtteranceMetrics(params: LexModelsV2.Types.ListUtteranceMetricsRequest, callback?: (err: AWSError, data: LexModelsV2.Types.ListUtteranceMetricsResponse) => void): Request<LexModelsV2.Types.ListUtteranceMetricsResponse, AWSError>;
602
+ /**
603
+ * Retrieves summary metrics for the utterances in your bot. The following fields are required: metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results. Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.
604
+ */
605
+ listUtteranceMetrics(callback?: (err: AWSError, data: LexModelsV2.Types.ListUtteranceMetricsResponse) => void): Request<LexModelsV2.Types.ListUtteranceMetricsResponse, AWSError>;
550
606
  /**
551
607
  * Search for associated transcripts that meet the specified criteria.
552
608
  */
@@ -798,6 +854,434 @@ declare namespace LexModelsV2 {
798
854
  allowDTMFInput: BoxedBoolean;
799
855
  }
800
856
  export type AmazonResourceName = string;
857
+ export type AnalyticsBinByList = AnalyticsBinBySpecification[];
858
+ export type AnalyticsBinByName = "ConversationStartTime"|"UtteranceTimestamp"|string;
859
+ export interface AnalyticsBinBySpecification {
860
+ /**
861
+ * Specifies the time metric by which to bin the analytics data.
862
+ */
863
+ name: AnalyticsBinByName;
864
+ /**
865
+ * Specifies the interval of time by which to bin the analytics data.
866
+ */
867
+ interval: AnalyticsInterval;
868
+ /**
869
+ * Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
870
+ */
871
+ order?: AnalyticsSortOrder;
872
+ }
873
+ export interface AnalyticsBinKey {
874
+ /**
875
+ * The criterion by which to bin the results.
876
+ */
877
+ name?: AnalyticsBinByName;
878
+ /**
879
+ * The value of the criterion that defines the bin.
880
+ */
881
+ value?: AnalyticsBinValue;
882
+ }
883
+ export type AnalyticsBinKeys = AnalyticsBinKey[];
884
+ export type AnalyticsBinValue = number;
885
+ export type AnalyticsCommonFilterName = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|string;
886
+ export type AnalyticsFilterOperator = "EQ"|"GT"|"LT"|string;
887
+ export type AnalyticsFilterValue = string;
888
+ export type AnalyticsFilterValues = AnalyticsFilterValue[];
889
+ export type AnalyticsGroupByValue = string;
890
+ export type AnalyticsIntentField = "IntentName"|"IntentEndState"|"IntentLevel"|string;
891
+ export interface AnalyticsIntentFilter {
892
+ /**
893
+ * The category by which to filter the intents. The descriptions for each option are as follows: BotAlias – The name of the bot alias. BotVersion – The version of the bot. LocaleId – The locale of the bot. Modality – The modality of the session with the bot (audio, DTMF, or text). Channel – The channel that the bot is integrated with. SessionId – The identifier of the session with the bot. OriginatingRequestId – The identifier of the first request in a session. IntentName – The name of the intent. IntentEndState – The final state of the intent.
894
+ */
895
+ name: AnalyticsIntentFilterName;
896
+ /**
897
+ * The operation by which to filter the category. The following operations are possible: CO – Contains EQ – Equals GT – Greater than LT – Less than The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. SessionId – EQ. OriginatingRequestId – EQ. IntentName – EQ, CO. IntentEndState – EQ, CO.
898
+ */
899
+ operator: AnalyticsFilterOperator;
900
+ /**
901
+ * An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
902
+ */
903
+ values: AnalyticsFilterValues;
904
+ }
905
+ export type AnalyticsIntentFilterName = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|"SessionId"|"OriginatingRequestId"|"IntentName"|"IntentEndState"|string;
906
+ export type AnalyticsIntentFilters = AnalyticsIntentFilter[];
907
+ export interface AnalyticsIntentGroupByKey {
908
+ /**
909
+ * A category by which the intent analytics were grouped.
910
+ */
911
+ name?: AnalyticsIntentField;
912
+ /**
913
+ * A member of the category by which the intent analytics were grouped.
914
+ */
915
+ value?: AnalyticsGroupByValue;
916
+ }
917
+ export type AnalyticsIntentGroupByKeys = AnalyticsIntentGroupByKey[];
918
+ export type AnalyticsIntentGroupByList = AnalyticsIntentGroupBySpecification[];
919
+ export interface AnalyticsIntentGroupBySpecification {
920
+ /**
921
+ * Specifies whether to group the intent stages by their name or their end state.
922
+ */
923
+ name: AnalyticsIntentField;
924
+ }
925
+ export interface AnalyticsIntentMetric {
926
+ /**
927
+ * The metric for which you want to get intent summary statistics. Count – The number of times the intent was invoked. Success – The number of times the intent succeeded. Failure – The number of times the intent failed. Switched – The number of times there was a switch to a different intent. Dropped – The number of times the user dropped the intent.
928
+ */
929
+ name: AnalyticsIntentMetricName;
930
+ /**
931
+ * The summary statistic to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of intents in the category you provide in name. Max – The highest count in the category you provide in name.
932
+ */
933
+ statistic: AnalyticsMetricStatistic;
934
+ /**
935
+ * Specifies whether to sort the results in ascending or descending order.
936
+ */
937
+ order?: AnalyticsSortOrder;
938
+ }
939
+ export type AnalyticsIntentMetricName = "Count"|"Success"|"Failure"|"Switched"|"Dropped"|string;
940
+ export interface AnalyticsIntentMetricResult {
941
+ /**
942
+ * The metric that you requested. See Key definitions for more details about these metrics. Count – The number of times the intent was invoked. Success – The number of times the intent succeeded. Failure – The number of times the intent failed. Switched – The number of times there was a switch to a different intent. Dropped – The number of times the user dropped the intent.
943
+ */
944
+ name?: AnalyticsIntentMetricName;
945
+ /**
946
+ * The statistic that you requested to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of intents in the category you provide in name. Max – The highest count in the category you provide in name.
947
+ */
948
+ statistic?: AnalyticsMetricStatistic;
949
+ /**
950
+ * The value of the summary statistic for the metric that you requested.
951
+ */
952
+ value?: AnalyticsMetricValue;
953
+ }
954
+ export type AnalyticsIntentMetricResults = AnalyticsIntentMetricResult[];
955
+ export type AnalyticsIntentMetrics = AnalyticsIntentMetric[];
956
+ export type AnalyticsIntentNodeSummaries = AnalyticsIntentNodeSummary[];
957
+ export interface AnalyticsIntentNodeSummary {
958
+ /**
959
+ * The name of the intent at the end of the requested path.
960
+ */
961
+ intentName?: Name;
962
+ /**
963
+ * The path.
964
+ */
965
+ intentPath?: AnalyticsPath;
966
+ /**
967
+ * The total number of sessions that follow the given path to the given intent.
968
+ */
969
+ intentCount?: AnalyticsNodeCount;
970
+ /**
971
+ * The number of intents up to and including the requested path.
972
+ */
973
+ intentLevel?: AnalyticsNodeLevel;
974
+ /**
975
+ * Specifies whether the node is the end of a path (Exit) or not (Inner).
976
+ */
977
+ nodeType?: AnalyticsNodeType;
978
+ }
979
+ export interface AnalyticsIntentResult {
980
+ /**
981
+ * A list of objects containing the criteria you requested for binning results and the values of the bins.
982
+ */
983
+ binKeys?: AnalyticsBinKeys;
984
+ /**
985
+ * A list of objects containing the criteria you requested for grouping results and the values of the groups.
986
+ */
987
+ groupByKeys?: AnalyticsIntentGroupByKeys;
988
+ /**
989
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
990
+ */
991
+ metricsResults?: AnalyticsIntentMetricResults;
992
+ }
993
+ export type AnalyticsIntentResults = AnalyticsIntentResult[];
994
+ export type AnalyticsIntentStageField = "IntentStageName"|"SwitchedToIntent"|string;
995
+ export interface AnalyticsIntentStageFilter {
996
+ /**
997
+ * The category by which to filter the intent stages. The descriptions for each option are as follows: BotAlias – The name of the bot alias. BotVersion – The version of the bot. LocaleId – The locale of the bot. Modality – The modality of the session with the bot (audio, DTMF, or text). Channel – The channel that the bot is integrated with. SessionId – The identifier of the session with the bot. OriginatingRequestId – The identifier of the first request in a session. IntentName – The name of the intent. IntentStageName – The stage in the intent.
998
+ */
999
+ name: AnalyticsIntentStageFilterName;
1000
+ /**
1001
+ * The operation by which to filter the category. The following operations are possible: CO – Contains EQ – Equals GT – Greater than LT – Less than The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. SessionId – EQ. OriginatingRequestId – EQ. IntentName – EQ, CO. IntentStageName – EQ, CO.
1002
+ */
1003
+ operator: AnalyticsFilterOperator;
1004
+ /**
1005
+ * An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
1006
+ */
1007
+ values: AnalyticsFilterValues;
1008
+ }
1009
+ export type AnalyticsIntentStageFilterName = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|"SessionId"|"OriginatingRequestId"|"IntentName"|"IntentStageName"|string;
1010
+ export type AnalyticsIntentStageFilters = AnalyticsIntentStageFilter[];
1011
+ export interface AnalyticsIntentStageGroupByKey {
1012
+ /**
1013
+ * A category by which the intent stage analytics were grouped.
1014
+ */
1015
+ name?: AnalyticsIntentStageField;
1016
+ /**
1017
+ * A member of the category by which the intent stage analytics were grouped.
1018
+ */
1019
+ value?: AnalyticsGroupByValue;
1020
+ }
1021
+ export type AnalyticsIntentStageGroupByKeys = AnalyticsIntentStageGroupByKey[];
1022
+ export type AnalyticsIntentStageGroupByList = AnalyticsIntentStageGroupBySpecification[];
1023
+ export interface AnalyticsIntentStageGroupBySpecification {
1024
+ /**
1025
+ * Specifies whether to group the intent stages by their name or the intent to which the session was switched.
1026
+ */
1027
+ name: AnalyticsIntentStageField;
1028
+ }
1029
+ export interface AnalyticsIntentStageMetric {
1030
+ /**
1031
+ * The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics. Count – The number of times the intent stage occurred. Success – The number of times the intent stage succeeded. Failure – The number of times the intent stage failed. Dropped – The number of times the user dropped the intent stage. Retry – The number of times the bot tried to elicit a response from the user at this stage.
1032
+ */
1033
+ name: AnalyticsIntentStageMetricName;
1034
+ /**
1035
+ * The summary statistic to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of intent stages in the category you provide in name. Max – The highest count in the category you provide in name.
1036
+ */
1037
+ statistic: AnalyticsMetricStatistic;
1038
+ /**
1039
+ * Specifies whether to sort the results in ascending or descending order of the summary statistic (value in the response).
1040
+ */
1041
+ order?: AnalyticsSortOrder;
1042
+ }
1043
+ export type AnalyticsIntentStageMetricName = "Count"|"Success"|"Failed"|"Dropped"|"Retry"|string;
1044
+ export interface AnalyticsIntentStageMetricResult {
1045
+ /**
1046
+ * The metric that you requested. Count – The number of times the intent stage occurred. Success – The number of times the intent stage succeeded. Failure – The number of times the intent stage failed. Dropped – The number of times the user dropped the intent stage. Retry – The number of times the bot tried to elicit a response from the user at this stage.
1047
+ */
1048
+ name?: AnalyticsIntentStageMetricName;
1049
+ /**
1050
+ * The summary statistic that you requested to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of intent stages in the category you provide in name. Max – The highest count in the category you provide in name.
1051
+ */
1052
+ statistic?: AnalyticsMetricStatistic;
1053
+ /**
1054
+ * The value of the summary statistic for the metric that you requested.
1055
+ */
1056
+ value?: AnalyticsMetricValue;
1057
+ }
1058
+ export type AnalyticsIntentStageMetricResults = AnalyticsIntentStageMetricResult[];
1059
+ export type AnalyticsIntentStageMetrics = AnalyticsIntentStageMetric[];
1060
+ export interface AnalyticsIntentStageResult {
1061
+ /**
1062
+ * A list of objects containing the criteria you requested for binning results and the values of the bins.
1063
+ */
1064
+ binKeys?: AnalyticsBinKeys;
1065
+ /**
1066
+ * A list of objects containing the criteria you requested for grouping results and the values of the bins.
1067
+ */
1068
+ groupByKeys?: AnalyticsIntentStageGroupByKeys;
1069
+ /**
1070
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
1071
+ */
1072
+ metricsResults?: AnalyticsIntentStageMetricResults;
1073
+ }
1074
+ export type AnalyticsIntentStageResults = AnalyticsIntentStageResult[];
1075
+ export type AnalyticsInterval = "OneHour"|"OneDay"|string;
1076
+ export type AnalyticsLongValue = number;
1077
+ export type AnalyticsMetricStatistic = "Sum"|"Avg"|"Max"|string;
1078
+ export type AnalyticsMetricValue = number;
1079
+ export type AnalyticsModality = "Speech"|"Text"|"DTMF"|"MultiMode"|string;
1080
+ export type AnalyticsNodeCount = number;
1081
+ export type AnalyticsNodeLevel = number;
1082
+ export type AnalyticsNodeType = "Inner"|"Exit"|string;
1083
+ export type AnalyticsOriginatingRequestId = string;
1084
+ export type AnalyticsPath = string;
1085
+ export interface AnalyticsPathFilter {
1086
+ /**
1087
+ * The category by which to filter the intent paths. The descriptions for each option are as follows: BotAlias – The name of the bot alias. BotVersion – The version of the bot. LocaleId – The locale of the bot. Modality – The modality of the session with the bot (audio, DTMF, or text). Channel – The channel that the bot is integrated with.
1088
+ */
1089
+ name: AnalyticsCommonFilterName;
1090
+ /**
1091
+ * The operation by which to filter the category. The following operations are possible: CO – Contains EQ – Equals GT – Greater than LT – Less than The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ.
1092
+ */
1093
+ operator: AnalyticsFilterOperator;
1094
+ /**
1095
+ * An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
1096
+ */
1097
+ values: AnalyticsFilterValues;
1098
+ }
1099
+ export type AnalyticsPathFilters = AnalyticsPathFilter[];
1100
+ export type AnalyticsSessionField = "ConversationEndState"|"LocaleId"|string;
1101
+ export interface AnalyticsSessionFilter {
1102
+ /**
1103
+ * The category by which to filter the sessions. The descriptions for each option are as follows: BotAlias – The name of the bot alias. BotVersion – The version of the bot. LocaleId – The locale of the bot. Modality – The modality of the session with the bot (audio, DTMF, or text). Channel – The channel that the bot is integrated with. Duration – The duration of the session. conversationEndState – The final state of the session. SessionId – The identifier of the session with the bot. OriginatingRequestId – The identifier of the first request in a session. IntentPath – The order of intents taken in a session.
1104
+ */
1105
+ name: AnalyticsSessionFilterName;
1106
+ /**
1107
+ * The operation by which to filter the category. The following operations are possible: CO – Contains EQ – Equals GT – Greater than LT – Less than The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. Duration – EQ, GT, LT. conversationEndState – EQ, CO. SessionId – EQ. OriginatingRequestId – EQ. IntentPath – EQ.
1108
+ */
1109
+ operator: AnalyticsFilterOperator;
1110
+ /**
1111
+ * An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
1112
+ */
1113
+ values: AnalyticsFilterValues;
1114
+ }
1115
+ export type AnalyticsSessionFilterName = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|"Duration"|"ConversationEndState"|"SessionId"|"OriginatingRequestId"|"IntentPath"|string;
1116
+ export type AnalyticsSessionFilters = AnalyticsSessionFilter[];
1117
+ export interface AnalyticsSessionGroupByKey {
1118
+ /**
1119
+ * The category by which the session analytics were grouped.
1120
+ */
1121
+ name?: AnalyticsSessionField;
1122
+ /**
1123
+ * A member of the category by which the session analytics were grouped.
1124
+ */
1125
+ value?: AnalyticsGroupByValue;
1126
+ }
1127
+ export type AnalyticsSessionGroupByKeys = AnalyticsSessionGroupByKey[];
1128
+ export type AnalyticsSessionGroupByList = AnalyticsSessionGroupBySpecification[];
1129
+ export interface AnalyticsSessionGroupBySpecification {
1130
+ /**
1131
+ * Specifies whether to group the session by their end state or their locale.
1132
+ */
1133
+ name: AnalyticsSessionField;
1134
+ }
1135
+ export type AnalyticsSessionId = string;
1136
+ export interface AnalyticsSessionMetric {
1137
+ /**
1138
+ * The metric for which you want to get session summary statistics. Count – The number of sessions. Success – The number of sessions that succeeded. Failure – The number of sessions that failed. Dropped – The number of sessions that the user dropped. Duration – The duration of sessions. TurnsPerSession – The number of turns in the sessions. Concurrency – The number of sessions occurring in the same period of time.
1139
+ */
1140
+ name: AnalyticsSessionMetricName;
1141
+ /**
1142
+ * The summary statistic to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of sessions in the category you provide in name. Max – The highest count in the category you provide in name.
1143
+ */
1144
+ statistic: AnalyticsMetricStatistic;
1145
+ /**
1146
+ * Specifies whether to sort the results in ascending or descending order.
1147
+ */
1148
+ order?: AnalyticsSortOrder;
1149
+ }
1150
+ export type AnalyticsSessionMetricName = "Count"|"Success"|"Failure"|"Dropped"|"Duration"|"TurnsPerConversation"|"Concurrency"|string;
1151
+ export interface AnalyticsSessionMetricResult {
1152
+ /**
1153
+ * The metric that you requested. Count – The number of sessions. Success – The number of sessions that succeeded. Failure – The number of sessions that failed. Dropped – The number of sessions that the user dropped. Duration – The duration of sessions. TurnPersession – The number of turns in the sessions. Concurrency – The number of sessions occurring in the same period of time.
1154
+ */
1155
+ name?: AnalyticsSessionMetricName;
1156
+ /**
1157
+ * The summary statistic that you requested to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of sessions in the category you provide in name. Max – The highest count in the category you provide in name.
1158
+ */
1159
+ statistic?: AnalyticsMetricStatistic;
1160
+ /**
1161
+ * The value of the summary statistic for the metric that you requested.
1162
+ */
1163
+ value?: AnalyticsMetricValue;
1164
+ }
1165
+ export type AnalyticsSessionMetricResults = AnalyticsSessionMetricResult[];
1166
+ export type AnalyticsSessionMetrics = AnalyticsSessionMetric[];
1167
+ export interface AnalyticsSessionResult {
1168
+ /**
1169
+ * A list of objects containing the criteria you requested for binning results and the values of the bins.
1170
+ */
1171
+ binKeys?: AnalyticsBinKeys;
1172
+ /**
1173
+ * A list of objects containing the criteria you requested for grouping results and the values of the bins.
1174
+ */
1175
+ groupByKeys?: AnalyticsSessionGroupByKeys;
1176
+ /**
1177
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
1178
+ */
1179
+ metricsResults?: AnalyticsSessionMetricResults;
1180
+ }
1181
+ export type AnalyticsSessionResults = AnalyticsSessionResult[];
1182
+ export type AnalyticsSessionSortByName = "ConversationStartTime"|"NumberOfTurns"|"Duration"|string;
1183
+ export type AnalyticsSortOrder = "Ascending"|"Descending"|string;
1184
+ export interface AnalyticsUtteranceAttribute {
1185
+ /**
1186
+ * An attribute to return. The only available attribute is the intent that the bot mapped the utterance to.
1187
+ */
1188
+ name: AnalyticsUtteranceAttributeName;
1189
+ }
1190
+ export type AnalyticsUtteranceAttributeName = "LastUsedIntent"|string;
1191
+ export interface AnalyticsUtteranceAttributeResult {
1192
+ /**
1193
+ * The intent that the bot mapped the utterance to.
1194
+ */
1195
+ lastUsedIntent?: Name;
1196
+ }
1197
+ export type AnalyticsUtteranceAttributeResults = AnalyticsUtteranceAttributeResult[];
1198
+ export type AnalyticsUtteranceAttributes = AnalyticsUtteranceAttribute[];
1199
+ export type AnalyticsUtteranceField = "UtteranceText"|"UtteranceState"|string;
1200
+ export interface AnalyticsUtteranceFilter {
1201
+ /**
1202
+ * The category by which to filter the utterances. The descriptions for each option are as follows: BotAlias – The name of the bot alias. BotVersion – The version of the bot. LocaleId – The locale of the bot. Modality – The modality of the session with the bot (audio, DTMF, or text). Channel – The channel that the bot is integrated with. SessionId – The identifier of the session with the bot. OriginatingRequestId – The identifier of the first request in a session. UtteranceState – The state of the utterance. UtteranceText – The text in the utterance.
1203
+ */
1204
+ name: AnalyticsUtteranceFilterName;
1205
+ /**
1206
+ * The operation by which to filter the category. The following operations are possible: CO – Contains EQ – Equals GT – Greater than LT – Less than The operators that each filter supports are listed below: BotAlias – EQ. BotVersion – EQ. LocaleId – EQ. Modality – EQ. Channel – EQ. SessionId – EQ. OriginatingRequestId – EQ. UtteranceState – EQ. UtteranceText – EQ, CO.
1207
+ */
1208
+ operator: AnalyticsFilterOperator;
1209
+ /**
1210
+ * An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is EQ or CO. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the name, operator, and values fields are Modality, EQ, and [Speech, Text], the operation filters for results where the modality was either Speech or Text.
1211
+ */
1212
+ values: AnalyticsFilterValues;
1213
+ }
1214
+ export type AnalyticsUtteranceFilterName = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|"SessionId"|"OriginatingRequestId"|"UtteranceState"|"UtteranceText"|string;
1215
+ export type AnalyticsUtteranceFilters = AnalyticsUtteranceFilter[];
1216
+ export interface AnalyticsUtteranceGroupByKey {
1217
+ /**
1218
+ * The category by which the utterance analytics were grouped.
1219
+ */
1220
+ name?: AnalyticsUtteranceField;
1221
+ /**
1222
+ * A member of the category by which the utterance analytics were grouped.
1223
+ */
1224
+ value?: AnalyticsGroupByValue;
1225
+ }
1226
+ export type AnalyticsUtteranceGroupByKeys = AnalyticsUtteranceGroupByKey[];
1227
+ export type AnalyticsUtteranceGroupByList = AnalyticsUtteranceGroupBySpecification[];
1228
+ export interface AnalyticsUtteranceGroupBySpecification {
1229
+ /**
1230
+ * Specifies whether to group the utterances by their text or their state.
1231
+ */
1232
+ name: AnalyticsUtteranceField;
1233
+ }
1234
+ export interface AnalyticsUtteranceMetric {
1235
+ /**
1236
+ * The metric for which you want to get utterance summary statistics. Count – The number of utterances. Missed – The number of utterances that Amazon Lex failed to recognize. Detected – The number of utterances that Amazon Lex managed to detect. UtteranceTimestamp – The date and time of the utterance.
1237
+ */
1238
+ name: AnalyticsUtteranceMetricName;
1239
+ /**
1240
+ * The summary statistic to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of utterances in the category you provide in name. Max – The highest count in the category you provide in name.
1241
+ */
1242
+ statistic: AnalyticsMetricStatistic;
1243
+ /**
1244
+ * Specifies whether to sort the results in ascending or descending order.
1245
+ */
1246
+ order?: AnalyticsSortOrder;
1247
+ }
1248
+ export type AnalyticsUtteranceMetricName = "Count"|"Missed"|"Detected"|"UtteranceTimestamp"|string;
1249
+ export interface AnalyticsUtteranceMetricResult {
1250
+ /**
1251
+ * The metric that you requested. Count – The number of utterances. Missed – The number of utterances that Amazon Lex failed to recognize. Detected – The number of utterances that Amazon Lex managed to detect. UtteranceTimeStamp – The date and time of the utterance.
1252
+ */
1253
+ name?: AnalyticsUtteranceMetricName;
1254
+ /**
1255
+ * The summary statistic that you requested to calculate. Sum – The total count for the category you provide in name. Average – The total count divided by the number of utterances in the category you provide in name. Max – The highest count in the category you provide in name.
1256
+ */
1257
+ statistic?: AnalyticsMetricStatistic;
1258
+ /**
1259
+ * The value of the summary statistic for the metric that you requested.
1260
+ */
1261
+ value?: AnalyticsMetricValue;
1262
+ }
1263
+ export type AnalyticsUtteranceMetricResults = AnalyticsUtteranceMetricResult[];
1264
+ export type AnalyticsUtteranceMetrics = AnalyticsUtteranceMetric[];
1265
+ export interface AnalyticsUtteranceResult {
1266
+ /**
1267
+ * A list of objects containing the criteria you requested for binning results and the values of the bins.
1268
+ */
1269
+ binKeys?: AnalyticsBinKeys;
1270
+ /**
1271
+ * A list of objects containing the criteria you requested for grouping results and the values of the bins.
1272
+ */
1273
+ groupByKeys?: AnalyticsUtteranceGroupByKeys;
1274
+ /**
1275
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
1276
+ */
1277
+ metricsResults?: AnalyticsUtteranceMetricResults;
1278
+ /**
1279
+ * A list of objects containing information about the last used intent at the time of an utterance.
1280
+ */
1281
+ attributeResults?: AnalyticsUtteranceAttributeResults;
1282
+ }
1283
+ export type AnalyticsUtteranceResults = AnalyticsUtteranceResult[];
1284
+ export type AnalyticsUtteranceSortByName = "UtteranceTimestamp"|string;
801
1285
  export interface AssociatedTranscript {
802
1286
  /**
803
1287
  * The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.
@@ -1054,6 +1538,7 @@ declare namespace LexModelsV2 {
1054
1538
  */
1055
1539
  localeId: LocaleId;
1056
1540
  }
1541
+ export type BotChannelType = "Facebook"|"Slack"|"TwilioSms"|string;
1057
1542
  export interface BotExportSpecification {
1058
1543
  /**
1059
1544
  * The identifier of the bot assigned by Amazon Lex.
@@ -1521,6 +2006,7 @@ declare namespace LexModelsV2 {
1521
2006
  export type ConfidenceThreshold = number;
1522
2007
  export type ContextTimeToLiveInSeconds = number;
1523
2008
  export type ContextTurnsToLive = number;
2009
+ export type ConversationEndState = "Success"|"Failure"|"Dropped"|string;
1524
2010
  export interface ConversationLevelIntentClassificationResultItem {
1525
2011
  /**
1526
2012
  * The intent name used in the evaluation of intent level success or failure.
@@ -4253,6 +4739,7 @@ declare namespace LexModelsV2 {
4253
4739
  */
4254
4740
  order: SortOrder;
4255
4741
  }
4742
+ export type IntentState = "Failed"|"Fulfilled"|"InProgress"|"ReadyForFulfillment"|"Waiting"|"FulfillmentInProgress"|string;
4256
4743
  export interface IntentStatistics {
4257
4744
  /**
4258
4745
  * The number of recommended intents associated with the bot recommendation.
@@ -4290,6 +4777,13 @@ declare namespace LexModelsV2 {
4290
4777
  lastUpdatedDateTime?: Timestamp;
4291
4778
  }
4292
4779
  export type IntentSummaryList = IntentSummary[];
4780
+ export interface InvokedIntentSample {
4781
+ /**
4782
+ * The name of an intent that was invoked.
4783
+ */
4784
+ intentName?: Name;
4785
+ }
4786
+ export type InvokedIntentSamples = InvokedIntentSample[];
4293
4787
  export type ItemId = string;
4294
4788
  export interface KendraConfiguration {
4295
4789
  /**
@@ -4792,75 +5286,207 @@ declare namespace LexModelsV2 {
4792
5286
  */
4793
5287
  localeId?: LocaleId;
4794
5288
  }
4795
- export interface ListIntentsRequest {
5289
+ export interface ListIntentMetricsRequest {
4796
5290
  /**
4797
- * The unique identifier of the bot that contains the intent.
5291
+ * The identifier for the bot for which you want to retrieve intent metrics.
4798
5292
  */
4799
5293
  botId: Id;
4800
5294
  /**
4801
- * The version of the bot that contains the intent.
5295
+ * The timestamp that marks the beginning of the range of time for which you want to see intent metrics.
4802
5296
  */
4803
- botVersion: BotVersion;
5297
+ startDateTime: Timestamp;
4804
5298
  /**
4805
- * The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
5299
+ * The date and time that marks the end of the range of time for which you want to see intent metrics.
4806
5300
  */
4807
- localeId: LocaleId;
5301
+ endDateTime: Timestamp;
4808
5302
  /**
4809
- * Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
5303
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.
4810
5304
  */
4811
- sortBy?: IntentSortBy;
5305
+ metrics: AnalyticsIntentMetrics;
4812
5306
  /**
4813
- * Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
5307
+ * A list of objects, each of which contains specifications for organizing the results by time.
4814
5308
  */
4815
- filters?: IntentFilters;
5309
+ binBy?: AnalyticsBinByList;
4816
5310
  /**
4817
- * The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
5311
+ * A list of objects, each of which specifies how to group the results. You can group by the following criteria: IntentName The name of the intent. IntentEndState The final state of the intent. The possible end states are detailed in Key definitions in the user guide.
4818
5312
  */
4819
- maxResults?: MaxResults;
5313
+ groupBy?: AnalyticsIntentGroupByList;
4820
5314
  /**
4821
- * If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.
5315
+ * A list of objects, each of which describes a condition by which you want to filter the results.
4822
5316
  */
4823
- nextToken?: NextToken;
4824
- }
4825
- export interface ListIntentsResponse {
5317
+ filters?: AnalyticsIntentFilters;
4826
5318
  /**
4827
- * The identifier of the bot that contains the intent.
5319
+ * The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
4828
5320
  */
4829
- botId?: Id;
5321
+ maxResults?: MaxResults;
4830
5322
  /**
4831
- * The version of the bot that contains the intent.
5323
+ * If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
4832
5324
  */
4833
- botVersion?: BotVersion;
5325
+ nextToken?: NextToken;
5326
+ }
5327
+ export interface ListIntentMetricsResponse {
4834
5328
  /**
4835
- * The language and locale of the intents in the list.
5329
+ * The identifier for the bot for which you retrieved intent metrics.
4836
5330
  */
4837
- localeId?: LocaleId;
5331
+ botId?: Id;
4838
5332
  /**
4839
- * Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
5333
+ * The results for the intent metrics.
4840
5334
  */
4841
- intentSummaries?: IntentSummaryList;
5335
+ results?: AnalyticsIntentResults;
4842
5336
  /**
4843
- * A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.
5337
+ * If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
4844
5338
  */
4845
5339
  nextToken?: NextToken;
4846
5340
  }
4847
- export interface ListRecommendedIntentsRequest {
5341
+ export interface ListIntentPathsRequest {
4848
5342
  /**
4849
- * The unique identifier of the bot associated with the recommended intents.
5343
+ * The identifier for the bot for which you want to retrieve intent path metrics.
4850
5344
  */
4851
5345
  botId: Id;
4852
5346
  /**
4853
- * The version of the bot that contains the recommended intents.
5347
+ * The date and time that marks the beginning of the range of time for which you want to see intent path metrics.
4854
5348
  */
4855
- botVersion: DraftBotVersion;
5349
+ startDateTime: Timestamp;
4856
5350
  /**
4857
- * The identifier of the language and locale of the recommended intents.
5351
+ * The date and time that marks the end of the range of time for which you want to see intent path metrics.
4858
5352
  */
4859
- localeId: LocaleId;
5353
+ endDateTime: Timestamp;
4860
5354
  /**
4861
- * The identifier of the bot recommendation that contains the recommended intents.
5355
+ * The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example: /BookCar /BookCar/BookHotel /BookHotel/BookCar
4862
5356
  */
4863
- botRecommendationId: Id;
5357
+ intentPath: AnalyticsPath;
5358
+ /**
5359
+ * A list of objects, each describes a condition by which you want to filter the results.
5360
+ */
5361
+ filters?: AnalyticsPathFilters;
5362
+ }
5363
+ export interface ListIntentPathsResponse {
5364
+ /**
5365
+ * A list of objects, each of which contains information about a node in the intent path for which you requested metrics.
5366
+ */
5367
+ nodeSummaries?: AnalyticsIntentNodeSummaries;
5368
+ }
5369
+ export interface ListIntentStageMetricsRequest {
5370
+ /**
5371
+ * The identifier for the bot for which you want to retrieve intent stage metrics.
5372
+ */
5373
+ botId: Id;
5374
+ /**
5375
+ * The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
5376
+ */
5377
+ startDateTime: Timestamp;
5378
+ /**
5379
+ * The date and time that marks the end of the range of time for which you want to see intent stage metrics.
5380
+ */
5381
+ endDateTime: Timestamp;
5382
+ /**
5383
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
5384
+ */
5385
+ metrics: AnalyticsIntentStageMetrics;
5386
+ /**
5387
+ * A list of objects, each of which contains specifications for organizing the results by time.
5388
+ */
5389
+ binBy?: AnalyticsBinByList;
5390
+ /**
5391
+ * A list of objects, each of which specifies how to group the results. You can group by the following criteria: IntentStageName – The name of the intent stage. SwitchedToIntent – The intent to which the conversation was switched (if any).
5392
+ */
5393
+ groupBy?: AnalyticsIntentStageGroupByList;
5394
+ /**
5395
+ * A list of objects, each of which describes a condition by which you want to filter the results.
5396
+ */
5397
+ filters?: AnalyticsIntentStageFilters;
5398
+ /**
5399
+ * The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
5400
+ */
5401
+ maxResults?: MaxResults;
5402
+ /**
5403
+ * If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
5404
+ */
5405
+ nextToken?: NextToken;
5406
+ }
5407
+ export interface ListIntentStageMetricsResponse {
5408
+ /**
5409
+ * The identifier for the bot for which you retrieved intent stage metrics.
5410
+ */
5411
+ botId?: Id;
5412
+ /**
5413
+ * The results for the intent stage metrics.
5414
+ */
5415
+ results?: AnalyticsIntentStageResults;
5416
+ /**
5417
+ * If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
5418
+ */
5419
+ nextToken?: NextToken;
5420
+ }
5421
+ export interface ListIntentsRequest {
5422
+ /**
5423
+ * The unique identifier of the bot that contains the intent.
5424
+ */
5425
+ botId: Id;
5426
+ /**
5427
+ * The version of the bot that contains the intent.
5428
+ */
5429
+ botVersion: BotVersion;
5430
+ /**
5431
+ * The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
5432
+ */
5433
+ localeId: LocaleId;
5434
+ /**
5435
+ * Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
5436
+ */
5437
+ sortBy?: IntentSortBy;
5438
+ /**
5439
+ * Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
5440
+ */
5441
+ filters?: IntentFilters;
5442
+ /**
5443
+ * The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
5444
+ */
5445
+ maxResults?: MaxResults;
5446
+ /**
5447
+ * If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.
5448
+ */
5449
+ nextToken?: NextToken;
5450
+ }
5451
+ export interface ListIntentsResponse {
5452
+ /**
5453
+ * The identifier of the bot that contains the intent.
5454
+ */
5455
+ botId?: Id;
5456
+ /**
5457
+ * The version of the bot that contains the intent.
5458
+ */
5459
+ botVersion?: BotVersion;
5460
+ /**
5461
+ * The language and locale of the intents in the list.
5462
+ */
5463
+ localeId?: LocaleId;
5464
+ /**
5465
+ * Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
5466
+ */
5467
+ intentSummaries?: IntentSummaryList;
5468
+ /**
5469
+ * A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.
5470
+ */
5471
+ nextToken?: NextToken;
5472
+ }
5473
+ export interface ListRecommendedIntentsRequest {
5474
+ /**
5475
+ * The unique identifier of the bot associated with the recommended intents.
5476
+ */
5477
+ botId: Id;
5478
+ /**
5479
+ * The version of the bot that contains the recommended intents.
5480
+ */
5481
+ botVersion: DraftBotVersion;
5482
+ /**
5483
+ * The identifier of the language and locale of the recommended intents.
5484
+ */
5485
+ localeId: LocaleId;
5486
+ /**
5487
+ * The identifier of the bot recommendation that contains the recommended intents.
5488
+ */
5489
+ botRecommendationId: Id;
4864
5490
  /**
4865
5491
  * If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
4866
5492
  */
@@ -4896,6 +5522,102 @@ declare namespace LexModelsV2 {
4896
5522
  */
4897
5523
  nextToken?: NextToken;
4898
5524
  }
5525
+ export interface ListSessionAnalyticsDataRequest {
5526
+ /**
5527
+ * The identifier for the bot for which you want to retrieve session analytics.
5528
+ */
5529
+ botId: Id;
5530
+ /**
5531
+ * The date and time that marks the beginning of the range of time for which you want to see session analytics.
5532
+ */
5533
+ startDateTime: Timestamp;
5534
+ /**
5535
+ * The date and time that marks the end of the range of time for which you want to see session analytics.
5536
+ */
5537
+ endDateTime: Timestamp;
5538
+ /**
5539
+ * An object specifying the measure and method by which to sort the session analytics data.
5540
+ */
5541
+ sortBy?: SessionDataSortBy;
5542
+ /**
5543
+ * A list of objects, each of which describes a condition by which you want to filter the results.
5544
+ */
5545
+ filters?: AnalyticsSessionFilters;
5546
+ /**
5547
+ * The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
5548
+ */
5549
+ maxResults?: MaxResults;
5550
+ /**
5551
+ * If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
5552
+ */
5553
+ nextToken?: NextToken;
5554
+ }
5555
+ export interface ListSessionAnalyticsDataResponse {
5556
+ /**
5557
+ * The unique identifier of the bot that the sessions belong to.
5558
+ */
5559
+ botId?: Id;
5560
+ /**
5561
+ * If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
5562
+ */
5563
+ nextToken?: NextToken;
5564
+ /**
5565
+ * A list of objects, each of which contains information about a session with the bot.
5566
+ */
5567
+ sessions?: SessionSpecifications;
5568
+ }
5569
+ export interface ListSessionMetricsRequest {
5570
+ /**
5571
+ * The identifier for the bot for which you want to retrieve session metrics.
5572
+ */
5573
+ botId: Id;
5574
+ /**
5575
+ * The date and time that marks the beginning of the range of time for which you want to see session metrics.
5576
+ */
5577
+ startDateTime: Timestamp;
5578
+ /**
5579
+ * The date and time that marks the end of the range of time for which you want to see session metrics.
5580
+ */
5581
+ endDateTime: Timestamp;
5582
+ /**
5583
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
5584
+ */
5585
+ metrics: AnalyticsSessionMetrics;
5586
+ /**
5587
+ * A list of objects, each of which contains specifications for organizing the results by time.
5588
+ */
5589
+ binBy?: AnalyticsBinByList;
5590
+ /**
5591
+ * A list of objects, each of which specifies how to group the results. You can group by the following criteria: ConversationEndState – The final state of the conversation. The possible end states are detailed in Key definitions in the user guide. LocaleId – The unique identifier of the bot locale.
5592
+ */
5593
+ groupBy?: AnalyticsSessionGroupByList;
5594
+ /**
5595
+ * A list of objects, each of which describes a condition by which you want to filter the results.
5596
+ */
5597
+ filters?: AnalyticsSessionFilters;
5598
+ /**
5599
+ * The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
5600
+ */
5601
+ maxResults?: MaxResults;
5602
+ /**
5603
+ * If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
5604
+ */
5605
+ nextToken?: NextToken;
5606
+ }
5607
+ export interface ListSessionMetricsResponse {
5608
+ /**
5609
+ * The identifier for the bot for which you retrieved session metrics.
5610
+ */
5611
+ botId?: Id;
5612
+ /**
5613
+ * The results for the session metrics.
5614
+ */
5615
+ results?: AnalyticsSessionResults;
5616
+ /**
5617
+ * If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
5618
+ */
5619
+ nextToken?: NextToken;
5620
+ }
4899
5621
  export interface ListSlotTypesRequest {
4900
5622
  /**
4901
5623
  * The unique identifier of the bot that contains the slot types.
@@ -5120,6 +5842,106 @@ declare namespace LexModelsV2 {
5120
5842
  */
5121
5843
  nextToken?: NextToken;
5122
5844
  }
5845
+ export interface ListUtteranceAnalyticsDataRequest {
5846
+ /**
5847
+ * The identifier for the bot for which you want to retrieve utterance analytics.
5848
+ */
5849
+ botId: Id;
5850
+ /**
5851
+ * The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
5852
+ */
5853
+ startDateTime: Timestamp;
5854
+ /**
5855
+ * The date and time that marks the end of the range of time for which you want to see utterance analytics.
5856
+ */
5857
+ endDateTime: Timestamp;
5858
+ /**
5859
+ * An object specifying the measure and method by which to sort the utterance analytics data.
5860
+ */
5861
+ sortBy?: UtteranceDataSortBy;
5862
+ /**
5863
+ * A list of objects, each of which describes a condition by which you want to filter the results.
5864
+ */
5865
+ filters?: AnalyticsUtteranceFilters;
5866
+ /**
5867
+ * The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
5868
+ */
5869
+ maxResults?: MaxResults;
5870
+ /**
5871
+ * If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
5872
+ */
5873
+ nextToken?: NextToken;
5874
+ }
5875
+ export interface ListUtteranceAnalyticsDataResponse {
5876
+ /**
5877
+ * The unique identifier of the bot that the utterances belong to.
5878
+ */
5879
+ botId?: Id;
5880
+ /**
5881
+ * If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
5882
+ */
5883
+ nextToken?: NextToken;
5884
+ /**
5885
+ * A list of objects, each of which contains information about an utterance in a user session with your bot.
5886
+ */
5887
+ utterances?: UtteranceSpecifications;
5888
+ }
5889
+ export interface ListUtteranceMetricsRequest {
5890
+ /**
5891
+ * The identifier for the bot for which you want to retrieve utterance metrics.
5892
+ */
5893
+ botId: Id;
5894
+ /**
5895
+ * The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
5896
+ */
5897
+ startDateTime: Timestamp;
5898
+ /**
5899
+ * The date and time that marks the end of the range of time for which you want to see utterance metrics.
5900
+ */
5901
+ endDateTime: Timestamp;
5902
+ /**
5903
+ * A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
5904
+ */
5905
+ metrics: AnalyticsUtteranceMetrics;
5906
+ /**
5907
+ * A list of objects, each of which contains specifications for organizing the results by time.
5908
+ */
5909
+ binBy?: AnalyticsBinByList;
5910
+ /**
5911
+ * A list of objects, each of which specifies how to group the results. You can group by the following criteria: UtteranceText – The transcription of the utterance. UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.
5912
+ */
5913
+ groupBy?: AnalyticsUtteranceGroupByList;
5914
+ /**
5915
+ * A list containing attributes related to the utterance that you want the response to return. The following attributes are possible: LastUsedIntent – The last used intent at the time of the utterance.
5916
+ */
5917
+ attributes?: AnalyticsUtteranceAttributes;
5918
+ /**
5919
+ * A list of objects, each of which describes a condition by which you want to filter the results.
5920
+ */
5921
+ filters?: AnalyticsUtteranceFilters;
5922
+ /**
5923
+ * The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
5924
+ */
5925
+ maxResults?: MaxResults;
5926
+ /**
5927
+ * If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
5928
+ */
5929
+ nextToken?: NextToken;
5930
+ }
5931
+ export interface ListUtteranceMetricsResponse {
5932
+ /**
5933
+ * The identifier for the bot for which you retrieved utterance metrics.
5934
+ */
5935
+ botId?: Id;
5936
+ /**
5937
+ * The results for the utterance metrics.
5938
+ */
5939
+ results?: AnalyticsUtteranceResults;
5940
+ /**
5941
+ * If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
5942
+ */
5943
+ nextToken?: NextToken;
5944
+ }
5123
5945
  export type LocaleId = string;
5124
5946
  export type LocaleName = string;
5125
5947
  export type LogPrefix = string;
@@ -5574,7 +6396,72 @@ declare namespace LexModelsV2 {
5574
6396
  detectSentiment: Boolean;
5575
6397
  }
5576
6398
  export type ServicePrincipal = string;
6399
+ export interface SessionDataSortBy {
6400
+ /**
6401
+ * The measure by which to sort the session analytics data. conversationStartTime – The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId. numberOfTurns – The number of turns that the session took. conversationDurationSeconds – The duration of the conversation in seconds.
6402
+ */
6403
+ name: AnalyticsSessionSortByName;
6404
+ /**
6405
+ * Specifies whether to sort the results in ascending or descending order.
6406
+ */
6407
+ order: AnalyticsSortOrder;
6408
+ }
5577
6409
  export type SessionId = string;
6410
+ export interface SessionSpecification {
6411
+ /**
6412
+ * The identifier of the alias of the bot that the session was held with.
6413
+ */
6414
+ botAliasId?: BotAliasId;
6415
+ /**
6416
+ * The version of the bot that the session was held with.
6417
+ */
6418
+ botVersion?: NumericalBotVersion;
6419
+ /**
6420
+ * The locale of the bot that the session was held with.
6421
+ */
6422
+ localeId?: LocaleId;
6423
+ /**
6424
+ * The channel that is integrated with the bot that the session was held with.
6425
+ */
6426
+ channel?: BotChannelType;
6427
+ /**
6428
+ * The identifier of the session.
6429
+ */
6430
+ sessionId?: AnalyticsSessionId;
6431
+ /**
6432
+ * The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
6433
+ */
6434
+ conversationStartTime?: Timestamp;
6435
+ /**
6436
+ * The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
6437
+ */
6438
+ conversationEndTime?: Timestamp;
6439
+ /**
6440
+ * The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
6441
+ */
6442
+ conversationDurationSeconds?: AnalyticsLongValue;
6443
+ /**
6444
+ * The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
6445
+ */
6446
+ conversationEndState?: ConversationEndState;
6447
+ /**
6448
+ * The mode of the session. The possible values are as follows: Speech – The session was spoken. Text – The session was written. DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency). MultiMode – The session used multiple modes.
6449
+ */
6450
+ mode?: AnalyticsModality;
6451
+ /**
6452
+ * The number of turns that the session took.
6453
+ */
6454
+ numberOfTurns?: AnalyticsLongValue;
6455
+ /**
6456
+ * A list of objects containing the name of an intent that was invoked.
6457
+ */
6458
+ invokedIntentSamples?: InvokedIntentSamples;
6459
+ /**
6460
+ * The identifier of the first request in a session.
6461
+ */
6462
+ originatingRequestId?: AnalyticsOriginatingRequestId;
6463
+ }
6464
+ export type SessionSpecifications = SessionSpecification[];
5578
6465
  export type SessionTTL = number;
5579
6466
  export type SkipResourceInUseCheck = boolean;
5580
6467
  export interface SlotCaptureSetting {
@@ -7421,6 +8308,29 @@ declare namespace LexModelsV2 {
7421
8308
  */
7422
8309
  audioFileS3Location: AudioFileS3Location;
7423
8310
  }
8311
+ export interface UtteranceBotResponse {
8312
+ /**
8313
+ * The text of the response to the utterance from the bot.
8314
+ */
8315
+ content?: String;
8316
+ /**
8317
+ * The type of the response. The following values are possible: PlainText – A plain text string. CustomPayload – A response string that you can customize to include data or metadata for your application. SSML – A string that includes Speech Synthesis Markup Language to customize the audio response. ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.
8318
+ */
8319
+ contentType?: UtteranceContentType;
8320
+ imageResponseCard?: ImageResponseCard;
8321
+ }
8322
+ export type UtteranceBotResponses = UtteranceBotResponse[];
8323
+ export type UtteranceContentType = "PlainText"|"CustomPayload"|"SSML"|"ImageResponseCard"|string;
8324
+ export interface UtteranceDataSortBy {
8325
+ /**
8326
+ * The measure by which to sort the utterance analytics data. Count – The number of utterances. UtteranceTimeStamp – The date and time of the utterance.
8327
+ */
8328
+ name: AnalyticsUtteranceSortByName;
8329
+ /**
8330
+ * Specifies whether to sort the results in ascending or descending order.
8331
+ */
8332
+ order: AnalyticsSortOrder;
8333
+ }
7424
8334
  export interface UtteranceInputSpecification {
7425
8335
  /**
7426
8336
  * A text input transcription of the utterance. It is only applicable for test-sets containing text data.
@@ -7452,6 +8362,98 @@ declare namespace LexModelsV2 {
7452
8362
  */
7453
8363
  items: UtteranceLevelTestResultItemList;
7454
8364
  }
8365
+ export interface UtteranceSpecification {
8366
+ /**
8367
+ * The identifier of the alias of the bot that the utterance was made to.
8368
+ */
8369
+ botAliasId?: BotAliasId;
8370
+ /**
8371
+ * The version of the bot that the utterance was made to.
8372
+ */
8373
+ botVersion?: NumericalBotVersion;
8374
+ /**
8375
+ * The locale of the bot that the utterance was made to.
8376
+ */
8377
+ localeId?: LocaleId;
8378
+ /**
8379
+ * The identifier of the session that the utterance was made in.
8380
+ */
8381
+ sessionId?: AnalyticsSessionId;
8382
+ /**
8383
+ * The channel that is integrated with the bot that the utterance was made to.
8384
+ */
8385
+ channel?: BotChannelType;
8386
+ /**
8387
+ * The mode of the session. The possible values are as follows: Speech – The session consisted of spoken dialogue. Text – The session consisted of written dialogue. DTMF – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses. MultiMode – The session consisted of multiple modes.
8388
+ */
8389
+ mode?: AnalyticsModality;
8390
+ /**
8391
+ * The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
8392
+ */
8393
+ conversationStartTime?: Timestamp;
8394
+ /**
8395
+ * The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.
8396
+ */
8397
+ conversationEndTime?: Timestamp;
8398
+ /**
8399
+ * The text of the utterance.
8400
+ */
8401
+ utterance?: String;
8402
+ /**
8403
+ * The date and time when the utterance took place.
8404
+ */
8405
+ utteranceTimestamp?: Timestamp;
8406
+ /**
8407
+ * The duration in milliseconds of the audio associated with the utterance.
8408
+ */
8409
+ audioVoiceDurationMillis?: AnalyticsLongValue;
8410
+ /**
8411
+ * Specifies whether the bot understood the utterance or not.
8412
+ */
8413
+ utteranceUnderstood?: UtteranceUnderstood;
8414
+ /**
8415
+ * The input type of the utterance. The possible values are as follows: PCM format: audio data must be in little-endian byte order. audio/l16; rate=16000; channels=1 audio/x-l16; sample-rate=16000; channel-count=1 audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false Opus format audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4 Text format text/plain; charset=utf-8
8416
+ */
8417
+ inputType?: String;
8418
+ /**
8419
+ * The output type of the utterance. The possible values are as follows: audio/mpeg audio/ogg audio/pcm (16 KHz) audio/ (defaults to mpeg) text/plain; charset=utf-8
8420
+ */
8421
+ outputType?: String;
8422
+ /**
8423
+ * The name of the intent that the utterance is associated to.
8424
+ */
8425
+ associatedIntentName?: Name;
8426
+ /**
8427
+ * The name of the slot that the utterance is associated to.
8428
+ */
8429
+ associatedSlotName?: Name;
8430
+ /**
8431
+ * The state of the intent that the utterance is associated to.
8432
+ */
8433
+ intentState?: IntentState;
8434
+ /**
8435
+ * The type of dialog action that the utterance is associated to. See the type field in DialogAction for more information.
8436
+ */
8437
+ dialogActionType?: String;
8438
+ /**
8439
+ * The identifier for the audio of the bot response.
8440
+ */
8441
+ botResponseAudioVoiceId?: String;
8442
+ /**
8443
+ * The slots that have been filled in the session by the time of the utterance.
8444
+ */
8445
+ slotsFilledInSession?: String;
8446
+ /**
8447
+ * The identifier of the request associated with the utterance.
8448
+ */
8449
+ utteranceRequestId?: Id;
8450
+ /**
8451
+ * A list of objects containing information about the bot response to the utterance.
8452
+ */
8453
+ botResponses?: UtteranceBotResponses;
8454
+ }
8455
+ export type UtteranceSpecifications = UtteranceSpecification[];
8456
+ export type UtteranceUnderstood = boolean;
7455
8457
  export type Value = string;
7456
8458
  export type VoiceEngine = "standard"|"neural"|string;
7457
8459
  export type VoiceId = string;