@aws-sdk/client-lex-models-v2 3.150.0 → 3.155.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/CHANGELOG.md +30 -0
- package/dist-cjs/LexModelsV2.js +15 -0
- package/dist-cjs/commands/CreateIntentCommand.js +3 -3
- package/dist-cjs/commands/CreateSlotCommand.js +3 -3
- package/dist-cjs/commands/DescribeIntentCommand.js +2 -1
- package/dist-cjs/commands/DescribeSlotCommand.js +2 -1
- package/dist-cjs/commands/StopBotRecommendationCommand.js +36 -0
- package/dist-cjs/commands/UpdateIntentCommand.js +3 -3
- package/dist-cjs/commands/UpdateSlotCommand.js +3 -3
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +119 -92
- package/dist-cjs/models/models_1.js +59 -0
- package/dist-cjs/protocols/Aws_restJson1.js +584 -2
- package/dist-es/LexModelsV2.js +15 -0
- package/dist-es/commands/CreateIntentCommand.js +1 -1
- package/dist-es/commands/CreateSlotCommand.js +1 -1
- package/dist-es/commands/DescribeIntentCommand.js +2 -1
- package/dist-es/commands/DescribeSlotCommand.js +2 -1
- package/dist-es/commands/StopBotRecommendationCommand.js +39 -0
- package/dist-es/commands/UpdateIntentCommand.js +1 -1
- package/dist-es/commands/UpdateSlotCommand.js +1 -1
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +43 -22
- package/dist-es/models/models_1.js +15 -0
- package/dist-es/protocols/Aws_restJson1.js +534 -8
- package/dist-types/LexModelsV2.d.ts +7 -0
- package/dist-types/LexModelsV2Client.d.ts +3 -2
- package/dist-types/commands/CreateIntentCommand.d.ts +1 -1
- package/dist-types/commands/CreateSlotCommand.d.ts +1 -1
- package/dist-types/commands/DescribeIntentCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSlotCommand.d.ts +2 -1
- package/dist-types/commands/StopBotRecommendationCommand.d.ts +35 -0
- package/dist-types/commands/UpdateIntentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSlotCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +686 -1079
- package/dist-types/models/models_1.d.ts +994 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/LexModelsV2.d.ts +5 -0
- package/dist-types/ts3.4/LexModelsV2Client.d.ts +3 -2
- package/dist-types/ts3.4/commands/CreateIntentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateSlotCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeIntentCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DescribeSlotCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/StopBotRecommendationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/UpdateIntentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSlotCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +260 -413
- package/dist-types/ts3.4/models/models_1.d.ts +415 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +3 -0
- package/package.json +4 -4
|
@@ -0,0 +1,994 @@
|
|
|
1
|
+
import { ConditionalSpecification, DialogCodeHookInvocationSetting, DialogCodeHookSettings, DialogState, ElicitationCodeHookInvocationSetting, FulfillmentCodeHookSettings, InputContext, IntentClosingSetting, KendraConfiguration, MultipleValuesSetting, ObfuscationSetting, OutputContext, PromptSpecification, ResponseSpecification, SampleUtterance, SlotConstraint, SlotDefaultValueSpecification, SlotPriority, WaitAndContinueSpecification } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* <p>Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.</p>
|
|
4
|
+
*/
|
|
5
|
+
export interface InitialResponseSetting {
|
|
6
|
+
/**
|
|
7
|
+
* <p>Specifies a list of message groups that Amazon Lex uses to respond the
|
|
8
|
+
* user input.</p>
|
|
9
|
+
*/
|
|
10
|
+
initialResponse?: ResponseSpecification;
|
|
11
|
+
/**
|
|
12
|
+
* <p>The next step in the conversation.</p>
|
|
13
|
+
*/
|
|
14
|
+
nextStep?: DialogState;
|
|
15
|
+
/**
|
|
16
|
+
* <p>Provides a list of conditional branches. Branches are evaluated in
|
|
17
|
+
* the order that they are entered in the list. The first branch with a
|
|
18
|
+
* condition that evaluates to true is executed. The last branch in the
|
|
19
|
+
* list is the default branch. The default branch should not have any condition
|
|
20
|
+
* expression. The default branch is executed if no other branch has a
|
|
21
|
+
* matching condition.</p>
|
|
22
|
+
*/
|
|
23
|
+
conditional?: ConditionalSpecification;
|
|
24
|
+
/**
|
|
25
|
+
* <p> Settings that specify the dialog code hook that is
|
|
26
|
+
* called by Amazon Lex at a step of the conversation. </p>
|
|
27
|
+
*/
|
|
28
|
+
codeHook?: DialogCodeHookInvocationSetting;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* <p>Settings used when Amazon Lex successfully captures a slot
|
|
32
|
+
* value from a user.</p>
|
|
33
|
+
*/
|
|
34
|
+
export interface SlotCaptureSetting {
|
|
35
|
+
/**
|
|
36
|
+
* <p>Specifies a list of message groups that Amazon Lex uses to respond the
|
|
37
|
+
* user input.</p>
|
|
38
|
+
*/
|
|
39
|
+
captureResponse?: ResponseSpecification;
|
|
40
|
+
/**
|
|
41
|
+
* <p>Specifies the next step that the bot runs when the slot value is
|
|
42
|
+
* captured before the code hook times out.</p>
|
|
43
|
+
*/
|
|
44
|
+
captureNextStep?: DialogState;
|
|
45
|
+
/**
|
|
46
|
+
* <p>A list of conditional branches to evaluate after the slot value is
|
|
47
|
+
* captured.</p>
|
|
48
|
+
*/
|
|
49
|
+
captureConditional?: ConditionalSpecification;
|
|
50
|
+
/**
|
|
51
|
+
* <p>Specifies a list of message groups that Amazon Lex uses to respond the
|
|
52
|
+
* user input.</p>
|
|
53
|
+
*/
|
|
54
|
+
failureResponse?: ResponseSpecification;
|
|
55
|
+
/**
|
|
56
|
+
* <p>Specifies the next step that the bot runs when the slot value code
|
|
57
|
+
* is not recognized.</p>
|
|
58
|
+
*/
|
|
59
|
+
failureNextStep?: DialogState;
|
|
60
|
+
/**
|
|
61
|
+
* <p>A list of conditional branches to evaluate when the slot value isn't
|
|
62
|
+
* captured.</p>
|
|
63
|
+
*/
|
|
64
|
+
failureConditional?: ConditionalSpecification;
|
|
65
|
+
/**
|
|
66
|
+
* <p>Code hook called after Amazon Lex successfully captures a
|
|
67
|
+
* slot value.</p>
|
|
68
|
+
*/
|
|
69
|
+
codeHook?: DialogCodeHookInvocationSetting;
|
|
70
|
+
/**
|
|
71
|
+
* <p>Code hook called when Amazon Lex doesn't capture a slot
|
|
72
|
+
* value.</p>
|
|
73
|
+
*/
|
|
74
|
+
elicitationCodeHook?: ElicitationCodeHookInvocationSetting;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* <p>Settings that you can use for eliciting a slot value.</p>
|
|
78
|
+
*/
|
|
79
|
+
export interface SlotValueElicitationSetting {
|
|
80
|
+
/**
|
|
81
|
+
* <p>A list of default values for a slot. Default values are used when
|
|
82
|
+
* Amazon Lex hasn't determined a value for a slot. You can specify default
|
|
83
|
+
* values from context variables, session attributes, and defined
|
|
84
|
+
* values.</p>
|
|
85
|
+
*/
|
|
86
|
+
defaultValueSpecification?: SlotDefaultValueSpecification;
|
|
87
|
+
/**
|
|
88
|
+
* <p>Specifies whether the slot is required or optional.</p>
|
|
89
|
+
*/
|
|
90
|
+
slotConstraint: SlotConstraint | string | undefined;
|
|
91
|
+
/**
|
|
92
|
+
* <p>The prompt that Amazon Lex uses to elicit the slot value from the
|
|
93
|
+
* user.</p>
|
|
94
|
+
*/
|
|
95
|
+
promptSpecification?: PromptSpecification;
|
|
96
|
+
/**
|
|
97
|
+
* <p>If you know a specific pattern that users might respond to an Amazon Lex
|
|
98
|
+
* request for a slot value, you can provide those utterances to improve
|
|
99
|
+
* accuracy. This is optional. In most cases, Amazon Lex is capable of
|
|
100
|
+
* understanding user utterances.</p>
|
|
101
|
+
*/
|
|
102
|
+
sampleUtterances?: SampleUtterance[];
|
|
103
|
+
/**
|
|
104
|
+
* <p>Specifies the prompts that Amazon Lex uses while a bot is waiting for
|
|
105
|
+
* customer input. </p>
|
|
106
|
+
*/
|
|
107
|
+
waitAndContinueSpecification?: WaitAndContinueSpecification;
|
|
108
|
+
/**
|
|
109
|
+
* <p>Specifies the settings that Amazon Lex uses when a slot
|
|
110
|
+
* value is successfully entered by a user.</p>
|
|
111
|
+
*/
|
|
112
|
+
slotCaptureSetting?: SlotCaptureSetting;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* <p>Provides a prompt for making sure that the user is ready for the
|
|
116
|
+
* intent to be fulfilled.</p>
|
|
117
|
+
*/
|
|
118
|
+
export interface IntentConfirmationSetting {
|
|
119
|
+
/**
|
|
120
|
+
* <p>Prompts the user to confirm the intent. This question should have a
|
|
121
|
+
* yes or no answer.</p>
|
|
122
|
+
* <p>Amazon Lex uses this prompt to ensure that the user acknowledges that the
|
|
123
|
+
* intent is ready for fulfillment. For example, with the
|
|
124
|
+
* <code>OrderPizza</code> intent, you might want to confirm that the
|
|
125
|
+
* order is correct before placing it. For other intents, such as intents
|
|
126
|
+
* that simply respond to user questions, you might not need to ask the
|
|
127
|
+
* user for confirmation before providing the information. </p>
|
|
128
|
+
*/
|
|
129
|
+
promptSpecification: PromptSpecification | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>When the user answers "no" to the question defined in
|
|
132
|
+
* <code>promptSpecification</code>, Amazon Lex responds with this response
|
|
133
|
+
* to acknowledge that the intent was canceled. </p>
|
|
134
|
+
*/
|
|
135
|
+
declinationResponse?: ResponseSpecification;
|
|
136
|
+
/**
|
|
137
|
+
* <p>Specifies whether the intent's confirmation is sent to the user.
|
|
138
|
+
* When this field is false, confirmation and declination responses aren't
|
|
139
|
+
* sent. If the <code>active</code> field isn't specified, the default is
|
|
140
|
+
* true.</p>
|
|
141
|
+
*/
|
|
142
|
+
active?: boolean;
|
|
143
|
+
/**
|
|
144
|
+
* <p>Specifies a list of message groups that Amazon Lex uses to respond the
|
|
145
|
+
* user input.</p>
|
|
146
|
+
*/
|
|
147
|
+
confirmationResponse?: ResponseSpecification;
|
|
148
|
+
/**
|
|
149
|
+
* <p>Specifies the next step that the bot executes when the customer
|
|
150
|
+
* confirms the intent.</p>
|
|
151
|
+
*/
|
|
152
|
+
confirmationNextStep?: DialogState;
|
|
153
|
+
/**
|
|
154
|
+
* <p>A list of conditional branches to evaluate after the intent is
|
|
155
|
+
* closed.</p>
|
|
156
|
+
*/
|
|
157
|
+
confirmationConditional?: ConditionalSpecification;
|
|
158
|
+
/**
|
|
159
|
+
* <p>Specifies the next step that the bot executes when the customer
|
|
160
|
+
* declines the intent.</p>
|
|
161
|
+
*/
|
|
162
|
+
declinationNextStep?: DialogState;
|
|
163
|
+
/**
|
|
164
|
+
* <p>A list of conditional branches to evaluate after the intent is
|
|
165
|
+
* declined.</p>
|
|
166
|
+
*/
|
|
167
|
+
declinationConditional?: ConditionalSpecification;
|
|
168
|
+
/**
|
|
169
|
+
* <p>Specifies a list of message groups that Amazon Lex uses to respond the
|
|
170
|
+
* user input.</p>
|
|
171
|
+
*/
|
|
172
|
+
failureResponse?: ResponseSpecification;
|
|
173
|
+
/**
|
|
174
|
+
* <p>The next step to take in the conversation if the confirmation step
|
|
175
|
+
* fails.</p>
|
|
176
|
+
*/
|
|
177
|
+
failureNextStep?: DialogState;
|
|
178
|
+
/**
|
|
179
|
+
* <p>Provides a list of conditional branches. Branches are evaluated in
|
|
180
|
+
* the order that they are entered in the list. The first branch with a
|
|
181
|
+
* condition that evaluates to true is executed. The last branch in the
|
|
182
|
+
* list is the default branch. The default branch should not have any condition
|
|
183
|
+
* expression. The default branch is executed if no other branch has a
|
|
184
|
+
* matching condition.</p>
|
|
185
|
+
*/
|
|
186
|
+
failureConditional?: ConditionalSpecification;
|
|
187
|
+
/**
|
|
188
|
+
* <p>The <code>DialogCodeHookInvocationSetting</code> object associated
|
|
189
|
+
* with intent's confirmation step. The dialog code hook is triggered
|
|
190
|
+
* based on these invocation settings when the confirmation next step or
|
|
191
|
+
* declination next step or failure next step is
|
|
192
|
+
* <code>InvokeDialogCodeHook</code>. </p>
|
|
193
|
+
*/
|
|
194
|
+
codeHook?: DialogCodeHookInvocationSetting;
|
|
195
|
+
/**
|
|
196
|
+
* <p>The <code>DialogCodeHookInvocationSetting</code> used when the code
|
|
197
|
+
* hook is invoked during confirmation prompt retries.</p>
|
|
198
|
+
*/
|
|
199
|
+
elicitationCodeHook?: ElicitationCodeHookInvocationSetting;
|
|
200
|
+
}
|
|
201
|
+
export interface CreateSlotRequest {
|
|
202
|
+
/**
|
|
203
|
+
* <p>The name of the slot. Slot names must be unique within the bot that
|
|
204
|
+
* contains the slot.</p>
|
|
205
|
+
*/
|
|
206
|
+
slotName: string | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* <p>A description of the slot. Use this to help identify the slot in
|
|
209
|
+
* lists.</p>
|
|
210
|
+
*/
|
|
211
|
+
description?: string;
|
|
212
|
+
/**
|
|
213
|
+
* <p>The unique identifier for the slot type associated with this slot.
|
|
214
|
+
* The slot type determines the values that can be entered into the
|
|
215
|
+
* slot.</p>
|
|
216
|
+
*/
|
|
217
|
+
slotTypeId?: string;
|
|
218
|
+
/**
|
|
219
|
+
* <p>Specifies prompts that Amazon Lex sends to the user to elicit a response
|
|
220
|
+
* that provides the value for the slot. </p>
|
|
221
|
+
*/
|
|
222
|
+
valueElicitationSetting: SlotValueElicitationSetting | undefined;
|
|
223
|
+
/**
|
|
224
|
+
* <p>Determines how slot values are used in Amazon CloudWatch logs. If the value of
|
|
225
|
+
* the <code>obfuscationSetting</code> parameter is
|
|
226
|
+
* <code>DefaultObfuscation</code>, slot values are obfuscated in the
|
|
227
|
+
* log output. If the value is <code>None</code>, the actual value is
|
|
228
|
+
* present in the log output.</p>
|
|
229
|
+
* <p>The default is to obfuscate values in the CloudWatch logs.</p>
|
|
230
|
+
*/
|
|
231
|
+
obfuscationSetting?: ObfuscationSetting;
|
|
232
|
+
/**
|
|
233
|
+
* <p>The identifier of the bot associated with the slot.</p>
|
|
234
|
+
*/
|
|
235
|
+
botId: string | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* <p>The version of the bot associated with the slot.</p>
|
|
238
|
+
*/
|
|
239
|
+
botVersion: string | undefined;
|
|
240
|
+
/**
|
|
241
|
+
* <p>The identifier of the language and locale that the slot will be used
|
|
242
|
+
* in. The string must match one of the supported locales. All of the
|
|
243
|
+
* bots, intents, slot types used by the slot must have the same locale.
|
|
244
|
+
* For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
245
|
+
*/
|
|
246
|
+
localeId: string | undefined;
|
|
247
|
+
/**
|
|
248
|
+
* <p>The identifier of the intent that contains the slot.</p>
|
|
249
|
+
*/
|
|
250
|
+
intentId: string | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* <p>Indicates whether the slot returns multiple values in one response.
|
|
253
|
+
* Multi-value slots are only available in the en-US locale. If you set
|
|
254
|
+
* this value to <code>true</code> in any other locale, Amazon Lex throws a
|
|
255
|
+
* <code>ValidationException</code>. </p>
|
|
256
|
+
* <p>If the <code>multipleValuesSetting</code> is not set, the default
|
|
257
|
+
* value is <code>false</code>.</p>
|
|
258
|
+
*/
|
|
259
|
+
multipleValuesSetting?: MultipleValuesSetting;
|
|
260
|
+
}
|
|
261
|
+
export interface CreateSlotResponse {
|
|
262
|
+
/**
|
|
263
|
+
* <p>The unique identifier associated with the slot. Use this to identify
|
|
264
|
+
* the slot when you update or delete it.</p>
|
|
265
|
+
*/
|
|
266
|
+
slotId?: string;
|
|
267
|
+
/**
|
|
268
|
+
* <p>The name specified for the slot.</p>
|
|
269
|
+
*/
|
|
270
|
+
slotName?: string;
|
|
271
|
+
/**
|
|
272
|
+
* <p>The description associated with the slot.</p>
|
|
273
|
+
*/
|
|
274
|
+
description?: string;
|
|
275
|
+
/**
|
|
276
|
+
* <p>The unique identifier of the slot type associated with this
|
|
277
|
+
* slot.</p>
|
|
278
|
+
*/
|
|
279
|
+
slotTypeId?: string;
|
|
280
|
+
/**
|
|
281
|
+
* <p>The value elicitation settings specified for the slot.</p>
|
|
282
|
+
*/
|
|
283
|
+
valueElicitationSetting?: SlotValueElicitationSetting;
|
|
284
|
+
/**
|
|
285
|
+
* <p>Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch
|
|
286
|
+
* logs.</p>
|
|
287
|
+
*/
|
|
288
|
+
obfuscationSetting?: ObfuscationSetting;
|
|
289
|
+
/**
|
|
290
|
+
* <p>The unique identifier of the bot associated with the slot.</p>
|
|
291
|
+
*/
|
|
292
|
+
botId?: string;
|
|
293
|
+
/**
|
|
294
|
+
* <p>The version of the bot associated with the slot.</p>
|
|
295
|
+
*/
|
|
296
|
+
botVersion?: string;
|
|
297
|
+
/**
|
|
298
|
+
* <p>The language and local specified for the slot.</p>
|
|
299
|
+
*/
|
|
300
|
+
localeId?: string;
|
|
301
|
+
/**
|
|
302
|
+
* <p>The unique identifier of the intent associated with the slot.</p>
|
|
303
|
+
*/
|
|
304
|
+
intentId?: string;
|
|
305
|
+
/**
|
|
306
|
+
* <p>The timestamp of the date and time that the slot was created.</p>
|
|
307
|
+
*/
|
|
308
|
+
creationDateTime?: Date;
|
|
309
|
+
/**
|
|
310
|
+
* <p>Indicates whether the slot returns multiple values in one
|
|
311
|
+
* response.</p>
|
|
312
|
+
*/
|
|
313
|
+
multipleValuesSetting?: MultipleValuesSetting;
|
|
314
|
+
}
|
|
315
|
+
export interface DescribeSlotResponse {
|
|
316
|
+
/**
|
|
317
|
+
* <p>The unique identifier generated for the slot.</p>
|
|
318
|
+
*/
|
|
319
|
+
slotId?: string;
|
|
320
|
+
/**
|
|
321
|
+
* <p>The name specified for the slot.</p>
|
|
322
|
+
*/
|
|
323
|
+
slotName?: string;
|
|
324
|
+
/**
|
|
325
|
+
* <p>The description specified for the slot.</p>
|
|
326
|
+
*/
|
|
327
|
+
description?: string;
|
|
328
|
+
/**
|
|
329
|
+
* <p>The identifier of the slot type that determines the values entered
|
|
330
|
+
* into the slot.</p>
|
|
331
|
+
*/
|
|
332
|
+
slotTypeId?: string;
|
|
333
|
+
/**
|
|
334
|
+
* <p>Prompts that Amazon Lex uses to elicit a value for the slot.</p>
|
|
335
|
+
*/
|
|
336
|
+
valueElicitationSetting?: SlotValueElicitationSetting;
|
|
337
|
+
/**
|
|
338
|
+
* <p>Whether slot values are shown in Amazon CloudWatch logs. If the value is
|
|
339
|
+
* <code>None</code>, the actual value of the slot is shown in
|
|
340
|
+
* logs.</p>
|
|
341
|
+
*/
|
|
342
|
+
obfuscationSetting?: ObfuscationSetting;
|
|
343
|
+
/**
|
|
344
|
+
* <p>The identifier of the bot associated with the slot.</p>
|
|
345
|
+
*/
|
|
346
|
+
botId?: string;
|
|
347
|
+
/**
|
|
348
|
+
* <p>The version of the bot associated with the slot.</p>
|
|
349
|
+
*/
|
|
350
|
+
botVersion?: string;
|
|
351
|
+
/**
|
|
352
|
+
* <p>The language and locale specified for the slot.</p>
|
|
353
|
+
*/
|
|
354
|
+
localeId?: string;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The identifier of the intent associated with the slot.</p>
|
|
357
|
+
*/
|
|
358
|
+
intentId?: string;
|
|
359
|
+
/**
|
|
360
|
+
* <p>A timestamp of the date and time that the slot was created.</p>
|
|
361
|
+
*/
|
|
362
|
+
creationDateTime?: Date;
|
|
363
|
+
/**
|
|
364
|
+
* <p>A timestamp of the date and time that the slot was last
|
|
365
|
+
* updated.</p>
|
|
366
|
+
*/
|
|
367
|
+
lastUpdatedDateTime?: Date;
|
|
368
|
+
/**
|
|
369
|
+
* <p>Indicates whether the slot accepts multiple values in a single
|
|
370
|
+
* utterance.</p>
|
|
371
|
+
* <p>If the <code>multipleValuesSetting</code> is not set, the default
|
|
372
|
+
* value is <code>false</code>.</p>
|
|
373
|
+
*/
|
|
374
|
+
multipleValuesSetting?: MultipleValuesSetting;
|
|
375
|
+
}
|
|
376
|
+
export interface UpdateSlotRequest {
|
|
377
|
+
/**
|
|
378
|
+
* <p>The unique identifier for the slot to update.</p>
|
|
379
|
+
*/
|
|
380
|
+
slotId: string | undefined;
|
|
381
|
+
/**
|
|
382
|
+
* <p>The new name for the slot.</p>
|
|
383
|
+
*/
|
|
384
|
+
slotName: string | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* <p>The new description for the slot.</p>
|
|
387
|
+
*/
|
|
388
|
+
description?: string;
|
|
389
|
+
/**
|
|
390
|
+
* <p>The unique identifier of the new slot type to associate with this
|
|
391
|
+
* slot. </p>
|
|
392
|
+
*/
|
|
393
|
+
slotTypeId?: string;
|
|
394
|
+
/**
|
|
395
|
+
* <p>A new set of prompts that Amazon Lex sends to the user to elicit a
|
|
396
|
+
* response the provides a value for the slot.</p>
|
|
397
|
+
*/
|
|
398
|
+
valueElicitationSetting: SlotValueElicitationSetting | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* <p>New settings that determine how slot values are formatted in Amazon CloudWatch
|
|
401
|
+
* logs. </p>
|
|
402
|
+
*/
|
|
403
|
+
obfuscationSetting?: ObfuscationSetting;
|
|
404
|
+
/**
|
|
405
|
+
* <p>The unique identifier of the bot that contains the slot.</p>
|
|
406
|
+
*/
|
|
407
|
+
botId: string | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* <p>The version of the bot that contains the slot. Must always be
|
|
410
|
+
* <code>DRAFT</code>.</p>
|
|
411
|
+
*/
|
|
412
|
+
botVersion: string | undefined;
|
|
413
|
+
/**
|
|
414
|
+
* <p>The identifier of the language and locale that contains the slot.
|
|
415
|
+
* The string must match one of the supported locales. For more
|
|
416
|
+
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
417
|
+
*/
|
|
418
|
+
localeId: string | undefined;
|
|
419
|
+
/**
|
|
420
|
+
* <p>The identifier of the intent that contains the slot.</p>
|
|
421
|
+
*/
|
|
422
|
+
intentId: string | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* <p>Determines whether the slot accepts multiple values in one response.
|
|
425
|
+
* Multiple value slots are only available in the en-US locale. If you set
|
|
426
|
+
* this value to <code>true</code> in any other locale, Amazon Lex throws a
|
|
427
|
+
* <code>ValidationException</code>.</p>
|
|
428
|
+
* <p>If the <code>multipleValuesSetting</code> is not set, the default
|
|
429
|
+
* value is <code>false</code>.</p>
|
|
430
|
+
*/
|
|
431
|
+
multipleValuesSetting?: MultipleValuesSetting;
|
|
432
|
+
}
|
|
433
|
+
export interface UpdateSlotResponse {
|
|
434
|
+
/**
|
|
435
|
+
* <p>The unique identifier of the slot that was updated.</p>
|
|
436
|
+
*/
|
|
437
|
+
slotId?: string;
|
|
438
|
+
/**
|
|
439
|
+
* <p>The updated name of the slot.</p>
|
|
440
|
+
*/
|
|
441
|
+
slotName?: string;
|
|
442
|
+
/**
|
|
443
|
+
* <p>The updated description of the bot.</p>
|
|
444
|
+
*/
|
|
445
|
+
description?: string;
|
|
446
|
+
/**
|
|
447
|
+
* <p>The updated identifier of the slot type that provides values for the
|
|
448
|
+
* slot.</p>
|
|
449
|
+
*/
|
|
450
|
+
slotTypeId?: string;
|
|
451
|
+
/**
|
|
452
|
+
* <p>The updated prompts that Amazon Lex sends to the user to elicit a
|
|
453
|
+
* response that provides a value for the slot.</p>
|
|
454
|
+
*/
|
|
455
|
+
valueElicitationSetting?: SlotValueElicitationSetting;
|
|
456
|
+
/**
|
|
457
|
+
* <p>The updated setting that determines whether the slot value is
|
|
458
|
+
* obfuscated in the Amazon CloudWatch logs.</p>
|
|
459
|
+
*/
|
|
460
|
+
obfuscationSetting?: ObfuscationSetting;
|
|
461
|
+
/**
|
|
462
|
+
* <p>The identifier of the bot that contains the slot.</p>
|
|
463
|
+
*/
|
|
464
|
+
botId?: string;
|
|
465
|
+
/**
|
|
466
|
+
* <p>The identifier of the slot version that contains the slot. Will
|
|
467
|
+
* always be <code>DRAFT</code>.</p>
|
|
468
|
+
*/
|
|
469
|
+
botVersion?: string;
|
|
470
|
+
/**
|
|
471
|
+
* <p>The locale that contains the slot.</p>
|
|
472
|
+
*/
|
|
473
|
+
localeId?: string;
|
|
474
|
+
/**
|
|
475
|
+
* <p>The intent that contains the slot.</p>
|
|
476
|
+
*/
|
|
477
|
+
intentId?: string;
|
|
478
|
+
/**
|
|
479
|
+
* <p>The timestamp of the date and time that the slot was created.</p>
|
|
480
|
+
*/
|
|
481
|
+
creationDateTime?: Date;
|
|
482
|
+
/**
|
|
483
|
+
* <p>The timestamp of the date and time that the slot was last
|
|
484
|
+
* updated.</p>
|
|
485
|
+
*/
|
|
486
|
+
lastUpdatedDateTime?: Date;
|
|
487
|
+
/**
|
|
488
|
+
* <p>Indicates whether the slot accepts multiple values in one
|
|
489
|
+
* response.</p>
|
|
490
|
+
*/
|
|
491
|
+
multipleValuesSetting?: MultipleValuesSetting;
|
|
492
|
+
}
|
|
493
|
+
export interface CreateIntentRequest {
|
|
494
|
+
/**
|
|
495
|
+
* <p>The name of the intent. Intent names must be unique in the locale
|
|
496
|
+
* that contains the intent and cannot match the name of any built-in
|
|
497
|
+
* intent.</p>
|
|
498
|
+
*/
|
|
499
|
+
intentName: string | undefined;
|
|
500
|
+
/**
|
|
501
|
+
* <p>A description of the intent. Use the description to help identify
|
|
502
|
+
* the intent in lists.</p>
|
|
503
|
+
*/
|
|
504
|
+
description?: string;
|
|
505
|
+
/**
|
|
506
|
+
* <p>A unique identifier for the built-in intent to base this intent
|
|
507
|
+
* on.</p>
|
|
508
|
+
*/
|
|
509
|
+
parentIntentSignature?: string;
|
|
510
|
+
/**
|
|
511
|
+
* <p>An array of strings that a user might say to signal the intent. For
|
|
512
|
+
* example, "I want a pizza", or "I want a {PizzaSize} pizza". </p>
|
|
513
|
+
* <p>In an utterance, slot names are enclosed in curly braces ("{", "}")
|
|
514
|
+
* to indicate where they should be displayed in the utterance shown to
|
|
515
|
+
* the user.. </p>
|
|
516
|
+
*/
|
|
517
|
+
sampleUtterances?: SampleUtterance[];
|
|
518
|
+
/**
|
|
519
|
+
* <p>Specifies that Amazon Lex invokes the alias Lambda function for each user
|
|
520
|
+
* input. You can invoke this Lambda function to personalize user
|
|
521
|
+
* interaction.</p>
|
|
522
|
+
* <p>For example, suppose that your bot determines that the user's name
|
|
523
|
+
* is John. You Lambda function might retrieve John's information from a
|
|
524
|
+
* backend database and prepopulate some of the values. For example, if
|
|
525
|
+
* you find that John is gluten intolerant, you might set the
|
|
526
|
+
* corresponding intent slot, <code>glutenIntolerant</code> to
|
|
527
|
+
* <code>true</code>. You might find John's phone number and set the
|
|
528
|
+
* corresponding session attribute.</p>
|
|
529
|
+
*/
|
|
530
|
+
dialogCodeHook?: DialogCodeHookSettings;
|
|
531
|
+
/**
|
|
532
|
+
* <p>Specifies that Amazon Lex invokes the alias Lambda function when the
|
|
533
|
+
* intent is ready for fulfillment. You can invoke this function to
|
|
534
|
+
* complete the bot's transaction with the user.</p>
|
|
535
|
+
* <p>For example, in a pizza ordering bot, the Lambda function can look up
|
|
536
|
+
* the closest pizza restaurant to the customer's location and then place
|
|
537
|
+
* an order on the customer's behalf.</p>
|
|
538
|
+
*/
|
|
539
|
+
fulfillmentCodeHook?: FulfillmentCodeHookSettings;
|
|
540
|
+
/**
|
|
541
|
+
* <p>Provides prompts that Amazon Lex sends to the user to confirm the
|
|
542
|
+
* completion of an intent. If the user answers "no," the settings contain
|
|
543
|
+
* a statement that is sent to the user to end the intent.</p>
|
|
544
|
+
*/
|
|
545
|
+
intentConfirmationSetting?: IntentConfirmationSetting;
|
|
546
|
+
/**
|
|
547
|
+
* <p>Sets the response that Amazon Lex sends to the user when the intent is
|
|
548
|
+
* closed.</p>
|
|
549
|
+
*/
|
|
550
|
+
intentClosingSetting?: IntentClosingSetting;
|
|
551
|
+
/**
|
|
552
|
+
* <p>A list of contexts that must be active for this intent to be
|
|
553
|
+
* considered by Amazon Lex.</p>
|
|
554
|
+
* <p>When an intent has an input context list, Amazon Lex only considers using
|
|
555
|
+
* the intent in an interaction with the user when the specified contexts
|
|
556
|
+
* are included in the active context list for the session. If the
|
|
557
|
+
* contexts are not active, then Amazon Lex will not use the intent.</p>
|
|
558
|
+
* <p>A context can be automatically activated using the
|
|
559
|
+
* <code>outputContexts</code> property or it can be set at
|
|
560
|
+
* runtime.</p>
|
|
561
|
+
* <p> For example, if there are two intents with different input contexts
|
|
562
|
+
* that respond to the same utterances, only the intent with the active
|
|
563
|
+
* context will respond.</p>
|
|
564
|
+
* <p>An intent may have up to 5 input contexts. If an intent has multiple
|
|
565
|
+
* input contexts, all of the contexts must be active to consider the
|
|
566
|
+
* intent.</p>
|
|
567
|
+
*/
|
|
568
|
+
inputContexts?: InputContext[];
|
|
569
|
+
/**
|
|
570
|
+
* <p>A lists of contexts that the intent activates when it is
|
|
571
|
+
* fulfilled.</p>
|
|
572
|
+
* <p>You can use an output context to indicate the intents that Amazon Lex
|
|
573
|
+
* should consider for the next turn of the conversation with a customer. </p>
|
|
574
|
+
* <p>When you use the <code>outputContextsList</code> property, all of
|
|
575
|
+
* the contexts specified in the list are activated when the intent is
|
|
576
|
+
* fulfilled. You can set up to 10 output contexts. You can also set the
|
|
577
|
+
* number of conversation turns that the context should be active, or the
|
|
578
|
+
* length of time that the context should be active.</p>
|
|
579
|
+
*/
|
|
580
|
+
outputContexts?: OutputContext[];
|
|
581
|
+
/**
|
|
582
|
+
* <p>Configuration information required to use the
|
|
583
|
+
* <code>AMAZON.KendraSearchIntent</code> intent to connect to an Amazon Kendra
|
|
584
|
+
* index. The <code>AMAZON.KendraSearchIntent</code> intent is called when
|
|
585
|
+
* Amazon Lex can't determine another intent to invoke.</p>
|
|
586
|
+
*/
|
|
587
|
+
kendraConfiguration?: KendraConfiguration;
|
|
588
|
+
/**
|
|
589
|
+
* <p>The identifier of the bot associated with this intent.</p>
|
|
590
|
+
*/
|
|
591
|
+
botId: string | undefined;
|
|
592
|
+
/**
|
|
593
|
+
* <p>The identifier of the version of the bot associated with this
|
|
594
|
+
* intent.</p>
|
|
595
|
+
*/
|
|
596
|
+
botVersion: string | undefined;
|
|
597
|
+
/**
|
|
598
|
+
* <p>The identifier of the language and locale where this intent is used.
|
|
599
|
+
* All of the bots, slot types, and slots used by the intent must have the
|
|
600
|
+
* same locale. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
601
|
+
*/
|
|
602
|
+
localeId: string | undefined;
|
|
603
|
+
/**
|
|
604
|
+
* <p>Configuration settings for the response that is sent to the user at
|
|
605
|
+
* the beginning of a conversation, before eliciting slot values.</p>
|
|
606
|
+
*/
|
|
607
|
+
initialResponseSetting?: InitialResponseSetting;
|
|
608
|
+
}
|
|
609
|
+
export interface CreateIntentResponse {
|
|
610
|
+
/**
|
|
611
|
+
* <p>A unique identifier for the intent.</p>
|
|
612
|
+
*/
|
|
613
|
+
intentId?: string;
|
|
614
|
+
/**
|
|
615
|
+
* <p>The name specified for the intent.</p>
|
|
616
|
+
*/
|
|
617
|
+
intentName?: string;
|
|
618
|
+
/**
|
|
619
|
+
* <p>The description specified for the intent.</p>
|
|
620
|
+
*/
|
|
621
|
+
description?: string;
|
|
622
|
+
/**
|
|
623
|
+
* <p>The signature of the parent intent specified for the intent.</p>
|
|
624
|
+
*/
|
|
625
|
+
parentIntentSignature?: string;
|
|
626
|
+
/**
|
|
627
|
+
* <p>The sample utterances specified for the intent.</p>
|
|
628
|
+
*/
|
|
629
|
+
sampleUtterances?: SampleUtterance[];
|
|
630
|
+
/**
|
|
631
|
+
* <p>The dialog Lambda function specified for the intent.</p>
|
|
632
|
+
*/
|
|
633
|
+
dialogCodeHook?: DialogCodeHookSettings;
|
|
634
|
+
/**
|
|
635
|
+
* <p>The fulfillment Lambda function specified for the intent.</p>
|
|
636
|
+
*/
|
|
637
|
+
fulfillmentCodeHook?: FulfillmentCodeHookSettings;
|
|
638
|
+
/**
|
|
639
|
+
* <p>The confirmation setting specified for the intent.</p>
|
|
640
|
+
*/
|
|
641
|
+
intentConfirmationSetting?: IntentConfirmationSetting;
|
|
642
|
+
/**
|
|
643
|
+
* <p>The closing setting specified for the intent.</p>
|
|
644
|
+
*/
|
|
645
|
+
intentClosingSetting?: IntentClosingSetting;
|
|
646
|
+
/**
|
|
647
|
+
* <p>The list of input contexts specified for the intent.</p>
|
|
648
|
+
*/
|
|
649
|
+
inputContexts?: InputContext[];
|
|
650
|
+
/**
|
|
651
|
+
* <p>The list of output contexts specified for the intent.</p>
|
|
652
|
+
*/
|
|
653
|
+
outputContexts?: OutputContext[];
|
|
654
|
+
/**
|
|
655
|
+
* <p>Configuration for searching a Amazon Kendra index specified for the
|
|
656
|
+
* intent.</p>
|
|
657
|
+
*/
|
|
658
|
+
kendraConfiguration?: KendraConfiguration;
|
|
659
|
+
/**
|
|
660
|
+
* <p>The identifier of the bot associated with the intent.</p>
|
|
661
|
+
*/
|
|
662
|
+
botId?: string;
|
|
663
|
+
/**
|
|
664
|
+
* <p>The identifier of the version of the bot associated with the
|
|
665
|
+
* intent.</p>
|
|
666
|
+
*/
|
|
667
|
+
botVersion?: string;
|
|
668
|
+
/**
|
|
669
|
+
* <p>The locale that the intent is specified to use.</p>
|
|
670
|
+
*/
|
|
671
|
+
localeId?: string;
|
|
672
|
+
/**
|
|
673
|
+
* <p>A timestamp of the date and time that the intent was created.</p>
|
|
674
|
+
*/
|
|
675
|
+
creationDateTime?: Date;
|
|
676
|
+
/**
|
|
677
|
+
* <p>Configuration settings for the response that is sent to the user at
|
|
678
|
+
* the beginning of a conversation, before eliciting slot values.</p>
|
|
679
|
+
*/
|
|
680
|
+
initialResponseSetting?: InitialResponseSetting;
|
|
681
|
+
}
|
|
682
|
+
export interface DescribeIntentResponse {
|
|
683
|
+
/**
|
|
684
|
+
* <p>The unique identifier assigned to the intent when it was
|
|
685
|
+
* created.</p>
|
|
686
|
+
*/
|
|
687
|
+
intentId?: string;
|
|
688
|
+
/**
|
|
689
|
+
* <p>The name specified for the intent.</p>
|
|
690
|
+
*/
|
|
691
|
+
intentName?: string;
|
|
692
|
+
/**
|
|
693
|
+
* <p>The description of the intent.</p>
|
|
694
|
+
*/
|
|
695
|
+
description?: string;
|
|
696
|
+
/**
|
|
697
|
+
* <p>The identifier of the built-in intent that this intent is derived
|
|
698
|
+
* from, if any.</p>
|
|
699
|
+
*/
|
|
700
|
+
parentIntentSignature?: string;
|
|
701
|
+
/**
|
|
702
|
+
* <p>User utterances that trigger this intent.</p>
|
|
703
|
+
*/
|
|
704
|
+
sampleUtterances?: SampleUtterance[];
|
|
705
|
+
/**
|
|
706
|
+
* <p>The Lambda function called during each turn of a conversation with
|
|
707
|
+
* the intent.</p>
|
|
708
|
+
*/
|
|
709
|
+
dialogCodeHook?: DialogCodeHookSettings;
|
|
710
|
+
/**
|
|
711
|
+
* <p>The Lambda function called when the intent is complete and ready for
|
|
712
|
+
* fulfillment.</p>
|
|
713
|
+
*/
|
|
714
|
+
fulfillmentCodeHook?: FulfillmentCodeHookSettings;
|
|
715
|
+
/**
|
|
716
|
+
* <p>The list that determines the priority that slots should be elicited
|
|
717
|
+
* from the user.</p>
|
|
718
|
+
*/
|
|
719
|
+
slotPriorities?: SlotPriority[];
|
|
720
|
+
/**
|
|
721
|
+
* <p>Prompts that Amazon Lex sends to the user to confirm completion of an
|
|
722
|
+
* intent.</p>
|
|
723
|
+
*/
|
|
724
|
+
intentConfirmationSetting?: IntentConfirmationSetting;
|
|
725
|
+
/**
|
|
726
|
+
* <p>The response that Amazon Lex sends to when the intent is closed.</p>
|
|
727
|
+
*/
|
|
728
|
+
intentClosingSetting?: IntentClosingSetting;
|
|
729
|
+
/**
|
|
730
|
+
* <p>A list of contexts that must be active for the intent to be
|
|
731
|
+
* considered for sending to the user.</p>
|
|
732
|
+
*/
|
|
733
|
+
inputContexts?: InputContext[];
|
|
734
|
+
/**
|
|
735
|
+
* <p>A list of contexts that are activated when the intent is
|
|
736
|
+
* fulfilled.</p>
|
|
737
|
+
*/
|
|
738
|
+
outputContexts?: OutputContext[];
|
|
739
|
+
/**
|
|
740
|
+
* <p>Configuration information required to use the
|
|
741
|
+
* <code>AMAZON.KendraSearchIntent</code> intent.</p>
|
|
742
|
+
*/
|
|
743
|
+
kendraConfiguration?: KendraConfiguration;
|
|
744
|
+
/**
|
|
745
|
+
* <p>The identifier of the bot associated with the intent.</p>
|
|
746
|
+
*/
|
|
747
|
+
botId?: string;
|
|
748
|
+
/**
|
|
749
|
+
* <p>The version of the bot associated with the intent.</p>
|
|
750
|
+
*/
|
|
751
|
+
botVersion?: string;
|
|
752
|
+
/**
|
|
753
|
+
* <p>The language and locale specified for the intent.</p>
|
|
754
|
+
*/
|
|
755
|
+
localeId?: string;
|
|
756
|
+
/**
|
|
757
|
+
* <p>A timestamp of the date and time that the intent was created.</p>
|
|
758
|
+
*/
|
|
759
|
+
creationDateTime?: Date;
|
|
760
|
+
/**
|
|
761
|
+
* <p>A timestamp of the date and time that the intent was last
|
|
762
|
+
* updated.</p>
|
|
763
|
+
*/
|
|
764
|
+
lastUpdatedDateTime?: Date;
|
|
765
|
+
/**
|
|
766
|
+
* <p></p>
|
|
767
|
+
*/
|
|
768
|
+
initialResponseSetting?: InitialResponseSetting;
|
|
769
|
+
}
|
|
770
|
+
export interface UpdateIntentRequest {
|
|
771
|
+
/**
|
|
772
|
+
* <p>The unique identifier of the intent to update.</p>
|
|
773
|
+
*/
|
|
774
|
+
intentId: string | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* <p>The new name for the intent.</p>
|
|
777
|
+
*/
|
|
778
|
+
intentName: string | undefined;
|
|
779
|
+
/**
|
|
780
|
+
* <p>The new description of the intent.</p>
|
|
781
|
+
*/
|
|
782
|
+
description?: string;
|
|
783
|
+
/**
|
|
784
|
+
* <p>The signature of the new built-in intent to use as the parent of
|
|
785
|
+
* this intent.</p>
|
|
786
|
+
*/
|
|
787
|
+
parentIntentSignature?: string;
|
|
788
|
+
/**
|
|
789
|
+
* <p>New utterances used to invoke the intent.</p>
|
|
790
|
+
*/
|
|
791
|
+
sampleUtterances?: SampleUtterance[];
|
|
792
|
+
/**
|
|
793
|
+
* <p>The new Lambda function to use between each turn of the conversation
|
|
794
|
+
* with the bot.</p>
|
|
795
|
+
*/
|
|
796
|
+
dialogCodeHook?: DialogCodeHookSettings;
|
|
797
|
+
/**
|
|
798
|
+
* <p>The new Lambda function to call when all of the intents required
|
|
799
|
+
* slots are provided and the intent is ready for fulfillment.</p>
|
|
800
|
+
*/
|
|
801
|
+
fulfillmentCodeHook?: FulfillmentCodeHookSettings;
|
|
802
|
+
/**
|
|
803
|
+
* <p>A new list of slots and their priorities that are contained by the
|
|
804
|
+
* intent.</p>
|
|
805
|
+
*/
|
|
806
|
+
slotPriorities?: SlotPriority[];
|
|
807
|
+
/**
|
|
808
|
+
* <p>New prompts that Amazon Lex sends to the user to confirm the completion
|
|
809
|
+
* of an intent.</p>
|
|
810
|
+
*/
|
|
811
|
+
intentConfirmationSetting?: IntentConfirmationSetting;
|
|
812
|
+
/**
|
|
813
|
+
* <p>The new response that Amazon Lex sends the user when the intent is
|
|
814
|
+
* closed.</p>
|
|
815
|
+
*/
|
|
816
|
+
intentClosingSetting?: IntentClosingSetting;
|
|
817
|
+
/**
|
|
818
|
+
* <p>A new list of contexts that must be active in order for Amazon Lex to
|
|
819
|
+
* consider the intent.</p>
|
|
820
|
+
*/
|
|
821
|
+
inputContexts?: InputContext[];
|
|
822
|
+
/**
|
|
823
|
+
* <p>A new list of contexts that Amazon Lex activates when the intent is
|
|
824
|
+
* fulfilled.</p>
|
|
825
|
+
*/
|
|
826
|
+
outputContexts?: OutputContext[];
|
|
827
|
+
/**
|
|
828
|
+
* <p>New configuration settings for connecting to an Amazon Kendra index.</p>
|
|
829
|
+
*/
|
|
830
|
+
kendraConfiguration?: KendraConfiguration;
|
|
831
|
+
/**
|
|
832
|
+
* <p>The identifier of the bot that contains the intent.</p>
|
|
833
|
+
*/
|
|
834
|
+
botId: string | undefined;
|
|
835
|
+
/**
|
|
836
|
+
* <p>The version of the bot that contains the intent. Must be
|
|
837
|
+
* <code>DRAFT</code>.</p>
|
|
838
|
+
*/
|
|
839
|
+
botVersion: string | undefined;
|
|
840
|
+
/**
|
|
841
|
+
* <p>The identifier of the language and locale where this intent is used.
|
|
842
|
+
* The string must match one of the supported locales. For more
|
|
843
|
+
* information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
|
|
844
|
+
*/
|
|
845
|
+
localeId: string | undefined;
|
|
846
|
+
/**
|
|
847
|
+
* <p></p>
|
|
848
|
+
*/
|
|
849
|
+
initialResponseSetting?: InitialResponseSetting;
|
|
850
|
+
}
|
|
851
|
+
export interface UpdateIntentResponse {
|
|
852
|
+
/**
|
|
853
|
+
* <p>The identifier of the intent that was updated.</p>
|
|
854
|
+
*/
|
|
855
|
+
intentId?: string;
|
|
856
|
+
/**
|
|
857
|
+
* <p>The updated name of the intent.</p>
|
|
858
|
+
*/
|
|
859
|
+
intentName?: string;
|
|
860
|
+
/**
|
|
861
|
+
* <p>The updated description of the intent.</p>
|
|
862
|
+
*/
|
|
863
|
+
description?: string;
|
|
864
|
+
/**
|
|
865
|
+
* <p>The updated built-in intent that is the parent of this
|
|
866
|
+
* intent.</p>
|
|
867
|
+
*/
|
|
868
|
+
parentIntentSignature?: string;
|
|
869
|
+
/**
|
|
870
|
+
* <p>The updated list of sample utterances for the intent.</p>
|
|
871
|
+
*/
|
|
872
|
+
sampleUtterances?: SampleUtterance[];
|
|
873
|
+
/**
|
|
874
|
+
* <p>The updated Lambda function called during each turn of the
|
|
875
|
+
* conversation with the user.</p>
|
|
876
|
+
*/
|
|
877
|
+
dialogCodeHook?: DialogCodeHookSettings;
|
|
878
|
+
/**
|
|
879
|
+
* <p>The updated Lambda function called when the intent is ready for
|
|
880
|
+
* fulfillment.</p>
|
|
881
|
+
*/
|
|
882
|
+
fulfillmentCodeHook?: FulfillmentCodeHookSettings;
|
|
883
|
+
/**
|
|
884
|
+
* <p>The updated list of slots and their priorities that are elicited
|
|
885
|
+
* from the user for the intent.</p>
|
|
886
|
+
*/
|
|
887
|
+
slotPriorities?: SlotPriority[];
|
|
888
|
+
/**
|
|
889
|
+
* <p>The updated prompts that Amazon Lex sends to the user to confirm the
|
|
890
|
+
* completion of an intent.</p>
|
|
891
|
+
*/
|
|
892
|
+
intentConfirmationSetting?: IntentConfirmationSetting;
|
|
893
|
+
/**
|
|
894
|
+
* <p>The updated response that Amazon Lex sends the user when the intent is
|
|
895
|
+
* closed.</p>
|
|
896
|
+
*/
|
|
897
|
+
intentClosingSetting?: IntentClosingSetting;
|
|
898
|
+
/**
|
|
899
|
+
* <p>The updated list of contexts that must be active for the intent to
|
|
900
|
+
* be considered by Amazon Lex.</p>
|
|
901
|
+
*/
|
|
902
|
+
inputContexts?: InputContext[];
|
|
903
|
+
/**
|
|
904
|
+
* <p>The updated list of contexts that Amazon Lex activates when the intent is
|
|
905
|
+
* fulfilled.</p>
|
|
906
|
+
*/
|
|
907
|
+
outputContexts?: OutputContext[];
|
|
908
|
+
/**
|
|
909
|
+
* <p>The updated configuration for connecting to an Amazon Kendra index with the
|
|
910
|
+
* <code>AMAZON.KendraSearchIntent</code> intent.</p>
|
|
911
|
+
*/
|
|
912
|
+
kendraConfiguration?: KendraConfiguration;
|
|
913
|
+
/**
|
|
914
|
+
* <p>The identifier of the bot that contains the intent.</p>
|
|
915
|
+
*/
|
|
916
|
+
botId?: string;
|
|
917
|
+
/**
|
|
918
|
+
* <p>The version of the bot that contains the intent. Will always be
|
|
919
|
+
* <code>DRAFT</code>.</p>
|
|
920
|
+
*/
|
|
921
|
+
botVersion?: string;
|
|
922
|
+
/**
|
|
923
|
+
* <p>The updated language and locale of the intent.</p>
|
|
924
|
+
*/
|
|
925
|
+
localeId?: string;
|
|
926
|
+
/**
|
|
927
|
+
* <p>A timestamp of when the intent was created.</p>
|
|
928
|
+
*/
|
|
929
|
+
creationDateTime?: Date;
|
|
930
|
+
/**
|
|
931
|
+
* <p>A timestamp of the last time that the intent was modified.</p>
|
|
932
|
+
*/
|
|
933
|
+
lastUpdatedDateTime?: Date;
|
|
934
|
+
/**
|
|
935
|
+
* <p></p>
|
|
936
|
+
*/
|
|
937
|
+
initialResponseSetting?: InitialResponseSetting;
|
|
938
|
+
}
|
|
939
|
+
/**
|
|
940
|
+
* @internal
|
|
941
|
+
*/
|
|
942
|
+
export declare const InitialResponseSettingFilterSensitiveLog: (obj: InitialResponseSetting) => any;
|
|
943
|
+
/**
|
|
944
|
+
* @internal
|
|
945
|
+
*/
|
|
946
|
+
export declare const SlotCaptureSettingFilterSensitiveLog: (obj: SlotCaptureSetting) => any;
|
|
947
|
+
/**
|
|
948
|
+
* @internal
|
|
949
|
+
*/
|
|
950
|
+
export declare const SlotValueElicitationSettingFilterSensitiveLog: (obj: SlotValueElicitationSetting) => any;
|
|
951
|
+
/**
|
|
952
|
+
* @internal
|
|
953
|
+
*/
|
|
954
|
+
export declare const IntentConfirmationSettingFilterSensitiveLog: (obj: IntentConfirmationSetting) => any;
|
|
955
|
+
/**
|
|
956
|
+
* @internal
|
|
957
|
+
*/
|
|
958
|
+
export declare const CreateSlotRequestFilterSensitiveLog: (obj: CreateSlotRequest) => any;
|
|
959
|
+
/**
|
|
960
|
+
* @internal
|
|
961
|
+
*/
|
|
962
|
+
export declare const CreateSlotResponseFilterSensitiveLog: (obj: CreateSlotResponse) => any;
|
|
963
|
+
/**
|
|
964
|
+
* @internal
|
|
965
|
+
*/
|
|
966
|
+
export declare const DescribeSlotResponseFilterSensitiveLog: (obj: DescribeSlotResponse) => any;
|
|
967
|
+
/**
|
|
968
|
+
* @internal
|
|
969
|
+
*/
|
|
970
|
+
export declare const UpdateSlotRequestFilterSensitiveLog: (obj: UpdateSlotRequest) => any;
|
|
971
|
+
/**
|
|
972
|
+
* @internal
|
|
973
|
+
*/
|
|
974
|
+
export declare const UpdateSlotResponseFilterSensitiveLog: (obj: UpdateSlotResponse) => any;
|
|
975
|
+
/**
|
|
976
|
+
* @internal
|
|
977
|
+
*/
|
|
978
|
+
export declare const CreateIntentRequestFilterSensitiveLog: (obj: CreateIntentRequest) => any;
|
|
979
|
+
/**
|
|
980
|
+
* @internal
|
|
981
|
+
*/
|
|
982
|
+
export declare const CreateIntentResponseFilterSensitiveLog: (obj: CreateIntentResponse) => any;
|
|
983
|
+
/**
|
|
984
|
+
* @internal
|
|
985
|
+
*/
|
|
986
|
+
export declare const DescribeIntentResponseFilterSensitiveLog: (obj: DescribeIntentResponse) => any;
|
|
987
|
+
/**
|
|
988
|
+
* @internal
|
|
989
|
+
*/
|
|
990
|
+
export declare const UpdateIntentRequestFilterSensitiveLog: (obj: UpdateIntentRequest) => any;
|
|
991
|
+
/**
|
|
992
|
+
* @internal
|
|
993
|
+
*/
|
|
994
|
+
export declare const UpdateIntentResponseFilterSensitiveLog: (obj: UpdateIntentResponse) => any;
|