@aws-sdk/client-lex-models-v2 3.345.0 → 3.347.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.
- package/README.md +112 -0
- package/dist-cjs/LexModelsV2.js +28 -0
- package/dist-cjs/commands/CreateTestSetDiscrepancyReportCommand.js +46 -0
- package/dist-cjs/commands/DeleteTestSetCommand.js +46 -0
- package/dist-cjs/commands/DescribeTestExecutionCommand.js +46 -0
- package/dist-cjs/commands/DescribeTestSetCommand.js +46 -0
- package/dist-cjs/commands/DescribeTestSetDiscrepancyReportCommand.js +46 -0
- package/dist-cjs/commands/DescribeTestSetGenerationCommand.js +46 -0
- package/dist-cjs/commands/GetTestExecutionArtifactsUrlCommand.js +46 -0
- package/dist-cjs/commands/ListTestExecutionResultItemsCommand.js +46 -0
- package/dist-cjs/commands/ListTestExecutionsCommand.js +46 -0
- package/dist-cjs/commands/ListTestSetRecordsCommand.js +46 -0
- package/dist-cjs/commands/ListTestSetsCommand.js +46 -0
- package/dist-cjs/commands/StartBotRecommendationCommand.js +3 -3
- package/dist-cjs/commands/StartImportCommand.js +2 -2
- package/dist-cjs/commands/StartTestExecutionCommand.js +46 -0
- package/dist-cjs/commands/StartTestSetGenerationCommand.js +46 -0
- package/dist-cjs/commands/UpdateTestSetCommand.js +46 -0
- package/dist-cjs/commands/index.js +14 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +52 -50
- package/dist-cjs/models/models_1.js +64 -1
- package/dist-cjs/pagination/ListTestExecutionResultItemsPaginator.js +29 -0
- package/dist-cjs/pagination/ListTestExecutionsPaginator.js +29 -0
- package/dist-cjs/pagination/ListTestSetRecordsPaginator.js +29 -0
- package/dist-cjs/pagination/ListTestSetsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1395 -146
- package/dist-es/LexModelsV2.js +28 -0
- package/dist-es/commands/CreateTestSetDiscrepancyReportCommand.js +42 -0
- package/dist-es/commands/DeleteTestSetCommand.js +42 -0
- package/dist-es/commands/DescribeTestExecutionCommand.js +42 -0
- package/dist-es/commands/DescribeTestSetCommand.js +42 -0
- package/dist-es/commands/DescribeTestSetDiscrepancyReportCommand.js +42 -0
- package/dist-es/commands/DescribeTestSetGenerationCommand.js +42 -0
- package/dist-es/commands/GetTestExecutionArtifactsUrlCommand.js +42 -0
- package/dist-es/commands/ListTestExecutionResultItemsCommand.js +42 -0
- package/dist-es/commands/ListTestExecutionsCommand.js +42 -0
- package/dist-es/commands/ListTestSetRecordsCommand.js +42 -0
- package/dist-es/commands/ListTestSetsCommand.js +42 -0
- package/dist-es/commands/StartBotRecommendationCommand.js +1 -1
- package/dist-es/commands/StartImportCommand.js +1 -1
- package/dist-es/commands/StartTestExecutionCommand.js +42 -0
- package/dist-es/commands/StartTestSetGenerationCommand.js +42 -0
- package/dist-es/commands/UpdateTestSetCommand.js +42 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +50 -45
- package/dist-es/models/models_1.js +60 -0
- package/dist-es/pagination/ListTestExecutionResultItemsPaginator.js +25 -0
- package/dist-es/pagination/ListTestExecutionsPaginator.js +25 -0
- package/dist-es/pagination/ListTestSetRecordsPaginator.js +25 -0
- package/dist-es/pagination/ListTestSetsPaginator.js +25 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +1360 -140
- package/dist-types/LexModelsV2.d.ts +98 -0
- package/dist-types/LexModelsV2Client.d.ts +16 -2
- package/dist-types/commands/CreateExportCommand.d.ts +8 -2
- package/dist-types/commands/CreateTestSetDiscrepancyReportCommand.d.ts +113 -0
- package/dist-types/commands/DeleteTestSetCommand.d.ts +96 -0
- package/dist-types/commands/DescribeExportCommand.d.ts +4 -1
- package/dist-types/commands/DescribeImportCommand.d.ts +18 -0
- package/dist-types/commands/DescribeTestExecutionCommand.d.ts +109 -0
- package/dist-types/commands/DescribeTestSetCommand.d.ts +105 -0
- package/dist-types/commands/DescribeTestSetDiscrepancyReportCommand.d.ts +122 -0
- package/dist-types/commands/DescribeTestSetGenerationCommand.d.ts +119 -0
- package/dist-types/commands/GetTestExecutionArtifactsUrlCommand.d.ts +93 -0
- package/dist-types/commands/ListBotAliasesCommand.d.ts +1 -1
- package/dist-types/commands/ListBotLocalesCommand.d.ts +1 -1
- package/dist-types/commands/ListBotRecommendationsCommand.d.ts +1 -1
- package/dist-types/commands/ListBotVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListBotsCommand.d.ts +1 -1
- package/dist-types/commands/ListBuiltInIntentsCommand.d.ts +1 -1
- package/dist-types/commands/ListBuiltInSlotTypesCommand.d.ts +1 -1
- package/dist-types/commands/ListCustomVocabularyItemsCommand.d.ts +1 -1
- package/dist-types/commands/ListExportsCommand.d.ts +5 -2
- package/dist-types/commands/ListImportsCommand.d.ts +2 -2
- package/dist-types/commands/ListIntentsCommand.d.ts +1 -1
- package/dist-types/commands/ListRecommendedIntentsCommand.d.ts +1 -1
- package/dist-types/commands/ListSlotTypesCommand.d.ts +1 -1
- package/dist-types/commands/ListSlotsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTestExecutionResultItemsCommand.d.ts +291 -0
- package/dist-types/commands/ListTestExecutionsCommand.d.ts +112 -0
- package/dist-types/commands/ListTestSetRecordsCommand.d.ts +180 -0
- package/dist-types/commands/ListTestSetsCommand.d.ts +111 -0
- package/dist-types/commands/SearchAssociatedTranscriptsCommand.d.ts +1 -1
- package/dist-types/commands/StartBotRecommendationCommand.d.ts +1 -1
- package/dist-types/commands/StartImportCommand.d.ts +37 -1
- package/dist-types/commands/StartTestExecutionCommand.d.ts +117 -0
- package/dist-types/commands/StartTestSetGenerationCommand.d.ts +144 -0
- package/dist-types/commands/StopBotRecommendationCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -2
- package/dist-types/commands/UpdateExportCommand.d.ts +4 -1
- package/dist-types/commands/UpdateTestSetCommand.d.ts +113 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1054 -1714
- package/dist-types/models/models_1.d.ts +2465 -18
- package/dist-types/pagination/ListTestExecutionResultItemsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTestExecutionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTestSetRecordsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTestSetsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/LexModelsV2.d.ts +238 -0
- package/dist-types/ts3.4/LexModelsV2Client.d.ts +86 -2
- package/dist-types/ts3.4/commands/CreateTestSetDiscrepancyReportCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteTestSetCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/DescribeTestExecutionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeTestSetCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DescribeTestSetDiscrepancyReportCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DescribeTestSetGenerationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetTestExecutionArtifactsUrlCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListBotAliasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBotLocalesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBotRecommendationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBotVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBuiltInIntentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListBuiltInSlotTypesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListCustomVocabularyItemsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListExportsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListImportsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListIntentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListRecommendedIntentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSlotTypesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSlotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTestExecutionResultItemsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListTestExecutionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTestSetRecordsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTestSetsCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/SearchAssociatedTranscriptsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartBotRecommendationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartImportCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartTestExecutionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/StartTestSetGenerationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StopBotRecommendationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/UpdateTestSetCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +293 -362
- package/dist-types/ts3.4/models/models_1.d.ts +646 -0
- package/dist-types/ts3.4/pagination/ListTestExecutionResultItemsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTestExecutionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTestSetRecordsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTestSetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +29 -29
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { LexModelsV2ServiceException as __BaseException } from "./LexModelsV2ServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>The active context used in the test execution.</p>
|
|
6
|
+
*/
|
|
7
|
+
export interface ActiveContext {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The name of active context.</p>
|
|
10
|
+
*/
|
|
11
|
+
name: string | undefined;
|
|
12
|
+
}
|
|
3
13
|
/**
|
|
4
14
|
* @public
|
|
5
15
|
* @enum
|
|
@@ -21,6 +31,56 @@ export interface AdvancedRecognitionSetting {
|
|
|
21
31
|
*/
|
|
22
32
|
audioRecognitionStrategy?: AudioRecognitionStrategy | string;
|
|
23
33
|
}
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
* <p>Details about an error in an execution of a test set.</p>
|
|
37
|
+
*/
|
|
38
|
+
export interface ExecutionErrorDetails {
|
|
39
|
+
/**
|
|
40
|
+
* <p>The error code for the error.</p>
|
|
41
|
+
*/
|
|
42
|
+
errorCode: string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The message describing the error.</p>
|
|
45
|
+
*/
|
|
46
|
+
errorMessage: string | undefined;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* @public
|
|
50
|
+
* <p>The information about the agent turn in a test set execution.</p>
|
|
51
|
+
*/
|
|
52
|
+
export interface AgentTurnResult {
|
|
53
|
+
/**
|
|
54
|
+
* <p>The expected agent prompt for the agent turn in a test set execution.</p>
|
|
55
|
+
*/
|
|
56
|
+
expectedAgentPrompt: string | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* <p>The actual agent prompt for the agent turn in a test set execution.</p>
|
|
59
|
+
*/
|
|
60
|
+
actualAgentPrompt?: string;
|
|
61
|
+
/**
|
|
62
|
+
* <p>Details about an error in an execution of a test set.</p>
|
|
63
|
+
*/
|
|
64
|
+
errorDetails?: ExecutionErrorDetails;
|
|
65
|
+
/**
|
|
66
|
+
* <p>The actual elicited slot for the agent turn in a test set execution.</p>
|
|
67
|
+
*/
|
|
68
|
+
actualElicitedSlot?: string;
|
|
69
|
+
/**
|
|
70
|
+
* <p>The actual intent for the agent turn in a test set execution.</p>
|
|
71
|
+
*/
|
|
72
|
+
actualIntent?: string;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
* <p>The specification of an agent turn.</p>
|
|
77
|
+
*/
|
|
78
|
+
export interface AgentTurnSpecification {
|
|
79
|
+
/**
|
|
80
|
+
* <p>The agent prompt for the agent turn in a test set.</p>
|
|
81
|
+
*/
|
|
82
|
+
agentPrompt: string | undefined;
|
|
83
|
+
}
|
|
24
84
|
/**
|
|
25
85
|
* @public
|
|
26
86
|
* @enum
|
|
@@ -271,7 +331,7 @@ export interface AudioAndDTMFInputSpecification {
|
|
|
271
331
|
*/
|
|
272
332
|
export interface S3BucketLogDestination {
|
|
273
333
|
/**
|
|
274
|
-
* <p>The Amazon Resource Name (ARN) of an
|
|
334
|
+
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service
|
|
275
335
|
* (KMS) key for encrypting audio log files stored in an S3 bucket.</p>
|
|
276
336
|
*/
|
|
277
337
|
kmsKeyArn?: string;
|
|
@@ -748,7 +808,7 @@ export interface BotAliasSummary {
|
|
|
748
808
|
botVersion?: string;
|
|
749
809
|
/**
|
|
750
810
|
* <p>The current state of the bot alias. If the status is
|
|
751
|
-
*
|
|
811
|
+
* <code>Available</code>, the alias is ready for use.</p>
|
|
752
812
|
*/
|
|
753
813
|
botAliasStatus?: BotAliasStatus | string;
|
|
754
814
|
/**
|
|
@@ -762,6 +822,24 @@ export interface BotAliasSummary {
|
|
|
762
822
|
*/
|
|
763
823
|
lastUpdatedDateTime?: Date;
|
|
764
824
|
}
|
|
825
|
+
/**
|
|
826
|
+
* @public
|
|
827
|
+
* <p>The target Amazon S3 location for the test set execution using a bot alias.</p>
|
|
828
|
+
*/
|
|
829
|
+
export interface BotAliasTestExecutionTarget {
|
|
830
|
+
/**
|
|
831
|
+
* <p>The bot Id of the bot alias used in the test set execution.</p>
|
|
832
|
+
*/
|
|
833
|
+
botId: string | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* <p>The bot alias Id of the bot alias used in the test set execution.</p>
|
|
836
|
+
*/
|
|
837
|
+
botAliasId: string | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* <p>The locale Id of the bot alias used in the test set execution.</p>
|
|
840
|
+
*/
|
|
841
|
+
localeId: string | undefined;
|
|
842
|
+
}
|
|
765
843
|
/**
|
|
766
844
|
* @public
|
|
767
845
|
* <p>Provides the identity of a the bot that was exported.</p>
|
|
@@ -818,9 +896,9 @@ export interface BotFilter {
|
|
|
818
896
|
values: string[] | undefined;
|
|
819
897
|
/**
|
|
820
898
|
* <p>The operator to use for the filter. Specify <code>EQ</code> when the
|
|
821
|
-
*
|
|
899
|
+
* <code>ListBots</code> operation should return only aliases that
|
|
822
900
|
* equal the specified value. Specify <code>CO</code> when the
|
|
823
|
-
*
|
|
901
|
+
* <code>ListBots</code> operation should return aliases that contain
|
|
824
902
|
* the specified value.</p>
|
|
825
903
|
*/
|
|
826
904
|
operator: BotFilterOperator | string | undefined;
|
|
@@ -858,7 +936,7 @@ export interface DataPrivacy {
|
|
|
858
936
|
* must obtain any required verifiable parental consent under COPPA. For
|
|
859
937
|
* information regarding the use of Amazon Lex in connection with websites,
|
|
860
938
|
* programs, or other applications that are directed or targeted, in whole
|
|
861
|
-
* or in part, to children under age 13, see the <a href="
|
|
939
|
+
* or in part, to children under age 13, see the <a href="http://aws.amazon.com/lex/faqs#data-security">Amazon Lex
|
|
862
940
|
* FAQ</a>.</p>
|
|
863
941
|
*/
|
|
864
942
|
childDirected: boolean | undefined;
|
|
@@ -968,9 +1046,9 @@ export interface BotLocaleFilter {
|
|
|
968
1046
|
values: string[] | undefined;
|
|
969
1047
|
/**
|
|
970
1048
|
* <p>The operator to use for the filter. Specify <code>EQ</code> when the
|
|
971
|
-
*
|
|
1049
|
+
* <code>ListBotLocales</code> operation should return only aliases
|
|
972
1050
|
* that equal the specified value. Specify <code>CO</code> when the
|
|
973
|
-
*
|
|
1051
|
+
* <code>ListBotLocales</code> operation should return aliases that
|
|
974
1052
|
* contain the specified value.</p>
|
|
975
1053
|
*/
|
|
976
1054
|
operator: BotLocaleFilterOperator | string | undefined;
|
|
@@ -978,7 +1056,7 @@ export interface BotLocaleFilter {
|
|
|
978
1056
|
/**
|
|
979
1057
|
* @public
|
|
980
1058
|
* <p>Provides information about an event that occurred affecting the bot
|
|
981
|
-
*
|
|
1059
|
+
* locale.</p>
|
|
982
1060
|
*/
|
|
983
1061
|
export interface BotLocaleHistoryEvent {
|
|
984
1062
|
/**
|
|
@@ -1013,13 +1091,9 @@ export interface VoiceSettings {
|
|
|
1013
1091
|
*/
|
|
1014
1092
|
voiceId: string | undefined;
|
|
1015
1093
|
/**
|
|
1016
|
-
* <p>Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more
|
|
1017
|
-
*
|
|
1018
|
-
*
|
|
1019
|
-
* <code>SynthesizeSpeech</code> operation</a> in the
|
|
1020
|
-
* <i>Amazon Polly developer guide</i>.</p>
|
|
1021
|
-
* <p>If you do not specify a value, the default is
|
|
1022
|
-
* <code>standard</code>.</p>
|
|
1094
|
+
* <p>Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine">
|
|
1095
|
+
* <code>engine</code> parameter of the <code>SynthesizeSpeech</code> operation</a> in the <i>Amazon Polly developer guide</i>.</p>
|
|
1096
|
+
* <p>If you do not specify a value, the default is <code>standard</code>.</p>
|
|
1023
1097
|
*/
|
|
1024
1098
|
engine?: VoiceEngine | string;
|
|
1025
1099
|
}
|
|
@@ -1152,7 +1226,7 @@ export interface BotLocaleSummary {
|
|
|
1152
1226
|
description?: string;
|
|
1153
1227
|
/**
|
|
1154
1228
|
* <p>The current status of the bot locale. When the status is
|
|
1155
|
-
*
|
|
1229
|
+
* <code>Built</code> the locale is ready for use.</p>
|
|
1156
1230
|
*/
|
|
1157
1231
|
botLocaleStatus?: BotLocaleStatus | string;
|
|
1158
1232
|
/**
|
|
@@ -1195,24 +1269,24 @@ export interface BotMember {
|
|
|
1195
1269
|
/**
|
|
1196
1270
|
* @public
|
|
1197
1271
|
* <p>The object that contains the statistical summary of recommended
|
|
1198
|
-
*
|
|
1272
|
+
* intents associated with the bot recommendation.</p>
|
|
1199
1273
|
*/
|
|
1200
1274
|
export interface IntentStatistics {
|
|
1201
1275
|
/**
|
|
1202
1276
|
* <p>The number of recommended intents associated with the bot
|
|
1203
|
-
*
|
|
1277
|
+
* recommendation.</p>
|
|
1204
1278
|
*/
|
|
1205
1279
|
discoveredIntentCount?: number;
|
|
1206
1280
|
}
|
|
1207
1281
|
/**
|
|
1208
1282
|
* @public
|
|
1209
1283
|
* <p>The object that contains the statistical summary of the recommended
|
|
1210
|
-
*
|
|
1284
|
+
* slot type associated with the bot recommendation.</p>
|
|
1211
1285
|
*/
|
|
1212
1286
|
export interface SlotTypeStatistics {
|
|
1213
1287
|
/**
|
|
1214
1288
|
* <p>The number of recommended slot types associated with the bot
|
|
1215
|
-
*
|
|
1289
|
+
* recommendation.</p>
|
|
1216
1290
|
*/
|
|
1217
1291
|
discoveredSlotTypeCount?: number;
|
|
1218
1292
|
}
|
|
@@ -1223,20 +1297,20 @@ export interface SlotTypeStatistics {
|
|
|
1223
1297
|
export interface BotRecommendationResultStatistics {
|
|
1224
1298
|
/**
|
|
1225
1299
|
* <p>Statistical information about about the intents associated with the
|
|
1226
|
-
*
|
|
1300
|
+
* bot recommendation results.</p>
|
|
1227
1301
|
*/
|
|
1228
1302
|
intents?: IntentStatistics;
|
|
1229
1303
|
/**
|
|
1230
1304
|
* <p>Statistical information about the slot types associated with the bot
|
|
1231
|
-
*
|
|
1305
|
+
* recommendation results.</p>
|
|
1232
1306
|
*/
|
|
1233
1307
|
slotTypes?: SlotTypeStatistics;
|
|
1234
1308
|
}
|
|
1235
1309
|
/**
|
|
1236
1310
|
* @public
|
|
1237
1311
|
* <p>The object representing the URL of the bot definition, the URL of
|
|
1238
|
-
*
|
|
1239
|
-
*
|
|
1312
|
+
* the associated transcript, and a statistical summary of the bot
|
|
1313
|
+
* recommendation results.</p>
|
|
1240
1314
|
*/
|
|
1241
1315
|
export interface BotRecommendationResults {
|
|
1242
1316
|
/**
|
|
@@ -1374,7 +1448,7 @@ export interface BotSummary {
|
|
|
1374
1448
|
description?: string;
|
|
1375
1449
|
/**
|
|
1376
1450
|
* <p>The current status of the bot. When the status is
|
|
1377
|
-
*
|
|
1451
|
+
* <code>Available</code> the bot is ready for use.</p>
|
|
1378
1452
|
*/
|
|
1379
1453
|
botStatus?: BotStatus | string;
|
|
1380
1454
|
/**
|
|
@@ -1608,7 +1682,7 @@ export interface BuiltInSlotTypeSortBy {
|
|
|
1608
1682
|
/**
|
|
1609
1683
|
* @public
|
|
1610
1684
|
* <p>Provides summary information about a built-in slot type for the
|
|
1611
|
-
*
|
|
1685
|
+
* <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html"> ListBuiltInSlotTypes </a>
|
|
1612
1686
|
* operation.</p>
|
|
1613
1687
|
*/
|
|
1614
1688
|
export interface BuiltInSlotTypeSummary {
|
|
@@ -1713,7 +1787,7 @@ export declare const DialogActionType: {
|
|
|
1713
1787
|
export type DialogActionType = (typeof DialogActionType)[keyof typeof DialogActionType];
|
|
1714
1788
|
/**
|
|
1715
1789
|
* @public
|
|
1716
|
-
* <p>
|
|
1790
|
+
* <p>Defines the action that the bot executes at runtime when the
|
|
1717
1791
|
* conversation reaches this step.</p>
|
|
1718
1792
|
*/
|
|
1719
1793
|
export interface DialogAction {
|
|
@@ -1822,7 +1896,7 @@ export interface SSMLMessage {
|
|
|
1822
1896
|
}
|
|
1823
1897
|
/**
|
|
1824
1898
|
* @public
|
|
1825
|
-
* <p>The object that provides message text and
|
|
1899
|
+
* <p>The object that provides message text and its type.</p>
|
|
1826
1900
|
*/
|
|
1827
1901
|
export interface Message {
|
|
1828
1902
|
/**
|
|
@@ -1878,6 +1952,165 @@ export interface ResponseSpecification {
|
|
|
1878
1952
|
*/
|
|
1879
1953
|
allowInterrupt?: boolean;
|
|
1880
1954
|
}
|
|
1955
|
+
/**
|
|
1956
|
+
* @public
|
|
1957
|
+
* @enum
|
|
1958
|
+
*/
|
|
1959
|
+
export declare const TestResultMatchStatus: {
|
|
1960
|
+
readonly ExecutionError: "ExecutionError";
|
|
1961
|
+
readonly Matched: "Matched";
|
|
1962
|
+
readonly Mismatched: "Mismatched";
|
|
1963
|
+
};
|
|
1964
|
+
/**
|
|
1965
|
+
* @public
|
|
1966
|
+
*/
|
|
1967
|
+
export type TestResultMatchStatus = (typeof TestResultMatchStatus)[keyof typeof TestResultMatchStatus];
|
|
1968
|
+
/**
|
|
1969
|
+
* @public
|
|
1970
|
+
* <p>The item listing the evaluation of intent level success or failure.</p>
|
|
1971
|
+
*/
|
|
1972
|
+
export interface ConversationLevelIntentClassificationResultItem {
|
|
1973
|
+
/**
|
|
1974
|
+
* <p>The intent name used in the evaluation of intent level success or failure.</p>
|
|
1975
|
+
*/
|
|
1976
|
+
intentName: string | undefined;
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>The number of times the specific intent is used in the evaluation of intent level
|
|
1979
|
+
* success or failure.</p>
|
|
1980
|
+
*/
|
|
1981
|
+
matchResult: TestResultMatchStatus | string | undefined;
|
|
1982
|
+
}
|
|
1983
|
+
/**
|
|
1984
|
+
* @public
|
|
1985
|
+
* <p>The conversation level details of the conversation used in the test set.</p>
|
|
1986
|
+
*/
|
|
1987
|
+
export interface ConversationLevelResultDetail {
|
|
1988
|
+
/**
|
|
1989
|
+
* <p>The success or failure of the streaming of the conversation.</p>
|
|
1990
|
+
*/
|
|
1991
|
+
endToEndResult: TestResultMatchStatus | string | undefined;
|
|
1992
|
+
/**
|
|
1993
|
+
* <p>The speech transcription success or failure details of the conversation.</p>
|
|
1994
|
+
*/
|
|
1995
|
+
speechTranscriptionResult?: TestResultMatchStatus | string;
|
|
1996
|
+
}
|
|
1997
|
+
/**
|
|
1998
|
+
* @public
|
|
1999
|
+
* <p>The slots used for the slot resolution in the conversation.</p>
|
|
2000
|
+
*/
|
|
2001
|
+
export interface ConversationLevelSlotResolutionResultItem {
|
|
2002
|
+
/**
|
|
2003
|
+
* <p>The intents used in the slots list for the slot resolution details.</p>
|
|
2004
|
+
*/
|
|
2005
|
+
intentName: string | undefined;
|
|
2006
|
+
/**
|
|
2007
|
+
* <p>The slot name in the slots list for the slot resolution details.</p>
|
|
2008
|
+
*/
|
|
2009
|
+
slotName: string | undefined;
|
|
2010
|
+
/**
|
|
2011
|
+
* <p>The number of matching slots used in the slots listings for the slot resolution evaluation.</p>
|
|
2012
|
+
*/
|
|
2013
|
+
matchResult: TestResultMatchStatus | string | undefined;
|
|
2014
|
+
}
|
|
2015
|
+
/**
|
|
2016
|
+
* @public
|
|
2017
|
+
* <p>The test result evaluation item at the conversation level.</p>
|
|
2018
|
+
*/
|
|
2019
|
+
export interface ConversationLevelTestResultItem {
|
|
2020
|
+
/**
|
|
2021
|
+
* <p>The conversation Id of the test result evaluation item.</p>
|
|
2022
|
+
*/
|
|
2023
|
+
conversationId: string | undefined;
|
|
2024
|
+
/**
|
|
2025
|
+
* <p>The end-to-end success or failure of the test result evaluation item.</p>
|
|
2026
|
+
*/
|
|
2027
|
+
endToEndResult: TestResultMatchStatus | string | undefined;
|
|
2028
|
+
/**
|
|
2029
|
+
* <p>The speech transcription success or failure of the test result evaluation item.</p>
|
|
2030
|
+
*/
|
|
2031
|
+
speechTranscriptionResult?: TestResultMatchStatus | string;
|
|
2032
|
+
/**
|
|
2033
|
+
* <p>The intent classification of the test result evaluation item.</p>
|
|
2034
|
+
*/
|
|
2035
|
+
intentClassificationResults: ConversationLevelIntentClassificationResultItem[] | undefined;
|
|
2036
|
+
/**
|
|
2037
|
+
* <p>The slot success or failure of the test result evaluation item.</p>
|
|
2038
|
+
*/
|
|
2039
|
+
slotResolutionResults: ConversationLevelSlotResolutionResultItem[] | undefined;
|
|
2040
|
+
}
|
|
2041
|
+
/**
|
|
2042
|
+
* @public
|
|
2043
|
+
* <p>The test set results data at the conversation level.</p>
|
|
2044
|
+
*/
|
|
2045
|
+
export interface ConversationLevelTestResults {
|
|
2046
|
+
/**
|
|
2047
|
+
* <p>The item list in the test set results data at the conversation level.</p>
|
|
2048
|
+
*/
|
|
2049
|
+
items: ConversationLevelTestResultItem[] | undefined;
|
|
2050
|
+
}
|
|
2051
|
+
/**
|
|
2052
|
+
* @public
|
|
2053
|
+
* <p>The selection to filter the test set results data at the conversation level.</p>
|
|
2054
|
+
*/
|
|
2055
|
+
export interface ConversationLevelTestResultsFilterBy {
|
|
2056
|
+
/**
|
|
2057
|
+
* <p>The selection of matched or mismatched end-to-end status to filter test set results data
|
|
2058
|
+
* at the conversation level.</p>
|
|
2059
|
+
*/
|
|
2060
|
+
endToEndResult?: TestResultMatchStatus | string;
|
|
2061
|
+
}
|
|
2062
|
+
/**
|
|
2063
|
+
* @public
|
|
2064
|
+
* @enum
|
|
2065
|
+
*/
|
|
2066
|
+
export declare const ConversationLogsInputModeFilter: {
|
|
2067
|
+
readonly Speech: "Speech";
|
|
2068
|
+
readonly Text: "Text";
|
|
2069
|
+
};
|
|
2070
|
+
/**
|
|
2071
|
+
* @public
|
|
2072
|
+
*/
|
|
2073
|
+
export type ConversationLogsInputModeFilter = (typeof ConversationLogsInputModeFilter)[keyof typeof ConversationLogsInputModeFilter];
|
|
2074
|
+
/**
|
|
2075
|
+
* @public
|
|
2076
|
+
* <p>The selected data source to filter the conversation log.</p>
|
|
2077
|
+
*/
|
|
2078
|
+
export interface ConversationLogsDataSourceFilterBy {
|
|
2079
|
+
/**
|
|
2080
|
+
* <p>The start time for the conversation log.</p>
|
|
2081
|
+
*/
|
|
2082
|
+
startTime: Date | undefined;
|
|
2083
|
+
/**
|
|
2084
|
+
* <p>The end time for the conversation log.</p>
|
|
2085
|
+
*/
|
|
2086
|
+
endTime: Date | undefined;
|
|
2087
|
+
/**
|
|
2088
|
+
* <p>The selection to filter by input mode for the conversation logs. </p>
|
|
2089
|
+
*/
|
|
2090
|
+
inputMode: ConversationLogsInputModeFilter | string | undefined;
|
|
2091
|
+
}
|
|
2092
|
+
/**
|
|
2093
|
+
* @public
|
|
2094
|
+
* <p>The data source that uses conversation logs.</p>
|
|
2095
|
+
*/
|
|
2096
|
+
export interface ConversationLogsDataSource {
|
|
2097
|
+
/**
|
|
2098
|
+
* <p>The bot Id from the conversation logs.</p>
|
|
2099
|
+
*/
|
|
2100
|
+
botId: string | undefined;
|
|
2101
|
+
/**
|
|
2102
|
+
* <p>The bot alias Id from the conversation logs.</p>
|
|
2103
|
+
*/
|
|
2104
|
+
botAliasId: string | undefined;
|
|
2105
|
+
/**
|
|
2106
|
+
* <p>The locale Id of the conversation log.</p>
|
|
2107
|
+
*/
|
|
2108
|
+
localeId: string | undefined;
|
|
2109
|
+
/**
|
|
2110
|
+
* <p>The filter for the data source of the conversation log.</p>
|
|
2111
|
+
*/
|
|
2112
|
+
filter: ConversationLogsDataSourceFilterBy | undefined;
|
|
2113
|
+
}
|
|
1881
2114
|
/**
|
|
1882
2115
|
* @public
|
|
1883
2116
|
* <p>Defines the Amazon CloudWatch Logs destination log group for
|
|
@@ -2325,6 +2558,7 @@ export interface CreateBotVersionResponse {
|
|
|
2325
2558
|
* @enum
|
|
2326
2559
|
*/
|
|
2327
2560
|
export declare const ImportExportFileFormat: {
|
|
2561
|
+
readonly CSV: "CSV";
|
|
2328
2562
|
readonly LexJson: "LexJson";
|
|
2329
2563
|
readonly TSV: "TSV";
|
|
2330
2564
|
};
|
|
@@ -2350,6 +2584,16 @@ export interface CustomVocabularyExportSpecification {
|
|
|
2350
2584
|
*/
|
|
2351
2585
|
localeId: string | undefined;
|
|
2352
2586
|
}
|
|
2587
|
+
/**
|
|
2588
|
+
* @public
|
|
2589
|
+
* <p>Contains information about the test set that is exported.</p>
|
|
2590
|
+
*/
|
|
2591
|
+
export interface TestSetExportSpecification {
|
|
2592
|
+
/**
|
|
2593
|
+
* <p>The unique identifier of the test set.</p>
|
|
2594
|
+
*/
|
|
2595
|
+
testSetId: string | undefined;
|
|
2596
|
+
}
|
|
2353
2597
|
/**
|
|
2354
2598
|
* @public
|
|
2355
2599
|
* <p>Provides information about the bot or bot locale that you want to
|
|
@@ -2369,6 +2613,10 @@ export interface ExportResourceSpecification {
|
|
|
2369
2613
|
* <p>The parameters required to export a custom vocabulary.</p>
|
|
2370
2614
|
*/
|
|
2371
2615
|
customVocabularyExportSpecification?: CustomVocabularyExportSpecification;
|
|
2616
|
+
/**
|
|
2617
|
+
* <p>Specifications for the test set that is exported as a resource.</p>
|
|
2618
|
+
*/
|
|
2619
|
+
testSetExportSpecification?: TestSetExportSpecification;
|
|
2372
2620
|
}
|
|
2373
2621
|
/**
|
|
2374
2622
|
* @public
|
|
@@ -2459,7 +2707,7 @@ export interface FulfillmentStartResponseSpecification {
|
|
|
2459
2707
|
*/
|
|
2460
2708
|
delayInSeconds: number | undefined;
|
|
2461
2709
|
/**
|
|
2462
|
-
* <p>
|
|
2710
|
+
* <p>1 - 5 message groups that contain start messages. Amazon Lex chooses
|
|
2463
2711
|
* one of the messages to play to the user.</p>
|
|
2464
2712
|
*/
|
|
2465
2713
|
messageGroups: MessageGroup[] | undefined;
|
|
@@ -2483,7 +2731,7 @@ export interface FulfillmentUpdateResponseSpecification {
|
|
|
2483
2731
|
*/
|
|
2484
2732
|
frequencyInSeconds: number | undefined;
|
|
2485
2733
|
/**
|
|
2486
|
-
* <p>
|
|
2734
|
+
* <p>1 - 5 message groups that contain update messages. Amazon Lex chooses
|
|
2487
2735
|
* one of the messages to play to the user.</p>
|
|
2488
2736
|
*/
|
|
2489
2737
|
messageGroups: MessageGroup[] | undefined;
|
|
@@ -2525,7 +2773,7 @@ export interface FulfillmentUpdatesSpecification {
|
|
|
2525
2773
|
}
|
|
2526
2774
|
/**
|
|
2527
2775
|
* @public
|
|
2528
|
-
* <p>
|
|
2776
|
+
* <p>A context that must be active for an intent to be
|
|
2529
2777
|
* selected by Amazon Lex.</p>
|
|
2530
2778
|
*/
|
|
2531
2779
|
export interface InputContext {
|
|
@@ -2642,7 +2890,7 @@ export interface PromptSpecification {
|
|
|
2642
2890
|
}
|
|
2643
2891
|
/**
|
|
2644
2892
|
* @public
|
|
2645
|
-
* <p>Provides configuration information for the AMAZON.KendraSearchIntent
|
|
2893
|
+
* <p>Provides configuration information for the <code>AMAZON.KendraSearchIntent</code>
|
|
2646
2894
|
* intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra
|
|
2647
2895
|
* index and returns documents from the index that match the user's
|
|
2648
2896
|
* utterance.</p>
|
|
@@ -2650,12 +2898,12 @@ export interface PromptSpecification {
|
|
|
2650
2898
|
export interface KendraConfiguration {
|
|
2651
2899
|
/**
|
|
2652
2900
|
* <p>The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
|
|
2653
|
-
* AMAZON.KendraSearchIntent intent to search. The index must be in the
|
|
2901
|
+
* <code>AMAZON.KendraSearchIntent</code> intent to search. The index must be in the
|
|
2654
2902
|
* same account and Region as the Amazon Lex bot.</p>
|
|
2655
2903
|
*/
|
|
2656
2904
|
kendraIndex: string | undefined;
|
|
2657
2905
|
/**
|
|
2658
|
-
* <p>Determines whether the AMAZON.KendraSearchIntent intent uses a
|
|
2906
|
+
* <p>Determines whether the <code>AMAZON.KendraSearchIntent</code> intent uses a
|
|
2659
2907
|
* custom query string to query the Amazon Kendra index.</p>
|
|
2660
2908
|
*/
|
|
2661
2909
|
queryFilterStringEnabled?: boolean;
|
|
@@ -2759,7 +3007,7 @@ export type Effect = (typeof Effect)[keyof typeof Effect];
|
|
|
2759
3007
|
*/
|
|
2760
3008
|
export interface Principal {
|
|
2761
3009
|
/**
|
|
2762
|
-
* <p>The name of the
|
|
3010
|
+
* <p>The name of the Amazon Web Services service that should allowed or denied access to
|
|
2763
3011
|
* an Amazon Lex action.</p>
|
|
2764
3012
|
*/
|
|
2765
3013
|
service?: string;
|
|
@@ -2790,9 +3038,10 @@ export interface CreateResourcePolicyStatementRequest {
|
|
|
2790
3038
|
*/
|
|
2791
3039
|
effect: Effect | string | undefined;
|
|
2792
3040
|
/**
|
|
2793
|
-
* <p>An IAM principal, such as an IAM
|
|
3041
|
+
* <p>An IAM principal, such as an IAM user, IAM role,
|
|
3042
|
+
* or Amazon Web Services services
|
|
2794
3043
|
* that is allowed or denied access to a resource. For more information,
|
|
2795
|
-
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">
|
|
3044
|
+
* see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html">Amazon Web Services JSON policy elements: Principal</a>.</p>
|
|
2796
3045
|
*/
|
|
2797
3046
|
principal: Principal[] | undefined;
|
|
2798
3047
|
/**
|
|
@@ -3036,27 +3285,25 @@ export type SlotConstraint = (typeof SlotConstraint)[keyof typeof SlotConstraint
|
|
|
3036
3285
|
/**
|
|
3037
3286
|
* @public
|
|
3038
3287
|
* <p>Describes the Amazon S3 bucket name and location for the grammar
|
|
3039
|
-
*
|
|
3288
|
+
* that is the source for the slot type.</p>
|
|
3040
3289
|
*/
|
|
3041
3290
|
export interface GrammarSlotTypeSource {
|
|
3042
3291
|
/**
|
|
3043
|
-
* <p>The name of the S3 bucket that contains the grammar source.</p>
|
|
3292
|
+
* <p>The name of the Amazon S3 bucket that contains the grammar source.</p>
|
|
3044
3293
|
*/
|
|
3045
3294
|
s3BucketName: string | undefined;
|
|
3046
3295
|
/**
|
|
3047
|
-
* <p>The path to the grammar in the S3 bucket.</p>
|
|
3296
|
+
* <p>The path to the grammar in the Amazon S3 bucket.</p>
|
|
3048
3297
|
*/
|
|
3049
3298
|
s3ObjectKey: string | undefined;
|
|
3050
3299
|
/**
|
|
3051
|
-
* <p>The
|
|
3052
|
-
* if any.</p>
|
|
3300
|
+
* <p>The KMS key required to decrypt the contents of the grammar, if any.</p>
|
|
3053
3301
|
*/
|
|
3054
3302
|
kmsKeyArn?: string;
|
|
3055
3303
|
}
|
|
3056
3304
|
/**
|
|
3057
3305
|
* @public
|
|
3058
|
-
* <p>Settings requried for a slot type based on a grammar that you
|
|
3059
|
-
* provide.</p>
|
|
3306
|
+
* <p>Settings requried for a slot type based on a grammar that you provide.</p>
|
|
3060
3307
|
*/
|
|
3061
3308
|
export interface GrammarSlotTypeSetting {
|
|
3062
3309
|
/**
|
|
@@ -3066,13 +3313,11 @@ export interface GrammarSlotTypeSetting {
|
|
|
3066
3313
|
}
|
|
3067
3314
|
/**
|
|
3068
3315
|
* @public
|
|
3069
|
-
* <p>Provides information about the external source of the slot type's
|
|
3070
|
-
* definition.</p>
|
|
3316
|
+
* <p>Provides information about the external source of the slot type's definition.</p>
|
|
3071
3317
|
*/
|
|
3072
3318
|
export interface ExternalSourceSetting {
|
|
3073
3319
|
/**
|
|
3074
|
-
* <p>Settings required for a slot type based on a grammar that you
|
|
3075
|
-
* provide.</p>
|
|
3320
|
+
* <p>Settings required for a slot type based on a grammar that you provide.</p>
|
|
3076
3321
|
*/
|
|
3077
3322
|
grammarSlotTypeSetting?: GrammarSlotTypeSetting;
|
|
3078
3323
|
}
|
|
@@ -3120,11 +3365,11 @@ export interface SlotValueRegexFilter {
|
|
|
3120
3365
|
* <p>0-9</p>
|
|
3121
3366
|
* </li>
|
|
3122
3367
|
* <li>
|
|
3123
|
-
* <p>Unicode characters ("
|
|
3368
|
+
* <p>Unicode characters ("\u<Unicode>")</p>
|
|
3124
3369
|
* </li>
|
|
3125
3370
|
* </ul>
|
|
3126
|
-
* <p> Represent Unicode characters with four digits, for example "
|
|
3127
|
-
* or "
|
|
3371
|
+
* <p> Represent Unicode characters with four digits, for example "\u0041"
|
|
3372
|
+
* or "\u005A". </p>
|
|
3128
3373
|
* <p> The following regular expression operators are not supported: </p>
|
|
3129
3374
|
* <ul>
|
|
3130
3375
|
* <li>
|
|
@@ -3161,17 +3406,19 @@ export interface SlotValueSelectionSetting {
|
|
|
3161
3406
|
* values:</p>
|
|
3162
3407
|
* <ul>
|
|
3163
3408
|
* <li>
|
|
3164
|
-
* <p>
|
|
3409
|
+
* <p>
|
|
3410
|
+
* <code>ORIGINAL_VALUE</code> - Returns the value entered by the user, if the
|
|
3165
3411
|
* user value is similar to the slot value.</p>
|
|
3166
3412
|
* </li>
|
|
3167
3413
|
* <li>
|
|
3168
|
-
* <p>
|
|
3414
|
+
* <p>
|
|
3415
|
+
* <code>TOP_RESOLUTION</code> - If there is a resolution list for the slot,
|
|
3169
3416
|
* return the first value in the resolution list as the slot type
|
|
3170
3417
|
* value. If there is no resolution list, null is returned.</p>
|
|
3171
3418
|
* </li>
|
|
3172
3419
|
* </ul>
|
|
3173
|
-
* <p>If you don't specify the valueSelectionStrategy
|
|
3174
|
-
*
|
|
3420
|
+
* <p>If you don't specify the <code>valueSelectionStrategy</code>, the
|
|
3421
|
+
* default is <code>ORIGINAL_VALUE</code>.</p>
|
|
3175
3422
|
*/
|
|
3176
3423
|
resolutionStrategy: SlotValueResolutionStrategy | string | undefined;
|
|
3177
3424
|
/**
|
|
@@ -3180,7 +3427,8 @@ export interface SlotValueSelectionSetting {
|
|
|
3180
3427
|
regexFilter?: SlotValueRegexFilter;
|
|
3181
3428
|
/**
|
|
3182
3429
|
* <p>Provides settings that enable advanced recognition settings for slot
|
|
3183
|
-
* values
|
|
3430
|
+
* values. You can use this to enable using slot values as a custom
|
|
3431
|
+
* vocabulary for recognizing user utterances.</p>
|
|
3184
3432
|
*/
|
|
3185
3433
|
advancedRecognitionSetting?: AdvancedRecognitionSetting;
|
|
3186
3434
|
}
|
|
@@ -3190,7 +3438,7 @@ export interface SlotValueSelectionSetting {
|
|
|
3190
3438
|
export interface CreateSlotTypeRequest {
|
|
3191
3439
|
/**
|
|
3192
3440
|
* <p>The name for the slot. A slot type name must be unique within the
|
|
3193
|
-
*
|
|
3441
|
+
* intent.</p>
|
|
3194
3442
|
*/
|
|
3195
3443
|
slotTypeName: string | undefined;
|
|
3196
3444
|
/**
|
|
@@ -3212,18 +3460,18 @@ export interface CreateSlotTypeRequest {
|
|
|
3212
3460
|
* <ul>
|
|
3213
3461
|
* <li>
|
|
3214
3462
|
* <p>
|
|
3215
|
-
* <code>
|
|
3463
|
+
* <code>ORIGINAL_VALUE</code> - Returns the value entered by the
|
|
3216
3464
|
* user, if the user value is similar to the slot value.</p>
|
|
3217
3465
|
* </li>
|
|
3218
3466
|
* <li>
|
|
3219
3467
|
* <p>
|
|
3220
|
-
* <code>
|
|
3468
|
+
* <code>TOP_RESOLUTION</code> - If there is a resolution list for
|
|
3221
3469
|
* the slot, return the first value in the resolution list. If there
|
|
3222
3470
|
* is no resolution list, return null.</p>
|
|
3223
3471
|
* </li>
|
|
3224
3472
|
* </ul>
|
|
3225
3473
|
* <p>If you don't specify the <code>valueSelectionSetting</code>
|
|
3226
|
-
* parameter, the default is <code>
|
|
3474
|
+
* parameter, the default is <code>ORIGINAL_VALUE</code>.</p>
|
|
3227
3475
|
*/
|
|
3228
3476
|
valueSelectionSetting?: SlotValueSelectionSetting;
|
|
3229
3477
|
/**
|
|
@@ -3318,6 +3566,71 @@ export interface CreateSlotTypeResponse {
|
|
|
3318
3566
|
*/
|
|
3319
3567
|
compositeSlotTypeSetting?: CompositeSlotTypeSetting;
|
|
3320
3568
|
}
|
|
3569
|
+
/**
|
|
3570
|
+
* @public
|
|
3571
|
+
* <p>Contains information about the bot alias used for the
|
|
3572
|
+
* test set discrepancy report.</p>
|
|
3573
|
+
*/
|
|
3574
|
+
export interface TestSetDiscrepancyReportBotAliasTarget {
|
|
3575
|
+
/**
|
|
3576
|
+
* <p>The unique identifier for the bot alias.</p>
|
|
3577
|
+
*/
|
|
3578
|
+
botId: string | undefined;
|
|
3579
|
+
/**
|
|
3580
|
+
* <p>The unique identifier for the bot associated with the bot alias.</p>
|
|
3581
|
+
*/
|
|
3582
|
+
botAliasId: string | undefined;
|
|
3583
|
+
/**
|
|
3584
|
+
* <p>The unique identifier of the locale associated with the bot alias.</p>
|
|
3585
|
+
*/
|
|
3586
|
+
localeId: string | undefined;
|
|
3587
|
+
}
|
|
3588
|
+
/**
|
|
3589
|
+
* @public
|
|
3590
|
+
* <p>Contains information about the resource used for the
|
|
3591
|
+
* test set discrepancy report.</p>
|
|
3592
|
+
*/
|
|
3593
|
+
export interface TestSetDiscrepancyReportResourceTarget {
|
|
3594
|
+
/**
|
|
3595
|
+
* <p>Contains information about the bot alias used as the resource for the
|
|
3596
|
+
* test set discrepancy report.</p>
|
|
3597
|
+
*/
|
|
3598
|
+
botAliasTarget?: TestSetDiscrepancyReportBotAliasTarget;
|
|
3599
|
+
}
|
|
3600
|
+
/**
|
|
3601
|
+
* @public
|
|
3602
|
+
*/
|
|
3603
|
+
export interface CreateTestSetDiscrepancyReportRequest {
|
|
3604
|
+
/**
|
|
3605
|
+
* <p>The test set Id for the test set discrepancy report.</p>
|
|
3606
|
+
*/
|
|
3607
|
+
testSetId: string | undefined;
|
|
3608
|
+
/**
|
|
3609
|
+
* <p>The target bot for the test set discrepancy report.</p>
|
|
3610
|
+
*/
|
|
3611
|
+
target: TestSetDiscrepancyReportResourceTarget | undefined;
|
|
3612
|
+
}
|
|
3613
|
+
/**
|
|
3614
|
+
* @public
|
|
3615
|
+
*/
|
|
3616
|
+
export interface CreateTestSetDiscrepancyReportResponse {
|
|
3617
|
+
/**
|
|
3618
|
+
* <p>The unique identifier of the test set discrepancy report to describe.</p>
|
|
3619
|
+
*/
|
|
3620
|
+
testSetDiscrepancyReportId?: string;
|
|
3621
|
+
/**
|
|
3622
|
+
* <p>The creation date and time for the test set discrepancy report.</p>
|
|
3623
|
+
*/
|
|
3624
|
+
creationDateTime?: Date;
|
|
3625
|
+
/**
|
|
3626
|
+
* <p>The test set Id for the test set discrepancy report.</p>
|
|
3627
|
+
*/
|
|
3628
|
+
testSetId?: string;
|
|
3629
|
+
/**
|
|
3630
|
+
* <p>The target bot for the test set discrepancy report.</p>
|
|
3631
|
+
*/
|
|
3632
|
+
target?: TestSetDiscrepancyReportResourceTarget;
|
|
3633
|
+
}
|
|
3321
3634
|
/**
|
|
3322
3635
|
* @public
|
|
3323
3636
|
*/
|
|
@@ -3353,7 +3666,7 @@ export interface CustomVocabularyImportSpecification {
|
|
|
3353
3666
|
botVersion: string | undefined;
|
|
3354
3667
|
/**
|
|
3355
3668
|
* <p>The identifier of the local to import the custom vocabulary to. The value must
|
|
3356
|
-
*
|
|
3669
|
+
* be <code>en_GB</code>.</p>
|
|
3357
3670
|
*/
|
|
3358
3671
|
localeId: string | undefined;
|
|
3359
3672
|
}
|
|
@@ -3375,17 +3688,17 @@ export type CustomVocabularyStatus = (typeof CustomVocabularyStatus)[keyof typeo
|
|
|
3375
3688
|
/**
|
|
3376
3689
|
* @public
|
|
3377
3690
|
* <p>The object used for specifying the data range that the customer
|
|
3378
|
-
*
|
|
3691
|
+
* wants Amazon Lex to read through in the input transcripts.</p>
|
|
3379
3692
|
*/
|
|
3380
3693
|
export interface DateRangeFilter {
|
|
3381
3694
|
/**
|
|
3382
3695
|
* <p>A timestamp indicating the start date for the date range
|
|
3383
|
-
*
|
|
3696
|
+
* filter.</p>
|
|
3384
3697
|
*/
|
|
3385
3698
|
startDateTime: Date | undefined;
|
|
3386
3699
|
/**
|
|
3387
3700
|
* <p>A timestamp indicating the end date for the date range
|
|
3388
|
-
*
|
|
3701
|
+
* filter.</p>
|
|
3389
3702
|
*/
|
|
3390
3703
|
endDateTime: Date | undefined;
|
|
3391
3704
|
}
|
|
@@ -3807,6 +4120,15 @@ export interface DeleteSlotTypeRequest {
|
|
|
3807
4120
|
*/
|
|
3808
4121
|
skipResourceInUseCheck?: boolean;
|
|
3809
4122
|
}
|
|
4123
|
+
/**
|
|
4124
|
+
* @public
|
|
4125
|
+
*/
|
|
4126
|
+
export interface DeleteTestSetRequest {
|
|
4127
|
+
/**
|
|
4128
|
+
* <p>The test set Id of the test set to be deleted.</p>
|
|
4129
|
+
*/
|
|
4130
|
+
testSetId: string | undefined;
|
|
4131
|
+
}
|
|
3810
4132
|
/**
|
|
3811
4133
|
* @public
|
|
3812
4134
|
*/
|
|
@@ -4003,7 +4325,7 @@ export interface DescribeBotLocaleRequest {
|
|
|
4003
4325
|
*/
|
|
4004
4326
|
botId: string | undefined;
|
|
4005
4327
|
/**
|
|
4006
|
-
* <p>The
|
|
4328
|
+
* <p>The version of the bot associated with the
|
|
4007
4329
|
* locale.</p>
|
|
4008
4330
|
*/
|
|
4009
4331
|
botVersion: string | undefined;
|
|
@@ -4022,7 +4344,7 @@ export interface DescribeBotLocaleResponse {
|
|
|
4022
4344
|
*/
|
|
4023
4345
|
botId?: string;
|
|
4024
4346
|
/**
|
|
4025
|
-
* <p>The
|
|
4347
|
+
* <p>The version of the bot associated with the
|
|
4026
4348
|
* locale.</p>
|
|
4027
4349
|
*/
|
|
4028
4350
|
botVersion?: string;
|
|
@@ -4121,18 +4443,18 @@ export interface DescribeBotRecommendationRequest {
|
|
|
4121
4443
|
/**
|
|
4122
4444
|
* @public
|
|
4123
4445
|
* <p>The object representing the passwords that were used to encrypt the
|
|
4124
|
-
*
|
|
4125
|
-
*
|
|
4446
|
+
* data related to the bot recommendation, as well as the KMS key ARN used
|
|
4447
|
+
* to encrypt the associated metadata.</p>
|
|
4126
4448
|
*/
|
|
4127
4449
|
export interface EncryptionSetting {
|
|
4128
4450
|
/**
|
|
4129
4451
|
* <p>The KMS key ARN used to encrypt the metadata associated with the bot
|
|
4130
|
-
*
|
|
4452
|
+
* recommendation.</p>
|
|
4131
4453
|
*/
|
|
4132
4454
|
kmsKeyArn?: string;
|
|
4133
4455
|
/**
|
|
4134
4456
|
* <p>The password used to encrypt the recommended bot recommendation
|
|
4135
|
-
*
|
|
4457
|
+
* file.</p>
|
|
4136
4458
|
*/
|
|
4137
4459
|
botLocaleExportPassword?: string;
|
|
4138
4460
|
/**
|
|
@@ -4143,41 +4465,41 @@ export interface EncryptionSetting {
|
|
|
4143
4465
|
/**
|
|
4144
4466
|
* @public
|
|
4145
4467
|
* <p>The object that contains a path format that will be applied when
|
|
4146
|
-
*
|
|
4147
|
-
*
|
|
4148
|
-
*
|
|
4468
|
+
* Amazon Lex reads the transcript file in the bucket you provide. Specify this
|
|
4469
|
+
* object if you only want Lex to read a subset of files in your Amazon S3
|
|
4470
|
+
* bucket.</p>
|
|
4149
4471
|
*/
|
|
4150
4472
|
export interface PathFormat {
|
|
4151
4473
|
/**
|
|
4152
4474
|
* <p>A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3
|
|
4153
|
-
*
|
|
4154
|
-
*
|
|
4475
|
+
* bucket. Specify this list if you only want Lex to read the files under
|
|
4476
|
+
* this set of sub-folders.</p>
|
|
4155
4477
|
*/
|
|
4156
4478
|
objectPrefixes?: string[];
|
|
4157
4479
|
}
|
|
4158
4480
|
/**
|
|
4159
4481
|
* @public
|
|
4160
4482
|
* <p>The object that contains transcript filter details that are
|
|
4161
|
-
*
|
|
4483
|
+
* associated with a bot recommendation.</p>
|
|
4162
4484
|
*/
|
|
4163
4485
|
export interface LexTranscriptFilter {
|
|
4164
4486
|
/**
|
|
4165
4487
|
* <p>The object that contains a date range filter that will be applied to
|
|
4166
|
-
*
|
|
4167
|
-
*
|
|
4488
|
+
* the transcript. Specify this object if you want Amazon Lex to only read the
|
|
4489
|
+
* files that are within the date range.</p>
|
|
4168
4490
|
*/
|
|
4169
4491
|
dateRangeFilter?: DateRangeFilter;
|
|
4170
4492
|
}
|
|
4171
4493
|
/**
|
|
4172
4494
|
* @public
|
|
4173
4495
|
* <p>The object representing the filter that Amazon Lex will use to select the
|
|
4174
|
-
*
|
|
4496
|
+
* appropriate transcript.</p>
|
|
4175
4497
|
*/
|
|
4176
4498
|
export interface TranscriptFilter {
|
|
4177
4499
|
/**
|
|
4178
4500
|
* <p>The object representing the filter that Amazon Lex will use to select the
|
|
4179
|
-
*
|
|
4180
|
-
*
|
|
4501
|
+
* appropriate transcript when the transcript format is the Amazon Lex
|
|
4502
|
+
* format.</p>
|
|
4181
4503
|
*/
|
|
4182
4504
|
lexTranscriptFilter?: LexTranscriptFilter;
|
|
4183
4505
|
}
|
|
@@ -4195,49 +4517,49 @@ export type TranscriptFormat = (typeof TranscriptFormat)[keyof typeof Transcript
|
|
|
4195
4517
|
/**
|
|
4196
4518
|
* @public
|
|
4197
4519
|
* <p>The object representing the Amazon S3 bucket containing the transcript,
|
|
4198
|
-
*
|
|
4520
|
+
* as well as the associated metadata.</p>
|
|
4199
4521
|
*/
|
|
4200
4522
|
export interface S3BucketTranscriptSource {
|
|
4201
4523
|
/**
|
|
4202
4524
|
* <p>The name of the bucket containing the transcript and the associated
|
|
4203
|
-
*
|
|
4525
|
+
* metadata.</p>
|
|
4204
4526
|
*/
|
|
4205
4527
|
s3BucketName: string | undefined;
|
|
4206
4528
|
/**
|
|
4207
4529
|
* <p>The object that contains a path format that will be applied when
|
|
4208
|
-
*
|
|
4209
|
-
*
|
|
4210
|
-
*
|
|
4530
|
+
* Amazon Lex reads the transcript file in the bucket you provide. Specify this
|
|
4531
|
+
* object if you only want Lex to read a subset of files in your Amazon S3
|
|
4532
|
+
* bucket.</p>
|
|
4211
4533
|
*/
|
|
4212
4534
|
pathFormat?: PathFormat;
|
|
4213
4535
|
/**
|
|
4214
4536
|
* <p>The format of the transcript content. Currently, Genie only supports
|
|
4215
|
-
*
|
|
4537
|
+
* the Amazon Lex transcript format.</p>
|
|
4216
4538
|
*/
|
|
4217
4539
|
transcriptFormat: TranscriptFormat | string | undefined;
|
|
4218
4540
|
/**
|
|
4219
4541
|
* <p>The object that contains the filter which will be applied when Amazon Lex
|
|
4220
|
-
*
|
|
4221
|
-
*
|
|
4222
|
-
*
|
|
4542
|
+
* reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to
|
|
4543
|
+
* read only a subset of the Amazon S3 bucket based on the filter you
|
|
4544
|
+
* provide.</p>
|
|
4223
4545
|
*/
|
|
4224
4546
|
transcriptFilter?: TranscriptFilter;
|
|
4225
4547
|
/**
|
|
4226
4548
|
* <p>The ARN of the KMS key that customer use to encrypt their Amazon S3
|
|
4227
|
-
*
|
|
4228
|
-
*
|
|
4549
|
+
* bucket. Only use this field if your bucket is encrypted using a
|
|
4550
|
+
* customer managed KMS key.</p>
|
|
4229
4551
|
*/
|
|
4230
4552
|
kmsKeyArn?: string;
|
|
4231
4553
|
}
|
|
4232
4554
|
/**
|
|
4233
4555
|
* @public
|
|
4234
4556
|
* <p>Indicates the setting of the location where the transcript is
|
|
4235
|
-
*
|
|
4557
|
+
* stored.</p>
|
|
4236
4558
|
*/
|
|
4237
4559
|
export interface TranscriptSourceSetting {
|
|
4238
4560
|
/**
|
|
4239
4561
|
* <p>Indicates the setting of the Amazon S3 bucket where the transcript is
|
|
4240
|
-
*
|
|
4562
|
+
* stored.</p>
|
|
4241
4563
|
*/
|
|
4242
4564
|
s3BucketTranscriptSource?: S3BucketTranscriptSource;
|
|
4243
4565
|
}
|
|
@@ -4499,6 +4821,86 @@ export declare const MergeStrategy: {
|
|
|
4499
4821
|
* @public
|
|
4500
4822
|
*/
|
|
4501
4823
|
export type MergeStrategy = (typeof MergeStrategy)[keyof typeof MergeStrategy];
|
|
4824
|
+
/**
|
|
4825
|
+
* @public
|
|
4826
|
+
* <p>Contains information about the Amazon S3 location from which the test set is imported.</p>
|
|
4827
|
+
*/
|
|
4828
|
+
export interface TestSetImportInputLocation {
|
|
4829
|
+
/**
|
|
4830
|
+
* <p>The name of the Amazon S3 bucket.</p>
|
|
4831
|
+
*/
|
|
4832
|
+
s3BucketName: string | undefined;
|
|
4833
|
+
/**
|
|
4834
|
+
* <p>The path inside the Amazon S3 bucket pointing to the test-set CSV file.</p>
|
|
4835
|
+
*/
|
|
4836
|
+
s3Path: string | undefined;
|
|
4837
|
+
}
|
|
4838
|
+
/**
|
|
4839
|
+
* @public
|
|
4840
|
+
* @enum
|
|
4841
|
+
*/
|
|
4842
|
+
export declare const TestSetModality: {
|
|
4843
|
+
readonly Audio: "Audio";
|
|
4844
|
+
readonly Text: "Text";
|
|
4845
|
+
};
|
|
4846
|
+
/**
|
|
4847
|
+
* @public
|
|
4848
|
+
*/
|
|
4849
|
+
export type TestSetModality = (typeof TestSetModality)[keyof typeof TestSetModality];
|
|
4850
|
+
/**
|
|
4851
|
+
* @public
|
|
4852
|
+
* <p>Contains information about the location in which the test set is stored.</p>
|
|
4853
|
+
*/
|
|
4854
|
+
export interface TestSetStorageLocation {
|
|
4855
|
+
/**
|
|
4856
|
+
* <p>The name of the Amazon S3 bucket in which the test set is stored.</p>
|
|
4857
|
+
*/
|
|
4858
|
+
s3BucketName: string | undefined;
|
|
4859
|
+
/**
|
|
4860
|
+
* <p>The path inside the Amazon S3 bucket where the test set is stored.</p>
|
|
4861
|
+
*/
|
|
4862
|
+
s3Path: string | undefined;
|
|
4863
|
+
/**
|
|
4864
|
+
* <p>The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service
|
|
4865
|
+
* (KMS) key for encrypting the test set.</p>
|
|
4866
|
+
*/
|
|
4867
|
+
kmsKeyArn?: string;
|
|
4868
|
+
}
|
|
4869
|
+
/**
|
|
4870
|
+
* @public
|
|
4871
|
+
* <p>Contains information about the test set that is imported.</p>
|
|
4872
|
+
*/
|
|
4873
|
+
export interface TestSetImportResourceSpecification {
|
|
4874
|
+
/**
|
|
4875
|
+
* <p>The name of the test set.</p>
|
|
4876
|
+
*/
|
|
4877
|
+
testSetName: string | undefined;
|
|
4878
|
+
/**
|
|
4879
|
+
* <p>The description of the test set.</p>
|
|
4880
|
+
*/
|
|
4881
|
+
description?: string;
|
|
4882
|
+
/**
|
|
4883
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that has
|
|
4884
|
+
* permission to access the test set.</p>
|
|
4885
|
+
*/
|
|
4886
|
+
roleArn: string | undefined;
|
|
4887
|
+
/**
|
|
4888
|
+
* <p>Contains information about the location that Amazon Lex uses to store the test-set.</p>
|
|
4889
|
+
*/
|
|
4890
|
+
storageLocation: TestSetStorageLocation | undefined;
|
|
4891
|
+
/**
|
|
4892
|
+
* <p>Contains information about the input location from where test-set should be imported.</p>
|
|
4893
|
+
*/
|
|
4894
|
+
importInputLocation: TestSetImportInputLocation | undefined;
|
|
4895
|
+
/**
|
|
4896
|
+
* <p>Specifies whether the test-set being imported contains written or spoken data.</p>
|
|
4897
|
+
*/
|
|
4898
|
+
modality: TestSetModality | string | undefined;
|
|
4899
|
+
/**
|
|
4900
|
+
* <p>A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the <code>UpdateTestSet</code> operation to update tags. To update tags, use the <code>TagResource</code> operation.</p>
|
|
4901
|
+
*/
|
|
4902
|
+
testSetTags?: Record<string, string>;
|
|
4903
|
+
}
|
|
4502
4904
|
/**
|
|
4503
4905
|
* @public
|
|
4504
4906
|
* <p>Provides information about the bot or bot locale that you want to
|
|
@@ -4518,6 +4920,10 @@ export interface ImportResourceSpecification {
|
|
|
4518
4920
|
* <p>Provides the parameters required for importing a custom vocabulary.</p>
|
|
4519
4921
|
*/
|
|
4520
4922
|
customVocabularyImportSpecification?: CustomVocabularyImportSpecification;
|
|
4923
|
+
/**
|
|
4924
|
+
* <p>Specifications for the test set that is imported.</p>
|
|
4925
|
+
*/
|
|
4926
|
+
testSetImportResourceSpecification?: TestSetImportResourceSpecification;
|
|
4521
4927
|
}
|
|
4522
4928
|
/**
|
|
4523
4929
|
* @public
|
|
@@ -4598,7 +5004,7 @@ export interface DescribeIntentRequest {
|
|
|
4598
5004
|
*/
|
|
4599
5005
|
export interface SlotPriority {
|
|
4600
5006
|
/**
|
|
4601
|
-
* <p>The priority that
|
|
5007
|
+
* <p>The priority that Amazon Lex should apply to the slot.</p>
|
|
4602
5008
|
*/
|
|
4603
5009
|
priority: number | undefined;
|
|
4604
5010
|
/**
|
|
@@ -4742,8 +5148,7 @@ export interface DescribeSlotTypeResponse {
|
|
|
4742
5148
|
*/
|
|
4743
5149
|
lastUpdatedDateTime?: Date;
|
|
4744
5150
|
/**
|
|
4745
|
-
* <p>Provides information about the external source of the slot type's
|
|
4746
|
-
* definition.</p>
|
|
5151
|
+
* <p>Provides information about the external source of the slot type's definition.</p>
|
|
4747
5152
|
*/
|
|
4748
5153
|
externalSourceSetting?: ExternalSourceSetting;
|
|
4749
5154
|
/**
|
|
@@ -4753,7 +5158,377 @@ export interface DescribeSlotTypeResponse {
|
|
|
4753
5158
|
}
|
|
4754
5159
|
/**
|
|
4755
5160
|
* @public
|
|
4756
|
-
|
|
5161
|
+
*/
|
|
5162
|
+
export interface DescribeTestExecutionRequest {
|
|
5163
|
+
/**
|
|
5164
|
+
* <p>The execution Id of the test set execution.</p>
|
|
5165
|
+
*/
|
|
5166
|
+
testExecutionId: string | undefined;
|
|
5167
|
+
}
|
|
5168
|
+
/**
|
|
5169
|
+
* @public
|
|
5170
|
+
* @enum
|
|
5171
|
+
*/
|
|
5172
|
+
export declare const TestExecutionApiMode: {
|
|
5173
|
+
readonly NonStreaming: "NonStreaming";
|
|
5174
|
+
readonly Streaming: "Streaming";
|
|
5175
|
+
};
|
|
5176
|
+
/**
|
|
5177
|
+
* @public
|
|
5178
|
+
*/
|
|
5179
|
+
export type TestExecutionApiMode = (typeof TestExecutionApiMode)[keyof typeof TestExecutionApiMode];
|
|
5180
|
+
/**
|
|
5181
|
+
* @public
|
|
5182
|
+
* <p>Contains information about the bot used for the test execution.</p>
|
|
5183
|
+
*/
|
|
5184
|
+
export interface TestExecutionTarget {
|
|
5185
|
+
/**
|
|
5186
|
+
* <p>Contains information about the bot alias used for the test execution.</p>
|
|
5187
|
+
*/
|
|
5188
|
+
botAliasTarget?: BotAliasTestExecutionTarget;
|
|
5189
|
+
}
|
|
5190
|
+
/**
|
|
5191
|
+
* @public
|
|
5192
|
+
* @enum
|
|
5193
|
+
*/
|
|
5194
|
+
export declare const TestExecutionModality: {
|
|
5195
|
+
readonly Audio: "Audio";
|
|
5196
|
+
readonly Text: "Text";
|
|
5197
|
+
};
|
|
5198
|
+
/**
|
|
5199
|
+
* @public
|
|
5200
|
+
*/
|
|
5201
|
+
export type TestExecutionModality = (typeof TestExecutionModality)[keyof typeof TestExecutionModality];
|
|
5202
|
+
/**
|
|
5203
|
+
* @public
|
|
5204
|
+
* @enum
|
|
5205
|
+
*/
|
|
5206
|
+
export declare const TestExecutionStatus: {
|
|
5207
|
+
readonly Completed: "Completed";
|
|
5208
|
+
readonly Failed: "Failed";
|
|
5209
|
+
readonly InProgress: "InProgress";
|
|
5210
|
+
readonly Pending: "Pending";
|
|
5211
|
+
readonly Stopped: "Stopped";
|
|
5212
|
+
readonly Stopping: "Stopping";
|
|
5213
|
+
readonly Waiting: "Waiting";
|
|
5214
|
+
};
|
|
5215
|
+
/**
|
|
5216
|
+
* @public
|
|
5217
|
+
*/
|
|
5218
|
+
export type TestExecutionStatus = (typeof TestExecutionStatus)[keyof typeof TestExecutionStatus];
|
|
5219
|
+
/**
|
|
5220
|
+
* @public
|
|
5221
|
+
*/
|
|
5222
|
+
export interface DescribeTestExecutionResponse {
|
|
5223
|
+
/**
|
|
5224
|
+
* <p>The execution Id for the test set execution.</p>
|
|
5225
|
+
*/
|
|
5226
|
+
testExecutionId?: string;
|
|
5227
|
+
/**
|
|
5228
|
+
* <p>The execution creation date and time for the test set execution.</p>
|
|
5229
|
+
*/
|
|
5230
|
+
creationDateTime?: Date;
|
|
5231
|
+
/**
|
|
5232
|
+
* <p>The date and time of the last update for the execution.</p>
|
|
5233
|
+
*/
|
|
5234
|
+
lastUpdatedDateTime?: Date;
|
|
5235
|
+
/**
|
|
5236
|
+
* <p>The test execution status for the test execution.</p>
|
|
5237
|
+
*/
|
|
5238
|
+
testExecutionStatus?: TestExecutionStatus | string;
|
|
5239
|
+
/**
|
|
5240
|
+
* <p>The test set Id for the test set execution.</p>
|
|
5241
|
+
*/
|
|
5242
|
+
testSetId?: string;
|
|
5243
|
+
/**
|
|
5244
|
+
* <p>The test set name of the test set execution.</p>
|
|
5245
|
+
*/
|
|
5246
|
+
testSetName?: string;
|
|
5247
|
+
/**
|
|
5248
|
+
* <p>The target bot for the test set execution details.</p>
|
|
5249
|
+
*/
|
|
5250
|
+
target?: TestExecutionTarget;
|
|
5251
|
+
/**
|
|
5252
|
+
* <p>Indicates whether we use streaming or non-streaming APIs are used for
|
|
5253
|
+
* the test set execution. For streaming, <code>StartConversation</code>
|
|
5254
|
+
* Amazon Lex Runtime API is used. Whereas for non-streaming, <code>RecognizeUtterance</code>
|
|
5255
|
+
* and <code>RecognizeText</code> Amazon Lex Runtime API is used.</p>
|
|
5256
|
+
*/
|
|
5257
|
+
apiMode?: TestExecutionApiMode | string;
|
|
5258
|
+
/**
|
|
5259
|
+
* <p>Indicates whether test set is audio or text.</p>
|
|
5260
|
+
*/
|
|
5261
|
+
testExecutionModality?: TestExecutionModality | string;
|
|
5262
|
+
/**
|
|
5263
|
+
* <p>Reasons for the failure of the test set execution.</p>
|
|
5264
|
+
*/
|
|
5265
|
+
failureReasons?: string[];
|
|
5266
|
+
}
|
|
5267
|
+
/**
|
|
5268
|
+
* @public
|
|
5269
|
+
*/
|
|
5270
|
+
export interface DescribeTestSetRequest {
|
|
5271
|
+
/**
|
|
5272
|
+
* <p>The test set Id for the test set request.</p>
|
|
5273
|
+
*/
|
|
5274
|
+
testSetId: string | undefined;
|
|
5275
|
+
}
|
|
5276
|
+
/**
|
|
5277
|
+
* @public
|
|
5278
|
+
* @enum
|
|
5279
|
+
*/
|
|
5280
|
+
export declare const TestSetStatus: {
|
|
5281
|
+
readonly Deleting: "Deleting";
|
|
5282
|
+
readonly Importing: "Importing";
|
|
5283
|
+
readonly PendingAnnotation: "PendingAnnotation";
|
|
5284
|
+
readonly Ready: "Ready";
|
|
5285
|
+
readonly ValidationError: "ValidationError";
|
|
5286
|
+
};
|
|
5287
|
+
/**
|
|
5288
|
+
* @public
|
|
5289
|
+
*/
|
|
5290
|
+
export type TestSetStatus = (typeof TestSetStatus)[keyof typeof TestSetStatus];
|
|
5291
|
+
/**
|
|
5292
|
+
* @public
|
|
5293
|
+
*/
|
|
5294
|
+
export interface DescribeTestSetResponse {
|
|
5295
|
+
/**
|
|
5296
|
+
* <p>The test set Id for the test set response.</p>
|
|
5297
|
+
*/
|
|
5298
|
+
testSetId?: string;
|
|
5299
|
+
/**
|
|
5300
|
+
* <p>The test set name of the test set.</p>
|
|
5301
|
+
*/
|
|
5302
|
+
testSetName?: string;
|
|
5303
|
+
/**
|
|
5304
|
+
* <p>The description of the test set.</p>
|
|
5305
|
+
*/
|
|
5306
|
+
description?: string;
|
|
5307
|
+
/**
|
|
5308
|
+
* <p>Indicates whether the test set is audio or text data.</p>
|
|
5309
|
+
*/
|
|
5310
|
+
modality?: TestSetModality | string;
|
|
5311
|
+
/**
|
|
5312
|
+
* <p>The status of the test set.</p>
|
|
5313
|
+
*/
|
|
5314
|
+
status?: TestSetStatus | string;
|
|
5315
|
+
/**
|
|
5316
|
+
* <p>The roleARN used for any operation in the test set to access
|
|
5317
|
+
* resources in the Amazon Web Services account.</p>
|
|
5318
|
+
*/
|
|
5319
|
+
roleArn?: string;
|
|
5320
|
+
/**
|
|
5321
|
+
* <p>The total number of agent and user turn in the test set.</p>
|
|
5322
|
+
*/
|
|
5323
|
+
numTurns?: number;
|
|
5324
|
+
/**
|
|
5325
|
+
* <p>The Amazon S3 storage location for the test set data.</p>
|
|
5326
|
+
*/
|
|
5327
|
+
storageLocation?: TestSetStorageLocation;
|
|
5328
|
+
/**
|
|
5329
|
+
* <p>The creation date and time for the test set data.</p>
|
|
5330
|
+
*/
|
|
5331
|
+
creationDateTime?: Date;
|
|
5332
|
+
/**
|
|
5333
|
+
* <p>The date and time for the last update of the test set data.</p>
|
|
5334
|
+
*/
|
|
5335
|
+
lastUpdatedDateTime?: Date;
|
|
5336
|
+
}
|
|
5337
|
+
/**
|
|
5338
|
+
* @public
|
|
5339
|
+
*/
|
|
5340
|
+
export interface DescribeTestSetDiscrepancyReportRequest {
|
|
5341
|
+
/**
|
|
5342
|
+
* <p>The unique identifier of the test set discrepancy report.</p>
|
|
5343
|
+
*/
|
|
5344
|
+
testSetDiscrepancyReportId: string | undefined;
|
|
5345
|
+
}
|
|
5346
|
+
/**
|
|
5347
|
+
* @public
|
|
5348
|
+
* @enum
|
|
5349
|
+
*/
|
|
5350
|
+
export declare const TestSetDiscrepancyReportStatus: {
|
|
5351
|
+
readonly Completed: "Completed";
|
|
5352
|
+
readonly Failed: "Failed";
|
|
5353
|
+
readonly InProgress: "InProgress";
|
|
5354
|
+
};
|
|
5355
|
+
/**
|
|
5356
|
+
* @public
|
|
5357
|
+
*/
|
|
5358
|
+
export type TestSetDiscrepancyReportStatus = (typeof TestSetDiscrepancyReportStatus)[keyof typeof TestSetDiscrepancyReportStatus];
|
|
5359
|
+
/**
|
|
5360
|
+
* @public
|
|
5361
|
+
* <p>Contains information about discrepancy in an intent information between the test set and the
|
|
5362
|
+
* bot.</p>
|
|
5363
|
+
*/
|
|
5364
|
+
export interface TestSetIntentDiscrepancyItem {
|
|
5365
|
+
/**
|
|
5366
|
+
* <p>The name of the intent in the discrepancy report.</p>
|
|
5367
|
+
*/
|
|
5368
|
+
intentName: string | undefined;
|
|
5369
|
+
/**
|
|
5370
|
+
* <p>The error message for a discrepancy for an intent between the test set and the bot.</p>
|
|
5371
|
+
*/
|
|
5372
|
+
errorMessage: string | undefined;
|
|
5373
|
+
}
|
|
5374
|
+
/**
|
|
5375
|
+
* @public
|
|
5376
|
+
* <p>Contains information about discrepancy in a slot information between the test set and the bot.</p>
|
|
5377
|
+
*/
|
|
5378
|
+
export interface TestSetSlotDiscrepancyItem {
|
|
5379
|
+
/**
|
|
5380
|
+
* <p>The name of the intent associated with the slot in the discrepancy report.</p>
|
|
5381
|
+
*/
|
|
5382
|
+
intentName: string | undefined;
|
|
5383
|
+
/**
|
|
5384
|
+
* <p>The name of the slot in the discrepancy report.</p>
|
|
5385
|
+
*/
|
|
5386
|
+
slotName: string | undefined;
|
|
5387
|
+
/**
|
|
5388
|
+
* <p>The error message for a discrepancy for an intent between the test set and the bot.</p>
|
|
5389
|
+
*/
|
|
5390
|
+
errorMessage: string | undefined;
|
|
5391
|
+
}
|
|
5392
|
+
/**
|
|
5393
|
+
* @public
|
|
5394
|
+
* <p>Contains details about the errors in the test set discrepancy report</p>
|
|
5395
|
+
*/
|
|
5396
|
+
export interface TestSetDiscrepancyErrors {
|
|
5397
|
+
/**
|
|
5398
|
+
* <p>Contains information about discrepancies found for intents between the test set and the bot.</p>
|
|
5399
|
+
*/
|
|
5400
|
+
intentDiscrepancies: TestSetIntentDiscrepancyItem[] | undefined;
|
|
5401
|
+
/**
|
|
5402
|
+
* <p>Contains information about discrepancies found for slots between the test set and the bot.</p>
|
|
5403
|
+
*/
|
|
5404
|
+
slotDiscrepancies: TestSetSlotDiscrepancyItem[] | undefined;
|
|
5405
|
+
}
|
|
5406
|
+
/**
|
|
5407
|
+
* @public
|
|
5408
|
+
*/
|
|
5409
|
+
export interface DescribeTestSetDiscrepancyReportResponse {
|
|
5410
|
+
/**
|
|
5411
|
+
* <p>The unique identifier of the test set discrepancy report to describe.</p>
|
|
5412
|
+
*/
|
|
5413
|
+
testSetDiscrepancyReportId?: string;
|
|
5414
|
+
/**
|
|
5415
|
+
* <p>The test set Id for the test set discrepancy report.</p>
|
|
5416
|
+
*/
|
|
5417
|
+
testSetId?: string;
|
|
5418
|
+
/**
|
|
5419
|
+
* <p>The time and date of creation for the test set discrepancy report.</p>
|
|
5420
|
+
*/
|
|
5421
|
+
creationDateTime?: Date;
|
|
5422
|
+
/**
|
|
5423
|
+
* <p>The target bot location for the test set discrepancy report.</p>
|
|
5424
|
+
*/
|
|
5425
|
+
target?: TestSetDiscrepancyReportResourceTarget;
|
|
5426
|
+
/**
|
|
5427
|
+
* <p>The status for the test set discrepancy report.</p>
|
|
5428
|
+
*/
|
|
5429
|
+
testSetDiscrepancyReportStatus?: TestSetDiscrepancyReportStatus | string;
|
|
5430
|
+
/**
|
|
5431
|
+
* <p>The date and time of the last update for the test set discrepancy report.</p>
|
|
5432
|
+
*/
|
|
5433
|
+
lastUpdatedDataTime?: Date;
|
|
5434
|
+
/**
|
|
5435
|
+
* <p>The top 200 error results from the test set discrepancy report.</p>
|
|
5436
|
+
*/
|
|
5437
|
+
testSetDiscrepancyTopErrors?: TestSetDiscrepancyErrors;
|
|
5438
|
+
/**
|
|
5439
|
+
* <p>Pre-signed Amazon S3 URL to download the test set discrepancy report.</p>
|
|
5440
|
+
*/
|
|
5441
|
+
testSetDiscrepancyRawOutputUrl?: string;
|
|
5442
|
+
/**
|
|
5443
|
+
* <p>The failure report for the test set discrepancy report generation action.</p>
|
|
5444
|
+
*/
|
|
5445
|
+
failureReasons?: string[];
|
|
5446
|
+
}
|
|
5447
|
+
/**
|
|
5448
|
+
* @public
|
|
5449
|
+
*/
|
|
5450
|
+
export interface DescribeTestSetGenerationRequest {
|
|
5451
|
+
/**
|
|
5452
|
+
* <p>The unique identifier of the test set generation.</p>
|
|
5453
|
+
*/
|
|
5454
|
+
testSetGenerationId: string | undefined;
|
|
5455
|
+
}
|
|
5456
|
+
/**
|
|
5457
|
+
* @public
|
|
5458
|
+
* <p>Contains information about the data source from which the test set is generated.</p>
|
|
5459
|
+
*/
|
|
5460
|
+
export interface TestSetGenerationDataSource {
|
|
5461
|
+
/**
|
|
5462
|
+
* <p>Contains information about the bot from which the conversation logs are sourced.</p>
|
|
5463
|
+
*/
|
|
5464
|
+
conversationLogsDataSource?: ConversationLogsDataSource;
|
|
5465
|
+
}
|
|
5466
|
+
/**
|
|
5467
|
+
* @public
|
|
5468
|
+
* @enum
|
|
5469
|
+
*/
|
|
5470
|
+
export declare const TestSetGenerationStatus: {
|
|
5471
|
+
readonly Failed: "Failed";
|
|
5472
|
+
readonly Generating: "Generating";
|
|
5473
|
+
readonly Pending: "Pending";
|
|
5474
|
+
readonly Ready: "Ready";
|
|
5475
|
+
};
|
|
5476
|
+
/**
|
|
5477
|
+
* @public
|
|
5478
|
+
*/
|
|
5479
|
+
export type TestSetGenerationStatus = (typeof TestSetGenerationStatus)[keyof typeof TestSetGenerationStatus];
|
|
5480
|
+
/**
|
|
5481
|
+
* @public
|
|
5482
|
+
*/
|
|
5483
|
+
export interface DescribeTestSetGenerationResponse {
|
|
5484
|
+
/**
|
|
5485
|
+
* <p>The unique identifier of the test set generation.</p>
|
|
5486
|
+
*/
|
|
5487
|
+
testSetGenerationId?: string;
|
|
5488
|
+
/**
|
|
5489
|
+
* <p>The status for the test set generation.</p>
|
|
5490
|
+
*/
|
|
5491
|
+
testSetGenerationStatus?: TestSetGenerationStatus | string;
|
|
5492
|
+
/**
|
|
5493
|
+
* <p>The reasons the test set generation failed.</p>
|
|
5494
|
+
*/
|
|
5495
|
+
failureReasons?: string[];
|
|
5496
|
+
/**
|
|
5497
|
+
* <p>The unique identifier for the test set created for the generated test set.</p>
|
|
5498
|
+
*/
|
|
5499
|
+
testSetId?: string;
|
|
5500
|
+
/**
|
|
5501
|
+
* <p>The test set name for the generated test set.</p>
|
|
5502
|
+
*/
|
|
5503
|
+
testSetName?: string;
|
|
5504
|
+
/**
|
|
5505
|
+
* <p>The test set description for the test set generation.</p>
|
|
5506
|
+
*/
|
|
5507
|
+
description?: string;
|
|
5508
|
+
/**
|
|
5509
|
+
* <p>The Amazon S3 storage location for the test set generation.</p>
|
|
5510
|
+
*/
|
|
5511
|
+
storageLocation?: TestSetStorageLocation;
|
|
5512
|
+
/**
|
|
5513
|
+
* <p>The data source of the test set used for the test set generation.</p>
|
|
5514
|
+
*/
|
|
5515
|
+
generationDataSource?: TestSetGenerationDataSource;
|
|
5516
|
+
/**
|
|
5517
|
+
* <p> The roleARN of the test set used for the test set generation.</p>
|
|
5518
|
+
*/
|
|
5519
|
+
roleArn?: string;
|
|
5520
|
+
/**
|
|
5521
|
+
* <p>The creation date and time for the test set generation.</p>
|
|
5522
|
+
*/
|
|
5523
|
+
creationDateTime?: Date;
|
|
5524
|
+
/**
|
|
5525
|
+
* <p>The date and time of the last update for the test set generation.</p>
|
|
5526
|
+
*/
|
|
5527
|
+
lastUpdatedDateTime?: Date;
|
|
5528
|
+
}
|
|
5529
|
+
/**
|
|
5530
|
+
* @public
|
|
5531
|
+
* @enum
|
|
4757
5532
|
*/
|
|
4758
5533
|
export declare const ExportFilterName: {
|
|
4759
5534
|
readonly ExportResourceType: "ExportResourceType";
|
|
@@ -4785,15 +5560,15 @@ export interface ExportFilter {
|
|
|
4785
5560
|
name: ExportFilterName | string | undefined;
|
|
4786
5561
|
/**
|
|
4787
5562
|
* <p>The values to use to filter the response. The values must be
|
|
4788
|
-
*
|
|
4789
|
-
*
|
|
5563
|
+
* <code>Bot</code>, <code>BotLocale</code>, or
|
|
5564
|
+
* <code>CustomVocabulary</code>.</p>
|
|
4790
5565
|
*/
|
|
4791
5566
|
values: string[] | undefined;
|
|
4792
5567
|
/**
|
|
4793
5568
|
* <p>The operator to use for the filter. Specify EQ when the
|
|
4794
|
-
*
|
|
5569
|
+
* <code>ListExports</code> operation should return only resource types
|
|
4795
5570
|
* that equal the specified value. Specify CO when the
|
|
4796
|
-
*
|
|
5571
|
+
* <code>ListExports</code> operation should return resource types that
|
|
4797
5572
|
* contain the specified value.</p>
|
|
4798
5573
|
*/
|
|
4799
5574
|
operator: ExportFilterOperator | string | undefined;
|
|
@@ -4855,6 +5630,28 @@ export interface ExportSummary {
|
|
|
4855
5630
|
*/
|
|
4856
5631
|
lastUpdatedDateTime?: Date;
|
|
4857
5632
|
}
|
|
5633
|
+
/**
|
|
5634
|
+
* @public
|
|
5635
|
+
*/
|
|
5636
|
+
export interface GetTestExecutionArtifactsUrlRequest {
|
|
5637
|
+
/**
|
|
5638
|
+
* <p>The unique identifier of the completed test execution.</p>
|
|
5639
|
+
*/
|
|
5640
|
+
testExecutionId: string | undefined;
|
|
5641
|
+
}
|
|
5642
|
+
/**
|
|
5643
|
+
* @public
|
|
5644
|
+
*/
|
|
5645
|
+
export interface GetTestExecutionArtifactsUrlResponse {
|
|
5646
|
+
/**
|
|
5647
|
+
* <p>The unique identifier of the completed test execution.</p>
|
|
5648
|
+
*/
|
|
5649
|
+
testExecutionId?: string;
|
|
5650
|
+
/**
|
|
5651
|
+
* <p>The pre-signed Amazon S3 URL to download completed test execution.</p>
|
|
5652
|
+
*/
|
|
5653
|
+
downloadArtifactsUrl?: string;
|
|
5654
|
+
}
|
|
4858
5655
|
/**
|
|
4859
5656
|
* @public
|
|
4860
5657
|
* @enum
|
|
@@ -4889,15 +5686,15 @@ export interface ImportFilter {
|
|
|
4889
5686
|
name: ImportFilterName | string | undefined;
|
|
4890
5687
|
/**
|
|
4891
5688
|
* <p>The values to use to filter the response. The values must be
|
|
4892
|
-
*
|
|
4893
|
-
*
|
|
5689
|
+
* <code>Bot</code>, <code>BotLocale</code>, or
|
|
5690
|
+
* <code>CustomVocabulary</code>.</p>
|
|
4894
5691
|
*/
|
|
4895
5692
|
values: string[] | undefined;
|
|
4896
5693
|
/**
|
|
4897
5694
|
* <p>The operator to use for the filter. Specify EQ when the
|
|
4898
|
-
*
|
|
5695
|
+
* <code>ListImports</code> operation should return only resource types
|
|
4899
5696
|
* that equal the specified value. Specify CO when the
|
|
4900
|
-
*
|
|
5697
|
+
* <code>ListImports</code> operation should return resource types that
|
|
4901
5698
|
* contain the specified value.</p>
|
|
4902
5699
|
*/
|
|
4903
5700
|
operator: ImportFilterOperator | string | undefined;
|
|
@@ -4910,6 +5707,7 @@ export declare const ImportResourceType: {
|
|
|
4910
5707
|
readonly Bot: "Bot";
|
|
4911
5708
|
readonly BotLocale: "BotLocale";
|
|
4912
5709
|
readonly CustomVocabulary: "CustomVocabulary";
|
|
5710
|
+
readonly TestSet: "TestSet";
|
|
4913
5711
|
};
|
|
4914
5712
|
/**
|
|
4915
5713
|
* @public
|
|
@@ -4961,7 +5759,7 @@ export interface ImportSummary {
|
|
|
4961
5759
|
importedResourceName?: string;
|
|
4962
5760
|
/**
|
|
4963
5761
|
* <p>The status of the resource. When the status is
|
|
4964
|
-
*
|
|
5762
|
+
* <code>Completed</code> the resource is ready to build.</p>
|
|
4965
5763
|
*/
|
|
4966
5764
|
importStatus?: ImportStatus | string;
|
|
4967
5765
|
/**
|
|
@@ -4984,11 +5782,69 @@ export interface ImportSummary {
|
|
|
4984
5782
|
}
|
|
4985
5783
|
/**
|
|
4986
5784
|
* @public
|
|
4987
|
-
*
|
|
5785
|
+
* <p>Provides the phrase that Amazon Lex should look for in the user's input
|
|
5786
|
+
* to the bot.</p>
|
|
4988
5787
|
*/
|
|
4989
|
-
export
|
|
4990
|
-
|
|
4991
|
-
|
|
5788
|
+
export interface RuntimeHintValue {
|
|
5789
|
+
/**
|
|
5790
|
+
* <p>The phrase that Amazon Lex should look for in the user's input to the
|
|
5791
|
+
* bot.</p>
|
|
5792
|
+
*/
|
|
5793
|
+
phrase: string | undefined;
|
|
5794
|
+
}
|
|
5795
|
+
/**
|
|
5796
|
+
* @public
|
|
5797
|
+
* <p>The number of items in the intent classification test.</p>
|
|
5798
|
+
*/
|
|
5799
|
+
export interface IntentClassificationTestResultItemCounts {
|
|
5800
|
+
/**
|
|
5801
|
+
* <p>The total number of results in the intent classification test.</p>
|
|
5802
|
+
*/
|
|
5803
|
+
totalResultCount: number | undefined;
|
|
5804
|
+
/**
|
|
5805
|
+
* <p>The number of matched, mismatched, and execution error results for speech transcription for the intent.</p>
|
|
5806
|
+
*/
|
|
5807
|
+
speechTranscriptionResultCounts?: Record<string, number>;
|
|
5808
|
+
/**
|
|
5809
|
+
* <p>The number of matched and mismatched results for intent recognition for the intent.</p>
|
|
5810
|
+
*/
|
|
5811
|
+
intentMatchResultCounts: Record<string, number> | undefined;
|
|
5812
|
+
}
|
|
5813
|
+
/**
|
|
5814
|
+
* @public
|
|
5815
|
+
* <p>Information for an intent that is classified by the test workbench.</p>
|
|
5816
|
+
*/
|
|
5817
|
+
export interface IntentClassificationTestResultItem {
|
|
5818
|
+
/**
|
|
5819
|
+
* <p>The name of the intent.</p>
|
|
5820
|
+
*/
|
|
5821
|
+
intentName: string | undefined;
|
|
5822
|
+
/**
|
|
5823
|
+
* <p>Indicates whether the conversation involves multiple turns or not.</p>
|
|
5824
|
+
*/
|
|
5825
|
+
multiTurnConversation: boolean | undefined;
|
|
5826
|
+
/**
|
|
5827
|
+
* <p>The result of the intent classification test.</p>
|
|
5828
|
+
*/
|
|
5829
|
+
resultCounts: IntentClassificationTestResultItemCounts | undefined;
|
|
5830
|
+
}
|
|
5831
|
+
/**
|
|
5832
|
+
* @public
|
|
5833
|
+
* <p>Information for the results of the intent classification test. </p>
|
|
5834
|
+
*/
|
|
5835
|
+
export interface IntentClassificationTestResults {
|
|
5836
|
+
/**
|
|
5837
|
+
* <p>A list of the results for the intent classification test.</p>
|
|
5838
|
+
*/
|
|
5839
|
+
items: IntentClassificationTestResultItem[] | undefined;
|
|
5840
|
+
}
|
|
5841
|
+
/**
|
|
5842
|
+
* @public
|
|
5843
|
+
* @enum
|
|
5844
|
+
*/
|
|
5845
|
+
export declare const IntentFilterName: {
|
|
5846
|
+
readonly IntentName: "IntentName";
|
|
5847
|
+
};
|
|
4992
5848
|
/**
|
|
4993
5849
|
* @public
|
|
4994
5850
|
*/
|
|
@@ -5021,13 +5877,74 @@ export interface IntentFilter {
|
|
|
5021
5877
|
values: string[] | undefined;
|
|
5022
5878
|
/**
|
|
5023
5879
|
* <p>The operator to use for the filter. Specify <code>EQ</code> when the
|
|
5024
|
-
*
|
|
5880
|
+
* <code>ListIntents</code> operation should return only aliases that
|
|
5025
5881
|
* equal the specified value. Specify <code>CO</code> when the
|
|
5026
|
-
*
|
|
5882
|
+
* <code>ListIntents</code> operation should return aliases that
|
|
5027
5883
|
* contain the specified value.</p>
|
|
5028
5884
|
*/
|
|
5029
5885
|
operator: IntentFilterOperator | string | undefined;
|
|
5030
5886
|
}
|
|
5887
|
+
/**
|
|
5888
|
+
* @public
|
|
5889
|
+
* <p>Information about the counts for a slot resolution in the results of a test execution.</p>
|
|
5890
|
+
*/
|
|
5891
|
+
export interface SlotResolutionTestResultItemCounts {
|
|
5892
|
+
/**
|
|
5893
|
+
* <p>The total number of results.</p>
|
|
5894
|
+
*/
|
|
5895
|
+
totalResultCount: number | undefined;
|
|
5896
|
+
/**
|
|
5897
|
+
* <p>The number of matched, mismatched and execution error results for speech transcription for the slot.</p>
|
|
5898
|
+
*/
|
|
5899
|
+
speechTranscriptionResultCounts?: Record<string, number>;
|
|
5900
|
+
/**
|
|
5901
|
+
* <p>The number of matched and mismatched results for slot resolution for the slot.</p>
|
|
5902
|
+
*/
|
|
5903
|
+
slotMatchResultCounts: Record<string, number> | undefined;
|
|
5904
|
+
}
|
|
5905
|
+
/**
|
|
5906
|
+
* @public
|
|
5907
|
+
* <p>Information about the success and failure rate of slot resolution
|
|
5908
|
+
* in the results of a test execution.</p>
|
|
5909
|
+
*/
|
|
5910
|
+
export interface SlotResolutionTestResultItem {
|
|
5911
|
+
/**
|
|
5912
|
+
* <p>The name of the slot.</p>
|
|
5913
|
+
*/
|
|
5914
|
+
slotName: string | undefined;
|
|
5915
|
+
/**
|
|
5916
|
+
* <p>A result for slot resolution in the results of a test execution.</p>
|
|
5917
|
+
*/
|
|
5918
|
+
resultCounts: SlotResolutionTestResultItemCounts | undefined;
|
|
5919
|
+
}
|
|
5920
|
+
/**
|
|
5921
|
+
* @public
|
|
5922
|
+
* <p>Information about intent-level slot resolution in a test result.</p>
|
|
5923
|
+
*/
|
|
5924
|
+
export interface IntentLevelSlotResolutionTestResultItem {
|
|
5925
|
+
/**
|
|
5926
|
+
* <p>The name of the intent that was recognized.</p>
|
|
5927
|
+
*/
|
|
5928
|
+
intentName: string | undefined;
|
|
5929
|
+
/**
|
|
5930
|
+
* <p>Indicates whether the conversation involves multiple turns or not.</p>
|
|
5931
|
+
*/
|
|
5932
|
+
multiTurnConversation: boolean | undefined;
|
|
5933
|
+
/**
|
|
5934
|
+
* <p>The results for the slot resolution in the test execution result.</p>
|
|
5935
|
+
*/
|
|
5936
|
+
slotResolutionResults: SlotResolutionTestResultItem[] | undefined;
|
|
5937
|
+
}
|
|
5938
|
+
/**
|
|
5939
|
+
* @public
|
|
5940
|
+
* <p>Indicates the success or failure of slots at the intent level.</p>
|
|
5941
|
+
*/
|
|
5942
|
+
export interface IntentLevelSlotResolutionTestResults {
|
|
5943
|
+
/**
|
|
5944
|
+
* <p>Indicates the items for the slot level resolution for the intents.</p>
|
|
5945
|
+
*/
|
|
5946
|
+
items: IntentLevelSlotResolutionTestResultItem[] | undefined;
|
|
5947
|
+
}
|
|
5031
5948
|
/**
|
|
5032
5949
|
* @public
|
|
5033
5950
|
* @enum
|
|
@@ -5058,13 +5975,13 @@ export interface IntentSortBy {
|
|
|
5058
5975
|
/**
|
|
5059
5976
|
* @public
|
|
5060
5977
|
* <p>Summary information about an intent returned by the
|
|
5061
|
-
*
|
|
5978
|
+
* <code>ListIntents</code> operation.</p>
|
|
5062
5979
|
*/
|
|
5063
5980
|
export interface IntentSummary {
|
|
5064
5981
|
/**
|
|
5065
5982
|
* <p>The unique identifier assigned to the intent. Use this ID to get
|
|
5066
5983
|
* detailed information about the intent with the
|
|
5067
|
-
*
|
|
5984
|
+
* <code>DescribeIntent</code> operation.</p>
|
|
5068
5985
|
*/
|
|
5069
5986
|
intentId?: string;
|
|
5070
5987
|
/**
|
|
@@ -5112,46 +6029,46 @@ export type TimeDimension = (typeof TimeDimension)[keyof typeof TimeDimension];
|
|
|
5112
6029
|
/**
|
|
5113
6030
|
* @public
|
|
5114
6031
|
* <p>Specifies the time window that utterance statistics are returned
|
|
5115
|
-
*
|
|
5116
|
-
*
|
|
6032
|
+
* for. The time window is always relative to the last time that the that
|
|
6033
|
+
* utterances were aggregated. For example, if the
|
|
5117
6034
|
* <code>ListAggregatedUtterances</code> operation is called at 1600,
|
|
5118
|
-
*
|
|
5119
|
-
*
|
|
6035
|
+
* the time window is set to 1 hour, and the last refresh time was 1530,
|
|
6036
|
+
* only utterances made between 1430 and 1530 are returned.</p>
|
|
5120
6037
|
* <p>You can choose the time window that statistics should be returned
|
|
5121
|
-
*
|
|
6038
|
+
* for.</p>
|
|
5122
6039
|
* <ul>
|
|
5123
6040
|
* <li>
|
|
5124
6041
|
* <p>
|
|
5125
6042
|
* <b>Hours</b> - You can request
|
|
5126
|
-
*
|
|
5127
|
-
*
|
|
5128
|
-
*
|
|
6043
|
+
* utterance statistics for 1, 3, 6, 12, or 24 hour time windows.
|
|
6044
|
+
* Statistics are refreshed every half hour for 1 hour time windows,
|
|
6045
|
+
* and hourly for the other time windows.</p>
|
|
5129
6046
|
* </li>
|
|
5130
6047
|
* <li>
|
|
5131
6048
|
* <p>
|
|
5132
6049
|
* <b>Days</b> - You can request
|
|
5133
|
-
*
|
|
5134
|
-
*
|
|
6050
|
+
* utterance statistics for 3 days. Statistics are refreshed every 6
|
|
6051
|
+
* hours.</p>
|
|
5135
6052
|
* </li>
|
|
5136
6053
|
* <li>
|
|
5137
6054
|
* <p>
|
|
5138
6055
|
* <b>Weeks</b> - You can see
|
|
5139
|
-
*
|
|
5140
|
-
*
|
|
5141
|
-
*
|
|
6056
|
+
* statistics for one or two weeks. Statistics are refreshed every
|
|
6057
|
+
* 12 hours for one week time windows, and once per day for two week
|
|
6058
|
+
* time windows.</p>
|
|
5142
6059
|
* </li>
|
|
5143
6060
|
* </ul>
|
|
5144
6061
|
*/
|
|
5145
6062
|
export interface RelativeAggregationDuration {
|
|
5146
6063
|
/**
|
|
5147
6064
|
* <p>The type of time period that the <code>timeValue</code> field
|
|
5148
|
-
*
|
|
6065
|
+
* represents. </p>
|
|
5149
6066
|
*/
|
|
5150
6067
|
timeDimension: TimeDimension | string | undefined;
|
|
5151
6068
|
/**
|
|
5152
6069
|
* <p>The period of the time window to gather statistics for. The valid
|
|
5153
|
-
*
|
|
5154
|
-
*
|
|
6070
|
+
* value depends on the setting of the <code>timeDimension</code>
|
|
6071
|
+
* field.</p>
|
|
5155
6072
|
* <ul>
|
|
5156
6073
|
* <li>
|
|
5157
6074
|
* <p>
|
|
@@ -5172,7 +6089,7 @@ export interface RelativeAggregationDuration {
|
|
|
5172
6089
|
/**
|
|
5173
6090
|
* @public
|
|
5174
6091
|
* <p>Provides parameters for setting the time window and duration for
|
|
5175
|
-
*
|
|
6092
|
+
* aggregating utterance data.</p>
|
|
5176
6093
|
*/
|
|
5177
6094
|
export interface UtteranceAggregationDuration {
|
|
5178
6095
|
/**
|
|
@@ -5316,1591 +6233,14 @@ export interface ListAggregatedUtterancesResponse {
|
|
|
5316
6233
|
nextToken?: string;
|
|
5317
6234
|
}
|
|
5318
6235
|
/**
|
|
5319
|
-
* @
|
|
5320
|
-
*/
|
|
5321
|
-
export interface ListBotAliasesRequest {
|
|
5322
|
-
/**
|
|
5323
|
-
* <p>The identifier of the bot to list aliases for.</p>
|
|
5324
|
-
*/
|
|
5325
|
-
botId: string | undefined;
|
|
5326
|
-
/**
|
|
5327
|
-
* <p>The maximum number of aliases to return in each page of results. If
|
|
5328
|
-
* there are fewer results than the max page size, only the actual number
|
|
5329
|
-
* of results are returned.</p>
|
|
5330
|
-
*/
|
|
5331
|
-
maxResults?: number;
|
|
5332
|
-
/**
|
|
5333
|
-
* <p>If the response from the <code>ListBotAliases</code> operation
|
|
5334
|
-
* contains more results than specified in the <code>maxResults</code>
|
|
5335
|
-
* parameter, a token is returned in the response. Use that token in the
|
|
5336
|
-
* <code>nextToken</code> parameter to return the next page of
|
|
5337
|
-
* results.</p>
|
|
5338
|
-
*/
|
|
5339
|
-
nextToken?: string;
|
|
5340
|
-
}
|
|
5341
|
-
/**
|
|
5342
|
-
* @public
|
|
5343
|
-
*/
|
|
5344
|
-
export interface ListBotAliasesResponse {
|
|
5345
|
-
/**
|
|
5346
|
-
* <p>Summary information for the bot aliases that meet the filter
|
|
5347
|
-
* criteria specified in the request. The length of the list is specified
|
|
5348
|
-
* in the <code>maxResults</code> parameter of the request. If there are
|
|
5349
|
-
* more aliases available, the <code>nextToken</code> field contains a
|
|
5350
|
-
* token to get the next page of results.</p>
|
|
5351
|
-
*/
|
|
5352
|
-
botAliasSummaries?: BotAliasSummary[];
|
|
5353
|
-
/**
|
|
5354
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5355
|
-
* response to the <code>ListBotAliases</code> operation. If the
|
|
5356
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5357
|
-
* the <code>nextToken</code> parameter of a <code>ListBotAliases</code>
|
|
5358
|
-
* operation request to get the next page of results.</p>
|
|
5359
|
-
*/
|
|
5360
|
-
nextToken?: string;
|
|
5361
|
-
/**
|
|
5362
|
-
* <p>The identifier of the bot associated with the aliases.</p>
|
|
5363
|
-
*/
|
|
5364
|
-
botId?: string;
|
|
5365
|
-
}
|
|
5366
|
-
/**
|
|
5367
|
-
* @public
|
|
5368
|
-
*/
|
|
5369
|
-
export interface ListBotLocalesRequest {
|
|
5370
|
-
/**
|
|
5371
|
-
* <p>The identifier of the bot to list locales for.</p>
|
|
5372
|
-
*/
|
|
5373
|
-
botId: string | undefined;
|
|
5374
|
-
/**
|
|
5375
|
-
* <p>The version of the bot to list locales for.</p>
|
|
5376
|
-
*/
|
|
5377
|
-
botVersion: string | undefined;
|
|
5378
|
-
/**
|
|
5379
|
-
* <p>Specifies sorting parameters for the list of locales. You can sort
|
|
5380
|
-
* by locale name in ascending or descending order.</p>
|
|
5381
|
-
*/
|
|
5382
|
-
sortBy?: BotLocaleSortBy;
|
|
5383
|
-
/**
|
|
5384
|
-
* <p>Provides the specification for a filter used to limit the response
|
|
5385
|
-
* to only those locales that match the filter specification. You can only
|
|
5386
|
-
* specify one filter and one value to filter on.</p>
|
|
5387
|
-
*/
|
|
5388
|
-
filters?: BotLocaleFilter[];
|
|
5389
|
-
/**
|
|
5390
|
-
* <p>The maximum number of aliases to return in each page of results. If
|
|
5391
|
-
* there are fewer results than the max page size, only the actual number
|
|
5392
|
-
* of results are returned.</p>
|
|
5393
|
-
*/
|
|
5394
|
-
maxResults?: number;
|
|
5395
|
-
/**
|
|
5396
|
-
* <p>If the response from the <code>ListBotLocales</code> operation
|
|
5397
|
-
* contains more results than specified in the <code>maxResults</code>
|
|
5398
|
-
* parameter, a token is returned in the response. Use that token as the
|
|
5399
|
-
* <code>nextToken</code> parameter to return the next page of results.
|
|
5400
|
-
* </p>
|
|
5401
|
-
*/
|
|
5402
|
-
nextToken?: string;
|
|
5403
|
-
}
|
|
5404
|
-
/**
|
|
5405
|
-
* @public
|
|
5406
|
-
*/
|
|
5407
|
-
export interface ListBotLocalesResponse {
|
|
5408
|
-
/**
|
|
5409
|
-
* <p>The identifier of the bot to list locales for.</p>
|
|
5410
|
-
*/
|
|
5411
|
-
botId?: string;
|
|
5412
|
-
/**
|
|
5413
|
-
* <p>The version of the bot.</p>
|
|
5414
|
-
*/
|
|
5415
|
-
botVersion?: string;
|
|
5416
|
-
/**
|
|
5417
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5418
|
-
* response to the <code>ListBotLocales</code> operation. If the
|
|
5419
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5420
|
-
* the <code>nextToken</code> parameter of a <code>ListBotLocales</code>
|
|
5421
|
-
* operation request to get the next page of results.</p>
|
|
5422
|
-
*/
|
|
5423
|
-
nextToken?: string;
|
|
5424
|
-
/**
|
|
5425
|
-
* <p>Summary information for the locales that meet the filter criteria
|
|
5426
|
-
* specified in the request. The length of the list is specified in the
|
|
5427
|
-
* <code>maxResults</code> parameter of the request. If there are more
|
|
5428
|
-
* locales available, the <code>nextToken</code> field contains a token to
|
|
5429
|
-
* get the next page of results.</p>
|
|
5430
|
-
*/
|
|
5431
|
-
botLocaleSummaries?: BotLocaleSummary[];
|
|
5432
|
-
}
|
|
5433
|
-
/**
|
|
5434
|
-
* @public
|
|
5435
|
-
*/
|
|
5436
|
-
export interface ListBotRecommendationsRequest {
|
|
5437
|
-
/**
|
|
5438
|
-
* <p>The unique identifier of the bot that contains the bot
|
|
5439
|
-
* recommendation list.</p>
|
|
5440
|
-
*/
|
|
5441
|
-
botId: string | undefined;
|
|
5442
|
-
/**
|
|
5443
|
-
* <p>The version of the bot that contains the bot recommendation
|
|
5444
|
-
* list.</p>
|
|
5445
|
-
*/
|
|
5446
|
-
botVersion: string | undefined;
|
|
5447
|
-
/**
|
|
5448
|
-
* <p>The identifier of the language and locale of the bot recommendation
|
|
5449
|
-
* list.</p>
|
|
5450
|
-
*/
|
|
5451
|
-
localeId: string | undefined;
|
|
5452
|
-
/**
|
|
5453
|
-
* <p>The maximum number of bot recommendations to return in each page of
|
|
5454
|
-
* results. If there are fewer results than the max page size, only the
|
|
5455
|
-
* actual number of results are returned.</p>
|
|
5456
|
-
*/
|
|
5457
|
-
maxResults?: number;
|
|
5458
|
-
/**
|
|
5459
|
-
* <p>If the response from the ListBotRecommendation operation contains
|
|
5460
|
-
* more results than specified in the maxResults parameter, a token is
|
|
5461
|
-
* returned in the response. Use that token in the nextToken parameter to
|
|
5462
|
-
* return the next page of results.</p>
|
|
5463
|
-
*/
|
|
5464
|
-
nextToken?: string;
|
|
5465
|
-
}
|
|
5466
|
-
/**
|
|
5467
|
-
* @public
|
|
5468
|
-
*/
|
|
5469
|
-
export interface ListBotRecommendationsResponse {
|
|
5470
|
-
/**
|
|
5471
|
-
* <p>The unique identifier of the bot that contains the bot
|
|
5472
|
-
* recommendation list.</p>
|
|
5473
|
-
*/
|
|
5474
|
-
botId?: string;
|
|
5475
|
-
/**
|
|
5476
|
-
* <p>The version of the bot that contains the bot recommendation
|
|
5477
|
-
* list.</p>
|
|
5478
|
-
*/
|
|
5479
|
-
botVersion?: string;
|
|
5480
|
-
/**
|
|
5481
|
-
* <p>The identifier of the language and locale of the bot recommendation
|
|
5482
|
-
* list.</p>
|
|
5483
|
-
*/
|
|
5484
|
-
localeId?: string;
|
|
5485
|
-
/**
|
|
5486
|
-
* <p>Summary information for the bot recommendations that meet the filter
|
|
5487
|
-
* specified in this request. The length of the list is specified in the
|
|
5488
|
-
* maxResults parameter of the request. If there are more bot
|
|
5489
|
-
* recommendations available, the nextToken field contains a token to get
|
|
5490
|
-
* the next page of results.</p>
|
|
5491
|
-
*/
|
|
5492
|
-
botRecommendationSummaries?: BotRecommendationSummary[];
|
|
5493
|
-
/**
|
|
5494
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5495
|
-
* response to the ListBotRecommendations operation. If the nextToken
|
|
5496
|
-
* field is present, you send the contents as the nextToken parameter of a
|
|
5497
|
-
* ListBotRecommendations operation request to get the next page of
|
|
5498
|
-
* results. </p>
|
|
5499
|
-
*/
|
|
5500
|
-
nextToken?: string;
|
|
5501
|
-
}
|
|
5502
|
-
/**
|
|
5503
|
-
* @public
|
|
5504
|
-
*/
|
|
5505
|
-
export interface ListBotsRequest {
|
|
5506
|
-
/**
|
|
5507
|
-
* <p>Specifies sorting parameters for the list of bots. You can specify
|
|
5508
|
-
* that the list be sorted by bot name in ascending or descending
|
|
5509
|
-
* order.</p>
|
|
5510
|
-
*/
|
|
5511
|
-
sortBy?: BotSortBy;
|
|
5512
|
-
/**
|
|
5513
|
-
* <p>Provides the specification of a filter used to limit the bots in the
|
|
5514
|
-
* response to only those that match the filter specification. You can
|
|
5515
|
-
* only specify one filter and one string to filter on.</p>
|
|
5516
|
-
*/
|
|
5517
|
-
filters?: BotFilter[];
|
|
5518
|
-
/**
|
|
5519
|
-
* <p>The maximum number of bots to return in each page of results. If
|
|
5520
|
-
* there are fewer results than the maximum page size, only the actual
|
|
5521
|
-
* number of results are returned.</p>
|
|
5522
|
-
*/
|
|
5523
|
-
maxResults?: number;
|
|
5524
|
-
/**
|
|
5525
|
-
* <p>If the response from the <code>ListBots</code> operation contains
|
|
5526
|
-
* more results than specified in the <code>maxResults</code> parameter, a
|
|
5527
|
-
* token is returned in the response. </p>
|
|
5528
|
-
* <p>Use the returned token in the <code>nextToken</code> parameter of a
|
|
5529
|
-
* <code>ListBots</code> request to return the next page of results.
|
|
5530
|
-
* For a complete set of results, call the <code>ListBots</code> operation
|
|
5531
|
-
* until the <code>nextToken</code> returned in the response is
|
|
5532
|
-
* null.</p>
|
|
5533
|
-
*/
|
|
5534
|
-
nextToken?: string;
|
|
5535
|
-
}
|
|
5536
|
-
/**
|
|
5537
|
-
* @public
|
|
5538
|
-
*/
|
|
5539
|
-
export interface ListBotsResponse {
|
|
5540
|
-
/**
|
|
5541
|
-
* <p>Summary information for the bots that meet the filter criteria
|
|
5542
|
-
* specified in the request. The length of the list is specified in the
|
|
5543
|
-
* <code>maxResults</code> parameter of the request. If there are more
|
|
5544
|
-
* bots available, the <code>nextToken</code> field contains a token to
|
|
5545
|
-
* the next page of results.</p>
|
|
5546
|
-
*/
|
|
5547
|
-
botSummaries?: BotSummary[];
|
|
5548
|
-
/**
|
|
5549
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5550
|
-
* response to the <code>ListBots</code> operation. If the
|
|
5551
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5552
|
-
* the <code>nextToken</code> parameter of a <code>ListBots</code>
|
|
5553
|
-
* operation request to get the next page of results.</p>
|
|
5554
|
-
*/
|
|
5555
|
-
nextToken?: string;
|
|
5556
|
-
}
|
|
5557
|
-
/**
|
|
5558
|
-
* @public
|
|
5559
|
-
*/
|
|
5560
|
-
export interface ListBotVersionsRequest {
|
|
5561
|
-
/**
|
|
5562
|
-
* <p>The identifier of the bot to list versions for.</p>
|
|
5563
|
-
*/
|
|
5564
|
-
botId: string | undefined;
|
|
5565
|
-
/**
|
|
5566
|
-
* <p>Specifies sorting parameters for the list of versions. You can
|
|
5567
|
-
* specify that the list be sorted by version name in either ascending or
|
|
5568
|
-
* descending order.</p>
|
|
5569
|
-
*/
|
|
5570
|
-
sortBy?: BotVersionSortBy;
|
|
5571
|
-
/**
|
|
5572
|
-
* <p>The maximum number of versions to return in each page of results. If
|
|
5573
|
-
* there are fewer results than the max page size, only the actual number
|
|
5574
|
-
* of results are returned.</p>
|
|
5575
|
-
*/
|
|
5576
|
-
maxResults?: number;
|
|
5577
|
-
/**
|
|
5578
|
-
* <p>If the response to the <code>ListBotVersion</code> operation
|
|
5579
|
-
* contains more results than specified in the <code>maxResults</code>
|
|
5580
|
-
* parameter, a token is returned in the response. Use that token in the
|
|
5581
|
-
* <code>nextToken</code> parameter to return the next page of
|
|
5582
|
-
* results.</p>
|
|
5583
|
-
*/
|
|
5584
|
-
nextToken?: string;
|
|
5585
|
-
}
|
|
5586
|
-
/**
|
|
5587
|
-
* @public
|
|
6236
|
+
* @internal
|
|
5588
6237
|
*/
|
|
5589
|
-
export
|
|
5590
|
-
/**
|
|
5591
|
-
* <p>The identifier of the bot to list versions for.</p>
|
|
5592
|
-
*/
|
|
5593
|
-
botId?: string;
|
|
5594
|
-
/**
|
|
5595
|
-
* <p>Summary information for the bot versions that meet the filter
|
|
5596
|
-
* criteria specified in the request. The length of the list is specified
|
|
5597
|
-
* in the <code>maxResults</code> parameter of the request. If there are
|
|
5598
|
-
* more versions available, the <code>nextToken</code> field contains a
|
|
5599
|
-
* token to get the next page of results.</p>
|
|
5600
|
-
*/
|
|
5601
|
-
botVersionSummaries?: BotVersionSummary[];
|
|
5602
|
-
/**
|
|
5603
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5604
|
-
* response to the <code>ListBotVersions</code> operation. If the
|
|
5605
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5606
|
-
* the <code>nextToken</code> parameter of a <code>ListBotAliases</code>
|
|
5607
|
-
* operation request to get the next page of results.</p>
|
|
5608
|
-
*/
|
|
5609
|
-
nextToken?: string;
|
|
5610
|
-
}
|
|
6238
|
+
export declare const CreateExportRequestFilterSensitiveLog: (obj: CreateExportRequest) => any;
|
|
5611
6239
|
/**
|
|
5612
|
-
* @
|
|
6240
|
+
* @internal
|
|
5613
6241
|
*/
|
|
5614
|
-
export
|
|
5615
|
-
/**
|
|
5616
|
-
* <p>The identifier of the language and locale of the intents to list.
|
|
5617
|
-
* The string must match one of the supported locales. For more
|
|
5618
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
5619
|
-
*/
|
|
5620
|
-
localeId: string | undefined;
|
|
5621
|
-
/**
|
|
5622
|
-
* <p>Specifies sorting parameters for the list of built-in intents. You
|
|
5623
|
-
* can specify that the list be sorted by the built-in intent signature in
|
|
5624
|
-
* either ascending or descending order.</p>
|
|
5625
|
-
*/
|
|
5626
|
-
sortBy?: BuiltInIntentSortBy;
|
|
5627
|
-
/**
|
|
5628
|
-
* <p>The maximum number of built-in intents to return in each page of
|
|
5629
|
-
* results. If there are fewer results than the max page size, only the
|
|
5630
|
-
* actual number of results are returned.</p>
|
|
5631
|
-
*/
|
|
5632
|
-
maxResults?: number;
|
|
5633
|
-
/**
|
|
5634
|
-
* <p>If the response from the <code>ListBuiltInIntents</code> operation
|
|
5635
|
-
* contains more results than specified in the <code>maxResults</code>
|
|
5636
|
-
* parameter, a token is returned in the response. Use that token in the
|
|
5637
|
-
* <code>nextToken</code> parameter to return the next page of
|
|
5638
|
-
* results.</p>
|
|
5639
|
-
*/
|
|
5640
|
-
nextToken?: string;
|
|
5641
|
-
}
|
|
6242
|
+
export declare const EncryptionSettingFilterSensitiveLog: (obj: EncryptionSetting) => any;
|
|
5642
6243
|
/**
|
|
5643
|
-
* @
|
|
5644
|
-
*/
|
|
5645
|
-
export interface ListBuiltInIntentsResponse {
|
|
5646
|
-
/**
|
|
5647
|
-
* <p>Summary information for the built-in intents that meet the filter
|
|
5648
|
-
* criteria specified in the request. The length of the list is specified
|
|
5649
|
-
* in the <code>maxResults</code> parameter of the request. If there are
|
|
5650
|
-
* more intents available, the <code>nextToken</code> field contains a
|
|
5651
|
-
* token to get the next page of results.</p>
|
|
5652
|
-
*/
|
|
5653
|
-
builtInIntentSummaries?: BuiltInIntentSummary[];
|
|
5654
|
-
/**
|
|
5655
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5656
|
-
* response to the <code>ListBuiltInIntents</code> operation. If the
|
|
5657
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5658
|
-
* the <code>nextToken</code> parameter of a <code>ListBotAliases</code>
|
|
5659
|
-
* operation request to get the next page of results.</p>
|
|
5660
|
-
*/
|
|
5661
|
-
nextToken?: string;
|
|
5662
|
-
/**
|
|
5663
|
-
* <p>The language and locale of the intents in the list.</p>
|
|
5664
|
-
*/
|
|
5665
|
-
localeId?: string;
|
|
5666
|
-
}
|
|
5667
|
-
/**
|
|
5668
|
-
* @public
|
|
5669
|
-
*/
|
|
5670
|
-
export interface ListBuiltInSlotTypesRequest {
|
|
5671
|
-
/**
|
|
5672
|
-
* <p>The identifier of the language and locale of the slot types to list.
|
|
5673
|
-
* The string must match one of the supported locales. For more
|
|
5674
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
5675
|
-
*/
|
|
5676
|
-
localeId: string | undefined;
|
|
5677
|
-
/**
|
|
5678
|
-
* <p>Determines the sort order for the response from the
|
|
5679
|
-
* <code>ListBuiltInSlotTypes</code> operation. You can choose to sort
|
|
5680
|
-
* by the slot type signature in either ascending or descending
|
|
5681
|
-
* order.</p>
|
|
5682
|
-
*/
|
|
5683
|
-
sortBy?: BuiltInSlotTypeSortBy;
|
|
5684
|
-
/**
|
|
5685
|
-
* <p>The maximum number of built-in slot types to return in each page of
|
|
5686
|
-
* results. If there are fewer results than the max page size, only the
|
|
5687
|
-
* actual number of results are returned.</p>
|
|
5688
|
-
*/
|
|
5689
|
-
maxResults?: number;
|
|
5690
|
-
/**
|
|
5691
|
-
* <p>If the response from the <code>ListBuiltInSlotTypes</code> operation
|
|
5692
|
-
* contains more results than specified in the <code>maxResults</code>
|
|
5693
|
-
* parameter, a token is returned in the response. Use that token in the
|
|
5694
|
-
* <code>nextToken</code> parameter to return the next page of
|
|
5695
|
-
* results.</p>
|
|
5696
|
-
*/
|
|
5697
|
-
nextToken?: string;
|
|
5698
|
-
}
|
|
5699
|
-
/**
|
|
5700
|
-
* @public
|
|
5701
|
-
*/
|
|
5702
|
-
export interface ListBuiltInSlotTypesResponse {
|
|
5703
|
-
/**
|
|
5704
|
-
* <p>Summary information for the built-in slot types that meet the filter
|
|
5705
|
-
* criteria specified in the request. The length of the list is specified
|
|
5706
|
-
* in the <code>maxResults</code> parameter of the request. If there are
|
|
5707
|
-
* more slot types available, the <code>nextToken</code> field contains a
|
|
5708
|
-
* token to get the next page of results.</p>
|
|
5709
|
-
*/
|
|
5710
|
-
builtInSlotTypeSummaries?: BuiltInSlotTypeSummary[];
|
|
5711
|
-
/**
|
|
5712
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5713
|
-
* response to the <code>ListBuiltInSlotTypes</code> operation. If the
|
|
5714
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5715
|
-
* the <code>nextToken</code> parameter of a
|
|
5716
|
-
* <code>LIstBuiltInSlotTypes</code> operation request to get the next
|
|
5717
|
-
* page of results.</p>
|
|
5718
|
-
*/
|
|
5719
|
-
nextToken?: string;
|
|
5720
|
-
/**
|
|
5721
|
-
* <p>The language and locale of the slot types in the list.</p>
|
|
5722
|
-
*/
|
|
5723
|
-
localeId?: string;
|
|
5724
|
-
}
|
|
5725
|
-
/**
|
|
5726
|
-
* @public
|
|
5727
|
-
*/
|
|
5728
|
-
export interface ListCustomVocabularyItemsRequest {
|
|
5729
|
-
/**
|
|
5730
|
-
* <p>The identifier of the version of the bot associated with this custom
|
|
5731
|
-
* vocabulary.</p>
|
|
5732
|
-
*/
|
|
5733
|
-
botId: string | undefined;
|
|
5734
|
-
/**
|
|
5735
|
-
* <p>The bot version of the bot to the list custom vocabulary
|
|
5736
|
-
* request.</p>
|
|
5737
|
-
*/
|
|
5738
|
-
botVersion: string | undefined;
|
|
5739
|
-
/**
|
|
5740
|
-
* <p>The identifier of the language and locale where this custom vocabulary
|
|
5741
|
-
* is used. The string must match one of the supported locales. For more
|
|
5742
|
-
* information, see Supported
|
|
5743
|
-
* languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).</p>
|
|
5744
|
-
*/
|
|
5745
|
-
localeId: string | undefined;
|
|
5746
|
-
/**
|
|
5747
|
-
* <p>The maximum number of items returned by the list operation.</p>
|
|
5748
|
-
*/
|
|
5749
|
-
maxResults?: number;
|
|
5750
|
-
/**
|
|
5751
|
-
* <p>The nextToken identifier to the list custom vocabulary
|
|
5752
|
-
* request.</p>
|
|
5753
|
-
*/
|
|
5754
|
-
nextToken?: string;
|
|
5755
|
-
}
|
|
5756
|
-
/**
|
|
5757
|
-
* @public
|
|
5758
|
-
*/
|
|
5759
|
-
export interface ListCustomVocabularyItemsResponse {
|
|
5760
|
-
/**
|
|
5761
|
-
* <p>The identifier of the bot associated with this custom vocabulary.</p>
|
|
5762
|
-
*/
|
|
5763
|
-
botId?: string;
|
|
5764
|
-
/**
|
|
5765
|
-
* <p>The identifier of the version of the bot associated with this custom
|
|
5766
|
-
* vocabulary.</p>
|
|
5767
|
-
*/
|
|
5768
|
-
botVersion?: string;
|
|
5769
|
-
/**
|
|
5770
|
-
* <p>The identifier of the language and locale where this custom vocabulary
|
|
5771
|
-
* is used. The string must match one of the supported locales. For more
|
|
5772
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html"> Supported Languages </a>.</p>
|
|
5773
|
-
*/
|
|
5774
|
-
localeId?: string;
|
|
5775
|
-
/**
|
|
5776
|
-
* <p>The custom vocabulary items from the list custom vocabulary
|
|
5777
|
-
* response.</p>
|
|
5778
|
-
*/
|
|
5779
|
-
customVocabularyItems?: CustomVocabularyItem[];
|
|
5780
|
-
/**
|
|
5781
|
-
* <p>The nextToken identifier to the list custom vocabulary
|
|
5782
|
-
* response.</p>
|
|
5783
|
-
*/
|
|
5784
|
-
nextToken?: string;
|
|
5785
|
-
}
|
|
5786
|
-
/**
|
|
5787
|
-
* @public
|
|
5788
|
-
*/
|
|
5789
|
-
export interface ListExportsRequest {
|
|
5790
|
-
/**
|
|
5791
|
-
* <p>The unique identifier that Amazon Lex assigned to the bot.</p>
|
|
5792
|
-
*/
|
|
5793
|
-
botId?: string;
|
|
5794
|
-
/**
|
|
5795
|
-
* <p>The version of the bot to list exports for. </p>
|
|
5796
|
-
*/
|
|
5797
|
-
botVersion?: string;
|
|
5798
|
-
/**
|
|
5799
|
-
* <p>Determines the field that the list of exports is sorted by. You can
|
|
5800
|
-
* sort by the <code>LastUpdatedDateTime</code> field in ascending or
|
|
5801
|
-
* descending order.</p>
|
|
5802
|
-
*/
|
|
5803
|
-
sortBy?: ExportSortBy;
|
|
5804
|
-
/**
|
|
5805
|
-
* <p>Provides the specification of a filter used to limit the exports in
|
|
5806
|
-
* the response to only those that match the filter specification. You can
|
|
5807
|
-
* only specify one filter and one string to filter on.</p>
|
|
5808
|
-
*/
|
|
5809
|
-
filters?: ExportFilter[];
|
|
5810
|
-
/**
|
|
5811
|
-
* <p>The maximum number of exports to return in each page of results. If
|
|
5812
|
-
* there are fewer results than the max page size, only the actual number
|
|
5813
|
-
* of results are returned.</p>
|
|
5814
|
-
*/
|
|
5815
|
-
maxResults?: number;
|
|
5816
|
-
/**
|
|
5817
|
-
* <p>If the response from the <code>ListExports</code> operation contains
|
|
5818
|
-
* more results that specified in the <code>maxResults</code> parameter, a
|
|
5819
|
-
* token is returned in the response. </p>
|
|
5820
|
-
* <p>Use the returned token in the <code>nextToken</code> parameter of a
|
|
5821
|
-
* <code>ListExports</code> request to return the next page of results.
|
|
5822
|
-
* For a complete set of results, call the <code>ListExports</code>
|
|
5823
|
-
* operation until the <code>nextToken</code> returned in the response is
|
|
5824
|
-
* null.</p>
|
|
5825
|
-
*/
|
|
5826
|
-
nextToken?: string;
|
|
5827
|
-
/**
|
|
5828
|
-
* <p>Specifies the resources that should be exported. If you
|
|
5829
|
-
* don't specify a resource type in the <code>filters</code> parameter,
|
|
5830
|
-
* both bot locales and custom vocabularies are exported.</p>
|
|
5831
|
-
*/
|
|
5832
|
-
localeId?: string;
|
|
5833
|
-
}
|
|
5834
|
-
/**
|
|
5835
|
-
* @public
|
|
5836
|
-
*/
|
|
5837
|
-
export interface ListExportsResponse {
|
|
5838
|
-
/**
|
|
5839
|
-
* <p>The unique identifier assigned to the bot by Amazon Lex.</p>
|
|
5840
|
-
*/
|
|
5841
|
-
botId?: string;
|
|
5842
|
-
/**
|
|
5843
|
-
* <p>The version of the bot that was exported.</p>
|
|
5844
|
-
*/
|
|
5845
|
-
botVersion?: string;
|
|
5846
|
-
/**
|
|
5847
|
-
* <p>Summary information for the exports that meet the filter criteria
|
|
5848
|
-
* specified in the request. The length of the list is specified in the
|
|
5849
|
-
* <code>maxResults</code> parameter. If there are more exports
|
|
5850
|
-
* available, the <code>nextToken</code> field contains a token to get the
|
|
5851
|
-
* next page of results.</p>
|
|
5852
|
-
*/
|
|
5853
|
-
exportSummaries?: ExportSummary[];
|
|
5854
|
-
/**
|
|
5855
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5856
|
-
* response to the <code>ListExports</code> operation. If the
|
|
5857
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5858
|
-
* the <code>nextToken</code> parameter of a <code>ListExports</code>
|
|
5859
|
-
* operation request to get the next page of results.</p>
|
|
5860
|
-
*/
|
|
5861
|
-
nextToken?: string;
|
|
5862
|
-
/**
|
|
5863
|
-
* <p>The locale specified in the request.</p>
|
|
5864
|
-
*/
|
|
5865
|
-
localeId?: string;
|
|
5866
|
-
}
|
|
5867
|
-
/**
|
|
5868
|
-
* @public
|
|
5869
|
-
*/
|
|
5870
|
-
export interface ListImportsRequest {
|
|
5871
|
-
/**
|
|
5872
|
-
* <p>The unique identifier that Amazon Lex assigned to the bot.</p>
|
|
5873
|
-
*/
|
|
5874
|
-
botId?: string;
|
|
5875
|
-
/**
|
|
5876
|
-
* <p>The version of the bot to list imports for.</p>
|
|
5877
|
-
*/
|
|
5878
|
-
botVersion?: string;
|
|
5879
|
-
/**
|
|
5880
|
-
* <p>Determines the field that the list of imports is sorted by. You can
|
|
5881
|
-
* sort by the <code>LastUpdatedDateTime</code> field in ascending or
|
|
5882
|
-
* descending order.</p>
|
|
5883
|
-
*/
|
|
5884
|
-
sortBy?: ImportSortBy;
|
|
5885
|
-
/**
|
|
5886
|
-
* <p>Provides the specification of a filter used to limit the bots in the
|
|
5887
|
-
* response to only those that match the filter specification. You can
|
|
5888
|
-
* only specify one filter and one string to filter on.</p>
|
|
5889
|
-
*/
|
|
5890
|
-
filters?: ImportFilter[];
|
|
5891
|
-
/**
|
|
5892
|
-
* <p>The maximum number of imports to return in each page of results. If
|
|
5893
|
-
* there are fewer results than the max page size, only the actual number
|
|
5894
|
-
* of results are returned.</p>
|
|
5895
|
-
*/
|
|
5896
|
-
maxResults?: number;
|
|
5897
|
-
/**
|
|
5898
|
-
* <p>If the response from the <code>ListImports</code> operation contains
|
|
5899
|
-
* more results than specified in the <code>maxResults</code> parameter, a
|
|
5900
|
-
* token is returned in the response.</p>
|
|
5901
|
-
* <p>Use the returned token in the <code>nextToken</code> parameter of a
|
|
5902
|
-
* <code>ListImports</code> request to return the next page of results.
|
|
5903
|
-
* For a complete set of results, call the <code>ListImports</code>
|
|
5904
|
-
* operation until the <code>nextToken</code> returned in the response is
|
|
5905
|
-
* null.</p>
|
|
5906
|
-
*/
|
|
5907
|
-
nextToken?: string;
|
|
5908
|
-
/**
|
|
5909
|
-
* <p>Specifies the locale that should be present in the list. If you
|
|
5910
|
-
* don't specify a resource type in the <code>filters</code> parameter,
|
|
5911
|
-
* the list contains both bot locales and custom vocabularies.</p>
|
|
5912
|
-
*/
|
|
5913
|
-
localeId?: string;
|
|
5914
|
-
}
|
|
5915
|
-
/**
|
|
5916
|
-
* @public
|
|
5917
|
-
*/
|
|
5918
|
-
export interface ListImportsResponse {
|
|
5919
|
-
/**
|
|
5920
|
-
* <p>The unique identifier assigned by Amazon Lex to the bot.</p>
|
|
5921
|
-
*/
|
|
5922
|
-
botId?: string;
|
|
5923
|
-
/**
|
|
5924
|
-
* <p>The version of the bot that was imported. It will always be
|
|
5925
|
-
* <code>DRAFT</code>.</p>
|
|
5926
|
-
*/
|
|
5927
|
-
botVersion?: string;
|
|
5928
|
-
/**
|
|
5929
|
-
* <p>Summary information for the imports that meet the filter criteria
|
|
5930
|
-
* specified in the request. The length of the list is specified in the
|
|
5931
|
-
* <code>maxResults</code> parameter. If there are more imports
|
|
5932
|
-
* available, the <code>nextToken</code> field contains a token to get the
|
|
5933
|
-
* next page of results.</p>
|
|
5934
|
-
*/
|
|
5935
|
-
importSummaries?: ImportSummary[];
|
|
5936
|
-
/**
|
|
5937
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
5938
|
-
* response to the <code>ListImports</code> operation. If the
|
|
5939
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
5940
|
-
* the <code>nextToken</code> parameter of a <code>ListImports</code>
|
|
5941
|
-
* operation request to get the next page of results.</p>
|
|
5942
|
-
*/
|
|
5943
|
-
nextToken?: string;
|
|
5944
|
-
/**
|
|
5945
|
-
* <p>The locale specified in the request.</p>
|
|
5946
|
-
*/
|
|
5947
|
-
localeId?: string;
|
|
5948
|
-
}
|
|
5949
|
-
/**
|
|
5950
|
-
* @public
|
|
5951
|
-
*/
|
|
5952
|
-
export interface ListIntentsRequest {
|
|
5953
|
-
/**
|
|
5954
|
-
* <p>The unique identifier of the bot that contains the intent.</p>
|
|
5955
|
-
*/
|
|
5956
|
-
botId: string | undefined;
|
|
5957
|
-
/**
|
|
5958
|
-
* <p>The version of the bot that contains the intent.</p>
|
|
5959
|
-
*/
|
|
5960
|
-
botVersion: string | undefined;
|
|
5961
|
-
/**
|
|
5962
|
-
* <p>The identifier of the language and locale of the intents to list.
|
|
5963
|
-
* The string must match one of the supported locales. For more
|
|
5964
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
5965
|
-
*/
|
|
5966
|
-
localeId: string | undefined;
|
|
5967
|
-
/**
|
|
5968
|
-
* <p>Determines the sort order for the response from the
|
|
5969
|
-
* <code>ListIntents</code> operation. You can choose to sort by the
|
|
5970
|
-
* intent name or last updated date in either ascending or descending
|
|
5971
|
-
* order.</p>
|
|
5972
|
-
*/
|
|
5973
|
-
sortBy?: IntentSortBy;
|
|
5974
|
-
/**
|
|
5975
|
-
* <p>Provides the specification of a filter used to limit the intents in
|
|
5976
|
-
* the response to only those that match the filter specification. You can
|
|
5977
|
-
* only specify one filter and only one string to filter on.</p>
|
|
5978
|
-
*/
|
|
5979
|
-
filters?: IntentFilter[];
|
|
5980
|
-
/**
|
|
5981
|
-
* <p>The maximum number of intents to return in each page of results. If
|
|
5982
|
-
* there are fewer results than the max page size, only the actual number
|
|
5983
|
-
* of results are returned.</p>
|
|
5984
|
-
*/
|
|
5985
|
-
maxResults?: number;
|
|
5986
|
-
/**
|
|
5987
|
-
* <p>If the response from the <code>ListIntents</code> operation contains
|
|
5988
|
-
* more results than specified in the <code>maxResults</code> parameter, a
|
|
5989
|
-
* token is returned in the response.</p>
|
|
5990
|
-
* <p>Use the returned token in the <code>nextToken</code> parameter of a
|
|
5991
|
-
* <code>ListIntents</code> request to return the next page of results.
|
|
5992
|
-
* For a complete set of results, call the <code>ListIntents</code>
|
|
5993
|
-
* operation until the <code>nextToken</code> returned in the response is
|
|
5994
|
-
* null.</p>
|
|
5995
|
-
*/
|
|
5996
|
-
nextToken?: string;
|
|
5997
|
-
}
|
|
5998
|
-
/**
|
|
5999
|
-
* @public
|
|
6000
|
-
*/
|
|
6001
|
-
export interface ListIntentsResponse {
|
|
6002
|
-
/**
|
|
6003
|
-
* <p>The identifier of the bot that contains the intent.</p>
|
|
6004
|
-
*/
|
|
6005
|
-
botId?: string;
|
|
6006
|
-
/**
|
|
6007
|
-
* <p>The version of the bot that contains the intent.</p>
|
|
6008
|
-
*/
|
|
6009
|
-
botVersion?: string;
|
|
6010
|
-
/**
|
|
6011
|
-
* <p>The language and locale of the intents in the list.</p>
|
|
6012
|
-
*/
|
|
6013
|
-
localeId?: string;
|
|
6014
|
-
/**
|
|
6015
|
-
* <p>Summary information for the intents that meet the filter criteria
|
|
6016
|
-
* specified in the request. The length of the list is specified in the
|
|
6017
|
-
* <code>maxResults</code> parameter of the request. If there are more
|
|
6018
|
-
* intents available, the <code>nextToken</code> field contains a token to
|
|
6019
|
-
* get the next page of results.</p>
|
|
6020
|
-
*/
|
|
6021
|
-
intentSummaries?: IntentSummary[];
|
|
6022
|
-
/**
|
|
6023
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
6024
|
-
* response to the <code>ListIntents</code> operation. If the
|
|
6025
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
6026
|
-
* the <code>nextToken</code> parameter of a <code>ListIntents</code>
|
|
6027
|
-
* operation request to get the next page of results.</p>
|
|
6028
|
-
*/
|
|
6029
|
-
nextToken?: string;
|
|
6030
|
-
}
|
|
6031
|
-
/**
|
|
6032
|
-
* @public
|
|
6033
|
-
*/
|
|
6034
|
-
export interface ListRecommendedIntentsRequest {
|
|
6035
|
-
/**
|
|
6036
|
-
* <p>The unique identifier of the bot associated with the recommended
|
|
6037
|
-
* intents.</p>
|
|
6038
|
-
*/
|
|
6039
|
-
botId: string | undefined;
|
|
6040
|
-
/**
|
|
6041
|
-
* <p>The version of the bot that contains the recommended intents.</p>
|
|
6042
|
-
*/
|
|
6043
|
-
botVersion: string | undefined;
|
|
6044
|
-
/**
|
|
6045
|
-
* <p>The identifier of the language and locale of the recommended
|
|
6046
|
-
* intents.</p>
|
|
6047
|
-
*/
|
|
6048
|
-
localeId: string | undefined;
|
|
6049
|
-
/**
|
|
6050
|
-
* <p>The identifier of the bot recommendation that contains the
|
|
6051
|
-
* recommended intents.</p>
|
|
6052
|
-
*/
|
|
6053
|
-
botRecommendationId: string | undefined;
|
|
6054
|
-
/**
|
|
6055
|
-
* <p>If the response from the ListRecommendedIntents operation contains
|
|
6056
|
-
* more results than specified in the maxResults parameter, a token is
|
|
6057
|
-
* returned in the response. Use that token in the nextToken parameter to
|
|
6058
|
-
* return the next page of results.</p>
|
|
6059
|
-
*/
|
|
6060
|
-
nextToken?: string;
|
|
6061
|
-
/**
|
|
6062
|
-
* <p>The maximum number of bot recommendations to return in each page of
|
|
6063
|
-
* results. If there are fewer results than the max page size, only the
|
|
6064
|
-
* actual number of results are returned.</p>
|
|
6065
|
-
*/
|
|
6066
|
-
maxResults?: number;
|
|
6067
|
-
}
|
|
6068
|
-
/**
|
|
6069
|
-
* @public
|
|
6070
|
-
* <p>An object that contains a summary of a recommended intent.</p>
|
|
6071
|
-
*/
|
|
6072
|
-
export interface RecommendedIntentSummary {
|
|
6073
|
-
/**
|
|
6074
|
-
* <p>The unique identifier of a recommended intent associated with the
|
|
6075
|
-
* bot recommendation.</p>
|
|
6076
|
-
*/
|
|
6077
|
-
intentId?: string;
|
|
6078
|
-
/**
|
|
6079
|
-
* <p>The name of a recommended intent associated with the bot
|
|
6080
|
-
* recommendation.</p>
|
|
6081
|
-
*/
|
|
6082
|
-
intentName?: string;
|
|
6083
|
-
/**
|
|
6084
|
-
* <p>The count of sample utterances of a recommended intent that is
|
|
6085
|
-
* associated with a bot recommendation.</p>
|
|
6086
|
-
*/
|
|
6087
|
-
sampleUtterancesCount?: number;
|
|
6088
|
-
}
|
|
6089
|
-
/**
|
|
6090
|
-
* @public
|
|
6091
|
-
*/
|
|
6092
|
-
export interface ListRecommendedIntentsResponse {
|
|
6093
|
-
/**
|
|
6094
|
-
* <p>The unique identifier of the bot associated with the recommended
|
|
6095
|
-
* intent.</p>
|
|
6096
|
-
*/
|
|
6097
|
-
botId?: string;
|
|
6098
|
-
/**
|
|
6099
|
-
* <p>The version of the bot that contains the intent.</p>
|
|
6100
|
-
*/
|
|
6101
|
-
botVersion?: string;
|
|
6102
|
-
/**
|
|
6103
|
-
* <p>The identifier of the language and locale of the intents to list.
|
|
6104
|
-
* The string must match one of the supported locales. For more
|
|
6105
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
6106
|
-
*/
|
|
6107
|
-
localeId?: string;
|
|
6108
|
-
/**
|
|
6109
|
-
* <p>The identifier of the bot recommendation that contains the
|
|
6110
|
-
* recommended intent.</p>
|
|
6111
|
-
*/
|
|
6112
|
-
botRecommendationId?: string;
|
|
6113
|
-
/**
|
|
6114
|
-
* <p>Summary information for the intents that meet the filter criteria
|
|
6115
|
-
* specified in the request. The length of the list is specified in the
|
|
6116
|
-
* maxResults parameter of the request. If there are more intents
|
|
6117
|
-
* available, the nextToken field contains a token to get the next page of
|
|
6118
|
-
* results.</p>
|
|
6119
|
-
*/
|
|
6120
|
-
summaryList?: RecommendedIntentSummary[];
|
|
6121
|
-
/**
|
|
6122
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
6123
|
-
* response to the ListRecommendedIntents operation. If the nextToken
|
|
6124
|
-
* field is present, you send the contents as the nextToken parameter of a
|
|
6125
|
-
* ListRecommendedIntents operation request to get the next page of
|
|
6126
|
-
* results.</p>
|
|
6127
|
-
*/
|
|
6128
|
-
nextToken?: string;
|
|
6129
|
-
}
|
|
6130
|
-
/**
|
|
6131
|
-
* @public
|
|
6132
|
-
* @enum
|
|
6133
|
-
*/
|
|
6134
|
-
export declare const SlotFilterName: {
|
|
6135
|
-
readonly SlotName: "SlotName";
|
|
6136
|
-
};
|
|
6137
|
-
/**
|
|
6138
|
-
* @public
|
|
6139
|
-
*/
|
|
6140
|
-
export type SlotFilterName = (typeof SlotFilterName)[keyof typeof SlotFilterName];
|
|
6141
|
-
/**
|
|
6142
|
-
* @public
|
|
6143
|
-
* @enum
|
|
6144
|
-
*/
|
|
6145
|
-
export declare const SlotFilterOperator: {
|
|
6146
|
-
readonly Contains: "CO";
|
|
6147
|
-
readonly Equals: "EQ";
|
|
6148
|
-
};
|
|
6149
|
-
/**
|
|
6150
|
-
* @public
|
|
6151
|
-
*/
|
|
6152
|
-
export type SlotFilterOperator = (typeof SlotFilterOperator)[keyof typeof SlotFilterOperator];
|
|
6153
|
-
/**
|
|
6154
|
-
* @public
|
|
6155
|
-
* <p>Filters the response from the <code>ListSlots</code>
|
|
6156
|
-
* operation.</p>
|
|
6157
|
-
*/
|
|
6158
|
-
export interface SlotFilter {
|
|
6159
|
-
/**
|
|
6160
|
-
* <p>The name of the field to use for filtering.</p>
|
|
6161
|
-
*/
|
|
6162
|
-
name: SlotFilterName | string | undefined;
|
|
6163
|
-
/**
|
|
6164
|
-
* <p>The value to use to filter the response.</p>
|
|
6165
|
-
*/
|
|
6166
|
-
values: string[] | undefined;
|
|
6167
|
-
/**
|
|
6168
|
-
* <p>The operator to use for the filter. Specify <code>EQ</code> when the
|
|
6169
|
-
* <code>ListSlots</code> operation should return only aliases that
|
|
6170
|
-
* equal the specified value. Specify <code>CO</code> when the
|
|
6171
|
-
* <code>ListSlots</code> operation should return aliases that contain
|
|
6172
|
-
* the specified value.</p>
|
|
6173
|
-
*/
|
|
6174
|
-
operator: SlotFilterOperator | string | undefined;
|
|
6175
|
-
}
|
|
6176
|
-
/**
|
|
6177
|
-
* @public
|
|
6178
|
-
* @enum
|
|
6179
|
-
*/
|
|
6180
|
-
export declare const SlotSortAttribute: {
|
|
6181
|
-
readonly LastUpdatedDateTime: "LastUpdatedDateTime";
|
|
6182
|
-
readonly SlotName: "SlotName";
|
|
6183
|
-
};
|
|
6184
|
-
/**
|
|
6185
|
-
* @public
|
|
6186
|
-
*/
|
|
6187
|
-
export type SlotSortAttribute = (typeof SlotSortAttribute)[keyof typeof SlotSortAttribute];
|
|
6188
|
-
/**
|
|
6189
|
-
* @public
|
|
6190
|
-
* <p>Specifies attributes for sorting a list of bots.</p>
|
|
6191
|
-
*/
|
|
6192
|
-
export interface SlotSortBy {
|
|
6193
|
-
/**
|
|
6194
|
-
* <p>The attribute to use to sort the list.</p>
|
|
6195
|
-
*/
|
|
6196
|
-
attribute: SlotSortAttribute | string | undefined;
|
|
6197
|
-
/**
|
|
6198
|
-
* <p>The order to sort the list. You can choose ascending or
|
|
6199
|
-
* descending.</p>
|
|
6200
|
-
*/
|
|
6201
|
-
order: SortOrder | string | undefined;
|
|
6202
|
-
}
|
|
6203
|
-
/**
|
|
6204
|
-
* @public
|
|
6205
|
-
*/
|
|
6206
|
-
export interface ListSlotsRequest {
|
|
6207
|
-
/**
|
|
6208
|
-
* <p>The identifier of the bot that contains the slot.</p>
|
|
6209
|
-
*/
|
|
6210
|
-
botId: string | undefined;
|
|
6211
|
-
/**
|
|
6212
|
-
* <p>The version of the bot that contains the slot.</p>
|
|
6213
|
-
*/
|
|
6214
|
-
botVersion: string | undefined;
|
|
6215
|
-
/**
|
|
6216
|
-
* <p>The identifier of the language and locale of the slots to list. The
|
|
6217
|
-
* string must match one of the supported locales. For more information,
|
|
6218
|
-
* see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
6219
|
-
*/
|
|
6220
|
-
localeId: string | undefined;
|
|
6221
|
-
/**
|
|
6222
|
-
* <p>The unique identifier of the intent that contains the slot.</p>
|
|
6223
|
-
*/
|
|
6224
|
-
intentId: string | undefined;
|
|
6225
|
-
/**
|
|
6226
|
-
* <p>Determines the sort order for the response from the
|
|
6227
|
-
* <code>ListSlots</code> operation. You can choose to sort by the slot
|
|
6228
|
-
* name or last updated date in either ascending or descending
|
|
6229
|
-
* order.</p>
|
|
6230
|
-
*/
|
|
6231
|
-
sortBy?: SlotSortBy;
|
|
6232
|
-
/**
|
|
6233
|
-
* <p>Provides the specification of a filter used to limit the slots in
|
|
6234
|
-
* the response to only those that match the filter specification. You can
|
|
6235
|
-
* only specify one filter and only one string to filter on.</p>
|
|
6236
|
-
*/
|
|
6237
|
-
filters?: SlotFilter[];
|
|
6238
|
-
/**
|
|
6239
|
-
* <p>The maximum number of slots to return in each page of results. If
|
|
6240
|
-
* there are fewer results than the max page size, only the actual number
|
|
6241
|
-
* of results are returned.</p>
|
|
6242
|
-
*/
|
|
6243
|
-
maxResults?: number;
|
|
6244
|
-
/**
|
|
6245
|
-
* <p>If the response from the <code>ListSlots</code> operation contains
|
|
6246
|
-
* more results than specified in the <code>maxResults</code> parameter, a
|
|
6247
|
-
* token is returned in the response. Use that token in the
|
|
6248
|
-
* <code>nextToken</code> parameter to return the next page of
|
|
6249
|
-
* results.</p>
|
|
6250
|
-
*/
|
|
6251
|
-
nextToken?: string;
|
|
6252
|
-
}
|
|
6253
|
-
/**
|
|
6254
|
-
* @public
|
|
6255
|
-
* <p>Summary information about a slot, a value that the bot elicits from
|
|
6256
|
-
* the user.</p>
|
|
6257
|
-
*/
|
|
6258
|
-
export interface SlotSummary {
|
|
6259
|
-
/**
|
|
6260
|
-
* <p>The unique identifier of the slot.</p>
|
|
6261
|
-
*/
|
|
6262
|
-
slotId?: string;
|
|
6263
|
-
/**
|
|
6264
|
-
* <p>The name given to the slot.</p>
|
|
6265
|
-
*/
|
|
6266
|
-
slotName?: string;
|
|
6267
|
-
/**
|
|
6268
|
-
* <p>The description of the slot.</p>
|
|
6269
|
-
*/
|
|
6270
|
-
description?: string;
|
|
6271
|
-
/**
|
|
6272
|
-
* <p>Whether the slot is required or optional. An intent is complete when
|
|
6273
|
-
* all required slots are filled.</p>
|
|
6274
|
-
*/
|
|
6275
|
-
slotConstraint?: SlotConstraint | string;
|
|
6276
|
-
/**
|
|
6277
|
-
* <p>The unique identifier for the slot type that defines the values for
|
|
6278
|
-
* the slot.</p>
|
|
6279
|
-
*/
|
|
6280
|
-
slotTypeId?: string;
|
|
6281
|
-
/**
|
|
6282
|
-
* <p>Prompts that are sent to the user to elicit a value for the
|
|
6283
|
-
* slot.</p>
|
|
6284
|
-
*/
|
|
6285
|
-
valueElicitationPromptSpecification?: PromptSpecification;
|
|
6286
|
-
/**
|
|
6287
|
-
* <p>The timestamp of the last date and time that the slot was
|
|
6288
|
-
* updated.</p>
|
|
6289
|
-
*/
|
|
6290
|
-
lastUpdatedDateTime?: Date;
|
|
6291
|
-
}
|
|
6292
|
-
/**
|
|
6293
|
-
* @public
|
|
6294
|
-
*/
|
|
6295
|
-
export interface ListSlotsResponse {
|
|
6296
|
-
/**
|
|
6297
|
-
* <p>The identifier of the bot that contains the slots.</p>
|
|
6298
|
-
*/
|
|
6299
|
-
botId?: string;
|
|
6300
|
-
/**
|
|
6301
|
-
* <p>The version of the bot that contains the slots.</p>
|
|
6302
|
-
*/
|
|
6303
|
-
botVersion?: string;
|
|
6304
|
-
/**
|
|
6305
|
-
* <p>The language and locale of the slots in the list.</p>
|
|
6306
|
-
*/
|
|
6307
|
-
localeId?: string;
|
|
6308
|
-
/**
|
|
6309
|
-
* <p>The identifier of the intent that contains the slots.</p>
|
|
6310
|
-
*/
|
|
6311
|
-
intentId?: string;
|
|
6312
|
-
/**
|
|
6313
|
-
* <p>Summary information for the slots that meet the filter criteria
|
|
6314
|
-
* specified in the request. The length of the list is specified in the
|
|
6315
|
-
* <code>maxResults</code> parameter of the request. If there are more
|
|
6316
|
-
* slots available, the <code>nextToken</code> field contains a token to
|
|
6317
|
-
* get the next page of results.</p>
|
|
6318
|
-
*/
|
|
6319
|
-
slotSummaries?: SlotSummary[];
|
|
6320
|
-
/**
|
|
6321
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
6322
|
-
* response to the <code>ListSlots</code> operation. If the
|
|
6323
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
6324
|
-
* the <code>nextToken</code> parameter of a <code>ListSlots</code>
|
|
6325
|
-
* operation request to get the next page of results.</p>
|
|
6326
|
-
*/
|
|
6327
|
-
nextToken?: string;
|
|
6328
|
-
}
|
|
6329
|
-
/**
|
|
6330
|
-
* @public
|
|
6331
|
-
* @enum
|
|
6332
|
-
*/
|
|
6333
|
-
export declare const SlotTypeFilterName: {
|
|
6334
|
-
readonly ExternalSourceType: "ExternalSourceType";
|
|
6335
|
-
readonly SlotTypeName: "SlotTypeName";
|
|
6336
|
-
};
|
|
6337
|
-
/**
|
|
6338
|
-
* @public
|
|
6339
|
-
*/
|
|
6340
|
-
export type SlotTypeFilterName = (typeof SlotTypeFilterName)[keyof typeof SlotTypeFilterName];
|
|
6341
|
-
/**
|
|
6342
|
-
* @public
|
|
6343
|
-
* @enum
|
|
6344
|
-
*/
|
|
6345
|
-
export declare const SlotTypeFilterOperator: {
|
|
6346
|
-
readonly Contains: "CO";
|
|
6347
|
-
readonly Equals: "EQ";
|
|
6348
|
-
};
|
|
6349
|
-
/**
|
|
6350
|
-
* @public
|
|
6351
|
-
*/
|
|
6352
|
-
export type SlotTypeFilterOperator = (typeof SlotTypeFilterOperator)[keyof typeof SlotTypeFilterOperator];
|
|
6353
|
-
/**
|
|
6354
|
-
* @public
|
|
6355
|
-
* <p>Filters the response from the <code>ListSlotTypes</code>
|
|
6356
|
-
* operation.</p>
|
|
6357
|
-
*/
|
|
6358
|
-
export interface SlotTypeFilter {
|
|
6359
|
-
/**
|
|
6360
|
-
* <p>The name of the field to use for filtering.</p>
|
|
6361
|
-
*/
|
|
6362
|
-
name: SlotTypeFilterName | string | undefined;
|
|
6363
|
-
/**
|
|
6364
|
-
* <p>The value to use to filter the response.</p>
|
|
6365
|
-
*/
|
|
6366
|
-
values: string[] | undefined;
|
|
6367
|
-
/**
|
|
6368
|
-
* <p>The operator to use for the filter. Specify <code>EQ</code> when the
|
|
6369
|
-
* <code>ListSlotTypes</code> operation should return only aliases that
|
|
6370
|
-
* equal the specified value. Specify <code>CO</code> when the
|
|
6371
|
-
* <code>ListSlotTypes</code> operation should return aliases that
|
|
6372
|
-
* contain the specified value.</p>
|
|
6373
|
-
*/
|
|
6374
|
-
operator: SlotTypeFilterOperator | string | undefined;
|
|
6375
|
-
}
|
|
6376
|
-
/**
|
|
6377
|
-
* @public
|
|
6378
|
-
* @enum
|
|
6379
|
-
*/
|
|
6380
|
-
export declare const SlotTypeSortAttribute: {
|
|
6381
|
-
readonly LastUpdatedDateTime: "LastUpdatedDateTime";
|
|
6382
|
-
readonly SlotTypeName: "SlotTypeName";
|
|
6383
|
-
};
|
|
6384
|
-
/**
|
|
6385
|
-
* @public
|
|
6386
|
-
*/
|
|
6387
|
-
export type SlotTypeSortAttribute = (typeof SlotTypeSortAttribute)[keyof typeof SlotTypeSortAttribute];
|
|
6388
|
-
/**
|
|
6389
|
-
* @public
|
|
6390
|
-
* <p>Specifies attributes for sorting a list of slot types.</p>
|
|
6391
|
-
*/
|
|
6392
|
-
export interface SlotTypeSortBy {
|
|
6393
|
-
/**
|
|
6394
|
-
* <p>The attribute to use to sort the list of slot types.</p>
|
|
6395
|
-
*/
|
|
6396
|
-
attribute: SlotTypeSortAttribute | string | undefined;
|
|
6397
|
-
/**
|
|
6398
|
-
* <p>The order to sort the list. You can say ascending or
|
|
6399
|
-
* descending.</p>
|
|
6400
|
-
*/
|
|
6401
|
-
order: SortOrder | string | undefined;
|
|
6402
|
-
}
|
|
6403
|
-
/**
|
|
6404
|
-
* @public
|
|
6405
|
-
*/
|
|
6406
|
-
export interface ListSlotTypesRequest {
|
|
6407
|
-
/**
|
|
6408
|
-
* <p>The unique identifier of the bot that contains the slot
|
|
6409
|
-
* types.</p>
|
|
6410
|
-
*/
|
|
6411
|
-
botId: string | undefined;
|
|
6412
|
-
/**
|
|
6413
|
-
* <p>The version of the bot that contains the slot type.</p>
|
|
6414
|
-
*/
|
|
6415
|
-
botVersion: string | undefined;
|
|
6416
|
-
/**
|
|
6417
|
-
* <p>The identifier of the language and locale of the slot types to list.
|
|
6418
|
-
* The string must match one of the supported locales. For more
|
|
6419
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
6420
|
-
*/
|
|
6421
|
-
localeId: string | undefined;
|
|
6422
|
-
/**
|
|
6423
|
-
* <p>Determines the sort order for the response from the
|
|
6424
|
-
* <code>ListSlotTypes</code> operation. You can choose to sort by the
|
|
6425
|
-
* slot type name or last updated date in either ascending or descending
|
|
6426
|
-
* order.</p>
|
|
6427
|
-
*/
|
|
6428
|
-
sortBy?: SlotTypeSortBy;
|
|
6429
|
-
/**
|
|
6430
|
-
* <p>Provides the specification of a filter used to limit the slot types
|
|
6431
|
-
* in the response to only those that match the filter specification. You
|
|
6432
|
-
* can only specify one filter and only one string to filter on.</p>
|
|
6433
|
-
*/
|
|
6434
|
-
filters?: SlotTypeFilter[];
|
|
6435
|
-
/**
|
|
6436
|
-
* <p>The maximum number of slot types to return in each page of results.
|
|
6437
|
-
* If there are fewer results than the max page size, only the actual
|
|
6438
|
-
* number of results are returned.</p>
|
|
6439
|
-
*/
|
|
6440
|
-
maxResults?: number;
|
|
6441
|
-
/**
|
|
6442
|
-
* <p>If the response from the <code>ListSlotTypes</code> operation
|
|
6443
|
-
* contains more results than specified in the <code>maxResults</code>
|
|
6444
|
-
* parameter, a token is returned in the response. Use that token in the
|
|
6445
|
-
* <code>nextToken</code> parameter to return the next page of
|
|
6446
|
-
* results.</p>
|
|
6447
|
-
*/
|
|
6448
|
-
nextToken?: string;
|
|
6449
|
-
}
|
|
6450
|
-
/**
|
|
6451
|
-
* @public
|
|
6452
|
-
* @enum
|
|
6453
|
-
*/
|
|
6454
|
-
export declare const SlotTypeCategory: {
|
|
6455
|
-
readonly Composite: "Composite";
|
|
6456
|
-
readonly Custom: "Custom";
|
|
6457
|
-
readonly Extended: "Extended";
|
|
6458
|
-
readonly ExternalGrammar: "ExternalGrammar";
|
|
6459
|
-
};
|
|
6460
|
-
/**
|
|
6461
|
-
* @public
|
|
6462
|
-
*/
|
|
6463
|
-
export type SlotTypeCategory = (typeof SlotTypeCategory)[keyof typeof SlotTypeCategory];
|
|
6464
|
-
/**
|
|
6465
|
-
* @public
|
|
6466
|
-
* <p>Provides summary information about a slot type.</p>
|
|
6467
|
-
*/
|
|
6468
|
-
export interface SlotTypeSummary {
|
|
6469
|
-
/**
|
|
6470
|
-
* <p>The unique identifier assigned to the slot type.</p>
|
|
6471
|
-
*/
|
|
6472
|
-
slotTypeId?: string;
|
|
6473
|
-
/**
|
|
6474
|
-
* <p>The name of the slot type.</p>
|
|
6475
|
-
*/
|
|
6476
|
-
slotTypeName?: string;
|
|
6477
|
-
/**
|
|
6478
|
-
* <p>The description of the slot type.</p>
|
|
6479
|
-
*/
|
|
6480
|
-
description?: string;
|
|
6481
|
-
/**
|
|
6482
|
-
* <p>If the slot type is derived from a built-on slot type, the name of
|
|
6483
|
-
* the parent slot type.</p>
|
|
6484
|
-
*/
|
|
6485
|
-
parentSlotTypeSignature?: string;
|
|
6486
|
-
/**
|
|
6487
|
-
* <p>A timestamp of the date and time that the slot type was last
|
|
6488
|
-
* updated.</p>
|
|
6489
|
-
*/
|
|
6490
|
-
lastUpdatedDateTime?: Date;
|
|
6491
|
-
/**
|
|
6492
|
-
* <p>Indicates the type of the slot type.</p>
|
|
6493
|
-
* <ul>
|
|
6494
|
-
* <li>
|
|
6495
|
-
* <p>
|
|
6496
|
-
* <code>Custom</code> - A slot type that you created using
|
|
6497
|
-
* custom values. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html">Creating custom slot
|
|
6498
|
-
* types</a>.</p>
|
|
6499
|
-
* </li>
|
|
6500
|
-
* <li>
|
|
6501
|
-
* <p>
|
|
6502
|
-
* <code>Extended</code> - A slot type created by extending the
|
|
6503
|
-
* AMAZON.AlphaNumeric built-in slot type. For more information, see
|
|
6504
|
-
* <a href="https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html">AMAZON.AlphaNumeric</a>.</p>
|
|
6505
|
-
* </li>
|
|
6506
|
-
* <li>
|
|
6507
|
-
* <p>
|
|
6508
|
-
* <code>ExternalGrammar</code> - A slot type using a custom
|
|
6509
|
-
* GRXML grammar to define values. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/building-grxml.html">Using a custom grammar slot type</a>.</p>
|
|
6510
|
-
* </li>
|
|
6511
|
-
* </ul>
|
|
6512
|
-
*/
|
|
6513
|
-
slotTypeCategory?: SlotTypeCategory | string;
|
|
6514
|
-
}
|
|
6515
|
-
/**
|
|
6516
|
-
* @public
|
|
6517
|
-
*/
|
|
6518
|
-
export interface ListSlotTypesResponse {
|
|
6519
|
-
/**
|
|
6520
|
-
* <p>The identifier of the bot that contains the slot types.</p>
|
|
6521
|
-
*/
|
|
6522
|
-
botId?: string;
|
|
6523
|
-
/**
|
|
6524
|
-
* <p>The version of the bot that contains the slot types.</p>
|
|
6525
|
-
*/
|
|
6526
|
-
botVersion?: string;
|
|
6527
|
-
/**
|
|
6528
|
-
* <p>The language and local of the slot types in the list.</p>
|
|
6529
|
-
*/
|
|
6530
|
-
localeId?: string;
|
|
6531
|
-
/**
|
|
6532
|
-
* <p>Summary information for the slot types that meet the filter criteria
|
|
6533
|
-
* specified in the request. The length of the list is specified in the
|
|
6534
|
-
* <code>maxResults</code> parameter of the request. If there are more
|
|
6535
|
-
* slot types available, the <code>nextToken</code> field contains a token
|
|
6536
|
-
* to get the next page of results.</p>
|
|
6537
|
-
*/
|
|
6538
|
-
slotTypeSummaries?: SlotTypeSummary[];
|
|
6539
|
-
/**
|
|
6540
|
-
* <p>A token that indicates whether there are more results to return in a
|
|
6541
|
-
* response to the <code>ListSlotTypes</code> operation. If the
|
|
6542
|
-
* <code>nextToken</code> field is present, you send the contents as
|
|
6543
|
-
* the <code>nextToken</code> parameter of a <code>ListSlotTypes</code>
|
|
6544
|
-
* operation request to get the next page of results.</p>
|
|
6545
|
-
*/
|
|
6546
|
-
nextToken?: string;
|
|
6547
|
-
}
|
|
6548
|
-
/**
|
|
6549
|
-
* @public
|
|
6550
|
-
*/
|
|
6551
|
-
export interface ListTagsForResourceRequest {
|
|
6552
|
-
/**
|
|
6553
|
-
* <p>The Amazon Resource Name (ARN) of the resource to get a list of tags
|
|
6554
|
-
* for.</p>
|
|
6555
|
-
*/
|
|
6556
|
-
resourceARN: string | undefined;
|
|
6557
|
-
}
|
|
6558
|
-
/**
|
|
6559
|
-
* @public
|
|
6560
|
-
*/
|
|
6561
|
-
export interface ListTagsForResourceResponse {
|
|
6562
|
-
/**
|
|
6563
|
-
* <p>The tags associated with a resource.</p>
|
|
6564
|
-
*/
|
|
6565
|
-
tags?: Record<string, string>;
|
|
6566
|
-
}
|
|
6567
|
-
/**
|
|
6568
|
-
* @public
|
|
6569
|
-
* @enum
|
|
6570
|
-
*/
|
|
6571
|
-
export declare const SearchOrder: {
|
|
6572
|
-
readonly Ascending: "Ascending";
|
|
6573
|
-
readonly Descending: "Descending";
|
|
6574
|
-
};
|
|
6575
|
-
/**
|
|
6576
|
-
* @public
|
|
6577
|
-
*/
|
|
6578
|
-
export type SearchOrder = (typeof SearchOrder)[keyof typeof SearchOrder];
|
|
6579
|
-
/**
|
|
6580
|
-
* @public
|
|
6581
|
-
*/
|
|
6582
|
-
export interface SearchAssociatedTranscriptsRequest {
|
|
6583
|
-
/**
|
|
6584
|
-
* <p>The unique identifier of the bot associated with the transcripts
|
|
6585
|
-
* that you are searching.</p>
|
|
6586
|
-
*/
|
|
6587
|
-
botId: string | undefined;
|
|
6588
|
-
/**
|
|
6589
|
-
* <p>The version of the bot containing the transcripts that you are
|
|
6590
|
-
* searching.</p>
|
|
6591
|
-
*/
|
|
6592
|
-
botVersion: string | undefined;
|
|
6593
|
-
/**
|
|
6594
|
-
* <p>The identifier of the language and locale of the transcripts to
|
|
6595
|
-
* search. The string must match one of the supported locales. For more
|
|
6596
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>
|
|
6597
|
-
* </p>
|
|
6598
|
-
*/
|
|
6599
|
-
localeId: string | undefined;
|
|
6600
|
-
/**
|
|
6601
|
-
* <p>The unique identifier of the bot recommendation associated with the
|
|
6602
|
-
* transcripts to search.</p>
|
|
6603
|
-
*/
|
|
6604
|
-
botRecommendationId: string | undefined;
|
|
6605
|
-
/**
|
|
6606
|
-
* <p>How SearchResults are ordered. Valid values are Ascending or
|
|
6607
|
-
* Descending. The default is Descending.</p>
|
|
6608
|
-
*/
|
|
6609
|
-
searchOrder?: SearchOrder | string;
|
|
6610
|
-
/**
|
|
6611
|
-
* <p>A list of filter objects.</p>
|
|
6612
|
-
*/
|
|
6613
|
-
filters: AssociatedTranscriptFilter[] | undefined;
|
|
6614
|
-
/**
|
|
6615
|
-
* <p>The maximum number of bot recommendations to return in each page of
|
|
6616
|
-
* results. If there are fewer results than the max page size, only the
|
|
6617
|
-
* actual number of results are returned.</p>
|
|
6618
|
-
*/
|
|
6619
|
-
maxResults?: number;
|
|
6620
|
-
/**
|
|
6621
|
-
* <p>If the response from the SearchAssociatedTranscriptsRequest
|
|
6622
|
-
* operation contains more results than specified in the maxResults
|
|
6623
|
-
* parameter, an index is returned in the response. Use that index in the
|
|
6624
|
-
* nextIndex parameter to return the next page of results.</p>
|
|
6625
|
-
*/
|
|
6626
|
-
nextIndex?: number;
|
|
6627
|
-
}
|
|
6628
|
-
/**
|
|
6629
|
-
* @public
|
|
6630
|
-
*/
|
|
6631
|
-
export interface SearchAssociatedTranscriptsResponse {
|
|
6632
|
-
/**
|
|
6633
|
-
* <p>The unique identifier of the bot associated with the transcripts
|
|
6634
|
-
* that you are searching.</p>
|
|
6635
|
-
*/
|
|
6636
|
-
botId?: string;
|
|
6637
|
-
/**
|
|
6638
|
-
* <p>The version of the bot containing the transcripts that you are
|
|
6639
|
-
* searching.</p>
|
|
6640
|
-
*/
|
|
6641
|
-
botVersion?: string;
|
|
6642
|
-
/**
|
|
6643
|
-
* <p>The identifier of the language and locale of the transcripts to
|
|
6644
|
-
* search. The string must match one of the supported locales. For more
|
|
6645
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>
|
|
6646
|
-
* </p>
|
|
6647
|
-
*/
|
|
6648
|
-
localeId?: string;
|
|
6649
|
-
/**
|
|
6650
|
-
* <p> The unique identifier of the bot recommendation associated with the
|
|
6651
|
-
* transcripts to search.</p>
|
|
6652
|
-
*/
|
|
6653
|
-
botRecommendationId?: string;
|
|
6654
|
-
/**
|
|
6655
|
-
* <p>A index that indicates whether there are more results to return in a
|
|
6656
|
-
* response to the SearchAssociatedTranscripts operation. If the nextIndex
|
|
6657
|
-
* field is present, you send the contents as the nextIndex parameter of a
|
|
6658
|
-
* SearchAssociatedTranscriptsRequest operation to get the next page of
|
|
6659
|
-
* results.</p>
|
|
6660
|
-
*/
|
|
6661
|
-
nextIndex?: number;
|
|
6662
|
-
/**
|
|
6663
|
-
* <p>The object that contains the associated transcript that meet the
|
|
6664
|
-
* criteria you specified.</p>
|
|
6665
|
-
*/
|
|
6666
|
-
associatedTranscripts?: AssociatedTranscript[];
|
|
6667
|
-
/**
|
|
6668
|
-
* <p>The total number of transcripts returned by the search.</p>
|
|
6669
|
-
*/
|
|
6670
|
-
totalResults?: number;
|
|
6671
|
-
}
|
|
6672
|
-
/**
|
|
6673
|
-
* @public
|
|
6674
|
-
*/
|
|
6675
|
-
export interface StartBotRecommendationRequest {
|
|
6676
|
-
/**
|
|
6677
|
-
* <p>The unique identifier of the bot containing the bot
|
|
6678
|
-
* recommendation.</p>
|
|
6679
|
-
*/
|
|
6680
|
-
botId: string | undefined;
|
|
6681
|
-
/**
|
|
6682
|
-
* <p>The version of the bot containing the bot recommendation.</p>
|
|
6683
|
-
*/
|
|
6684
|
-
botVersion: string | undefined;
|
|
6685
|
-
/**
|
|
6686
|
-
* <p>The identifier of the language and locale of the bot recommendation
|
|
6687
|
-
* to start. The string must match one of the supported locales. For more
|
|
6688
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>
|
|
6689
|
-
* </p>
|
|
6690
|
-
*/
|
|
6691
|
-
localeId: string | undefined;
|
|
6692
|
-
/**
|
|
6693
|
-
* <p>The object representing the Amazon S3 bucket containing the transcript,
|
|
6694
|
-
* as well as the associated metadata.</p>
|
|
6695
|
-
*/
|
|
6696
|
-
transcriptSourceSetting: TranscriptSourceSetting | undefined;
|
|
6697
|
-
/**
|
|
6698
|
-
* <p>The object representing the passwords that will be used to encrypt
|
|
6699
|
-
* the data related to the bot recommendation results, as well as the KMS
|
|
6700
|
-
* key ARN used to encrypt the associated metadata.</p>
|
|
6701
|
-
*/
|
|
6702
|
-
encryptionSetting?: EncryptionSetting;
|
|
6703
|
-
}
|
|
6704
|
-
/**
|
|
6705
|
-
* @public
|
|
6706
|
-
*/
|
|
6707
|
-
export interface StartBotRecommendationResponse {
|
|
6708
|
-
/**
|
|
6709
|
-
* <p>The unique identifier of the bot containing the bot
|
|
6710
|
-
* recommendation.</p>
|
|
6711
|
-
*/
|
|
6712
|
-
botId?: string;
|
|
6713
|
-
/**
|
|
6714
|
-
* <p>The version of the bot containing the bot recommendation.</p>
|
|
6715
|
-
*/
|
|
6716
|
-
botVersion?: string;
|
|
6717
|
-
/**
|
|
6718
|
-
* <p>The identifier of the language and locale of the bot recommendation
|
|
6719
|
-
* to start. The string must match one of the supported locales. For more
|
|
6720
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>
|
|
6721
|
-
* </p>
|
|
6722
|
-
*/
|
|
6723
|
-
localeId?: string;
|
|
6724
|
-
/**
|
|
6725
|
-
* <p>The status of the bot recommendation.</p>
|
|
6726
|
-
* <p>If the status is Failed, then the reasons for the failure are listed
|
|
6727
|
-
* in the failureReasons field. </p>
|
|
6728
|
-
*/
|
|
6729
|
-
botRecommendationStatus?: BotRecommendationStatus | string;
|
|
6730
|
-
/**
|
|
6731
|
-
* <p>The identifier of the bot recommendation that you have
|
|
6732
|
-
* created.</p>
|
|
6733
|
-
*/
|
|
6734
|
-
botRecommendationId?: string;
|
|
6735
|
-
/**
|
|
6736
|
-
* <p>A timestamp of the date and time that the bot recommendation was
|
|
6737
|
-
* created.</p>
|
|
6738
|
-
*/
|
|
6739
|
-
creationDateTime?: Date;
|
|
6740
|
-
/**
|
|
6741
|
-
* <p>The object representing the Amazon S3 bucket containing the transcript,
|
|
6742
|
-
* as well as the associated metadata.</p>
|
|
6743
|
-
*/
|
|
6744
|
-
transcriptSourceSetting?: TranscriptSourceSetting;
|
|
6745
|
-
/**
|
|
6746
|
-
* <p>The object representing the passwords that were used to encrypt the
|
|
6747
|
-
* data related to the bot recommendation results, as well as the KMS key
|
|
6748
|
-
* ARN used to encrypt the associated metadata.</p>
|
|
6749
|
-
*/
|
|
6750
|
-
encryptionSetting?: EncryptionSetting;
|
|
6751
|
-
}
|
|
6752
|
-
/**
|
|
6753
|
-
* @public
|
|
6754
|
-
*/
|
|
6755
|
-
export interface StartImportRequest {
|
|
6756
|
-
/**
|
|
6757
|
-
* <p>The unique identifier for the import. It is included in the response
|
|
6758
|
-
* from the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateUploadUrl.html">CreateUploadUrl</a> operation.</p>
|
|
6759
|
-
*/
|
|
6760
|
-
importId: string | undefined;
|
|
6761
|
-
/**
|
|
6762
|
-
* <p>Parameters for creating the bot, bot locale or custom
|
|
6763
|
-
* vocabulary.</p>
|
|
6764
|
-
*/
|
|
6765
|
-
resourceSpecification: ImportResourceSpecification | undefined;
|
|
6766
|
-
/**
|
|
6767
|
-
* <p>The strategy to use when there is a name conflict between the
|
|
6768
|
-
* imported resource and an existing resource. When the merge strategy is
|
|
6769
|
-
* <code>FailOnConflict</code> existing resources are not overwritten
|
|
6770
|
-
* and the import fails.</p>
|
|
6771
|
-
*/
|
|
6772
|
-
mergeStrategy: MergeStrategy | string | undefined;
|
|
6773
|
-
/**
|
|
6774
|
-
* <p>The password used to encrypt the zip archive that contains the
|
|
6775
|
-
* resource definition. You should always encrypt the zip archive to
|
|
6776
|
-
* protect it during transit between your site and Amazon Lex.</p>
|
|
6777
|
-
*/
|
|
6778
|
-
filePassword?: string;
|
|
6779
|
-
}
|
|
6780
|
-
/**
|
|
6781
|
-
* @public
|
|
6782
|
-
*/
|
|
6783
|
-
export interface StartImportResponse {
|
|
6784
|
-
/**
|
|
6785
|
-
* <p>A unique identifier for the import.</p>
|
|
6786
|
-
*/
|
|
6787
|
-
importId?: string;
|
|
6788
|
-
/**
|
|
6789
|
-
* <p>The parameters used when importing the resource.</p>
|
|
6790
|
-
*/
|
|
6791
|
-
resourceSpecification?: ImportResourceSpecification;
|
|
6792
|
-
/**
|
|
6793
|
-
* <p>The strategy used when there was a name conflict between the
|
|
6794
|
-
* imported resource and an existing resource. When the merge strategy is
|
|
6795
|
-
* <code>FailOnConflict</code> existing resources are not overwritten
|
|
6796
|
-
* and the import fails.</p>
|
|
6797
|
-
*/
|
|
6798
|
-
mergeStrategy?: MergeStrategy | string;
|
|
6799
|
-
/**
|
|
6800
|
-
* <p>The current status of the import. When the status is
|
|
6801
|
-
* <code>Complete</code> the bot, bot alias, or custom vocabulary is
|
|
6802
|
-
* ready to use.</p>
|
|
6803
|
-
*/
|
|
6804
|
-
importStatus?: ImportStatus | string;
|
|
6805
|
-
/**
|
|
6806
|
-
* <p>The date and time that the import request was created.</p>
|
|
6807
|
-
*/
|
|
6808
|
-
creationDateTime?: Date;
|
|
6809
|
-
}
|
|
6810
|
-
/**
|
|
6811
|
-
* @public
|
|
6812
|
-
*/
|
|
6813
|
-
export interface StopBotRecommendationRequest {
|
|
6814
|
-
/**
|
|
6815
|
-
* <p>The unique identifier of the bot containing the bot
|
|
6816
|
-
* recommendation to be stopped.</p>
|
|
6817
|
-
*/
|
|
6818
|
-
botId: string | undefined;
|
|
6819
|
-
/**
|
|
6820
|
-
* <p>The version of the bot containing the bot recommendation.</p>
|
|
6821
|
-
*/
|
|
6822
|
-
botVersion: string | undefined;
|
|
6823
|
-
/**
|
|
6824
|
-
* <p>The identifier of the language and locale of the bot recommendation
|
|
6825
|
-
* to stop. The string must match one of the supported locales. For more
|
|
6826
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>
|
|
6827
|
-
* </p>
|
|
6828
|
-
*/
|
|
6829
|
-
localeId: string | undefined;
|
|
6830
|
-
/**
|
|
6831
|
-
* <p>The unique identifier of the bot recommendation to be
|
|
6832
|
-
* stopped.</p>
|
|
6833
|
-
*/
|
|
6834
|
-
botRecommendationId: string | undefined;
|
|
6835
|
-
}
|
|
6836
|
-
/**
|
|
6837
|
-
* @public
|
|
6838
|
-
*/
|
|
6839
|
-
export interface StopBotRecommendationResponse {
|
|
6840
|
-
/**
|
|
6841
|
-
* <p>The unique identifier of the bot containing the bot recommendation that
|
|
6842
|
-
* is being stopped.</p>
|
|
6843
|
-
*/
|
|
6844
|
-
botId?: string;
|
|
6845
|
-
/**
|
|
6846
|
-
* <p>The version of the bot containing the recommendation that is being
|
|
6847
|
-
* stopped.</p>
|
|
6848
|
-
*/
|
|
6849
|
-
botVersion?: string;
|
|
6850
|
-
/**
|
|
6851
|
-
* <p>The identifier of the language and locale of the bot response
|
|
6852
|
-
* to stop. The string must match one of the supported locales. For more
|
|
6853
|
-
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>
|
|
6854
|
-
* </p>
|
|
6855
|
-
*/
|
|
6856
|
-
localeId?: string;
|
|
6857
|
-
/**
|
|
6858
|
-
* <p>The status of the bot recommendation. If the status is Failed,
|
|
6859
|
-
* then the reasons for the failure are listed in the failureReasons field.</p>
|
|
6860
|
-
*/
|
|
6861
|
-
botRecommendationStatus?: BotRecommendationStatus | string;
|
|
6862
|
-
/**
|
|
6863
|
-
* <p>The unique identifier of the bot recommendation that is being
|
|
6864
|
-
* stopped.</p>
|
|
6865
|
-
*/
|
|
6866
|
-
botRecommendationId?: string;
|
|
6867
|
-
}
|
|
6868
|
-
/**
|
|
6869
|
-
* @public
|
|
6870
|
-
*/
|
|
6871
|
-
export interface TagResourceRequest {
|
|
6872
|
-
/**
|
|
6873
|
-
* <p>The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel
|
|
6874
|
-
* to tag.</p>
|
|
6875
|
-
*/
|
|
6876
|
-
resourceARN: string | undefined;
|
|
6877
|
-
/**
|
|
6878
|
-
* <p>A list of tag keys to add to the resource. If a tag key already
|
|
6879
|
-
* exists, the existing value is replaced with the new value.</p>
|
|
6880
|
-
*/
|
|
6881
|
-
tags: Record<string, string> | undefined;
|
|
6882
|
-
}
|
|
6883
|
-
/**
|
|
6884
|
-
* @internal
|
|
6885
|
-
*/
|
|
6886
|
-
export declare const CreateExportRequestFilterSensitiveLog: (obj: CreateExportRequest) => any;
|
|
6887
|
-
/**
|
|
6888
|
-
* @internal
|
|
6889
|
-
*/
|
|
6890
|
-
export declare const EncryptionSettingFilterSensitiveLog: (obj: EncryptionSetting) => any;
|
|
6891
|
-
/**
|
|
6892
|
-
* @internal
|
|
6244
|
+
* @internal
|
|
6893
6245
|
*/
|
|
6894
6246
|
export declare const DescribeBotRecommendationResponseFilterSensitiveLog: (obj: DescribeBotRecommendationResponse) => any;
|
|
6895
|
-
/**
|
|
6896
|
-
* @internal
|
|
6897
|
-
*/
|
|
6898
|
-
export declare const StartBotRecommendationRequestFilterSensitiveLog: (obj: StartBotRecommendationRequest) => any;
|
|
6899
|
-
/**
|
|
6900
|
-
* @internal
|
|
6901
|
-
*/
|
|
6902
|
-
export declare const StartBotRecommendationResponseFilterSensitiveLog: (obj: StartBotRecommendationResponse) => any;
|
|
6903
|
-
/**
|
|
6904
|
-
* @internal
|
|
6905
|
-
*/
|
|
6906
|
-
export declare const StartImportRequestFilterSensitiveLog: (obj: StartImportRequest) => any;
|