@aws-sdk/client-lex-models-v2 3.370.0 → 3.374.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.
Files changed (94) hide show
  1. package/README.md +56 -0
  2. package/dist-cjs/LexModelsV2.js +14 -0
  3. package/dist-cjs/commands/ListIntentMetricsCommand.js +46 -0
  4. package/dist-cjs/commands/ListIntentPathsCommand.js +46 -0
  5. package/dist-cjs/commands/ListIntentStageMetricsCommand.js +46 -0
  6. package/dist-cjs/commands/ListSessionAnalyticsDataCommand.js +46 -0
  7. package/dist-cjs/commands/ListSessionMetricsCommand.js +46 -0
  8. package/dist-cjs/commands/ListUtteranceAnalyticsDataCommand.js +46 -0
  9. package/dist-cjs/commands/ListUtteranceMetricsCommand.js +46 -0
  10. package/dist-cjs/commands/index.js +7 -0
  11. package/dist-cjs/models/models_0.js +148 -79
  12. package/dist-cjs/models/models_1.js +92 -1
  13. package/dist-cjs/pagination/ListIntentMetricsPaginator.js +29 -0
  14. package/dist-cjs/pagination/ListIntentStageMetricsPaginator.js +29 -0
  15. package/dist-cjs/pagination/ListSessionAnalyticsDataPaginator.js +29 -0
  16. package/dist-cjs/pagination/ListSessionMetricsPaginator.js +29 -0
  17. package/dist-cjs/pagination/ListUtteranceAnalyticsDataPaginator.js +29 -0
  18. package/dist-cjs/pagination/ListUtteranceMetricsPaginator.js +29 -0
  19. package/dist-cjs/pagination/index.js +6 -0
  20. package/dist-cjs/protocols/Aws_restJson1.js +767 -56
  21. package/dist-es/LexModelsV2.js +14 -0
  22. package/dist-es/commands/ListIntentMetricsCommand.js +42 -0
  23. package/dist-es/commands/ListIntentPathsCommand.js +42 -0
  24. package/dist-es/commands/ListIntentStageMetricsCommand.js +42 -0
  25. package/dist-es/commands/ListSessionAnalyticsDataCommand.js +42 -0
  26. package/dist-es/commands/ListSessionMetricsCommand.js +42 -0
  27. package/dist-es/commands/ListUtteranceAnalyticsDataCommand.js +42 -0
  28. package/dist-es/commands/ListUtteranceMetricsCommand.js +42 -0
  29. package/dist-es/commands/index.js +7 -0
  30. package/dist-es/models/models_0.js +146 -77
  31. package/dist-es/models/models_1.js +91 -0
  32. package/dist-es/pagination/ListIntentMetricsPaginator.js +25 -0
  33. package/dist-es/pagination/ListIntentStageMetricsPaginator.js +25 -0
  34. package/dist-es/pagination/ListSessionAnalyticsDataPaginator.js +25 -0
  35. package/dist-es/pagination/ListSessionMetricsPaginator.js +25 -0
  36. package/dist-es/pagination/ListUtteranceAnalyticsDataPaginator.js +25 -0
  37. package/dist-es/pagination/ListUtteranceMetricsPaginator.js +25 -0
  38. package/dist-es/pagination/index.js +6 -0
  39. package/dist-es/protocols/Aws_restJson1.js +749 -52
  40. package/dist-types/LexModelsV2.d.ts +49 -0
  41. package/dist-types/LexModelsV2Client.d.ts +9 -2
  42. package/dist-types/commands/DescribeSlotTypeCommand.d.ts +2 -1
  43. package/dist-types/commands/DescribeTestExecutionCommand.d.ts +1 -1
  44. package/dist-types/commands/DescribeTestSetCommand.d.ts +1 -1
  45. package/dist-types/commands/DescribeTestSetDiscrepancyReportCommand.d.ts +1 -1
  46. package/dist-types/commands/DescribeTestSetGenerationCommand.d.ts +1 -1
  47. package/dist-types/commands/GetTestExecutionArtifactsUrlCommand.d.ts +1 -1
  48. package/dist-types/commands/ListAggregatedUtterancesCommand.d.ts +1 -1
  49. package/dist-types/commands/ListIntentMetricsCommand.d.ts +169 -0
  50. package/dist-types/commands/ListIntentPathsCommand.d.ts +124 -0
  51. package/dist-types/commands/ListIntentStageMetricsCommand.d.ts +169 -0
  52. package/dist-types/commands/ListSessionAnalyticsDataCommand.d.ts +140 -0
  53. package/dist-types/commands/ListSessionMetricsCommand.d.ts +169 -0
  54. package/dist-types/commands/ListUtteranceAnalyticsDataCommand.d.ts +174 -0
  55. package/dist-types/commands/ListUtteranceMetricsCommand.d.ts +185 -0
  56. package/dist-types/commands/index.d.ts +7 -0
  57. package/dist-types/models/models_0.d.ts +4423 -3748
  58. package/dist-types/models/models_1.d.ts +2016 -53
  59. package/dist-types/pagination/ListIntentMetricsPaginator.d.ts +7 -0
  60. package/dist-types/pagination/ListIntentStageMetricsPaginator.d.ts +7 -0
  61. package/dist-types/pagination/ListSessionAnalyticsDataPaginator.d.ts +7 -0
  62. package/dist-types/pagination/ListSessionMetricsPaginator.d.ts +7 -0
  63. package/dist-types/pagination/ListUtteranceAnalyticsDataPaginator.d.ts +7 -0
  64. package/dist-types/pagination/ListUtteranceMetricsPaginator.d.ts +7 -0
  65. package/dist-types/pagination/index.d.ts +6 -0
  66. package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
  67. package/dist-types/ts3.4/LexModelsV2.d.ts +119 -0
  68. package/dist-types/ts3.4/LexModelsV2Client.d.ts +42 -0
  69. package/dist-types/ts3.4/commands/DescribeSlotTypeCommand.d.ts +2 -4
  70. package/dist-types/ts3.4/commands/DescribeTestExecutionCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/DescribeTestSetCommand.d.ts +1 -1
  72. package/dist-types/ts3.4/commands/DescribeTestSetDiscrepancyReportCommand.d.ts +1 -1
  73. package/dist-types/ts3.4/commands/DescribeTestSetGenerationCommand.d.ts +1 -1
  74. package/dist-types/ts3.4/commands/GetTestExecutionArtifactsUrlCommand.d.ts +1 -1
  75. package/dist-types/ts3.4/commands/ListAggregatedUtterancesCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/ListIntentMetricsCommand.d.ts +39 -0
  77. package/dist-types/ts3.4/commands/ListIntentPathsCommand.d.ts +38 -0
  78. package/dist-types/ts3.4/commands/ListIntentStageMetricsCommand.d.ts +42 -0
  79. package/dist-types/ts3.4/commands/ListSessionAnalyticsDataCommand.d.ts +42 -0
  80. package/dist-types/ts3.4/commands/ListSessionMetricsCommand.d.ts +39 -0
  81. package/dist-types/ts3.4/commands/ListUtteranceAnalyticsDataCommand.d.ts +42 -0
  82. package/dist-types/ts3.4/commands/ListUtteranceMetricsCommand.d.ts +42 -0
  83. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  84. package/dist-types/ts3.4/models/models_0.d.ts +330 -327
  85. package/dist-types/ts3.4/models/models_1.d.ts +534 -19
  86. package/dist-types/ts3.4/pagination/ListIntentMetricsPaginator.d.ts +11 -0
  87. package/dist-types/ts3.4/pagination/ListIntentStageMetricsPaginator.d.ts +11 -0
  88. package/dist-types/ts3.4/pagination/ListSessionAnalyticsDataPaginator.d.ts +11 -0
  89. package/dist-types/ts3.4/pagination/ListSessionMetricsPaginator.d.ts +11 -0
  90. package/dist-types/ts3.4/pagination/ListUtteranceAnalyticsDataPaginator.d.ts +11 -0
  91. package/dist-types/ts3.4/pagination/ListUtteranceMetricsPaginator.d.ts +11 -0
  92. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  93. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +84 -0
  94. package/package.json +1 -1
@@ -1,4 +1,1167 @@
1
- import { ActiveContext, AgentTurnResult, AgentTurnSpecification, AssociatedTranscript, AssociatedTranscriptFilter, BotAliasLocaleSettings, BotAliasStatus, BotAliasSummary, BotFilter, BotLocaleFilter, BotLocaleSortBy, BotLocaleStatus, BotLocaleSummary, BotMember, BotRecommendationStatus, BotRecommendationSummary, BotSortBy, BotStatus, BotSummary, BotType, BotVersionSortBy, BotVersionSummary, BuiltInIntentSortBy, BuiltInIntentSummary, BuiltInSlotTypeSortBy, BuiltInSlotTypeSummary, CompositeSlotTypeSetting, Condition, ConversationLevelResultDetail, ConversationLevelTestResults, ConversationLevelTestResultsFilterBy, ConversationLogSettings, CustomVocabularyItem, DataPrivacy, DialogAction, DialogCodeHookSettings, ElicitationCodeHookInvocationSetting, EncryptionSetting, ExecutionErrorDetails, ExportFilter, ExportResourceSpecification, ExportSortBy, ExportStatus, ExportSummary, ExternalSourceSetting, FulfillmentUpdatesSpecification, ImportExportFileFormat, ImportFilter, ImportResourceSpecification, ImportSortBy, ImportStatus, ImportSummary, InputContext, IntentClassificationTestResults, IntentFilter, IntentLevelSlotResolutionTestResults, IntentSortBy, IntentSummary, KendraConfiguration, MergeStrategy, MultipleValuesSetting, ObfuscationSetting, OutputContext, PromptSpecification, ResponseSpecification, RuntimeHintValue, SampleUtterance, SentimentAnalysisSettings, SlotConstraint, SlotDefaultValueSpecification, SlotPriority, SlotShape, SlotTypeValue, SlotValue, SlotValueSelectionSetting, SortOrder, SubSlotSetting, TestExecutionApiMode, TestExecutionModality, TestExecutionStatus, TestExecutionTarget, TestResultMatchStatus, TestSetGenerationDataSource, TestSetGenerationStatus, TestSetModality, TestSetStatus, TestSetStorageLocation, TranscriptSourceSetting, VoiceSettings, WaitAndContinueSpecification } from "./models_0";
1
+ import { ActiveContext, AgentTurnResult, AgentTurnSpecification, AggregatedUtterancesFilter, AggregatedUtterancesSortBy, AggregatedUtterancesSummary, AnalyticsBinBySpecification, AnalyticsIntentFilter, AnalyticsIntentGroupBySpecification, AnalyticsIntentMetric, AnalyticsIntentNodeSummary, AnalyticsIntentResult, AnalyticsIntentStageFilter, AnalyticsIntentStageGroupBySpecification, AnalyticsIntentStageMetric, AnalyticsIntentStageResult, AnalyticsModality, AnalyticsPathFilter, AnalyticsSessionFilter, AnalyticsSessionGroupBySpecification, AnalyticsSessionMetric, AnalyticsSessionResult, AnalyticsSessionSortByName, AnalyticsSortOrder, AnalyticsUtteranceAttribute, AnalyticsUtteranceFilter, AnalyticsUtteranceGroupBySpecification, AnalyticsUtteranceMetric, AnalyticsUtteranceResult, AnalyticsUtteranceSortByName, AssociatedTranscript, AssociatedTranscriptFilter, BotAliasLocaleSettings, BotAliasStatus, BotAliasSummary, BotAliasTestExecutionTarget, BotFilter, BotLocaleFilter, BotLocaleSortBy, BotLocaleStatus, BotLocaleSummary, BotMember, BotRecommendationStatus, BotRecommendationSummary, BotSortBy, BotStatus, BotSummary, BotType, BotVersionSortBy, BotVersionSummary, BuiltInIntentSortBy, BuiltInIntentSummary, BuiltInSlotTypeSortBy, BuiltInSlotTypeSummary, CompositeSlotTypeSetting, Condition, ConversationEndState, ConversationLevelResultDetail, ConversationLevelTestResults, ConversationLevelTestResultsFilterBy, ConversationLogsDataSource, ConversationLogSettings, CustomVocabularyItem, DataPrivacy, DialogAction, DialogCodeHookSettings, ElicitationCodeHookInvocationSetting, EncryptionSetting, ExecutionErrorDetails, ExportResourceSpecification, ExportStatus, ExternalSourceSetting, FulfillmentUpdatesSpecification, ImageResponseCard, ImportExportFileFormat, ImportResourceSpecification, ImportStatus, InputContext, KendraConfiguration, MergeStrategy, MultipleValuesSetting, ObfuscationSetting, OutputContext, PromptSpecification, ResponseSpecification, SampleUtterance, SentimentAnalysisSettings, SlotConstraint, SlotDefaultValueSpecification, SlotPriority, SlotShape, SlotTypeValue, SlotValue, SlotValueSelectionSetting, SortOrder, SubSlotSetting, TestResultMatchStatus, TestSetDiscrepancyReportResourceTarget, TestSetModality, TestSetStorageLocation, TranscriptSourceSetting, VoiceSettings, WaitAndContinueSpecification } from "./models_0";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface DescribeSlotTypeResponse {
6
+ /**
7
+ * <p>The unique identifier for the slot type.</p>
8
+ */
9
+ slotTypeId?: string;
10
+ /**
11
+ * <p>The name specified for the slot type.</p>
12
+ */
13
+ slotTypeName?: string;
14
+ /**
15
+ * <p>The description specified for the slot type.</p>
16
+ */
17
+ description?: string;
18
+ /**
19
+ * <p>The values that the slot type can take. Includes any synonyms for
20
+ * the slot type values.</p>
21
+ */
22
+ slotTypeValues?: SlotTypeValue[];
23
+ /**
24
+ * <p>The strategy that Amazon Lex uses to choose a value from a list of
25
+ * possible values.</p>
26
+ */
27
+ valueSelectionSetting?: SlotValueSelectionSetting;
28
+ /**
29
+ * <p>The built in slot type used as a parent to this slot type.</p>
30
+ */
31
+ parentSlotTypeSignature?: string;
32
+ /**
33
+ * <p>The identifier of the bot associated with the slot type.</p>
34
+ */
35
+ botId?: string;
36
+ /**
37
+ * <p>The version of the bot associated with the slot type.</p>
38
+ */
39
+ botVersion?: string;
40
+ /**
41
+ * <p>The language and locale specified for the slot type.</p>
42
+ */
43
+ localeId?: string;
44
+ /**
45
+ * <p>A timestamp of the date and time that the slot type was
46
+ * created.</p>
47
+ */
48
+ creationDateTime?: Date;
49
+ /**
50
+ * <p>A timestamp of the date and time that the slot type was last
51
+ * updated.</p>
52
+ */
53
+ lastUpdatedDateTime?: Date;
54
+ /**
55
+ * <p>Provides information about the external source of the slot type's definition.</p>
56
+ */
57
+ externalSourceSetting?: ExternalSourceSetting;
58
+ /**
59
+ * <p>Specifications for a composite slot type.</p>
60
+ */
61
+ compositeSlotTypeSetting?: CompositeSlotTypeSetting;
62
+ }
63
+ /**
64
+ * @public
65
+ */
66
+ export interface DescribeTestExecutionRequest {
67
+ /**
68
+ * <p>The execution Id of the test set execution.</p>
69
+ */
70
+ testExecutionId: string | undefined;
71
+ }
72
+ /**
73
+ * @public
74
+ * @enum
75
+ */
76
+ export declare const TestExecutionApiMode: {
77
+ readonly NonStreaming: "NonStreaming";
78
+ readonly Streaming: "Streaming";
79
+ };
80
+ /**
81
+ * @public
82
+ */
83
+ export type TestExecutionApiMode = (typeof TestExecutionApiMode)[keyof typeof TestExecutionApiMode];
84
+ /**
85
+ * @public
86
+ * <p>Contains information about the bot used for the test execution.</p>
87
+ */
88
+ export interface TestExecutionTarget {
89
+ /**
90
+ * <p>Contains information about the bot alias used for the test execution.</p>
91
+ */
92
+ botAliasTarget?: BotAliasTestExecutionTarget;
93
+ }
94
+ /**
95
+ * @public
96
+ * @enum
97
+ */
98
+ export declare const TestExecutionModality: {
99
+ readonly Audio: "Audio";
100
+ readonly Text: "Text";
101
+ };
102
+ /**
103
+ * @public
104
+ */
105
+ export type TestExecutionModality = (typeof TestExecutionModality)[keyof typeof TestExecutionModality];
106
+ /**
107
+ * @public
108
+ * @enum
109
+ */
110
+ export declare const TestExecutionStatus: {
111
+ readonly Completed: "Completed";
112
+ readonly Failed: "Failed";
113
+ readonly InProgress: "InProgress";
114
+ readonly Pending: "Pending";
115
+ readonly Stopped: "Stopped";
116
+ readonly Stopping: "Stopping";
117
+ readonly Waiting: "Waiting";
118
+ };
119
+ /**
120
+ * @public
121
+ */
122
+ export type TestExecutionStatus = (typeof TestExecutionStatus)[keyof typeof TestExecutionStatus];
123
+ /**
124
+ * @public
125
+ */
126
+ export interface DescribeTestExecutionResponse {
127
+ /**
128
+ * <p>The execution Id for the test set execution.</p>
129
+ */
130
+ testExecutionId?: string;
131
+ /**
132
+ * <p>The execution creation date and time for the test set execution.</p>
133
+ */
134
+ creationDateTime?: Date;
135
+ /**
136
+ * <p>The date and time of the last update for the execution.</p>
137
+ */
138
+ lastUpdatedDateTime?: Date;
139
+ /**
140
+ * <p>The test execution status for the test execution.</p>
141
+ */
142
+ testExecutionStatus?: TestExecutionStatus | string;
143
+ /**
144
+ * <p>The test set Id for the test set execution.</p>
145
+ */
146
+ testSetId?: string;
147
+ /**
148
+ * <p>The test set name of the test set execution.</p>
149
+ */
150
+ testSetName?: string;
151
+ /**
152
+ * <p>The target bot for the test set execution details.</p>
153
+ */
154
+ target?: TestExecutionTarget;
155
+ /**
156
+ * <p>Indicates whether we use streaming or non-streaming APIs are used for
157
+ * the test set execution. For streaming, <code>StartConversation</code>
158
+ * Amazon Lex Runtime API is used. Whereas for non-streaming, <code>RecognizeUtterance</code>
159
+ * and <code>RecognizeText</code> Amazon Lex Runtime API is used.</p>
160
+ */
161
+ apiMode?: TestExecutionApiMode | string;
162
+ /**
163
+ * <p>Indicates whether test set is audio or text.</p>
164
+ */
165
+ testExecutionModality?: TestExecutionModality | string;
166
+ /**
167
+ * <p>Reasons for the failure of the test set execution.</p>
168
+ */
169
+ failureReasons?: string[];
170
+ }
171
+ /**
172
+ * @public
173
+ */
174
+ export interface DescribeTestSetRequest {
175
+ /**
176
+ * <p>The test set Id for the test set request.</p>
177
+ */
178
+ testSetId: string | undefined;
179
+ }
180
+ /**
181
+ * @public
182
+ * @enum
183
+ */
184
+ export declare const TestSetStatus: {
185
+ readonly Deleting: "Deleting";
186
+ readonly Importing: "Importing";
187
+ readonly PendingAnnotation: "PendingAnnotation";
188
+ readonly Ready: "Ready";
189
+ readonly ValidationError: "ValidationError";
190
+ };
191
+ /**
192
+ * @public
193
+ */
194
+ export type TestSetStatus = (typeof TestSetStatus)[keyof typeof TestSetStatus];
195
+ /**
196
+ * @public
197
+ */
198
+ export interface DescribeTestSetResponse {
199
+ /**
200
+ * <p>The test set Id for the test set response.</p>
201
+ */
202
+ testSetId?: string;
203
+ /**
204
+ * <p>The test set name of the test set.</p>
205
+ */
206
+ testSetName?: string;
207
+ /**
208
+ * <p>The description of the test set.</p>
209
+ */
210
+ description?: string;
211
+ /**
212
+ * <p>Indicates whether the test set is audio or text data.</p>
213
+ */
214
+ modality?: TestSetModality | string;
215
+ /**
216
+ * <p>The status of the test set.</p>
217
+ */
218
+ status?: TestSetStatus | string;
219
+ /**
220
+ * <p>The roleARN used for any operation in the test set to access
221
+ * resources in the Amazon Web Services account.</p>
222
+ */
223
+ roleArn?: string;
224
+ /**
225
+ * <p>The total number of agent and user turn in the test set.</p>
226
+ */
227
+ numTurns?: number;
228
+ /**
229
+ * <p>The Amazon S3 storage location for the test set data.</p>
230
+ */
231
+ storageLocation?: TestSetStorageLocation;
232
+ /**
233
+ * <p>The creation date and time for the test set data.</p>
234
+ */
235
+ creationDateTime?: Date;
236
+ /**
237
+ * <p>The date and time for the last update of the test set data.</p>
238
+ */
239
+ lastUpdatedDateTime?: Date;
240
+ }
241
+ /**
242
+ * @public
243
+ */
244
+ export interface DescribeTestSetDiscrepancyReportRequest {
245
+ /**
246
+ * <p>The unique identifier of the test set discrepancy report.</p>
247
+ */
248
+ testSetDiscrepancyReportId: string | undefined;
249
+ }
250
+ /**
251
+ * @public
252
+ * @enum
253
+ */
254
+ export declare const TestSetDiscrepancyReportStatus: {
255
+ readonly Completed: "Completed";
256
+ readonly Failed: "Failed";
257
+ readonly InProgress: "InProgress";
258
+ };
259
+ /**
260
+ * @public
261
+ */
262
+ export type TestSetDiscrepancyReportStatus = (typeof TestSetDiscrepancyReportStatus)[keyof typeof TestSetDiscrepancyReportStatus];
263
+ /**
264
+ * @public
265
+ * <p>Contains information about discrepancy in an intent information between the test set and the
266
+ * bot.</p>
267
+ */
268
+ export interface TestSetIntentDiscrepancyItem {
269
+ /**
270
+ * <p>The name of the intent in the discrepancy report.</p>
271
+ */
272
+ intentName: string | undefined;
273
+ /**
274
+ * <p>The error message for a discrepancy for an intent between the test set and the bot.</p>
275
+ */
276
+ errorMessage: string | undefined;
277
+ }
278
+ /**
279
+ * @public
280
+ * <p>Contains information about discrepancy in a slot information between the test set and the bot.</p>
281
+ */
282
+ export interface TestSetSlotDiscrepancyItem {
283
+ /**
284
+ * <p>The name of the intent associated with the slot in the discrepancy report.</p>
285
+ */
286
+ intentName: string | undefined;
287
+ /**
288
+ * <p>The name of the slot in the discrepancy report.</p>
289
+ */
290
+ slotName: string | undefined;
291
+ /**
292
+ * <p>The error message for a discrepancy for an intent between the test set and the bot.</p>
293
+ */
294
+ errorMessage: string | undefined;
295
+ }
296
+ /**
297
+ * @public
298
+ * <p>Contains details about the errors in the test set discrepancy report</p>
299
+ */
300
+ export interface TestSetDiscrepancyErrors {
301
+ /**
302
+ * <p>Contains information about discrepancies found for intents between the test set and the bot.</p>
303
+ */
304
+ intentDiscrepancies: TestSetIntentDiscrepancyItem[] | undefined;
305
+ /**
306
+ * <p>Contains information about discrepancies found for slots between the test set and the bot.</p>
307
+ */
308
+ slotDiscrepancies: TestSetSlotDiscrepancyItem[] | undefined;
309
+ }
310
+ /**
311
+ * @public
312
+ */
313
+ export interface DescribeTestSetDiscrepancyReportResponse {
314
+ /**
315
+ * <p>The unique identifier of the test set discrepancy report to describe.</p>
316
+ */
317
+ testSetDiscrepancyReportId?: string;
318
+ /**
319
+ * <p>The test set Id for the test set discrepancy report.</p>
320
+ */
321
+ testSetId?: string;
322
+ /**
323
+ * <p>The time and date of creation for the test set discrepancy report.</p>
324
+ */
325
+ creationDateTime?: Date;
326
+ /**
327
+ * <p>The target bot location for the test set discrepancy report.</p>
328
+ */
329
+ target?: TestSetDiscrepancyReportResourceTarget;
330
+ /**
331
+ * <p>The status for the test set discrepancy report.</p>
332
+ */
333
+ testSetDiscrepancyReportStatus?: TestSetDiscrepancyReportStatus | string;
334
+ /**
335
+ * <p>The date and time of the last update for the test set discrepancy report.</p>
336
+ */
337
+ lastUpdatedDataTime?: Date;
338
+ /**
339
+ * <p>The top 200 error results from the test set discrepancy report.</p>
340
+ */
341
+ testSetDiscrepancyTopErrors?: TestSetDiscrepancyErrors;
342
+ /**
343
+ * <p>Pre-signed Amazon S3 URL to download the test set discrepancy report.</p>
344
+ */
345
+ testSetDiscrepancyRawOutputUrl?: string;
346
+ /**
347
+ * <p>The failure report for the test set discrepancy report generation action.</p>
348
+ */
349
+ failureReasons?: string[];
350
+ }
351
+ /**
352
+ * @public
353
+ */
354
+ export interface DescribeTestSetGenerationRequest {
355
+ /**
356
+ * <p>The unique identifier of the test set generation.</p>
357
+ */
358
+ testSetGenerationId: string | undefined;
359
+ }
360
+ /**
361
+ * @public
362
+ * <p>Contains information about the data source from which the test set is generated.</p>
363
+ */
364
+ export interface TestSetGenerationDataSource {
365
+ /**
366
+ * <p>Contains information about the bot from which the conversation logs are sourced.</p>
367
+ */
368
+ conversationLogsDataSource?: ConversationLogsDataSource;
369
+ }
370
+ /**
371
+ * @public
372
+ * @enum
373
+ */
374
+ export declare const TestSetGenerationStatus: {
375
+ readonly Failed: "Failed";
376
+ readonly Generating: "Generating";
377
+ readonly Pending: "Pending";
378
+ readonly Ready: "Ready";
379
+ };
380
+ /**
381
+ * @public
382
+ */
383
+ export type TestSetGenerationStatus = (typeof TestSetGenerationStatus)[keyof typeof TestSetGenerationStatus];
384
+ /**
385
+ * @public
386
+ */
387
+ export interface DescribeTestSetGenerationResponse {
388
+ /**
389
+ * <p>The unique identifier of the test set generation.</p>
390
+ */
391
+ testSetGenerationId?: string;
392
+ /**
393
+ * <p>The status for the test set generation.</p>
394
+ */
395
+ testSetGenerationStatus?: TestSetGenerationStatus | string;
396
+ /**
397
+ * <p>The reasons the test set generation failed.</p>
398
+ */
399
+ failureReasons?: string[];
400
+ /**
401
+ * <p>The unique identifier for the test set created for the generated test set.</p>
402
+ */
403
+ testSetId?: string;
404
+ /**
405
+ * <p>The test set name for the generated test set.</p>
406
+ */
407
+ testSetName?: string;
408
+ /**
409
+ * <p>The test set description for the test set generation.</p>
410
+ */
411
+ description?: string;
412
+ /**
413
+ * <p>The Amazon S3 storage location for the test set generation.</p>
414
+ */
415
+ storageLocation?: TestSetStorageLocation;
416
+ /**
417
+ * <p>The data source of the test set used for the test set generation.</p>
418
+ */
419
+ generationDataSource?: TestSetGenerationDataSource;
420
+ /**
421
+ * <p> The roleARN of the test set used for the test set generation.</p>
422
+ */
423
+ roleArn?: string;
424
+ /**
425
+ * <p>The creation date and time for the test set generation.</p>
426
+ */
427
+ creationDateTime?: Date;
428
+ /**
429
+ * <p>The date and time of the last update for the test set generation.</p>
430
+ */
431
+ lastUpdatedDateTime?: Date;
432
+ }
433
+ /**
434
+ * @public
435
+ * @enum
436
+ */
437
+ export declare const ExportFilterName: {
438
+ readonly ExportResourceType: "ExportResourceType";
439
+ };
440
+ /**
441
+ * @public
442
+ */
443
+ export type ExportFilterName = (typeof ExportFilterName)[keyof typeof ExportFilterName];
444
+ /**
445
+ * @public
446
+ * @enum
447
+ */
448
+ export declare const ExportFilterOperator: {
449
+ readonly Contains: "CO";
450
+ readonly Equals: "EQ";
451
+ };
452
+ /**
453
+ * @public
454
+ */
455
+ export type ExportFilterOperator = (typeof ExportFilterOperator)[keyof typeof ExportFilterOperator];
456
+ /**
457
+ * @public
458
+ * <p>Filters the response form the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html">ListExports</a> operation</p>
459
+ */
460
+ export interface ExportFilter {
461
+ /**
462
+ * <p>The name of the field to use for filtering.</p>
463
+ */
464
+ name: ExportFilterName | string | undefined;
465
+ /**
466
+ * <p>The values to use to filter the response. The values must be
467
+ * <code>Bot</code>, <code>BotLocale</code>, or
468
+ * <code>CustomVocabulary</code>.</p>
469
+ */
470
+ values: string[] | undefined;
471
+ /**
472
+ * <p>The operator to use for the filter. Specify EQ when the
473
+ * <code>ListExports</code> operation should return only resource types
474
+ * that equal the specified value. Specify CO when the
475
+ * <code>ListExports</code> operation should return resource types that
476
+ * contain the specified value.</p>
477
+ */
478
+ operator: ExportFilterOperator | string | undefined;
479
+ }
480
+ /**
481
+ * @public
482
+ * @enum
483
+ */
484
+ export declare const ExportSortAttribute: {
485
+ readonly LastUpdatedDateTime: "LastUpdatedDateTime";
486
+ };
487
+ /**
488
+ * @public
489
+ */
490
+ export type ExportSortAttribute = (typeof ExportSortAttribute)[keyof typeof ExportSortAttribute];
491
+ /**
492
+ * @public
493
+ * <p>Provides information about sorting a list of exports.</p>
494
+ */
495
+ export interface ExportSortBy {
496
+ /**
497
+ * <p>The export field to use for sorting.</p>
498
+ */
499
+ attribute: ExportSortAttribute | string | undefined;
500
+ /**
501
+ * <p>The order to sort the list.</p>
502
+ */
503
+ order: SortOrder | string | undefined;
504
+ }
505
+ /**
506
+ * @public
507
+ * <p>Provides summary information about an export in an export list.
508
+ * </p>
509
+ */
510
+ export interface ExportSummary {
511
+ /**
512
+ * <p>The unique identifier that Amazon Lex assigned to the export.</p>
513
+ */
514
+ exportId?: string;
515
+ /**
516
+ * <p>Information about the bot or bot locale that was exported.</p>
517
+ */
518
+ resourceSpecification?: ExportResourceSpecification;
519
+ /**
520
+ * <p>The file format used in the export files.</p>
521
+ */
522
+ fileFormat?: ImportExportFileFormat | string;
523
+ /**
524
+ * <p>The status of the export. When the status is <code>Completed</code>
525
+ * the export is ready to download.</p>
526
+ */
527
+ exportStatus?: ExportStatus | string;
528
+ /**
529
+ * <p>The date and time that the export was created.</p>
530
+ */
531
+ creationDateTime?: Date;
532
+ /**
533
+ * <p>The date and time that the export was last updated.</p>
534
+ */
535
+ lastUpdatedDateTime?: Date;
536
+ }
537
+ /**
538
+ * @public
539
+ */
540
+ export interface GetTestExecutionArtifactsUrlRequest {
541
+ /**
542
+ * <p>The unique identifier of the completed test execution.</p>
543
+ */
544
+ testExecutionId: string | undefined;
545
+ }
546
+ /**
547
+ * @public
548
+ */
549
+ export interface GetTestExecutionArtifactsUrlResponse {
550
+ /**
551
+ * <p>The unique identifier of the completed test execution.</p>
552
+ */
553
+ testExecutionId?: string;
554
+ /**
555
+ * <p>The pre-signed Amazon S3 URL to download completed test execution.</p>
556
+ */
557
+ downloadArtifactsUrl?: string;
558
+ }
559
+ /**
560
+ * @public
561
+ * @enum
562
+ */
563
+ export declare const ImportFilterName: {
564
+ readonly ImportResourceType: "ImportResourceType";
565
+ };
566
+ /**
567
+ * @public
568
+ */
569
+ export type ImportFilterName = (typeof ImportFilterName)[keyof typeof ImportFilterName];
570
+ /**
571
+ * @public
572
+ * @enum
573
+ */
574
+ export declare const ImportFilterOperator: {
575
+ readonly Contains: "CO";
576
+ readonly Equals: "EQ";
577
+ };
578
+ /**
579
+ * @public
580
+ */
581
+ export type ImportFilterOperator = (typeof ImportFilterOperator)[keyof typeof ImportFilterOperator];
582
+ /**
583
+ * @public
584
+ * <p>Filters the response from the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html">ListImports</a> operation.</p>
585
+ */
586
+ export interface ImportFilter {
587
+ /**
588
+ * <p>The name of the field to use for filtering.</p>
589
+ */
590
+ name: ImportFilterName | string | undefined;
591
+ /**
592
+ * <p>The values to use to filter the response. The values must be
593
+ * <code>Bot</code>, <code>BotLocale</code>, or
594
+ * <code>CustomVocabulary</code>.</p>
595
+ */
596
+ values: string[] | undefined;
597
+ /**
598
+ * <p>The operator to use for the filter. Specify EQ when the
599
+ * <code>ListImports</code> operation should return only resource types
600
+ * that equal the specified value. Specify CO when the
601
+ * <code>ListImports</code> operation should return resource types that
602
+ * contain the specified value.</p>
603
+ */
604
+ operator: ImportFilterOperator | string | undefined;
605
+ }
606
+ /**
607
+ * @public
608
+ * @enum
609
+ */
610
+ export declare const ImportResourceType: {
611
+ readonly Bot: "Bot";
612
+ readonly BotLocale: "BotLocale";
613
+ readonly CustomVocabulary: "CustomVocabulary";
614
+ readonly TestSet: "TestSet";
615
+ };
616
+ /**
617
+ * @public
618
+ */
619
+ export type ImportResourceType = (typeof ImportResourceType)[keyof typeof ImportResourceType];
620
+ /**
621
+ * @public
622
+ * @enum
623
+ */
624
+ export declare const ImportSortAttribute: {
625
+ readonly LastUpdatedDateTime: "LastUpdatedDateTime";
626
+ };
627
+ /**
628
+ * @public
629
+ */
630
+ export type ImportSortAttribute = (typeof ImportSortAttribute)[keyof typeof ImportSortAttribute];
631
+ /**
632
+ * @public
633
+ * <p>Provides information for sorting a list of imports.</p>
634
+ */
635
+ export interface ImportSortBy {
636
+ /**
637
+ * <p>The export field to use for sorting.</p>
638
+ */
639
+ attribute: ImportSortAttribute | string | undefined;
640
+ /**
641
+ * <p>The order to sort the list.</p>
642
+ */
643
+ order: SortOrder | string | undefined;
644
+ }
645
+ /**
646
+ * @public
647
+ * <p>Provides summary information about an import in an import
648
+ * list.</p>
649
+ */
650
+ export interface ImportSummary {
651
+ /**
652
+ * <p>The unique identifier that Amazon Lex assigned to the import.</p>
653
+ */
654
+ importId?: string;
655
+ /**
656
+ * <p>The unique identifier that Amazon Lex assigned to the imported
657
+ * resource.</p>
658
+ */
659
+ importedResourceId?: string;
660
+ /**
661
+ * <p>The name that you gave the imported resource.</p>
662
+ */
663
+ importedResourceName?: string;
664
+ /**
665
+ * <p>The status of the resource. When the status is
666
+ * <code>Completed</code> the resource is ready to build.</p>
667
+ */
668
+ importStatus?: ImportStatus | string;
669
+ /**
670
+ * <p>The strategy used to merge existing bot or bot locale definitions
671
+ * with the imported definition.</p>
672
+ */
673
+ mergeStrategy?: MergeStrategy | string;
674
+ /**
675
+ * <p>The date and time that the import was created.</p>
676
+ */
677
+ creationDateTime?: Date;
678
+ /**
679
+ * <p>The date and time that the import was last updated.</p>
680
+ */
681
+ lastUpdatedDateTime?: Date;
682
+ /**
683
+ * <p>The type of resource that was imported.</p>
684
+ */
685
+ importedResourceType?: ImportResourceType | string;
686
+ }
687
+ /**
688
+ * @public
689
+ * <p>Provides the phrase that Amazon Lex should look for in the user's input
690
+ * to the bot.</p>
691
+ */
692
+ export interface RuntimeHintValue {
693
+ /**
694
+ * <p>The phrase that Amazon Lex should look for in the user's input to the
695
+ * bot.</p>
696
+ */
697
+ phrase: string | undefined;
698
+ }
699
+ /**
700
+ * @public
701
+ * <p>The number of items in the intent classification test.</p>
702
+ */
703
+ export interface IntentClassificationTestResultItemCounts {
704
+ /**
705
+ * <p>The total number of results in the intent classification test.</p>
706
+ */
707
+ totalResultCount: number | undefined;
708
+ /**
709
+ * <p>The number of matched, mismatched, and execution error results for speech transcription for the intent.</p>
710
+ */
711
+ speechTranscriptionResultCounts?: Record<string, number>;
712
+ /**
713
+ * <p>The number of matched and mismatched results for intent recognition for the intent.</p>
714
+ */
715
+ intentMatchResultCounts: Record<string, number> | undefined;
716
+ }
717
+ /**
718
+ * @public
719
+ * <p>Information for an intent that is classified by the test workbench.</p>
720
+ */
721
+ export interface IntentClassificationTestResultItem {
722
+ /**
723
+ * <p>The name of the intent.</p>
724
+ */
725
+ intentName: string | undefined;
726
+ /**
727
+ * <p>Indicates whether the conversation involves multiple turns or not.</p>
728
+ */
729
+ multiTurnConversation: boolean | undefined;
730
+ /**
731
+ * <p>The result of the intent classification test.</p>
732
+ */
733
+ resultCounts: IntentClassificationTestResultItemCounts | undefined;
734
+ }
735
+ /**
736
+ * @public
737
+ * <p>Information for the results of the intent classification test. </p>
738
+ */
739
+ export interface IntentClassificationTestResults {
740
+ /**
741
+ * <p>A list of the results for the intent classification test.</p>
742
+ */
743
+ items: IntentClassificationTestResultItem[] | undefined;
744
+ }
745
+ /**
746
+ * @public
747
+ * @enum
748
+ */
749
+ export declare const IntentFilterName: {
750
+ readonly IntentName: "IntentName";
751
+ };
752
+ /**
753
+ * @public
754
+ */
755
+ export type IntentFilterName = (typeof IntentFilterName)[keyof typeof IntentFilterName];
756
+ /**
757
+ * @public
758
+ * @enum
759
+ */
760
+ export declare const IntentFilterOperator: {
761
+ readonly Contains: "CO";
762
+ readonly Equals: "EQ";
763
+ };
764
+ /**
765
+ * @public
766
+ */
767
+ export type IntentFilterOperator = (typeof IntentFilterOperator)[keyof typeof IntentFilterOperator];
768
+ /**
769
+ * @public
770
+ * <p>Filters the response from the <code>ListIntents</code>
771
+ * operation.</p>
772
+ */
773
+ export interface IntentFilter {
774
+ /**
775
+ * <p>The name of the field to use for the filter.</p>
776
+ */
777
+ name: IntentFilterName | string | undefined;
778
+ /**
779
+ * <p>The value to use for the filter.</p>
780
+ */
781
+ values: string[] | undefined;
782
+ /**
783
+ * <p>The operator to use for the filter. Specify <code>EQ</code> when the
784
+ * <code>ListIntents</code> operation should return only aliases that
785
+ * equal the specified value. Specify <code>CO</code> when the
786
+ * <code>ListIntents</code> operation should return aliases that
787
+ * contain the specified value.</p>
788
+ */
789
+ operator: IntentFilterOperator | string | undefined;
790
+ }
791
+ /**
792
+ * @public
793
+ * <p>Information about the counts for a slot resolution in the results of a test execution.</p>
794
+ */
795
+ export interface SlotResolutionTestResultItemCounts {
796
+ /**
797
+ * <p>The total number of results.</p>
798
+ */
799
+ totalResultCount: number | undefined;
800
+ /**
801
+ * <p>The number of matched, mismatched and execution error results for speech transcription for the slot.</p>
802
+ */
803
+ speechTranscriptionResultCounts?: Record<string, number>;
804
+ /**
805
+ * <p>The number of matched and mismatched results for slot resolution for the slot.</p>
806
+ */
807
+ slotMatchResultCounts: Record<string, number> | undefined;
808
+ }
809
+ /**
810
+ * @public
811
+ * <p>Information about the success and failure rate of slot resolution
812
+ * in the results of a test execution.</p>
813
+ */
814
+ export interface SlotResolutionTestResultItem {
815
+ /**
816
+ * <p>The name of the slot.</p>
817
+ */
818
+ slotName: string | undefined;
819
+ /**
820
+ * <p>A result for slot resolution in the results of a test execution.</p>
821
+ */
822
+ resultCounts: SlotResolutionTestResultItemCounts | undefined;
823
+ }
824
+ /**
825
+ * @public
826
+ * <p>Information about intent-level slot resolution in a test result.</p>
827
+ */
828
+ export interface IntentLevelSlotResolutionTestResultItem {
829
+ /**
830
+ * <p>The name of the intent that was recognized.</p>
831
+ */
832
+ intentName: string | undefined;
833
+ /**
834
+ * <p>Indicates whether the conversation involves multiple turns or not.</p>
835
+ */
836
+ multiTurnConversation: boolean | undefined;
837
+ /**
838
+ * <p>The results for the slot resolution in the test execution result.</p>
839
+ */
840
+ slotResolutionResults: SlotResolutionTestResultItem[] | undefined;
841
+ }
842
+ /**
843
+ * @public
844
+ * <p>Indicates the success or failure of slots at the intent level.</p>
845
+ */
846
+ export interface IntentLevelSlotResolutionTestResults {
847
+ /**
848
+ * <p>Indicates the items for the slot level resolution for the intents.</p>
849
+ */
850
+ items: IntentLevelSlotResolutionTestResultItem[] | undefined;
851
+ }
852
+ /**
853
+ * @public
854
+ * @enum
855
+ */
856
+ export declare const IntentSortAttribute: {
857
+ readonly IntentName: "IntentName";
858
+ readonly LastUpdatedDateTime: "LastUpdatedDateTime";
859
+ };
860
+ /**
861
+ * @public
862
+ */
863
+ export type IntentSortAttribute = (typeof IntentSortAttribute)[keyof typeof IntentSortAttribute];
864
+ /**
865
+ * @public
866
+ * <p>Specifies attributes for sorting a list of intents.</p>
867
+ */
868
+ export interface IntentSortBy {
869
+ /**
870
+ * <p>The attribute to use to sort the list of intents.</p>
871
+ */
872
+ attribute: IntentSortAttribute | string | undefined;
873
+ /**
874
+ * <p>The order to sort the list. You can choose ascending or
875
+ * descending.</p>
876
+ */
877
+ order: SortOrder | string | undefined;
878
+ }
879
+ /**
880
+ * @public
881
+ * @enum
882
+ */
883
+ export declare const IntentState: {
884
+ readonly Failed: "Failed";
885
+ readonly Fulfilled: "Fulfilled";
886
+ readonly FulfillmentInProgress: "FulfillmentInProgress";
887
+ readonly InProgress: "InProgress";
888
+ readonly ReadyForFulfillment: "ReadyForFulfillment";
889
+ readonly Waiting: "Waiting";
890
+ };
891
+ /**
892
+ * @public
893
+ */
894
+ export type IntentState = (typeof IntentState)[keyof typeof IntentState];
895
+ /**
896
+ * @public
897
+ * <p>Summary information about an intent returned by the
898
+ * <code>ListIntents</code> operation.</p>
899
+ */
900
+ export interface IntentSummary {
901
+ /**
902
+ * <p>The unique identifier assigned to the intent. Use this ID to get
903
+ * detailed information about the intent with the
904
+ * <code>DescribeIntent</code> operation.</p>
905
+ */
906
+ intentId?: string;
907
+ /**
908
+ * <p>The name of the intent.</p>
909
+ */
910
+ intentName?: string;
911
+ /**
912
+ * <p>The description of the intent.</p>
913
+ */
914
+ description?: string;
915
+ /**
916
+ * <p>If this intent is derived from a built-in intent, the name of the
917
+ * parent intent.</p>
918
+ */
919
+ parentIntentSignature?: string;
920
+ /**
921
+ * <p>The input contexts that must be active for this intent to be
922
+ * considered for recognition.</p>
923
+ */
924
+ inputContexts?: InputContext[];
925
+ /**
926
+ * <p>The output contexts that are activated when this intent is
927
+ * fulfilled.</p>
928
+ */
929
+ outputContexts?: OutputContext[];
930
+ /**
931
+ * <p>The timestamp of the date and time that the intent was last
932
+ * updated.</p>
933
+ */
934
+ lastUpdatedDateTime?: Date;
935
+ }
936
+ /**
937
+ * @public
938
+ * <p>An object containing the name of an intent that was invoked.</p>
939
+ */
940
+ export interface InvokedIntentSample {
941
+ /**
942
+ * <p>The name of an intent that was invoked.</p>
943
+ */
944
+ intentName?: string;
945
+ }
946
+ /**
947
+ * @public
948
+ * @enum
949
+ */
950
+ export declare const TimeDimension: {
951
+ readonly Days: "Days";
952
+ readonly Hours: "Hours";
953
+ readonly Weeks: "Weeks";
954
+ };
955
+ /**
956
+ * @public
957
+ */
958
+ export type TimeDimension = (typeof TimeDimension)[keyof typeof TimeDimension];
959
+ /**
960
+ * @public
961
+ * <p>Specifies the time window that utterance statistics are returned
962
+ * for. The time window is always relative to the last time that the that
963
+ * utterances were aggregated. For example, if the
964
+ * <code>ListAggregatedUtterances</code> operation is called at 1600,
965
+ * the time window is set to 1 hour, and the last refresh time was 1530,
966
+ * only utterances made between 1430 and 1530 are returned.</p>
967
+ * <p>You can choose the time window that statistics should be returned
968
+ * for.</p>
969
+ * <ul>
970
+ * <li>
971
+ * <p>
972
+ * <b>Hours</b> - You can request
973
+ * utterance statistics for 1, 3, 6, 12, or 24 hour time windows.
974
+ * Statistics are refreshed every half hour for 1 hour time windows,
975
+ * and hourly for the other time windows.</p>
976
+ * </li>
977
+ * <li>
978
+ * <p>
979
+ * <b>Days</b> - You can request
980
+ * utterance statistics for 3 days. Statistics are refreshed every 6
981
+ * hours.</p>
982
+ * </li>
983
+ * <li>
984
+ * <p>
985
+ * <b>Weeks</b> - You can see
986
+ * statistics for one or two weeks. Statistics are refreshed every
987
+ * 12 hours for one week time windows, and once per day for two week
988
+ * time windows.</p>
989
+ * </li>
990
+ * </ul>
991
+ */
992
+ export interface RelativeAggregationDuration {
993
+ /**
994
+ * <p>The type of time period that the <code>timeValue</code> field
995
+ * represents. </p>
996
+ */
997
+ timeDimension: TimeDimension | string | undefined;
998
+ /**
999
+ * <p>The period of the time window to gather statistics for. The valid
1000
+ * value depends on the setting of the <code>timeDimension</code>
1001
+ * field.</p>
1002
+ * <ul>
1003
+ * <li>
1004
+ * <p>
1005
+ * <code>Hours</code> - 1/3/6/12/24</p>
1006
+ * </li>
1007
+ * <li>
1008
+ * <p>
1009
+ * <code>Days</code> - 3</p>
1010
+ * </li>
1011
+ * <li>
1012
+ * <p>
1013
+ * <code>Weeks</code> - 1/2</p>
1014
+ * </li>
1015
+ * </ul>
1016
+ */
1017
+ timeValue: number | undefined;
1018
+ }
1019
+ /**
1020
+ * @public
1021
+ * <p>Provides parameters for setting the time window and duration for
1022
+ * aggregating utterance data.</p>
1023
+ */
1024
+ export interface UtteranceAggregationDuration {
1025
+ /**
1026
+ * <p>The desired time window for aggregating utterances. </p>
1027
+ */
1028
+ relativeAggregationDuration: RelativeAggregationDuration | undefined;
1029
+ }
1030
+ /**
1031
+ * @public
1032
+ */
1033
+ export interface ListAggregatedUtterancesRequest {
1034
+ /**
1035
+ * <p>The unique identifier of the bot associated with this
1036
+ * request.</p>
1037
+ */
1038
+ botId: string | undefined;
1039
+ /**
1040
+ * <p>The identifier of the bot alias associated with this request. If you
1041
+ * specify the bot alias, you can't specify the bot version.</p>
1042
+ */
1043
+ botAliasId?: string;
1044
+ /**
1045
+ * <p>The identifier of the bot version associated with this request. If
1046
+ * you specify the bot version, you can't specify the bot alias.</p>
1047
+ */
1048
+ botVersion?: string;
1049
+ /**
1050
+ * <p>The identifier of the language and locale where the utterances were
1051
+ * collected. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported
1052
+ * languages</a>.</p>
1053
+ */
1054
+ localeId: string | undefined;
1055
+ /**
1056
+ * <p>The time window for aggregating the utterance information. You can
1057
+ * specify a time between one hour and two weeks.</p>
1058
+ */
1059
+ aggregationDuration: UtteranceAggregationDuration | undefined;
1060
+ /**
1061
+ * <p>Specifies sorting parameters for the list of utterances. You can
1062
+ * sort by the hit count, the missed count, or the number of distinct
1063
+ * sessions the utterance appeared in.</p>
1064
+ */
1065
+ sortBy?: AggregatedUtterancesSortBy;
1066
+ /**
1067
+ * <p>Provides the specification of a filter used to limit the utterances
1068
+ * in the response to only those that match the filter specification. You
1069
+ * can only specify one filter and one string to filter on.</p>
1070
+ */
1071
+ filters?: AggregatedUtterancesFilter[];
1072
+ /**
1073
+ * <p>The maximum number of utterances to return in each page of results.
1074
+ * If there are fewer results than the maximum page size, only the actual
1075
+ * number of results are returned. If you don't specify the
1076
+ * <code>maxResults</code> parameter, 1,000 results are
1077
+ * returned.</p>
1078
+ */
1079
+ maxResults?: number;
1080
+ /**
1081
+ * <p>If the response from the <code>ListAggregatedUtterances</code>
1082
+ * operation contains more results that specified in the
1083
+ * <code>maxResults</code> parameter, a token is returned in the
1084
+ * response. Use that token in the <code>nextToken</code> parameter to
1085
+ * return the next page of results.</p>
1086
+ */
1087
+ nextToken?: string;
1088
+ }
1089
+ /**
1090
+ * @public
1091
+ */
1092
+ export interface ListAggregatedUtterancesResponse {
1093
+ /**
1094
+ * <p>The identifier of the bot that contains the utterances.</p>
1095
+ */
1096
+ botId?: string;
1097
+ /**
1098
+ * <p>The identifier of the bot alias that contains the utterances. If you
1099
+ * specified the bot version, the bot alias ID isn't returned.</p>
1100
+ */
1101
+ botAliasId?: string;
1102
+ /**
1103
+ * <p>The identifier of the bot version that contains the utterances. If
1104
+ * you specified the bot alias, the bot version isn't returned.</p>
1105
+ */
1106
+ botVersion?: string;
1107
+ /**
1108
+ * <p>The identifier of the language and locale that the utterances are
1109
+ * in.</p>
1110
+ */
1111
+ localeId?: string;
1112
+ /**
1113
+ * <p>The time period used to aggregate the utterance data.</p>
1114
+ */
1115
+ aggregationDuration?: UtteranceAggregationDuration;
1116
+ /**
1117
+ * <p>The date and time that the aggregation window begins. Only data
1118
+ * collected after this time is returned in the results.</p>
1119
+ */
1120
+ aggregationWindowStartTime?: Date;
1121
+ /**
1122
+ * <p>The date and time that the aggregation window ends. Only data
1123
+ * collected between the start time and the end time are returned in the
1124
+ * results. </p>
1125
+ */
1126
+ aggregationWindowEndTime?: Date;
1127
+ /**
1128
+ * <p>The last date and time that the aggregated data was collected. The
1129
+ * time period depends on the length of the aggregation window.</p>
1130
+ * <ul>
1131
+ * <li>
1132
+ * <p>
1133
+ * <b>Hours</b> - for 1 hour time
1134
+ * window, every half hour; otherwise every hour.</p>
1135
+ * </li>
1136
+ * <li>
1137
+ * <p>
1138
+ * <b>Days</b> - every 6 hours</p>
1139
+ * </li>
1140
+ * <li>
1141
+ * <p>
1142
+ * <b>Weeks</b> - for a one week time
1143
+ * window, every 12 hours; otherwise, every day</p>
1144
+ * </li>
1145
+ * </ul>
1146
+ */
1147
+ aggregationLastRefreshedDateTime?: Date;
1148
+ /**
1149
+ * <p>Summaries of the aggregated utterance data. Each response contains
1150
+ * information about the number of times that the utterance was seen
1151
+ * during the time period, whether it was detected or missed, and when it
1152
+ * was seen during the time period.</p>
1153
+ */
1154
+ aggregatedUtterancesSummaries?: AggregatedUtterancesSummary[];
1155
+ /**
1156
+ * <p>A token that indicates whether there are more results to return in a
1157
+ * response to the <code>ListAggregatedUtterances</code> operation. If the
1158
+ * <code>nextToken</code> field is present, you send the contents as
1159
+ * the <code>nextToken</code> parameter of a
1160
+ * <code>ListAggregatedUtterances</code> operation request to get the
1161
+ * next page of results.</p>
1162
+ */
1163
+ nextToken?: string;
1164
+ }
2
1165
  /**
3
1166
  * @public
4
1167
  */
@@ -599,36 +1762,151 @@ export interface ListImportsRequest {
599
1762
  /**
600
1763
  * @public
601
1764
  */
602
- export interface ListImportsResponse {
1765
+ export interface ListImportsResponse {
1766
+ /**
1767
+ * <p>The unique identifier assigned by Amazon Lex to the bot.</p>
1768
+ */
1769
+ botId?: string;
1770
+ /**
1771
+ * <p>The version of the bot that was imported. It will always be
1772
+ * <code>DRAFT</code>.</p>
1773
+ */
1774
+ botVersion?: string;
1775
+ /**
1776
+ * <p>Summary information for the imports that meet the filter criteria
1777
+ * specified in the request. The length of the list is specified in the
1778
+ * <code>maxResults</code> parameter. If there are more imports
1779
+ * available, the <code>nextToken</code> field contains a token to get the
1780
+ * next page of results.</p>
1781
+ */
1782
+ importSummaries?: ImportSummary[];
1783
+ /**
1784
+ * <p>A token that indicates whether there are more results to return in a
1785
+ * response to the <code>ListImports</code> operation. If the
1786
+ * <code>nextToken</code> field is present, you send the contents as
1787
+ * the <code>nextToken</code> parameter of a <code>ListImports</code>
1788
+ * operation request to get the next page of results.</p>
1789
+ */
1790
+ nextToken?: string;
1791
+ /**
1792
+ * <p>The locale specified in the request.</p>
1793
+ */
1794
+ localeId?: string;
1795
+ }
1796
+ /**
1797
+ * @public
1798
+ */
1799
+ export interface ListIntentMetricsRequest {
1800
+ /**
1801
+ * <p>The identifier for the bot for which you want to retrieve intent metrics.</p>
1802
+ */
1803
+ botId: string | undefined;
1804
+ /**
1805
+ * <p>The timestamp that marks the beginning of the range of time for which you want to see intent metrics.</p>
1806
+ */
1807
+ startDateTime: Date | undefined;
1808
+ /**
1809
+ * <p>The date and time that marks the end of the range of time for which you want to see intent metrics.</p>
1810
+ */
1811
+ endDateTime: Date | undefined;
1812
+ /**
1813
+ * <p>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.</p>
1814
+ */
1815
+ metrics: AnalyticsIntentMetric[] | undefined;
1816
+ /**
1817
+ * <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
1818
+ */
1819
+ binBy?: AnalyticsBinBySpecification[];
1820
+ /**
1821
+ * <p>A list of objects, each of which specifies how to group the results. You can group by the following criteria:</p>
1822
+ * <ul>
1823
+ * <li>
1824
+ * <p>
1825
+ * <code>IntentName</code> – The name of the intent.</p>
1826
+ * </li>
1827
+ * <li>
1828
+ * <p>
1829
+ * <code>IntentEndState</code> – The final state of the intent. The possible end states are detailed in <a href="https://docs.aws.amazon.com/analytics-key-definitions-intents">Key definitions</a> in the user guide.</p>
1830
+ * </li>
1831
+ * </ul>
1832
+ */
1833
+ groupBy?: AnalyticsIntentGroupBySpecification[];
1834
+ /**
1835
+ * <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
1836
+ */
1837
+ filters?: AnalyticsIntentFilter[];
1838
+ /**
1839
+ * <p>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.</p>
1840
+ */
1841
+ maxResults?: number;
1842
+ /**
1843
+ * <p>If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
1844
+ * <p>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.</p>
1845
+ */
1846
+ nextToken?: string;
1847
+ }
1848
+ /**
1849
+ * @public
1850
+ */
1851
+ export interface ListIntentMetricsResponse {
1852
+ /**
1853
+ * <p>The identifier for the bot for which you retrieved intent metrics.</p>
1854
+ */
1855
+ botId?: string;
1856
+ /**
1857
+ * <p>The results for the intent metrics.</p>
1858
+ */
1859
+ results?: AnalyticsIntentResult[];
1860
+ /**
1861
+ * <p>If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
1862
+ * <p>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.</p>
1863
+ */
1864
+ nextToken?: string;
1865
+ }
1866
+ /**
1867
+ * @public
1868
+ */
1869
+ export interface ListIntentPathsRequest {
603
1870
  /**
604
- * <p>The unique identifier assigned by Amazon Lex to the bot.</p>
1871
+ * <p>The identifier for the bot for which you want to retrieve intent path metrics.</p>
605
1872
  */
606
- botId?: string;
1873
+ botId: string | undefined;
607
1874
  /**
608
- * <p>The version of the bot that was imported. It will always be
609
- * <code>DRAFT</code>.</p>
1875
+ * <p>The date and time that marks the beginning of the range of time for which you want to see intent path metrics.</p>
610
1876
  */
611
- botVersion?: string;
1877
+ startDateTime: Date | undefined;
612
1878
  /**
613
- * <p>Summary information for the imports that meet the filter criteria
614
- * specified in the request. The length of the list is specified in the
615
- * <code>maxResults</code> parameter. If there are more imports
616
- * available, the <code>nextToken</code> field contains a token to get the
617
- * next page of results.</p>
1879
+ * <p>The date and time that marks the end of the range of time for which you want to see intent path metrics.</p>
618
1880
  */
619
- importSummaries?: ImportSummary[];
1881
+ endDateTime: Date | undefined;
620
1882
  /**
621
- * <p>A token that indicates whether there are more results to return in a
622
- * response to the <code>ListImports</code> operation. If the
623
- * <code>nextToken</code> field is present, you send the contents as
624
- * the <code>nextToken</code> parameter of a <code>ListImports</code>
625
- * operation request to get the next page of results.</p>
1883
+ * <p>The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:</p>
1884
+ * <ul>
1885
+ * <li>
1886
+ * <p>/BookCar</p>
1887
+ * </li>
1888
+ * <li>
1889
+ * <p>/BookCar/BookHotel</p>
1890
+ * </li>
1891
+ * <li>
1892
+ * <p>/BookHotel/BookCar</p>
1893
+ * </li>
1894
+ * </ul>
626
1895
  */
627
- nextToken?: string;
1896
+ intentPath: string | undefined;
628
1897
  /**
629
- * <p>The locale specified in the request.</p>
1898
+ * <p>A list of objects, each describes a condition by which you want to filter the results.</p>
630
1899
  */
631
- localeId?: string;
1900
+ filters?: AnalyticsPathFilter[];
1901
+ }
1902
+ /**
1903
+ * @public
1904
+ */
1905
+ export interface ListIntentPathsResponse {
1906
+ /**
1907
+ * <p>A list of objects, each of which contains information about a node in the intent path for which you requested metrics.</p>
1908
+ */
1909
+ nodeSummaries?: AnalyticsIntentNodeSummary[];
632
1910
  }
633
1911
  /**
634
1912
  * @public
@@ -712,6 +1990,76 @@ export interface ListIntentsResponse {
712
1990
  */
713
1991
  nextToken?: string;
714
1992
  }
1993
+ /**
1994
+ * @public
1995
+ */
1996
+ export interface ListIntentStageMetricsRequest {
1997
+ /**
1998
+ * <p>The identifier for the bot for which you want to retrieve intent stage metrics.</p>
1999
+ */
2000
+ botId: string | undefined;
2001
+ /**
2002
+ * <p>The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.</p>
2003
+ */
2004
+ startDateTime: Date | undefined;
2005
+ /**
2006
+ * <p>The date and time that marks the end of the range of time for which you want to see intent stage metrics.</p>
2007
+ */
2008
+ endDateTime: Date | undefined;
2009
+ /**
2010
+ * <p>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.</p>
2011
+ */
2012
+ metrics: AnalyticsIntentStageMetric[] | undefined;
2013
+ /**
2014
+ * <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
2015
+ */
2016
+ binBy?: AnalyticsBinBySpecification[];
2017
+ /**
2018
+ * <p>A list of objects, each of which specifies how to group the results. You can group by the following criteria:</p>
2019
+ * <ul>
2020
+ * <li>
2021
+ * <p>
2022
+ * <code>IntentStageName</code> – The name of the intent stage.</p>
2023
+ * </li>
2024
+ * <li>
2025
+ * <p>
2026
+ * <code>SwitchedToIntent</code> – The intent to which the conversation was switched (if any).</p>
2027
+ * </li>
2028
+ * </ul>
2029
+ */
2030
+ groupBy?: AnalyticsIntentStageGroupBySpecification[];
2031
+ /**
2032
+ * <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
2033
+ */
2034
+ filters?: AnalyticsIntentStageFilter[];
2035
+ /**
2036
+ * <p>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.</p>
2037
+ */
2038
+ maxResults?: number;
2039
+ /**
2040
+ * <p>If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
2041
+ * <p>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.</p>
2042
+ */
2043
+ nextToken?: string;
2044
+ }
2045
+ /**
2046
+ * @public
2047
+ */
2048
+ export interface ListIntentStageMetricsResponse {
2049
+ /**
2050
+ * <p>The identifier for the bot for which you retrieved intent stage metrics.</p>
2051
+ */
2052
+ botId?: string;
2053
+ /**
2054
+ * <p>The results for the intent stage metrics.</p>
2055
+ */
2056
+ results?: AnalyticsIntentStageResult[];
2057
+ /**
2058
+ * <p>If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
2059
+ * <p>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.</p>
2060
+ */
2061
+ nextToken?: string;
2062
+ }
715
2063
  /**
716
2064
  * @public
717
2065
  */
@@ -765,49 +2113,275 @@ export interface RecommendedIntentSummary {
765
2113
  */
766
2114
  intentName?: string;
767
2115
  /**
768
- * <p>The count of sample utterances of a recommended intent that is
769
- * associated with a bot recommendation.</p>
2116
+ * <p>The count of sample utterances of a recommended intent that is
2117
+ * associated with a bot recommendation.</p>
2118
+ */
2119
+ sampleUtterancesCount?: number;
2120
+ }
2121
+ /**
2122
+ * @public
2123
+ */
2124
+ export interface ListRecommendedIntentsResponse {
2125
+ /**
2126
+ * <p>The unique identifier of the bot associated with the recommended
2127
+ * intent.</p>
2128
+ */
2129
+ botId?: string;
2130
+ /**
2131
+ * <p>The version of the bot that contains the intent.</p>
2132
+ */
2133
+ botVersion?: string;
2134
+ /**
2135
+ * <p>The identifier of the language and locale of the intents to list.
2136
+ * The string must match one of the supported locales. For more
2137
+ * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
2138
+ */
2139
+ localeId?: string;
2140
+ /**
2141
+ * <p>The identifier of the bot recommendation that contains the
2142
+ * recommended intent.</p>
2143
+ */
2144
+ botRecommendationId?: string;
2145
+ /**
2146
+ * <p>Summary information for the intents that meet the filter criteria
2147
+ * specified in the request. The length of the list is specified in the
2148
+ * maxResults parameter of the request. If there are more intents
2149
+ * available, the nextToken field contains a token to get the next page of
2150
+ * results.</p>
2151
+ */
2152
+ summaryList?: RecommendedIntentSummary[];
2153
+ /**
2154
+ * <p>A token that indicates whether there are more results to return in a
2155
+ * response to the ListRecommendedIntents operation. If the nextToken
2156
+ * field is present, you send the contents as the nextToken parameter of a
2157
+ * ListRecommendedIntents operation request to get the next page of
2158
+ * results.</p>
2159
+ */
2160
+ nextToken?: string;
2161
+ }
2162
+ /**
2163
+ * @public
2164
+ * <p>An object specifying the measure and method by which to sort the session analytics data.</p>
2165
+ */
2166
+ export interface SessionDataSortBy {
2167
+ /**
2168
+ * <p>The measure by which to sort the session analytics data.</p>
2169
+ * <ul>
2170
+ * <li>
2171
+ * <p>
2172
+ * <code>conversationStartTime</code> – The date and time when the conversation began. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>
2173
+ * </li>
2174
+ * <li>
2175
+ * <p>
2176
+ * <code>numberOfTurns</code> – The number of turns that the session took.</p>
2177
+ * </li>
2178
+ * <li>
2179
+ * <p>
2180
+ * <code>conversationDurationSeconds</code> – The duration of the conversation in seconds.</p>
2181
+ * </li>
2182
+ * </ul>
2183
+ */
2184
+ name: AnalyticsSessionSortByName | string | undefined;
2185
+ /**
2186
+ * <p>Specifies whether to sort the results in ascending or descending order.</p>
2187
+ */
2188
+ order: AnalyticsSortOrder | string | undefined;
2189
+ }
2190
+ /**
2191
+ * @public
2192
+ */
2193
+ export interface ListSessionAnalyticsDataRequest {
2194
+ /**
2195
+ * <p>The identifier for the bot for which you want to retrieve session analytics.</p>
2196
+ */
2197
+ botId: string | undefined;
2198
+ /**
2199
+ * <p>The date and time that marks the beginning of the range of time for which you want to see session analytics.</p>
2200
+ */
2201
+ startDateTime: Date | undefined;
2202
+ /**
2203
+ * <p>The date and time that marks the end of the range of time for which you want to see session analytics.</p>
2204
+ */
2205
+ endDateTime: Date | undefined;
2206
+ /**
2207
+ * <p>An object specifying the measure and method by which to sort the session analytics data.</p>
2208
+ */
2209
+ sortBy?: SessionDataSortBy;
2210
+ /**
2211
+ * <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
2212
+ */
2213
+ filters?: AnalyticsSessionFilter[];
2214
+ /**
2215
+ * <p>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.</p>
2216
+ */
2217
+ maxResults?: number;
2218
+ /**
2219
+ * <p>If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
2220
+ * <p>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.</p>
2221
+ */
2222
+ nextToken?: string;
2223
+ }
2224
+ /**
2225
+ * @public
2226
+ * <p>An object containing information about a specific session.</p>
2227
+ */
2228
+ export interface SessionSpecification {
2229
+ /**
2230
+ * <p>The identifier of the alias of the bot that the session was held with.</p>
2231
+ */
2232
+ botAliasId?: string;
2233
+ /**
2234
+ * <p>The version of the bot that the session was held with.</p>
2235
+ */
2236
+ botVersion?: string;
2237
+ /**
2238
+ * <p>The locale of the bot that the session was held with.</p>
2239
+ */
2240
+ localeId?: string;
2241
+ /**
2242
+ * <p>The channel that is integrated with the bot that the session was held with.</p>
2243
+ */
2244
+ channel?: string;
2245
+ /**
2246
+ * <p>The identifier of the session.</p>
2247
+ */
2248
+ sessionId?: string;
2249
+ /**
2250
+ * <p>The date and time when the conversation began. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>
2251
+ */
2252
+ conversationStartTime?: Date;
2253
+ /**
2254
+ * <p>The date and time when the conversation ended. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>
2255
+ */
2256
+ conversationEndTime?: Date;
2257
+ /**
2258
+ * <p>The duration of the conversation in seconds. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>
2259
+ */
2260
+ conversationDurationSeconds?: number;
2261
+ /**
2262
+ * <p>The final state of the conversation. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>
2263
+ */
2264
+ conversationEndState?: ConversationEndState | string;
2265
+ /**
2266
+ * <p>The mode of the session. The possible values are as follows:</p>
2267
+ * <ul>
2268
+ * <li>
2269
+ * <p>
2270
+ * <code>Speech</code> – The session was spoken.</p>
2271
+ * </li>
2272
+ * <li>
2273
+ * <p>
2274
+ * <code>Text</code> – The session was written.</p>
2275
+ * </li>
2276
+ * <li>
2277
+ * <p>
2278
+ * <code>DTMF</code> – The session used a touch-tone keypad (Dual Tone Multi-Frequency).</p>
2279
+ * </li>
2280
+ * <li>
2281
+ * <p>
2282
+ * <code>MultiMode</code> – The session used multiple modes.</p>
2283
+ * </li>
2284
+ * </ul>
2285
+ */
2286
+ mode?: AnalyticsModality | string;
2287
+ /**
2288
+ * <p>The number of turns that the session took.</p>
2289
+ */
2290
+ numberOfTurns?: number;
2291
+ /**
2292
+ * <p>A list of objects containing the name of an intent that was invoked.</p>
2293
+ */
2294
+ invokedIntentSamples?: InvokedIntentSample[];
2295
+ /**
2296
+ * <p>The identifier of the first request in a session.</p>
2297
+ */
2298
+ originatingRequestId?: string;
2299
+ }
2300
+ /**
2301
+ * @public
2302
+ */
2303
+ export interface ListSessionAnalyticsDataResponse {
2304
+ /**
2305
+ * <p>The unique identifier of the bot that the sessions belong to.</p>
2306
+ */
2307
+ botId?: string;
2308
+ /**
2309
+ * <p>If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
2310
+ * <p>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.</p>
2311
+ */
2312
+ nextToken?: string;
2313
+ /**
2314
+ * <p>A list of objects, each of which contains information about a session with the bot.</p>
2315
+ */
2316
+ sessions?: SessionSpecification[];
2317
+ }
2318
+ /**
2319
+ * @public
2320
+ */
2321
+ export interface ListSessionMetricsRequest {
2322
+ /**
2323
+ * <p>The identifier for the bot for which you want to retrieve session metrics.</p>
2324
+ */
2325
+ botId: string | undefined;
2326
+ /**
2327
+ * <p>The date and time that marks the beginning of the range of time for which you want to see session metrics.</p>
2328
+ */
2329
+ startDateTime: Date | undefined;
2330
+ /**
2331
+ * <p>The date and time that marks the end of the range of time for which you want to see session metrics.</p>
2332
+ */
2333
+ endDateTime: Date | undefined;
2334
+ /**
2335
+ * <p>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.</p>
2336
+ */
2337
+ metrics: AnalyticsSessionMetric[] | undefined;
2338
+ /**
2339
+ * <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
2340
+ */
2341
+ binBy?: AnalyticsBinBySpecification[];
2342
+ /**
2343
+ * <p>A list of objects, each of which specifies how to group the results. You can group by the following criteria:</p>
2344
+ * <ul>
2345
+ * <li>
2346
+ * <p>
2347
+ * <code>ConversationEndState</code> – The final state of the conversation. The possible end states are detailed in <a href="https://docs.aws.amazon.com/analytics-key-definitions-conversations">Key definitions</a> in the user guide.</p>
2348
+ * </li>
2349
+ * <li>
2350
+ * <p>
2351
+ * <code>LocaleId</code> – The unique identifier of the bot locale.</p>
2352
+ * </li>
2353
+ * </ul>
2354
+ */
2355
+ groupBy?: AnalyticsSessionGroupBySpecification[];
2356
+ /**
2357
+ * <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
2358
+ */
2359
+ filters?: AnalyticsSessionFilter[];
2360
+ /**
2361
+ * <p>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.</p>
2362
+ */
2363
+ maxResults?: number;
2364
+ /**
2365
+ * <p>If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
2366
+ * <p>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.</p>
770
2367
  */
771
- sampleUtterancesCount?: number;
2368
+ nextToken?: string;
772
2369
  }
773
2370
  /**
774
2371
  * @public
775
2372
  */
776
- export interface ListRecommendedIntentsResponse {
2373
+ export interface ListSessionMetricsResponse {
777
2374
  /**
778
- * <p>The unique identifier of the bot associated with the recommended
779
- * intent.</p>
2375
+ * <p>The identifier for the bot for which you retrieved session metrics.</p>
780
2376
  */
781
2377
  botId?: string;
782
2378
  /**
783
- * <p>The version of the bot that contains the intent.</p>
784
- */
785
- botVersion?: string;
786
- /**
787
- * <p>The identifier of the language and locale of the intents to list.
788
- * The string must match one of the supported locales. For more
789
- * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
790
- */
791
- localeId?: string;
792
- /**
793
- * <p>The identifier of the bot recommendation that contains the
794
- * recommended intent.</p>
795
- */
796
- botRecommendationId?: string;
797
- /**
798
- * <p>Summary information for the intents that meet the filter criteria
799
- * specified in the request. The length of the list is specified in the
800
- * maxResults parameter of the request. If there are more intents
801
- * available, the nextToken field contains a token to get the next page of
802
- * results.</p>
2379
+ * <p>The results for the session metrics.</p>
803
2380
  */
804
- summaryList?: RecommendedIntentSummary[];
2381
+ results?: AnalyticsSessionResult[];
805
2382
  /**
806
- * <p>A token that indicates whether there are more results to return in a
807
- * response to the ListRecommendedIntents operation. If the nextToken
808
- * field is present, you send the contents as the nextToken parameter of a
809
- * ListRecommendedIntents operation request to get the next page of
810
- * results.</p>
2383
+ * <p>If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
2384
+ * <p>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.</p>
811
2385
  */
812
2386
  nextToken?: string;
813
2387
  }
@@ -1600,6 +3174,395 @@ export interface ListTestSetsResponse {
1600
3174
  */
1601
3175
  nextToken?: string;
1602
3176
  }
3177
+ /**
3178
+ * @public
3179
+ * <p>An object specifying the measure and method by which to sort the utterance data.</p>
3180
+ */
3181
+ export interface UtteranceDataSortBy {
3182
+ /**
3183
+ * <p>The measure by which to sort the utterance analytics data.</p>
3184
+ * <ul>
3185
+ * <li>
3186
+ * <p>
3187
+ * <code>Count</code> – The number of utterances.</p>
3188
+ * </li>
3189
+ * <li>
3190
+ * <p>
3191
+ * <code>UtteranceTimestamp</code> – The date and time of the utterance.</p>
3192
+ * </li>
3193
+ * </ul>
3194
+ */
3195
+ name: AnalyticsUtteranceSortByName | string | undefined;
3196
+ /**
3197
+ * <p>Specifies whether to sort the results in ascending or descending order.</p>
3198
+ */
3199
+ order: AnalyticsSortOrder | string | undefined;
3200
+ }
3201
+ /**
3202
+ * @public
3203
+ */
3204
+ export interface ListUtteranceAnalyticsDataRequest {
3205
+ /**
3206
+ * <p>The identifier for the bot for which you want to retrieve utterance analytics.</p>
3207
+ */
3208
+ botId: string | undefined;
3209
+ /**
3210
+ * <p>The date and time that marks the beginning of the range of time for which you want to see utterance analytics.</p>
3211
+ */
3212
+ startDateTime: Date | undefined;
3213
+ /**
3214
+ * <p>The date and time that marks the end of the range of time for which you want to see utterance analytics.</p>
3215
+ */
3216
+ endDateTime: Date | undefined;
3217
+ /**
3218
+ * <p>An object specifying the measure and method by which to sort the utterance analytics data.</p>
3219
+ */
3220
+ sortBy?: UtteranceDataSortBy;
3221
+ /**
3222
+ * <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
3223
+ */
3224
+ filters?: AnalyticsUtteranceFilter[];
3225
+ /**
3226
+ * <p>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.</p>
3227
+ */
3228
+ maxResults?: number;
3229
+ /**
3230
+ * <p>If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
3231
+ * <p>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.</p>
3232
+ */
3233
+ nextToken?: string;
3234
+ }
3235
+ /**
3236
+ * @public
3237
+ * @enum
3238
+ */
3239
+ export declare const UtteranceContentType: {
3240
+ readonly CustomPayload: "CustomPayload";
3241
+ readonly ImageResponseCard: "ImageResponseCard";
3242
+ readonly PlainText: "PlainText";
3243
+ readonly SSML: "SSML";
3244
+ };
3245
+ /**
3246
+ * @public
3247
+ */
3248
+ export type UtteranceContentType = (typeof UtteranceContentType)[keyof typeof UtteranceContentType];
3249
+ /**
3250
+ * @public
3251
+ * <p>An object that contains a response to the utterance from the bot.</p>
3252
+ */
3253
+ export interface UtteranceBotResponse {
3254
+ /**
3255
+ * <p>The text of the response to the utterance from the bot.</p>
3256
+ */
3257
+ content?: string;
3258
+ /**
3259
+ * <p>The type of the response. The following values are possible:</p>
3260
+ * <ul>
3261
+ * <li>
3262
+ * <p>
3263
+ * <code>PlainText</code> – A plain text string.</p>
3264
+ * </li>
3265
+ * <li>
3266
+ * <p>
3267
+ * <code>CustomPayload</code> – A response string that you can customize to include data or metadata for your application.</p>
3268
+ * </li>
3269
+ * <li>
3270
+ * <p>
3271
+ * <code>SSML</code> – A string that includes Speech Synthesis Markup Language to customize the audio response.</p>
3272
+ * </li>
3273
+ * <li>
3274
+ * <p>
3275
+ * <code>ImageResponseCard</code> – An image with buttons that the customer can select. See <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html">ImageResponseCard</a> for more information.</p>
3276
+ * </li>
3277
+ * </ul>
3278
+ */
3279
+ contentType?: UtteranceContentType | string;
3280
+ /**
3281
+ * <p>A card that is shown to the user by a messaging platform. You define
3282
+ * the contents of the card, the card is displayed by the platform. </p>
3283
+ * <p>When you use a response card, the response from the user is
3284
+ * constrained to the text associated with a button on the card.</p>
3285
+ */
3286
+ imageResponseCard?: ImageResponseCard;
3287
+ }
3288
+ /**
3289
+ * @public
3290
+ * <p>An object containing information about a specific utterance.</p>
3291
+ */
3292
+ export interface UtteranceSpecification {
3293
+ /**
3294
+ * <p>The identifier of the alias of the bot that the utterance was made to.</p>
3295
+ */
3296
+ botAliasId?: string;
3297
+ /**
3298
+ * <p>The version of the bot that the utterance was made to.</p>
3299
+ */
3300
+ botVersion?: string;
3301
+ /**
3302
+ * <p>The locale of the bot that the utterance was made to.</p>
3303
+ */
3304
+ localeId?: string;
3305
+ /**
3306
+ * <p>The identifier of the session that the utterance was made in.</p>
3307
+ */
3308
+ sessionId?: string;
3309
+ /**
3310
+ * <p>The channel that is integrated with the bot that the utterance was made to.</p>
3311
+ */
3312
+ channel?: string;
3313
+ /**
3314
+ * <p>The mode of the session. The possible values are as follows:</p>
3315
+ * <ul>
3316
+ * <li>
3317
+ * <p>
3318
+ * <code>Speech</code> – The session consisted of spoken dialogue.</p>
3319
+ * </li>
3320
+ * <li>
3321
+ * <p>
3322
+ * <code>Text</code> – The session consisted of written dialogue.</p>
3323
+ * </li>
3324
+ * <li>
3325
+ * <p>
3326
+ * <code>DTMF</code> – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.</p>
3327
+ * </li>
3328
+ * <li>
3329
+ * <p>
3330
+ * <code>MultiMode</code> – The session consisted of multiple modes.</p>
3331
+ * </li>
3332
+ * </ul>
3333
+ */
3334
+ mode?: AnalyticsModality | string;
3335
+ /**
3336
+ * <p>The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>
3337
+ */
3338
+ conversationStartTime?: Date;
3339
+ /**
3340
+ * <p>The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>
3341
+ */
3342
+ conversationEndTime?: Date;
3343
+ /**
3344
+ * <p>The text of the utterance.</p>
3345
+ */
3346
+ utterance?: string;
3347
+ /**
3348
+ * <p>The date and time when the utterance took place.</p>
3349
+ */
3350
+ utteranceTimestamp?: Date;
3351
+ /**
3352
+ * <p>The duration in milliseconds of the audio associated with the utterance.</p>
3353
+ */
3354
+ audioVoiceDurationMillis?: number;
3355
+ /**
3356
+ * <p>Specifies whether the bot understood the utterance or not.</p>
3357
+ */
3358
+ utteranceUnderstood?: boolean;
3359
+ /**
3360
+ * <p>The input type of the utterance. The possible values are as follows:</p>
3361
+ * <ul>
3362
+ * <li>
3363
+ * <p>PCM format: audio data must be in little-endian byte order.</p>
3364
+ * <ul>
3365
+ * <li>
3366
+ * <p>
3367
+ * <code>audio/l16; rate=16000; channels=1</code>
3368
+ * </p>
3369
+ * </li>
3370
+ * <li>
3371
+ * <p>
3372
+ * <code>audio/x-l16; sample-rate=16000; channel-count=1</code>
3373
+ * </p>
3374
+ * </li>
3375
+ * <li>
3376
+ * <p>
3377
+ * <code>audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false</code>
3378
+ * </p>
3379
+ * </li>
3380
+ * </ul>
3381
+ * </li>
3382
+ * <li>
3383
+ * <p>Opus format</p>
3384
+ * <ul>
3385
+ * <li>
3386
+ * <p>
3387
+ * <code>audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4</code>
3388
+ * </p>
3389
+ * </li>
3390
+ * </ul>
3391
+ * </li>
3392
+ * <li>
3393
+ * <p>Text format</p>
3394
+ * <ul>
3395
+ * <li>
3396
+ * <p>
3397
+ * <code>text/plain; charset=utf-8</code>
3398
+ * </p>
3399
+ * </li>
3400
+ * </ul>
3401
+ * </li>
3402
+ * </ul>
3403
+ */
3404
+ inputType?: string;
3405
+ /**
3406
+ * <p>The output type of the utterance. The possible values are as follows:</p>
3407
+ * <ul>
3408
+ * <li>
3409
+ * <p>
3410
+ * <code>audio/mpeg</code>
3411
+ * </p>
3412
+ * </li>
3413
+ * <li>
3414
+ * <p>
3415
+ * <code>audio/ogg</code>
3416
+ * </p>
3417
+ * </li>
3418
+ * <li>
3419
+ * <p>
3420
+ * <code>audio/pcm (16 KHz)</code>
3421
+ * </p>
3422
+ * </li>
3423
+ * <li>
3424
+ * <p>
3425
+ * <code>audio/</code> (defaults to <code>mpeg</code>)</p>
3426
+ * </li>
3427
+ * <li>
3428
+ * <p>
3429
+ * <code>text/plain; charset=utf-8</code>
3430
+ * </p>
3431
+ * </li>
3432
+ * </ul>
3433
+ */
3434
+ outputType?: string;
3435
+ /**
3436
+ * <p>The name of the intent that the utterance is associated to.</p>
3437
+ */
3438
+ associatedIntentName?: string;
3439
+ /**
3440
+ * <p>The name of the slot that the utterance is associated to.</p>
3441
+ */
3442
+ associatedSlotName?: string;
3443
+ /**
3444
+ * <p>The state of the intent that the utterance is associated to.</p>
3445
+ */
3446
+ intentState?: IntentState | string;
3447
+ /**
3448
+ * <p>The type of dialog action that the utterance is associated to. See the <code>type</code> field in <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html">DialogAction</a> for more information.</p>
3449
+ */
3450
+ dialogActionType?: string;
3451
+ /**
3452
+ * <p>The identifier for the audio of the bot response.</p>
3453
+ */
3454
+ botResponseAudioVoiceId?: string;
3455
+ /**
3456
+ * <p>The slots that have been filled in the session by the time of the utterance.</p>
3457
+ */
3458
+ slotsFilledInSession?: string;
3459
+ /**
3460
+ * <p>The identifier of the request associated with the utterance.</p>
3461
+ */
3462
+ utteranceRequestId?: string;
3463
+ /**
3464
+ * <p>A list of objects containing information about the bot response to the utterance.</p>
3465
+ */
3466
+ botResponses?: UtteranceBotResponse[];
3467
+ }
3468
+ /**
3469
+ * @public
3470
+ */
3471
+ export interface ListUtteranceAnalyticsDataResponse {
3472
+ /**
3473
+ * <p>The unique identifier of the bot that the utterances belong to.</p>
3474
+ */
3475
+ botId?: string;
3476
+ /**
3477
+ * <p>If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
3478
+ * <p>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.</p>
3479
+ */
3480
+ nextToken?: string;
3481
+ /**
3482
+ * <p>A list of objects, each of which contains information about an utterance in a user session with your bot.</p>
3483
+ */
3484
+ utterances?: UtteranceSpecification[];
3485
+ }
3486
+ /**
3487
+ * @public
3488
+ */
3489
+ export interface ListUtteranceMetricsRequest {
3490
+ /**
3491
+ * <p>The identifier for the bot for which you want to retrieve utterance metrics.</p>
3492
+ */
3493
+ botId: string | undefined;
3494
+ /**
3495
+ * <p>The date and time that marks the beginning of the range of time for which you want to see utterance metrics.</p>
3496
+ */
3497
+ startDateTime: Date | undefined;
3498
+ /**
3499
+ * <p>The date and time that marks the end of the range of time for which you want to see utterance metrics.</p>
3500
+ */
3501
+ endDateTime: Date | undefined;
3502
+ /**
3503
+ * <p>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.</p>
3504
+ */
3505
+ metrics: AnalyticsUtteranceMetric[] | undefined;
3506
+ /**
3507
+ * <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
3508
+ */
3509
+ binBy?: AnalyticsBinBySpecification[];
3510
+ /**
3511
+ * <p>A list of objects, each of which specifies how to group the results. You can group by the following criteria:</p>
3512
+ * <ul>
3513
+ * <li>
3514
+ * <p>
3515
+ * <code>UtteranceText</code> – The transcription of the utterance.</p>
3516
+ * </li>
3517
+ * <li>
3518
+ * <p>
3519
+ * <code>UtteranceState</code> – The state of the utterance. The possible states are detailed in <a href="https://docs.aws.amazon.com/analytics-key-definitions-utterances">Key definitions</a> in the user guide.</p>
3520
+ * </li>
3521
+ * </ul>
3522
+ */
3523
+ groupBy?: AnalyticsUtteranceGroupBySpecification[];
3524
+ /**
3525
+ * <p>A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:</p>
3526
+ * <ul>
3527
+ * <li>
3528
+ * <p>
3529
+ * <code>LastUsedIntent</code> – The last used intent at the time of the utterance.</p>
3530
+ * </li>
3531
+ * </ul>
3532
+ */
3533
+ attributes?: AnalyticsUtteranceAttribute[];
3534
+ /**
3535
+ * <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
3536
+ */
3537
+ filters?: AnalyticsUtteranceFilter[];
3538
+ /**
3539
+ * <p>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.</p>
3540
+ */
3541
+ maxResults?: number;
3542
+ /**
3543
+ * <p>If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
3544
+ * <p>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.</p>
3545
+ */
3546
+ nextToken?: string;
3547
+ }
3548
+ /**
3549
+ * @public
3550
+ */
3551
+ export interface ListUtteranceMetricsResponse {
3552
+ /**
3553
+ * <p>The identifier for the bot for which you retrieved utterance metrics.</p>
3554
+ */
3555
+ botId?: string;
3556
+ /**
3557
+ * <p>The results for the utterance metrics.</p>
3558
+ */
3559
+ results?: AnalyticsUtteranceResult[];
3560
+ /**
3561
+ * <p>If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p>
3562
+ * <p>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.</p>
3563
+ */
3564
+ nextToken?: string;
3565
+ }
1603
3566
  /**
1604
3567
  * @public
1605
3568
  * @enum