@aws-sdk/client-lex-runtime-v2 3.533.0 → 3.535.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/dist-types/LexRuntimeV2.d.ts +1 -1
- package/dist-types/LexRuntimeV2Client.d.ts +1 -1
- package/dist-types/commands/DeleteSessionCommand.d.ts +2 -1
- package/dist-types/commands/GetSessionCommand.d.ts +2 -1
- package/dist-types/commands/PutSessionCommand.d.ts +2 -1
- package/dist-types/commands/RecognizeTextCommand.d.ts +2 -1
- package/dist-types/commands/RecognizeUtteranceCommand.d.ts +2 -1
- package/dist-types/commands/StartConversationCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +223 -223
- package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RecognizeTextCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RecognizeUtteranceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartConversationCommand.d.ts +9 -0
- package/package.json +46 -46
|
@@ -2,8 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { StreamingBlobTypes } from "@smithy/types";
|
|
3
3
|
import { LexRuntimeV2ServiceException as __BaseException } from "./LexRuntimeV2ServiceException";
|
|
4
4
|
/**
|
|
5
|
-
* @public
|
|
6
5
|
* <p></p>
|
|
6
|
+
* @public
|
|
7
7
|
*/
|
|
8
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
9
9
|
readonly name: "AccessDeniedException";
|
|
@@ -14,26 +14,25 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* @public
|
|
18
17
|
* <p>The time that a context is active. You can specify the time to live
|
|
19
18
|
* in seconds or in conversation turns.</p>
|
|
19
|
+
* @public
|
|
20
20
|
*/
|
|
21
21
|
export interface ActiveContextTimeToLive {
|
|
22
22
|
/**
|
|
23
|
-
* @public
|
|
24
23
|
* <p>The number of seconds that the context is active. You can specify
|
|
25
24
|
* between 5 and 86400 seconds (24 hours).</p>
|
|
25
|
+
* @public
|
|
26
26
|
*/
|
|
27
27
|
timeToLiveInSeconds: number | undefined;
|
|
28
28
|
/**
|
|
29
|
-
* @public
|
|
30
29
|
* <p>The number of turns that the context is active. You can specify up
|
|
31
30
|
* to 20 turns. Each request and response from the bot is a turn.</p>
|
|
31
|
+
* @public
|
|
32
32
|
*/
|
|
33
33
|
turnsToLive: number | undefined;
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
* @public
|
|
37
36
|
* <p>Contains information about the contexts that a user is using in a
|
|
38
37
|
* session. You can configure Amazon Lex V2 to set a context when an intent is
|
|
39
38
|
* fulfilled, or you can set a context using the , , or operations.</p>
|
|
@@ -42,46 +41,46 @@ export interface ActiveContextTimeToLive {
|
|
|
42
41
|
* <code>order-fulfilled</code>, only intents that have
|
|
43
42
|
* <code>order-fulfilled</code> configured as a trigger are considered
|
|
44
43
|
* for follow up.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
export interface ActiveContext {
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>The name of the context.</p>
|
|
49
|
+
* @public
|
|
50
50
|
*/
|
|
51
51
|
name: string | undefined;
|
|
52
52
|
/**
|
|
53
|
-
* @public
|
|
54
53
|
* <p>Indicates the number of turns or seconds that the context is active.
|
|
55
54
|
* Once the time to live expires, the context is no longer returned in a
|
|
56
55
|
* response.</p>
|
|
56
|
+
* @public
|
|
57
57
|
*/
|
|
58
58
|
timeToLive: ActiveContextTimeToLive | undefined;
|
|
59
59
|
/**
|
|
60
|
-
* @public
|
|
61
60
|
* <p>A list of contexts active for the request. A context can be
|
|
62
61
|
* activated when a previous intent is fulfilled, or by including the
|
|
63
62
|
* context in the request.</p>
|
|
64
63
|
* <p>If you don't specify a list of contexts, Amazon Lex V2 will use the current
|
|
65
64
|
* list of contexts for the session. If you specify an empty list, all
|
|
66
65
|
* contexts for the session are cleared. </p>
|
|
66
|
+
* @public
|
|
67
67
|
*/
|
|
68
68
|
contextAttributes: Record<string, string> | undefined;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>Represents a chunk of audio sent from the client application to
|
|
73
72
|
* Amazon Lex V2. The audio is all or part of an utterance from the user.</p>
|
|
74
73
|
* <p>Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause
|
|
75
74
|
* in speech before processing the input.</p>
|
|
75
|
+
* @public
|
|
76
76
|
*/
|
|
77
77
|
export interface AudioInputEvent {
|
|
78
78
|
/**
|
|
79
|
-
* @public
|
|
80
79
|
* <p>An encoded stream of audio.</p>
|
|
80
|
+
* @public
|
|
81
81
|
*/
|
|
82
82
|
audioChunk?: Uint8Array;
|
|
83
83
|
/**
|
|
84
|
-
* @public
|
|
85
84
|
* <p>The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit
|
|
86
85
|
* mono-channel little-endian format. The value of the field should
|
|
87
86
|
* be:</p>
|
|
@@ -89,51 +88,52 @@ export interface AudioInputEvent {
|
|
|
89
88
|
* <code>audio/lpcm; sample-rate=8000; sample-size-bits=16;
|
|
90
89
|
* channel-count=1; is-big-endian=false</code>
|
|
91
90
|
* </p>
|
|
91
|
+
* @public
|
|
92
92
|
*/
|
|
93
93
|
contentType: string | undefined;
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>A unique identifier that your application assigns to the event. You
|
|
97
96
|
* can use this to identify events in logs.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
eventId?: string;
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>A timestamp set by the client of the date and time that the event
|
|
103
102
|
* was sent to Amazon Lex V2.</p>
|
|
103
|
+
* @public
|
|
104
104
|
*/
|
|
105
105
|
clientTimestampMillis?: number;
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
|
-
* @public
|
|
109
108
|
* <p>An event sent from Amazon Lex V2 to your client application containing audio
|
|
110
109
|
* to play to the user. </p>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
export interface AudioResponseEvent {
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p>A chunk of the audio to play. </p>
|
|
115
|
+
* @public
|
|
116
116
|
*/
|
|
117
117
|
audioChunk?: Uint8Array;
|
|
118
118
|
/**
|
|
119
|
-
* @public
|
|
120
119
|
* <p>The encoding of the audio chunk. This is the same as the encoding
|
|
121
120
|
* configure in the <code>contentType</code> field of the
|
|
122
121
|
* <code>ConfigurationEvent</code>.</p>
|
|
122
|
+
* @public
|
|
123
123
|
*/
|
|
124
124
|
contentType?: string;
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
|
|
128
127
|
* the form <code>RESPONSE-N</code>, where N is a number starting with one
|
|
129
128
|
* and incremented for each event sent by Amazon Lex V2 in the current
|
|
130
129
|
* session.</p>
|
|
130
|
+
* @public
|
|
131
131
|
*/
|
|
132
132
|
eventId?: string;
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* @public
|
|
136
135
|
* <p></p>
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
export declare class ConflictException extends __BaseException {
|
|
139
139
|
readonly name: "ConflictException";
|
|
@@ -148,24 +148,24 @@ export declare class ConflictException extends __BaseException {
|
|
|
148
148
|
*/
|
|
149
149
|
export interface DeleteSessionRequest {
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p>The identifier of the bot that contains the session data.</p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
botId: string | undefined;
|
|
155
155
|
/**
|
|
156
|
-
* @public
|
|
157
156
|
* <p>The alias identifier in use for the bot that contains the session
|
|
158
157
|
* data.</p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
botAliasId: string | undefined;
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p>The locale where the session is in use.</p>
|
|
163
|
+
* @public
|
|
164
164
|
*/
|
|
165
165
|
localeId: string | undefined;
|
|
166
166
|
/**
|
|
167
|
-
* @public
|
|
168
167
|
* <p>The identifier of the session to delete.</p>
|
|
168
|
+
* @public
|
|
169
169
|
*/
|
|
170
170
|
sessionId: string | undefined;
|
|
171
171
|
}
|
|
@@ -174,30 +174,30 @@ export interface DeleteSessionRequest {
|
|
|
174
174
|
*/
|
|
175
175
|
export interface DeleteSessionResponse {
|
|
176
176
|
/**
|
|
177
|
-
* @public
|
|
178
177
|
* <p>The identifier of the bot that contained the session data.</p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
botId?: string;
|
|
181
181
|
/**
|
|
182
|
-
* @public
|
|
183
182
|
* <p>The alias identifier in use for the bot that contained the session
|
|
184
183
|
* data.</p>
|
|
184
|
+
* @public
|
|
185
185
|
*/
|
|
186
186
|
botAliasId?: string;
|
|
187
187
|
/**
|
|
188
|
-
* @public
|
|
189
188
|
* <p>The locale where the session was used.</p>
|
|
189
|
+
* @public
|
|
190
190
|
*/
|
|
191
191
|
localeId?: string;
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p>The identifier of the deleted session.</p>
|
|
194
|
+
* @public
|
|
195
195
|
*/
|
|
196
196
|
sessionId?: string;
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
|
-
* @public
|
|
200
199
|
* <p></p>
|
|
200
|
+
* @public
|
|
201
201
|
*/
|
|
202
202
|
export declare class InternalServerException extends __BaseException {
|
|
203
203
|
readonly name: "InternalServerException";
|
|
@@ -208,8 +208,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
208
208
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
209
209
|
}
|
|
210
210
|
/**
|
|
211
|
-
* @public
|
|
212
211
|
* <p></p>
|
|
212
|
+
* @public
|
|
213
213
|
*/
|
|
214
214
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
215
215
|
readonly name: "ResourceNotFoundException";
|
|
@@ -220,8 +220,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
220
220
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
|
-
* @public
|
|
224
223
|
* <p></p>
|
|
224
|
+
* @public
|
|
225
225
|
*/
|
|
226
226
|
export declare class ThrottlingException extends __BaseException {
|
|
227
227
|
readonly name: "ThrottlingException";
|
|
@@ -232,8 +232,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
232
232
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
233
233
|
}
|
|
234
234
|
/**
|
|
235
|
-
* @public
|
|
236
235
|
* <p></p>
|
|
236
|
+
* @public
|
|
237
237
|
*/
|
|
238
238
|
export declare class ValidationException extends __BaseException {
|
|
239
239
|
readonly name: "ValidationException";
|
|
@@ -248,24 +248,24 @@ export declare class ValidationException extends __BaseException {
|
|
|
248
248
|
*/
|
|
249
249
|
export interface GetSessionRequest {
|
|
250
250
|
/**
|
|
251
|
-
* @public
|
|
252
251
|
* <p>The identifier of the bot that contains the session data.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
botId: string | undefined;
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>The alias identifier in use for the bot that contains the session
|
|
258
257
|
* data.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
botAliasId: string | undefined;
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>The locale where the session is in use.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
localeId: string | undefined;
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>The identifier of the session to return.</p>
|
|
268
|
+
* @public
|
|
269
269
|
*/
|
|
270
270
|
sessionId: string | undefined;
|
|
271
271
|
}
|
|
@@ -296,23 +296,23 @@ export declare const Shape: {
|
|
|
296
296
|
*/
|
|
297
297
|
export type Shape = (typeof Shape)[keyof typeof Shape];
|
|
298
298
|
/**
|
|
299
|
-
* @public
|
|
300
299
|
* <p>Information about the value provided for a slot and Amazon Lex V2's interpretation.</p>
|
|
300
|
+
* @public
|
|
301
301
|
*/
|
|
302
302
|
export interface Value {
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.</p>
|
|
305
|
+
* @public
|
|
306
306
|
*/
|
|
307
307
|
originalValue?: string;
|
|
308
308
|
/**
|
|
309
|
-
* @public
|
|
310
309
|
* <p>The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the <code>resolvedValues</code> list.</p>
|
|
310
|
+
* @public
|
|
311
311
|
*/
|
|
312
312
|
interpretedValue: string | undefined;
|
|
313
313
|
/**
|
|
314
|
-
* @public
|
|
315
314
|
* <p>A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the <code>interpretedValue</code>.</p>
|
|
315
|
+
* @public
|
|
316
316
|
*/
|
|
317
317
|
resolvedValues?: string[];
|
|
318
318
|
}
|
|
@@ -345,16 +345,16 @@ export declare const InterpretationSource: {
|
|
|
345
345
|
*/
|
|
346
346
|
export type InterpretationSource = (typeof InterpretationSource)[keyof typeof InterpretationSource];
|
|
347
347
|
/**
|
|
348
|
-
* @public
|
|
349
348
|
* <p>Provides a score that indicates the confidence that Amazon Lex V2 has that
|
|
350
349
|
* an intent is the one that satisfies the user's intent.</p>
|
|
350
|
+
* @public
|
|
351
351
|
*/
|
|
352
352
|
export interface ConfidenceScore {
|
|
353
353
|
/**
|
|
354
|
-
* @public
|
|
355
354
|
* <p>A score that indicates how confident Amazon Lex V2 is that an intent
|
|
356
355
|
* satisfies the user's intent. Ranges between 0.00 and 1.00. Higher
|
|
357
356
|
* scores indicate higher confidence.</p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
score?: number;
|
|
360
360
|
}
|
|
@@ -373,37 +373,36 @@ export declare const SentimentType: {
|
|
|
373
373
|
*/
|
|
374
374
|
export type SentimentType = (typeof SentimentType)[keyof typeof SentimentType];
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>The individual sentiment responses for the utterance.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
export interface SentimentScore {
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>The level of confidence that Amazon Comprehend has in the accuracy
|
|
383
382
|
* of its detection of the <code>POSITIVE</code> sentiment.</p>
|
|
383
|
+
* @public
|
|
384
384
|
*/
|
|
385
385
|
positive?: number;
|
|
386
386
|
/**
|
|
387
|
-
* @public
|
|
388
387
|
* <p>The level of confidence that Amazon Comprehend has in the accuracy
|
|
389
388
|
* of its detection of the <code>NEGATIVE</code> sentiment.</p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
negative?: number;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>The level of confidence that Amazon Comprehend has in the accuracy
|
|
395
394
|
* of its detection of the <code>NEUTRAL</code> sentiment.</p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
neutral?: number;
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>The level of confidence that Amazon Comprehend has in the accuracy
|
|
401
400
|
* of its detection of the <code>MIXED</code> sentiment.</p>
|
|
401
|
+
* @public
|
|
402
402
|
*/
|
|
403
403
|
mixed?: number;
|
|
404
404
|
}
|
|
405
405
|
/**
|
|
406
|
-
* @public
|
|
407
406
|
* <p>Provides information about the sentiment expressed in a user's
|
|
408
407
|
* response in a conversation. Sentiments are determined using Amazon
|
|
409
408
|
* Comprehend. Sentiments are only returned if they are enabled for the
|
|
@@ -411,18 +410,19 @@ export interface SentimentScore {
|
|
|
411
410
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html">
|
|
412
411
|
* Determine Sentiment </a> in the <i>Amazon Comprehend
|
|
413
412
|
* developer guide</i>.</p>
|
|
413
|
+
* @public
|
|
414
414
|
*/
|
|
415
415
|
export interface SentimentResponse {
|
|
416
416
|
/**
|
|
417
|
-
* @public
|
|
418
417
|
* <p>The overall sentiment expressed in the user's response. This is the
|
|
419
418
|
* sentiment most likely expressed by the user based on the analysis by
|
|
420
419
|
* Amazon Comprehend.</p>
|
|
420
|
+
* @public
|
|
421
421
|
*/
|
|
422
422
|
sentiment?: SentimentType;
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p>The individual sentiment responses for the utterance.</p>
|
|
425
|
+
* @public
|
|
426
426
|
*/
|
|
427
427
|
sentimentScore?: SentimentScore;
|
|
428
428
|
}
|
|
@@ -441,78 +441,78 @@ export declare const MessageContentType: {
|
|
|
441
441
|
*/
|
|
442
442
|
export type MessageContentType = (typeof MessageContentType)[keyof typeof MessageContentType];
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>A button that appears on a response card show to the user.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
export interface Button {
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>The text that is displayed on the button.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
text: string | undefined;
|
|
453
453
|
/**
|
|
454
|
-
* @public
|
|
455
454
|
* <p>The value returned to Amazon Lex V2 when a user chooses the button.</p>
|
|
455
|
+
* @public
|
|
456
456
|
*/
|
|
457
457
|
value: string | undefined;
|
|
458
458
|
}
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>A card that is shown to the user by a messaging platform. You define
|
|
462
461
|
* the contents of the card, the card is displayed by the platform. </p>
|
|
463
462
|
* <p>When you use a response card, the response from the user is
|
|
464
463
|
* constrained to the text associated with a button on the card.</p>
|
|
464
|
+
* @public
|
|
465
465
|
*/
|
|
466
466
|
export interface ImageResponseCard {
|
|
467
467
|
/**
|
|
468
|
-
* @public
|
|
469
468
|
* <p>The title to display on the response card. The format of the title
|
|
470
469
|
* is determined by the platform displaying the response card.</p>
|
|
470
|
+
* @public
|
|
471
471
|
*/
|
|
472
472
|
title: string | undefined;
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>The subtitle to display on the response card. The format of the
|
|
476
475
|
* subtitle is determined by the platform displaying the response
|
|
477
476
|
* card.</p>
|
|
477
|
+
* @public
|
|
478
478
|
*/
|
|
479
479
|
subtitle?: string;
|
|
480
480
|
/**
|
|
481
|
-
* @public
|
|
482
481
|
* <p>The URL of an image to display on the response card. The image URL
|
|
483
482
|
* must be publicly available so that the platform displaying the response
|
|
484
483
|
* card has access to the image.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
imageUrl?: string;
|
|
487
487
|
/**
|
|
488
|
-
* @public
|
|
489
488
|
* <p>A list of buttons that should be displayed on the response card. The
|
|
490
489
|
* arrangement of the buttons is determined by the platform that displays
|
|
491
490
|
* the button.</p>
|
|
491
|
+
* @public
|
|
492
492
|
*/
|
|
493
493
|
buttons?: Button[];
|
|
494
494
|
}
|
|
495
495
|
/**
|
|
496
|
-
* @public
|
|
497
496
|
* <p>Container for text that is returned to the customer..</p>
|
|
497
|
+
* @public
|
|
498
498
|
*/
|
|
499
499
|
export interface Message {
|
|
500
500
|
/**
|
|
501
|
-
* @public
|
|
502
501
|
* <p>The text of the message.</p>
|
|
502
|
+
* @public
|
|
503
503
|
*/
|
|
504
504
|
content?: string;
|
|
505
505
|
/**
|
|
506
|
-
* @public
|
|
507
506
|
* <p>Indicates the type of response.</p>
|
|
507
|
+
* @public
|
|
508
508
|
*/
|
|
509
509
|
contentType: MessageContentType | undefined;
|
|
510
510
|
/**
|
|
511
|
-
* @public
|
|
512
511
|
* <p>A card that is shown to the user by a messaging platform. You define
|
|
513
512
|
* the contents of the card, the card is displayed by the platform. </p>
|
|
514
513
|
* <p>When you use a response card, the response from the user is
|
|
515
514
|
* constrained to the text associated with a button on the card.</p>
|
|
515
|
+
* @public
|
|
516
516
|
*/
|
|
517
517
|
imageResponseCard?: ImageResponseCard;
|
|
518
518
|
}
|
|
@@ -546,21 +546,21 @@ export declare const DialogActionType: {
|
|
|
546
546
|
*/
|
|
547
547
|
export type DialogActionType = (typeof DialogActionType)[keyof typeof DialogActionType];
|
|
548
548
|
/**
|
|
549
|
-
* @public
|
|
550
549
|
* <p>Provides the phrase that Amazon Lex V2 should look for in the user's input
|
|
551
550
|
* to the bot.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
export interface RuntimeHintValue {
|
|
554
554
|
/**
|
|
555
|
-
* @public
|
|
556
555
|
* <p>The phrase that Amazon Lex V2 should look for in the user's input to the
|
|
557
556
|
* bot.</p>
|
|
557
|
+
* @public
|
|
558
558
|
*/
|
|
559
559
|
phrase: string | undefined;
|
|
560
560
|
}
|
|
561
561
|
/**
|
|
562
|
-
* @public
|
|
563
562
|
* <p></p>
|
|
563
|
+
* @public
|
|
564
564
|
*/
|
|
565
565
|
export declare class BadGatewayException extends __BaseException {
|
|
566
566
|
readonly name: "BadGatewayException";
|
|
@@ -571,8 +571,8 @@ export declare class BadGatewayException extends __BaseException {
|
|
|
571
571
|
constructor(opts: __ExceptionOptionType<BadGatewayException, __BaseException>);
|
|
572
572
|
}
|
|
573
573
|
/**
|
|
574
|
-
* @public
|
|
575
574
|
* <p></p>
|
|
575
|
+
* @public
|
|
576
576
|
*/
|
|
577
577
|
export declare class DependencyFailedException extends __BaseException {
|
|
578
578
|
readonly name: "DependencyFailedException";
|
|
@@ -587,58 +587,58 @@ export declare class DependencyFailedException extends __BaseException {
|
|
|
587
587
|
*/
|
|
588
588
|
export interface PutSessionResponse {
|
|
589
589
|
/**
|
|
590
|
-
* @public
|
|
591
590
|
* <p>The type of response. Same as the type specified in the
|
|
592
591
|
* <code>responseContentType</code> field in the request.</p>
|
|
592
|
+
* @public
|
|
593
593
|
*/
|
|
594
594
|
contentType?: string;
|
|
595
595
|
/**
|
|
596
|
-
* @public
|
|
597
596
|
* <p>A list of messages that were last sent to the user. The messages are
|
|
598
597
|
* ordered based on how you return the messages from you Lambda function
|
|
599
598
|
* or the order that the messages are defined in the bot.</p>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
messages?: string;
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>A base-64-encoded gzipped field that represents the current state of
|
|
605
604
|
* the dialog between the user and the bot. Use this to determine the progress
|
|
606
605
|
* of the conversation and what the next action may be.</p>
|
|
606
|
+
* @public
|
|
607
607
|
*/
|
|
608
608
|
sessionState?: string;
|
|
609
609
|
/**
|
|
610
|
-
* @public
|
|
611
610
|
* <p>A base-64-encoded gzipped field that provides request-specific information
|
|
612
611
|
* passed between the client application and Amazon Lex V2. These are the same as the
|
|
613
612
|
* <code>requestAttribute</code> parameter in the call to the
|
|
614
613
|
* <code>PutSession</code> operation.</p>
|
|
614
|
+
* @public
|
|
615
615
|
*/
|
|
616
616
|
requestAttributes?: string;
|
|
617
617
|
/**
|
|
618
|
-
* @public
|
|
619
618
|
* <p>The identifier of the session that received the data.</p>
|
|
619
|
+
* @public
|
|
620
620
|
*/
|
|
621
621
|
sessionId?: string;
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>If the requested content type was audio, the audio version of the
|
|
625
624
|
* message to convey to the user.</p>
|
|
625
|
+
* @public
|
|
626
626
|
*/
|
|
627
627
|
audioStream?: StreamingBlobTypes;
|
|
628
628
|
}
|
|
629
629
|
/**
|
|
630
|
-
* @public
|
|
631
630
|
* <p>The bot member that processes the request.</p>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
export interface RecognizedBotMember {
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>The identifier of the bot member that processes the request.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
botId: string | undefined;
|
|
639
639
|
/**
|
|
640
|
-
* @public
|
|
641
640
|
* <p>The name of the bot member that processes the request.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
botName?: string;
|
|
644
644
|
}
|
|
@@ -647,38 +647,37 @@ export interface RecognizedBotMember {
|
|
|
647
647
|
*/
|
|
648
648
|
export interface RecognizeUtteranceRequest {
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>The identifier of the bot that should receive the request.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
botId: string | undefined;
|
|
654
654
|
/**
|
|
655
|
-
* @public
|
|
656
655
|
* <p>The alias identifier in use for the bot that should receive the
|
|
657
656
|
* request.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
botAliasId: string | undefined;
|
|
660
660
|
/**
|
|
661
|
-
* @public
|
|
662
661
|
* <p>The locale where the session is in use.</p>
|
|
662
|
+
* @public
|
|
663
663
|
*/
|
|
664
664
|
localeId: string | undefined;
|
|
665
665
|
/**
|
|
666
|
-
* @public
|
|
667
666
|
* <p>The identifier of the session in use.</p>
|
|
667
|
+
* @public
|
|
668
668
|
*/
|
|
669
669
|
sessionId: string | undefined;
|
|
670
670
|
/**
|
|
671
|
-
* @public
|
|
672
671
|
* <p>Sets the state of the session with the user. You can use this to set
|
|
673
672
|
* the current intent, attributes, context, and dialog action. Use the
|
|
674
673
|
* dialog action to determine the next step that Amazon Lex V2 should use in the
|
|
675
674
|
* conversation with the user.</p>
|
|
676
675
|
* <p>The <code>sessionState</code> field must be compressed using gzip
|
|
677
676
|
* and then base64 encoded before sending to Amazon Lex V2.</p>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
sessionState?: string;
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <p>Request-specific information passed between the client application
|
|
683
682
|
* and Amazon Lex V2 </p>
|
|
684
683
|
* <p>The namespace <code>x-amz-lex:</code> is reserved for special
|
|
@@ -686,10 +685,10 @@ export interface RecognizeUtteranceRequest {
|
|
|
686
685
|
* <code>x-amz-lex:</code>.</p>
|
|
687
686
|
* <p>The <code>requestAttributes</code> field must be compressed using
|
|
688
687
|
* gzip and then base64 encoded before sending to Amazon Lex V2.</p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
requestAttributes?: string;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>Indicates the format for audio input or that the content is text.
|
|
694
693
|
* The header must start with one of the following prefixes:</p>
|
|
695
694
|
* <ul>
|
|
@@ -726,10 +725,10 @@ export interface RecognizeUtteranceRequest {
|
|
|
726
725
|
* </ul>
|
|
727
726
|
* </li>
|
|
728
727
|
* </ul>
|
|
728
|
+
* @public
|
|
729
729
|
*/
|
|
730
730
|
requestContentType: string | undefined;
|
|
731
731
|
/**
|
|
732
|
-
* @public
|
|
733
732
|
* <p>The message that Amazon Lex V2 returns in the response can be either text or
|
|
734
733
|
* speech based on the <code>responseContentType</code> value.</p>
|
|
735
734
|
* <ul>
|
|
@@ -771,12 +770,13 @@ export interface RecognizeUtteranceRequest {
|
|
|
771
770
|
* </ul>
|
|
772
771
|
* </li>
|
|
773
772
|
* </ul>
|
|
773
|
+
* @public
|
|
774
774
|
*/
|
|
775
775
|
responseContentType?: string;
|
|
776
776
|
/**
|
|
777
|
-
* @public
|
|
778
777
|
* <p>User input in PCM or Opus audio format or text format as described
|
|
779
778
|
* in the <code>requestContentType</code> parameter.</p>
|
|
779
|
+
* @public
|
|
780
780
|
*/
|
|
781
781
|
inputStream?: StreamingBlobTypes;
|
|
782
782
|
}
|
|
@@ -785,19 +785,18 @@ export interface RecognizeUtteranceRequest {
|
|
|
785
785
|
*/
|
|
786
786
|
export interface RecognizeUtteranceResponse {
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>Indicates whether the input mode to the operation was text, speech, or from a touch-tone keypad.
|
|
790
789
|
* </p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
inputMode?: string;
|
|
793
793
|
/**
|
|
794
|
-
* @public
|
|
795
794
|
* <p>Content type as specified in the <code>responseContentType</code> in
|
|
796
795
|
* the request.</p>
|
|
796
|
+
* @public
|
|
797
797
|
*/
|
|
798
798
|
contentType?: string;
|
|
799
799
|
/**
|
|
800
|
-
* @public
|
|
801
800
|
* <p>A list of messages that were last sent to the user. The messages are
|
|
802
801
|
* ordered based on the order that you returned the messages from your
|
|
803
802
|
* Lambda function or the order that the messages are defined in the
|
|
@@ -806,10 +805,10 @@ export interface RecognizeUtteranceResponse {
|
|
|
806
805
|
* base64 encoded. Before you can use the contents of the field, you must
|
|
807
806
|
* decode and decompress the contents. See the example for a simple
|
|
808
807
|
* function to decode and decompress the contents.</p>
|
|
808
|
+
* @public
|
|
809
809
|
*/
|
|
810
810
|
messages?: string;
|
|
811
811
|
/**
|
|
812
|
-
* @public
|
|
813
812
|
* <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
|
|
814
813
|
* utterance.</p>
|
|
815
814
|
* <p>Each interpretation includes the intent, a score that indicates how
|
|
@@ -820,10 +819,10 @@ export interface RecognizeUtteranceResponse {
|
|
|
820
819
|
* then base64 encoded. Before you can use the contents of the field, you
|
|
821
820
|
* must decode and decompress the contents. See the example for a simple
|
|
822
821
|
* function to decode and decompress the contents.</p>
|
|
822
|
+
* @public
|
|
823
823
|
*/
|
|
824
824
|
interpretations?: string;
|
|
825
825
|
/**
|
|
826
|
-
* @public
|
|
827
826
|
* <p>Represents the current state of the dialog between the user and the
|
|
828
827
|
* bot.</p>
|
|
829
828
|
* <p>Use this to determine the progress of the conversation and what the
|
|
@@ -832,23 +831,23 @@ export interface RecognizeUtteranceResponse {
|
|
|
832
831
|
* base64 encoded. Before you can use the contents of the field, you must
|
|
833
832
|
* decode and decompress the contents. See the example for a simple
|
|
834
833
|
* function to decode and decompress the contents.</p>
|
|
834
|
+
* @public
|
|
835
835
|
*/
|
|
836
836
|
sessionState?: string;
|
|
837
837
|
/**
|
|
838
|
-
* @public
|
|
839
838
|
* <p>The attributes sent in the request.</p>
|
|
840
839
|
* <p>The <code>requestAttributes</code> field is compressed with gzip and
|
|
841
840
|
* then base64 encoded. Before you can use the contents of the field, you
|
|
842
841
|
* must decode and decompress the contents.</p>
|
|
842
|
+
* @public
|
|
843
843
|
*/
|
|
844
844
|
requestAttributes?: string;
|
|
845
845
|
/**
|
|
846
|
-
* @public
|
|
847
846
|
* <p>The identifier of the session in use.</p>
|
|
847
|
+
* @public
|
|
848
848
|
*/
|
|
849
849
|
sessionId?: string;
|
|
850
850
|
/**
|
|
851
|
-
* @public
|
|
852
851
|
* <p>The text used to process the request.</p>
|
|
853
852
|
* <p>If the input was an audio stream, the <code>inputTranscript</code>
|
|
854
853
|
* field contains the text extracted from the audio stream. This is the
|
|
@@ -859,10 +858,10 @@ export interface RecognizeUtteranceResponse {
|
|
|
859
858
|
* then base64 encoded. Before you can use the contents of the field, you
|
|
860
859
|
* must decode and decompress the contents. See the example for a simple
|
|
861
860
|
* function to decode and decompress the contents.</p>
|
|
861
|
+
* @public
|
|
862
862
|
*/
|
|
863
863
|
inputTranscript?: string;
|
|
864
864
|
/**
|
|
865
|
-
* @public
|
|
866
865
|
* <p>The prompt or statement to send to the user. This is based on the
|
|
867
866
|
* bot configuration and context. For example, if Amazon Lex V2 did not understand
|
|
868
867
|
* the user intent, it sends the <code>clarificationPrompt</code>
|
|
@@ -872,11 +871,12 @@ export interface RecognizeUtteranceResponse {
|
|
|
872
871
|
* Lambda function successfully fulfilled the intent, and sent a message
|
|
873
872
|
* to convey to the user. Then Amazon Lex V2 sends that message in the
|
|
874
873
|
* response.</p>
|
|
874
|
+
* @public
|
|
875
875
|
*/
|
|
876
876
|
audioStream?: StreamingBlobTypes;
|
|
877
877
|
/**
|
|
878
|
-
* @public
|
|
879
878
|
* <p>The bot member that recognized the utterance.</p>
|
|
879
|
+
* @public
|
|
880
880
|
*/
|
|
881
881
|
recognizedBotMember?: string;
|
|
882
882
|
}
|
|
@@ -893,109 +893,109 @@ export declare const ConversationMode: {
|
|
|
893
893
|
*/
|
|
894
894
|
export type ConversationMode = (typeof ConversationMode)[keyof typeof ConversationMode];
|
|
895
895
|
/**
|
|
896
|
-
* @public
|
|
897
896
|
* <p>A notification from the client that it is disconnecting from Amazon Lex V2.
|
|
898
897
|
* Sending a <code>DisconnectionEvent</code> event is optional, but can
|
|
899
898
|
* help identify a conversation in logs.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
export interface DisconnectionEvent {
|
|
902
902
|
/**
|
|
903
|
-
* @public
|
|
904
903
|
* <p>A unique identifier that your application assigns to the event. You
|
|
905
904
|
* can use this to identify events in logs.</p>
|
|
905
|
+
* @public
|
|
906
906
|
*/
|
|
907
907
|
eventId?: string;
|
|
908
908
|
/**
|
|
909
|
-
* @public
|
|
910
909
|
* <p>A timestamp set by the client of the date and time that the event
|
|
911
910
|
* was sent to Amazon Lex V2.</p>
|
|
911
|
+
* @public
|
|
912
912
|
*/
|
|
913
913
|
clientTimestampMillis?: number;
|
|
914
914
|
}
|
|
915
915
|
/**
|
|
916
|
-
* @public
|
|
917
916
|
* <p>A DTMF character sent from the client application. DTMF characters
|
|
918
917
|
* are typically sent from a phone keypad to represent numbers. For
|
|
919
918
|
* example, you can have Amazon Lex V2 process a credit card number input from a
|
|
920
919
|
* phone.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
export interface DTMFInputEvent {
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>The DTMF character that the user pressed. The allowed characters are
|
|
926
925
|
* A - D, 0 - 9, # and *.</p>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
inputCharacter: string | undefined;
|
|
929
929
|
/**
|
|
930
|
-
* @public
|
|
931
930
|
* <p>A unique identifier that your application assigns to the event. You
|
|
932
931
|
* can use this to identify events in logs.</p>
|
|
932
|
+
* @public
|
|
933
933
|
*/
|
|
934
934
|
eventId?: string;
|
|
935
935
|
/**
|
|
936
|
-
* @public
|
|
937
936
|
* <p>A timestamp set by the client of the date and time that the event
|
|
938
937
|
* was sent to Amazon Lex V2.</p>
|
|
938
|
+
* @public
|
|
939
939
|
*/
|
|
940
940
|
clientTimestampMillis?: number;
|
|
941
941
|
}
|
|
942
942
|
/**
|
|
943
|
-
* @public
|
|
944
943
|
* <p>Event sent from the client application to Amazon Lex V2 to indicate that
|
|
945
944
|
* playback of audio is complete and that Amazon Lex V2 should start processing
|
|
946
945
|
* the user's input.</p>
|
|
946
|
+
* @public
|
|
947
947
|
*/
|
|
948
948
|
export interface PlaybackCompletionEvent {
|
|
949
949
|
/**
|
|
950
|
-
* @public
|
|
951
950
|
* <p>A unique identifier that your application assigns to the event. You
|
|
952
951
|
* can use this to identify events in logs.</p>
|
|
952
|
+
* @public
|
|
953
953
|
*/
|
|
954
954
|
eventId?: string;
|
|
955
955
|
/**
|
|
956
|
-
* @public
|
|
957
956
|
* <p>A timestamp set by the client of the date and time that the event
|
|
958
957
|
* was sent to Amazon Lex V2.</p>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
clientTimestampMillis?: number;
|
|
961
961
|
}
|
|
962
962
|
/**
|
|
963
|
-
* @public
|
|
964
963
|
* <p>The event sent from your client application to Amazon Lex V2 with text input
|
|
965
964
|
* from the user.</p>
|
|
965
|
+
* @public
|
|
966
966
|
*/
|
|
967
967
|
export interface TextInputEvent {
|
|
968
968
|
/**
|
|
969
|
-
* @public
|
|
970
969
|
* <p>The text from the user. Amazon Lex V2 processes this as a complete
|
|
971
970
|
* statement.</p>
|
|
971
|
+
* @public
|
|
972
972
|
*/
|
|
973
973
|
text: string | undefined;
|
|
974
974
|
/**
|
|
975
|
-
* @public
|
|
976
975
|
* <p>A unique identifier that your application assigns to the event. You
|
|
977
976
|
* can use this to identify events in logs.</p>
|
|
977
|
+
* @public
|
|
978
978
|
*/
|
|
979
979
|
eventId?: string;
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p>A timestamp set by the client of the date and time that the event
|
|
983
982
|
* was sent to Amazon Lex V2.</p>
|
|
983
|
+
* @public
|
|
984
984
|
*/
|
|
985
985
|
clientTimestampMillis?: number;
|
|
986
986
|
}
|
|
987
987
|
/**
|
|
988
|
-
* @public
|
|
989
988
|
* <p>Event that Amazon Lex V2 sends to indicate that the stream is still open
|
|
990
989
|
* between the client application and Amazon Lex V2 </p>
|
|
990
|
+
* @public
|
|
991
991
|
*/
|
|
992
992
|
export interface HeartbeatEvent {
|
|
993
993
|
/**
|
|
994
|
-
* @public
|
|
995
994
|
* <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
|
|
996
995
|
* the form <code>RESPONSE-N</code>, where N is a number starting with one
|
|
997
996
|
* and incremented for each event sent by Amazon Lex V2 in the current
|
|
998
997
|
* session.</p>
|
|
998
|
+
* @public
|
|
999
999
|
*/
|
|
1000
1000
|
eventId?: string;
|
|
1001
1001
|
}
|
|
@@ -1026,100 +1026,99 @@ export declare const PlaybackInterruptionReason: {
|
|
|
1026
1026
|
*/
|
|
1027
1027
|
export type PlaybackInterruptionReason = (typeof PlaybackInterruptionReason)[keyof typeof PlaybackInterruptionReason];
|
|
1028
1028
|
/**
|
|
1029
|
-
* @public
|
|
1030
1029
|
* <p>Event sent from Amazon Lex V2 to indicate to the client application should
|
|
1031
1030
|
* stop playback of audio. For example, if the client is playing a prompt
|
|
1032
1031
|
* that asks for the user's telephone number, the user might start to say
|
|
1033
1032
|
* the phone number before the prompt is complete. Amazon Lex V2 sends this event
|
|
1034
1033
|
* to the client application to indicate that the user is responding and
|
|
1035
1034
|
* that Amazon Lex V2 is processing their input.</p>
|
|
1035
|
+
* @public
|
|
1036
1036
|
*/
|
|
1037
1037
|
export interface PlaybackInterruptionEvent {
|
|
1038
1038
|
/**
|
|
1039
|
-
* @public
|
|
1040
1039
|
* <p>Indicates the type of user input that Amazon Lex V2 detected.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
eventReason?: PlaybackInterruptionReason;
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>The identifier of the event that contained the audio, DTMF, or text
|
|
1046
1045
|
* that caused the interruption.</p>
|
|
1046
|
+
* @public
|
|
1047
1047
|
*/
|
|
1048
1048
|
causedByEventId?: string;
|
|
1049
1049
|
/**
|
|
1050
|
-
* @public
|
|
1051
1050
|
* <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
|
|
1052
1051
|
* the form <code>RESPONSE-N</code>, where N is a number starting with one
|
|
1053
1052
|
* and incremented for each event sent by Amazon Lex V2 in the current
|
|
1054
1053
|
* session.</p>
|
|
1054
|
+
* @public
|
|
1055
1055
|
*/
|
|
1056
1056
|
eventId?: string;
|
|
1057
1057
|
}
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>The event sent from Amazon Lex V2 to your application with text to present
|
|
1061
1060
|
* to the user.</p>
|
|
1061
|
+
* @public
|
|
1062
1062
|
*/
|
|
1063
1063
|
export interface TextResponseEvent {
|
|
1064
1064
|
/**
|
|
1065
|
-
* @public
|
|
1066
1065
|
* <p>A list of messages to send to the user. Messages are ordered based
|
|
1067
1066
|
* on the order that you returned the messages from your Lambda function
|
|
1068
1067
|
* or the order that the messages are defined in the bot.</p>
|
|
1068
|
+
* @public
|
|
1069
1069
|
*/
|
|
1070
1070
|
messages?: Message[];
|
|
1071
1071
|
/**
|
|
1072
|
-
* @public
|
|
1073
1072
|
* <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
|
|
1074
1073
|
* the form <code>RESPONSE-N</code>, where N is a number starting with one
|
|
1075
1074
|
* and incremented for each event sent by Amazon Lex V2 in the current
|
|
1076
1075
|
* session.</p>
|
|
1076
|
+
* @public
|
|
1077
1077
|
*/
|
|
1078
1078
|
eventId?: string;
|
|
1079
1079
|
}
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>Event sent from Amazon Lex V2 to your client application that contains a
|
|
1083
1082
|
* transcript of voice audio. </p>
|
|
1083
|
+
* @public
|
|
1084
1084
|
*/
|
|
1085
1085
|
export interface TranscriptEvent {
|
|
1086
1086
|
/**
|
|
1087
|
-
* @public
|
|
1088
1087
|
* <p>The transcript of the voice audio from the user.</p>
|
|
1088
|
+
* @public
|
|
1089
1089
|
*/
|
|
1090
1090
|
transcript?: string;
|
|
1091
1091
|
/**
|
|
1092
|
-
* @public
|
|
1093
1092
|
* <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
|
|
1094
1093
|
* the form <code>RESPONSE-N</code>, where N is a number starting with one
|
|
1095
1094
|
* and incremented for each event sent by Amazon Lex V2 in the current
|
|
1096
1095
|
* session.</p>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
eventId?: string;
|
|
1099
1099
|
}
|
|
1100
1100
|
/**
|
|
1101
|
-
* @public
|
|
1102
1101
|
* <p>The specific constituent sub slot of the composite slot to elicit in dialog action.</p>
|
|
1102
|
+
* @public
|
|
1103
1103
|
*/
|
|
1104
1104
|
export interface ElicitSubSlot {
|
|
1105
1105
|
/**
|
|
1106
|
-
* @public
|
|
1107
1106
|
* <p>The name of the slot that should be elicited from the user.</p>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
name: string | undefined;
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>The field is not supported.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
subSlotToElicit?: ElicitSubSlot;
|
|
1115
1115
|
}
|
|
1116
1116
|
/**
|
|
1117
|
-
* @public
|
|
1118
1117
|
* <p>The next action that Amazon Lex V2 should take.</p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
export interface DialogAction {
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>The next action that the bot should take in its interaction with the
|
|
1124
1123
|
* user. The following values are possible:</p>
|
|
1125
1124
|
* <ul>
|
|
@@ -1151,15 +1150,15 @@ export interface DialogAction {
|
|
|
1151
1150
|
* value from the user.</p>
|
|
1152
1151
|
* </li>
|
|
1153
1152
|
* </ul>
|
|
1153
|
+
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
type: DialogActionType | undefined;
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p>The name of the slot that should be elicited from the user.</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
slotToElicit?: string;
|
|
1161
1161
|
/**
|
|
1162
|
-
* @public
|
|
1163
1162
|
* <p>Configures the slot to use spell-by-letter or spell-by-word style.
|
|
1164
1163
|
* When you use a style on a slot, users can spell out their input to make
|
|
1165
1164
|
* it clear to your bot.</p>
|
|
@@ -1174,39 +1173,39 @@ export interface DialogAction {
|
|
|
1174
1173
|
* </ul>
|
|
1175
1174
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/spelling-styles.html">
|
|
1176
1175
|
* Using spelling to enter slot values </a>.</p>
|
|
1176
|
+
* @public
|
|
1177
1177
|
*/
|
|
1178
1178
|
slotElicitationStyle?: StyleType;
|
|
1179
1179
|
/**
|
|
1180
|
-
* @public
|
|
1181
1180
|
* <p>The name of the constituent sub slot of the composite slot
|
|
1182
1181
|
* specified in slotToElicit that should be elicited from the user.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
subSlotToElicit?: ElicitSubSlot;
|
|
1185
1185
|
}
|
|
1186
1186
|
/**
|
|
1187
|
-
* @public
|
|
1188
1187
|
* <p>Provides an array of phrases that should be given preference when
|
|
1189
1188
|
* resolving values for a slot.</p>
|
|
1189
|
+
* @public
|
|
1190
1190
|
*/
|
|
1191
1191
|
export interface RuntimeHintDetails {
|
|
1192
1192
|
/**
|
|
1193
|
-
* @public
|
|
1194
1193
|
* <p>One or more strings that Amazon Lex V2 should look for in the input to the
|
|
1195
1194
|
* bot. Each phrase is given preference when deciding on slot
|
|
1196
1195
|
* values.</p>
|
|
1196
|
+
* @public
|
|
1197
1197
|
*/
|
|
1198
1198
|
runtimeHintValues?: RuntimeHintValue[];
|
|
1199
1199
|
/**
|
|
1200
|
-
* @public
|
|
1201
1200
|
* <p>A map of constituent sub slot names inside a composite slot in the intent and the phrases
|
|
1202
1201
|
* that should be added for each sub slot. Inside each composite slot hints, this structure provides
|
|
1203
1202
|
* a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots.
|
|
1204
1203
|
* The intent name, composite slot name and the constituent sub slot names must exist.</p>
|
|
1204
|
+
* @public
|
|
1205
1205
|
*/
|
|
1206
1206
|
subSlotHints?: Record<string, RuntimeHintDetails>;
|
|
1207
1207
|
}
|
|
1208
1208
|
/**
|
|
1209
|
-
* @public
|
|
1210
1209
|
* <p>You can provide Amazon Lex V2 with hints to the phrases that a customer is
|
|
1211
1210
|
* likely to use for a slot. When a slot with hints is resolved, the
|
|
1212
1211
|
* phrases in the runtime hints are preferred in the resolution. You can
|
|
@@ -1216,10 +1215,10 @@ export interface RuntimeHintDetails {
|
|
|
1216
1215
|
* first rebuild the bot.</p>
|
|
1217
1216
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html">Using runtime hints to
|
|
1218
1217
|
* improve recognition of slot values</a>.</p>
|
|
1218
|
+
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
export interface RuntimeHints {
|
|
1221
1221
|
/**
|
|
1222
|
-
* @public
|
|
1223
1222
|
* <p>A list of the slots in the intent that should have runtime hints
|
|
1224
1223
|
* added, and the phrases that should be added for each slot.</p>
|
|
1225
1224
|
* <p>The first level of the <code>slotHints</code> map is the name of the
|
|
@@ -1227,59 +1226,59 @@ export interface RuntimeHints {
|
|
|
1227
1226
|
* more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html">Using hints to improve
|
|
1228
1227
|
* accuracy</a>.</p>
|
|
1229
1228
|
* <p>The intent name and slot name must exist.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
slotHints?: Record<string, Record<string, RuntimeHintDetails>>;
|
|
1232
1232
|
}
|
|
1233
1233
|
/**
|
|
1234
|
-
* @public
|
|
1235
1234
|
* <p>A value that Amazon Lex V2 uses to fulfill an intent. </p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
export interface Slot {
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>The current value of the slot.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
value?: Value;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>When the <code>shape</code> value is <code>List</code>, it indicates
|
|
1246
1245
|
* that the <code>values</code> field contains a list of slot values. When
|
|
1247
1246
|
* the value is <code>Scalar</code>, it indicates that the
|
|
1248
1247
|
* <code>value</code> field contains a single value.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
shape?: Shape;
|
|
1251
1251
|
/**
|
|
1252
|
-
* @public
|
|
1253
1252
|
* <p>A list of one or more values that the user provided for the slot.
|
|
1254
1253
|
* For example, if a for a slot that elicits pizza toppings, the values
|
|
1255
1254
|
* might be "pepperoni" and "pineapple." </p>
|
|
1255
|
+
* @public
|
|
1256
1256
|
*/
|
|
1257
1257
|
values?: Slot[];
|
|
1258
1258
|
/**
|
|
1259
|
-
* @public
|
|
1260
1259
|
* <p>The constituent sub slots of a composite slot.</p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
subSlots?: Record<string, Slot>;
|
|
1263
1263
|
}
|
|
1264
1264
|
/**
|
|
1265
|
-
* @public
|
|
1266
1265
|
* <p>The current intent that Amazon Lex V2 is attempting to fulfill.</p>
|
|
1266
|
+
* @public
|
|
1267
1267
|
*/
|
|
1268
1268
|
export interface Intent {
|
|
1269
1269
|
/**
|
|
1270
|
-
* @public
|
|
1271
1270
|
* <p>The name of the intent.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
name: string | undefined;
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>A map of all of the slots for the intent. The name of the slot maps
|
|
1277
1276
|
* to the value of the slot. If a slot has not been filled, the value is
|
|
1278
1277
|
* null.</p>
|
|
1278
|
+
* @public
|
|
1279
1279
|
*/
|
|
1280
1280
|
slots?: Record<string, Slot>;
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>Indicates the fulfillment state for the intent. The meanings of each value are as follows:</p>
|
|
1284
1283
|
* <ul>
|
|
1285
1284
|
* <li>
|
|
@@ -1307,110 +1306,110 @@ export interface Intent {
|
|
|
1307
1306
|
* <code>Waiting</code> – The bot is waiting for a response from the user (limited to streaming conversations).</p>
|
|
1308
1307
|
* </li>
|
|
1309
1308
|
* </ul>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
state?: IntentState;
|
|
1312
1312
|
/**
|
|
1313
|
-
* @public
|
|
1314
1313
|
* <p>Indicates whether the intent has been <code>Confirmed</code>, <code>Denied</code>, or <code>None</code> if the confirmation stage has not yet been reached.</p>
|
|
1314
|
+
* @public
|
|
1315
1315
|
*/
|
|
1316
1316
|
confirmationState?: ConfirmationState;
|
|
1317
1317
|
}
|
|
1318
1318
|
/**
|
|
1319
|
-
* @public
|
|
1320
1319
|
* <p>An object containing information about an intent that Amazon Lex V2 determined might satisfy the user's utterance.
|
|
1321
1320
|
* The intents are ordered by the confidence score. </p>
|
|
1321
|
+
* @public
|
|
1322
1322
|
*/
|
|
1323
1323
|
export interface Interpretation {
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>Determines the threshold where Amazon Lex V2 will insert the
|
|
1327
1326
|
* <code>AMAZON.FallbackIntent</code>,
|
|
1328
1327
|
* <code>AMAZON.KendraSearchIntent</code>, or both when returning
|
|
1329
1328
|
* alternative intents in a response. <code>AMAZON.FallbackIntent</code>
|
|
1330
1329
|
* and <code>AMAZON.KendraSearchIntent</code> are only inserted if they
|
|
1331
1330
|
* are configured for the bot.</p>
|
|
1331
|
+
* @public
|
|
1332
1332
|
*/
|
|
1333
1333
|
nluConfidence?: ConfidenceScore;
|
|
1334
1334
|
/**
|
|
1335
|
-
* @public
|
|
1336
1335
|
* <p>The sentiment expressed in an utterance. </p>
|
|
1337
1336
|
* <p>When the bot is configured to send utterances to Amazon Comprehend
|
|
1338
1337
|
* for sentiment analysis, this field contains the result of the
|
|
1339
1338
|
* analysis.</p>
|
|
1339
|
+
* @public
|
|
1340
1340
|
*/
|
|
1341
1341
|
sentimentResponse?: SentimentResponse;
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>A list of intents that might satisfy the user's utterance. The
|
|
1345
1344
|
* intents are ordered by the confidence score.</p>
|
|
1345
|
+
* @public
|
|
1346
1346
|
*/
|
|
1347
1347
|
intent?: Intent;
|
|
1348
1348
|
/**
|
|
1349
|
-
* @public
|
|
1350
1349
|
* <p>Specifies the service that interpreted the input.</p>
|
|
1350
|
+
* @public
|
|
1351
1351
|
*/
|
|
1352
1352
|
interpretationSource?: InterpretationSource;
|
|
1353
1353
|
}
|
|
1354
1354
|
/**
|
|
1355
|
-
* @public
|
|
1356
1355
|
* <p>The state of the user's session with Amazon Lex V2.</p>
|
|
1356
|
+
* @public
|
|
1357
1357
|
*/
|
|
1358
1358
|
export interface SessionState {
|
|
1359
1359
|
/**
|
|
1360
|
-
* @public
|
|
1361
1360
|
* <p>The next step that Amazon Lex V2 should take in the conversation with a
|
|
1362
1361
|
* user.</p>
|
|
1362
|
+
* @public
|
|
1363
1363
|
*/
|
|
1364
1364
|
dialogAction?: DialogAction;
|
|
1365
1365
|
/**
|
|
1366
|
-
* @public
|
|
1367
1366
|
* <p>The active intent that Amazon Lex V2 is processing.</p>
|
|
1367
|
+
* @public
|
|
1368
1368
|
*/
|
|
1369
1369
|
intent?: Intent;
|
|
1370
1370
|
/**
|
|
1371
|
-
* @public
|
|
1372
1371
|
* <p>One or more contexts that indicate to Amazon Lex V2 the context of a
|
|
1373
1372
|
* request. When a context is active, Amazon Lex V2 considers intents with the
|
|
1374
1373
|
* matching context as a trigger as the next intent in a session.</p>
|
|
1374
|
+
* @public
|
|
1375
1375
|
*/
|
|
1376
1376
|
activeContexts?: ActiveContext[];
|
|
1377
1377
|
/**
|
|
1378
|
-
* @public
|
|
1379
1378
|
* <p>Map of key/value pairs representing session-specific context
|
|
1380
1379
|
* information. It contains application information passed between Amazon Lex V2
|
|
1381
1380
|
* and a client application.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
sessionAttributes?: Record<string, string>;
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>A unique identifier for a specific request.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
originatingRequestId?: string;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2
|
|
1392
1391
|
* uses the hints to help determine the correct value of a slot.</p>
|
|
1392
|
+
* @public
|
|
1393
1393
|
*/
|
|
1394
1394
|
runtimeHints?: RuntimeHints;
|
|
1395
1395
|
}
|
|
1396
1396
|
/**
|
|
1397
|
-
* @public
|
|
1398
1397
|
* <p>The initial event sent from the application to Amazon Lex V2 to configure
|
|
1399
1398
|
* the conversation, including session and request attributes and the
|
|
1400
1399
|
* response content type.</p>
|
|
1400
|
+
* @public
|
|
1401
1401
|
*/
|
|
1402
1402
|
export interface ConfigurationEvent {
|
|
1403
1403
|
/**
|
|
1404
|
-
* @public
|
|
1405
1404
|
* <p>Request-specific information passed between the client application
|
|
1406
1405
|
* and Amazon Lex V2.</p>
|
|
1407
1406
|
* <p>The namespace <code>x-amz-lex:</code> is reserved for special
|
|
1408
1407
|
* attributes. Don't create any request attributes for prefix
|
|
1409
1408
|
* <code>x-amz-lex:</code>.</p>
|
|
1409
|
+
* @public
|
|
1410
1410
|
*/
|
|
1411
1411
|
requestAttributes?: Record<string, string>;
|
|
1412
1412
|
/**
|
|
1413
|
-
* @public
|
|
1414
1413
|
* <p>The message that Amazon Lex V2 returns in the response can be either text or
|
|
1415
1414
|
* speech based on the <code>responseContentType</code> value.</p>
|
|
1416
1415
|
* <ul>
|
|
@@ -1451,15 +1450,15 @@ export interface ConfigurationEvent {
|
|
|
1451
1450
|
* </ul>
|
|
1452
1451
|
* </li>
|
|
1453
1452
|
* </ul>
|
|
1453
|
+
* @public
|
|
1454
1454
|
*/
|
|
1455
1455
|
responseContentType: string | undefined;
|
|
1456
1456
|
/**
|
|
1457
|
-
* @public
|
|
1458
1457
|
* <p>The state of the user's session with Amazon Lex V2.</p>
|
|
1458
|
+
* @public
|
|
1459
1459
|
*/
|
|
1460
1460
|
sessionState?: SessionState;
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>A list of messages to send to the user.</p>
|
|
1464
1463
|
* <p>If you set the <code>welcomeMessage</code> field, you must also set
|
|
1465
1464
|
* the <a href="https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html">
|
|
@@ -1467,10 +1466,10 @@ export interface ConfigurationEvent {
|
|
|
1467
1466
|
* </a> structure's <a href="https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type">
|
|
1468
1467
|
* <code>type</code>
|
|
1469
1468
|
* </a> field.</p>
|
|
1469
|
+
* @public
|
|
1470
1470
|
*/
|
|
1471
1471
|
welcomeMessages?: Message[];
|
|
1472
1472
|
/**
|
|
1473
|
-
* @public
|
|
1474
1473
|
* <p>Determines whether Amazon Lex V2 should send audio responses to the client
|
|
1475
1474
|
* application.
|
|
1476
1475
|
* </p>
|
|
@@ -1479,18 +1478,19 @@ export interface ConfigurationEvent {
|
|
|
1479
1478
|
* operating in playback mode, such as a text chat application, set this
|
|
1480
1479
|
* to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on
|
|
1481
1480
|
* the client.</p>
|
|
1481
|
+
* @public
|
|
1482
1482
|
*/
|
|
1483
1483
|
disablePlayback?: boolean;
|
|
1484
1484
|
/**
|
|
1485
|
-
* @public
|
|
1486
1485
|
* <p>A unique identifier that your application assigns to the event. You
|
|
1487
1486
|
* can use this to identify events in logs.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
eventId?: string;
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>A timestamp set by the client of the date and time that the event
|
|
1493
1492
|
* was sent to Amazon Lex V2.</p>
|
|
1493
|
+
* @public
|
|
1494
1494
|
*/
|
|
1495
1495
|
clientTimestampMillis?: number;
|
|
1496
1496
|
}
|
|
@@ -1499,51 +1499,50 @@ export interface ConfigurationEvent {
|
|
|
1499
1499
|
*/
|
|
1500
1500
|
export interface PutSessionRequest {
|
|
1501
1501
|
/**
|
|
1502
|
-
* @public
|
|
1503
1502
|
* <p>The identifier of the bot that receives the session data.</p>
|
|
1503
|
+
* @public
|
|
1504
1504
|
*/
|
|
1505
1505
|
botId: string | undefined;
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>The alias identifier of the bot that receives the session
|
|
1509
1508
|
* data.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
botAliasId: string | undefined;
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>The locale where the session is in use.</p>
|
|
1514
|
+
* @public
|
|
1515
1515
|
*/
|
|
1516
1516
|
localeId: string | undefined;
|
|
1517
1517
|
/**
|
|
1518
|
-
* @public
|
|
1519
1518
|
* <p>The identifier of the session that receives the session data.</p>
|
|
1519
|
+
* @public
|
|
1520
1520
|
*/
|
|
1521
1521
|
sessionId: string | undefined;
|
|
1522
1522
|
/**
|
|
1523
|
-
* @public
|
|
1524
1523
|
* <p>A list of messages to send to the user. Messages are sent in the
|
|
1525
1524
|
* order that they are defined in the list.</p>
|
|
1525
|
+
* @public
|
|
1526
1526
|
*/
|
|
1527
1527
|
messages?: Message[];
|
|
1528
1528
|
/**
|
|
1529
|
-
* @public
|
|
1530
1529
|
* <p>Sets the state of the session with the user. You can use this to set
|
|
1531
1530
|
* the current intent, attributes, context, and dialog action. Use the
|
|
1532
1531
|
* dialog action to determine the next step that Amazon Lex V2 should use in the
|
|
1533
1532
|
* conversation with the user.</p>
|
|
1533
|
+
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
sessionState: SessionState | undefined;
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>Request-specific information passed between Amazon Lex V2 and the client
|
|
1539
1538
|
* application.</p>
|
|
1540
1539
|
* <p>The namespace <code>x-amz-lex:</code> is reserved for special
|
|
1541
1540
|
* attributes. Don't create any request attributes with the prefix
|
|
1542
1541
|
* <code>x-amz-lex:</code>.</p>
|
|
1542
|
+
* @public
|
|
1543
1543
|
*/
|
|
1544
1544
|
requestAttributes?: Record<string, string>;
|
|
1545
1545
|
/**
|
|
1546
|
-
* @public
|
|
1547
1546
|
* <p>The message that Amazon Lex V2 returns in the response can be either text or
|
|
1548
1547
|
* speech depending on the value of this parameter. </p>
|
|
1549
1548
|
* <ul>
|
|
@@ -1552,6 +1551,7 @@ export interface PutSessionRequest {
|
|
|
1552
1551
|
* returns text in the response.</p>
|
|
1553
1552
|
* </li>
|
|
1554
1553
|
* </ul>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
responseContentType?: string;
|
|
1557
1557
|
}
|
|
@@ -1560,51 +1560,51 @@ export interface PutSessionRequest {
|
|
|
1560
1560
|
*/
|
|
1561
1561
|
export interface RecognizeTextRequest {
|
|
1562
1562
|
/**
|
|
1563
|
-
* @public
|
|
1564
1563
|
* <p>The identifier of the bot that processes the request.</p>
|
|
1564
|
+
* @public
|
|
1565
1565
|
*/
|
|
1566
1566
|
botId: string | undefined;
|
|
1567
1567
|
/**
|
|
1568
|
-
* @public
|
|
1569
1568
|
* <p>The alias identifier in use for the bot that processes the
|
|
1570
1569
|
* request.</p>
|
|
1570
|
+
* @public
|
|
1571
1571
|
*/
|
|
1572
1572
|
botAliasId: string | undefined;
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>The locale where the session is in use.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
localeId: string | undefined;
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>The identifier of the user session that is having the
|
|
1581
1580
|
* conversation.</p>
|
|
1581
|
+
* @public
|
|
1582
1582
|
*/
|
|
1583
1583
|
sessionId: string | undefined;
|
|
1584
1584
|
/**
|
|
1585
|
-
* @public
|
|
1586
1585
|
* <p>The text that the user entered. Amazon Lex V2 interprets this text.</p>
|
|
1586
|
+
* @public
|
|
1587
1587
|
*/
|
|
1588
1588
|
text: string | undefined;
|
|
1589
1589
|
/**
|
|
1590
|
-
* @public
|
|
1591
1590
|
* <p>The current state of the dialog between the user and the bot.</p>
|
|
1591
|
+
* @public
|
|
1592
1592
|
*/
|
|
1593
1593
|
sessionState?: SessionState;
|
|
1594
1594
|
/**
|
|
1595
|
-
* @public
|
|
1596
1595
|
* <p>Request-specific information passed between the client application
|
|
1597
1596
|
* and Amazon Lex V2 </p>
|
|
1598
1597
|
* <p>The namespace <code>x-amz-lex:</code> is reserved for special
|
|
1599
1598
|
* attributes. Don't create any request attributes with the prefix
|
|
1600
1599
|
* <code>x-amz-lex:</code>.</p>
|
|
1600
|
+
* @public
|
|
1601
1601
|
*/
|
|
1602
1602
|
requestAttributes?: Record<string, string>;
|
|
1603
1603
|
}
|
|
1604
1604
|
/**
|
|
1605
|
-
* @public
|
|
1606
1605
|
* <p>Represents a stream of events between your application and
|
|
1607
1606
|
* Amazon Lex V2.</p>
|
|
1607
|
+
* @public
|
|
1608
1608
|
*/
|
|
1609
1609
|
export type StartConversationRequestEventStream = StartConversationRequestEventStream.AudioInputEventMember | StartConversationRequestEventStream.ConfigurationEventMember | StartConversationRequestEventStream.DTMFInputEventMember | StartConversationRequestEventStream.DisconnectionEventMember | StartConversationRequestEventStream.PlaybackCompletionEventMember | StartConversationRequestEventStream.TextInputEventMember | StartConversationRequestEventStream.$UnknownMember;
|
|
1610
1610
|
/**
|
|
@@ -1612,9 +1612,9 @@ export type StartConversationRequestEventStream = StartConversationRequestEventS
|
|
|
1612
1612
|
*/
|
|
1613
1613
|
export declare namespace StartConversationRequestEventStream {
|
|
1614
1614
|
/**
|
|
1615
|
-
* @public
|
|
1616
1615
|
* <p>Configuration information sent from your client application to
|
|
1617
1616
|
* Amazon Lex V2</p>
|
|
1617
|
+
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
interface ConfigurationEventMember {
|
|
1620
1620
|
ConfigurationEvent: ConfigurationEvent;
|
|
@@ -1626,10 +1626,10 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1626
1626
|
$unknown?: never;
|
|
1627
1627
|
}
|
|
1628
1628
|
/**
|
|
1629
|
-
* @public
|
|
1630
1629
|
* <p>Speech audio sent from your client application to Amazon Lex V2. Audio
|
|
1631
1630
|
* starts accumulating when Amazon Lex V2 identifies a voice and continues until a
|
|
1632
1631
|
* natural pause in the speech is found before processing.</p>
|
|
1632
|
+
* @public
|
|
1633
1633
|
*/
|
|
1634
1634
|
interface AudioInputEventMember {
|
|
1635
1635
|
ConfigurationEvent?: never;
|
|
@@ -1641,7 +1641,6 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1641
1641
|
$unknown?: never;
|
|
1642
1642
|
}
|
|
1643
1643
|
/**
|
|
1644
|
-
* @public
|
|
1645
1644
|
* <p>DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2
|
|
1646
1645
|
* accumulates the DMTF information from when the user sends the first
|
|
1647
1646
|
* character and ends</p>
|
|
@@ -1659,6 +1658,7 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1659
1658
|
* character configuration.</p>
|
|
1660
1659
|
* </li>
|
|
1661
1660
|
* </ul>
|
|
1661
|
+
* @public
|
|
1662
1662
|
*/
|
|
1663
1663
|
interface DTMFInputEventMember {
|
|
1664
1664
|
ConfigurationEvent?: never;
|
|
@@ -1670,9 +1670,9 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1670
1670
|
$unknown?: never;
|
|
1671
1671
|
}
|
|
1672
1672
|
/**
|
|
1673
|
-
* @public
|
|
1674
1673
|
* <p>Text sent from your client application to Amazon Lex V2. Each
|
|
1675
1674
|
* <code>TextInputEvent</code> is processed individually.</p>
|
|
1675
|
+
* @public
|
|
1676
1676
|
*/
|
|
1677
1677
|
interface TextInputEventMember {
|
|
1678
1678
|
ConfigurationEvent?: never;
|
|
@@ -1684,10 +1684,10 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1684
1684
|
$unknown?: never;
|
|
1685
1685
|
}
|
|
1686
1686
|
/**
|
|
1687
|
-
* @public
|
|
1688
1687
|
* <p>Event sent from the client application to Amazon Lex V2 to indicate that it
|
|
1689
1688
|
* has finished playing audio and that Amazon Lex V2 should start listening for
|
|
1690
1689
|
* user input.</p>
|
|
1690
|
+
* @public
|
|
1691
1691
|
*/
|
|
1692
1692
|
interface PlaybackCompletionEventMember {
|
|
1693
1693
|
ConfigurationEvent?: never;
|
|
@@ -1699,9 +1699,9 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1699
1699
|
$unknown?: never;
|
|
1700
1700
|
}
|
|
1701
1701
|
/**
|
|
1702
|
-
* @public
|
|
1703
1702
|
* <p>Event sent from the client application to indicate to Amazon Lex V2 that the
|
|
1704
1703
|
* conversation is over.</p>
|
|
1704
|
+
* @public
|
|
1705
1705
|
*/
|
|
1706
1706
|
interface DisconnectionEventMember {
|
|
1707
1707
|
ConfigurationEvent?: never;
|
|
@@ -1740,39 +1740,39 @@ export declare namespace StartConversationRequestEventStream {
|
|
|
1740
1740
|
*/
|
|
1741
1741
|
export interface StartConversationRequest {
|
|
1742
1742
|
/**
|
|
1743
|
-
* @public
|
|
1744
1743
|
* <p>The identifier of the bot to process the request.</p>
|
|
1744
|
+
* @public
|
|
1745
1745
|
*/
|
|
1746
1746
|
botId: string | undefined;
|
|
1747
1747
|
/**
|
|
1748
|
-
* @public
|
|
1749
1748
|
* <p>The alias identifier in use for the bot that processes the
|
|
1750
1749
|
* request.</p>
|
|
1750
|
+
* @public
|
|
1751
1751
|
*/
|
|
1752
1752
|
botAliasId: string | undefined;
|
|
1753
1753
|
/**
|
|
1754
|
-
* @public
|
|
1755
1754
|
* <p>The locale where the session is in use.</p>
|
|
1755
|
+
* @public
|
|
1756
1756
|
*/
|
|
1757
1757
|
localeId: string | undefined;
|
|
1758
1758
|
/**
|
|
1759
|
-
* @public
|
|
1760
1759
|
* <p>The identifier of the user session that is having the
|
|
1761
1760
|
* conversation.</p>
|
|
1761
|
+
* @public
|
|
1762
1762
|
*/
|
|
1763
1763
|
sessionId: string | undefined;
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>The conversation type that you are using the Amazon Lex V2. If the
|
|
1767
1766
|
* conversation mode is <code>AUDIO</code> you can send both audio and
|
|
1768
1767
|
* DTMF information. If the mode is <code>TEXT</code> you can only send
|
|
1769
1768
|
* text.</p>
|
|
1769
|
+
* @public
|
|
1770
1770
|
*/
|
|
1771
1771
|
conversationMode?: ConversationMode;
|
|
1772
1772
|
/**
|
|
1773
|
-
* @public
|
|
1774
1773
|
* <p>Represents the stream of events to Amazon Lex V2 from your application. The
|
|
1775
1774
|
* events are encoded as HTTP/2 data frames.</p>
|
|
1775
|
+
* @public
|
|
1776
1776
|
*/
|
|
1777
1777
|
requestEventStream: AsyncIterable<StartConversationRequestEventStream> | undefined;
|
|
1778
1778
|
}
|
|
@@ -1781,84 +1781,84 @@ export interface StartConversationRequest {
|
|
|
1781
1781
|
*/
|
|
1782
1782
|
export interface GetSessionResponse {
|
|
1783
1783
|
/**
|
|
1784
|
-
* @public
|
|
1785
1784
|
* <p>The identifier of the returned session.</p>
|
|
1785
|
+
* @public
|
|
1786
1786
|
*/
|
|
1787
1787
|
sessionId?: string;
|
|
1788
1788
|
/**
|
|
1789
|
-
* @public
|
|
1790
1789
|
* <p>A list of messages that were last sent to the user. The messages are
|
|
1791
1790
|
* ordered based on the order that your returned the messages from your
|
|
1792
1791
|
* Lambda function or the order that messages are defined in the bot.
|
|
1793
1792
|
* </p>
|
|
1793
|
+
* @public
|
|
1794
1794
|
*/
|
|
1795
1795
|
messages?: Message[];
|
|
1796
1796
|
/**
|
|
1797
|
-
* @public
|
|
1798
1797
|
* <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
|
|
1799
1798
|
* utterance. </p>
|
|
1800
1799
|
* <p>Each interpretation includes the intent, a score that indicates how
|
|
1801
1800
|
* confident Amazon Lex V2 is that the interpretation is the correct one, and an
|
|
1802
1801
|
* optional sentiment response that indicates the sentiment expressed in
|
|
1803
1802
|
* the utterance.</p>
|
|
1803
|
+
* @public
|
|
1804
1804
|
*/
|
|
1805
1805
|
interpretations?: Interpretation[];
|
|
1806
1806
|
/**
|
|
1807
|
-
* @public
|
|
1808
1807
|
* <p>Represents the current state of the dialog between the user and the
|
|
1809
1808
|
* bot.</p>
|
|
1810
1809
|
* <p>You can use this to determine the progress of the conversation and
|
|
1811
1810
|
* what the next action might be.</p>
|
|
1811
|
+
* @public
|
|
1812
1812
|
*/
|
|
1813
1813
|
sessionState?: SessionState;
|
|
1814
1814
|
}
|
|
1815
1815
|
/**
|
|
1816
|
-
* @public
|
|
1817
1816
|
* <p>Contains the current state of the conversation between the client
|
|
1818
1817
|
* application and Amazon Lex V2.</p>
|
|
1818
|
+
* @public
|
|
1819
1819
|
*/
|
|
1820
1820
|
export interface IntentResultEvent {
|
|
1821
1821
|
/**
|
|
1822
|
-
* @public
|
|
1823
1822
|
* <p>Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.</p>
|
|
1823
|
+
* @public
|
|
1824
1824
|
*/
|
|
1825
1825
|
inputMode?: InputMode;
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
|
|
1829
1828
|
* utterance.</p>
|
|
1830
1829
|
* <p>Each interpretation includes the intent, a score that indicates how
|
|
1831
1830
|
* confident Amazon Lex V2 is that the interpretation is the correct one, and an
|
|
1832
1831
|
* optional sentiment response that indicates the sentiment expressed in
|
|
1833
1832
|
* the utterance.</p>
|
|
1833
|
+
* @public
|
|
1834
1834
|
*/
|
|
1835
1835
|
interpretations?: Interpretation[];
|
|
1836
1836
|
/**
|
|
1837
|
-
* @public
|
|
1838
1837
|
* <p>The state of the user's session with Amazon Lex V2.</p>
|
|
1838
|
+
* @public
|
|
1839
1839
|
*/
|
|
1840
1840
|
sessionState?: SessionState;
|
|
1841
1841
|
/**
|
|
1842
|
-
* @public
|
|
1843
1842
|
* <p>The attributes sent in the request.</p>
|
|
1843
|
+
* @public
|
|
1844
1844
|
*/
|
|
1845
1845
|
requestAttributes?: Record<string, string>;
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>The identifier of the session in use.</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
sessionId?: string;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
|
|
1854
1853
|
* the form <code>RESPONSE-N</code>, where N is a number starting with one
|
|
1855
1854
|
* and incremented for each event sent by Amazon Lex V2 in the current
|
|
1856
1855
|
* session.</p>
|
|
1856
|
+
* @public
|
|
1857
1857
|
*/
|
|
1858
1858
|
eventId?: string;
|
|
1859
1859
|
/**
|
|
1860
|
-
* @public
|
|
1861
1860
|
* <p>The bot member that is processing the intent.</p>
|
|
1861
|
+
* @public
|
|
1862
1862
|
*/
|
|
1863
1863
|
recognizedBotMember?: RecognizedBotMember;
|
|
1864
1864
|
}
|
|
@@ -1867,50 +1867,50 @@ export interface IntentResultEvent {
|
|
|
1867
1867
|
*/
|
|
1868
1868
|
export interface RecognizeTextResponse {
|
|
1869
1869
|
/**
|
|
1870
|
-
* @public
|
|
1871
1870
|
* <p>A list of messages last sent to the user. The messages are ordered
|
|
1872
1871
|
* based on the order that you returned the messages from your Lambda
|
|
1873
1872
|
* function or the order that the messages are defined in the bot.</p>
|
|
1873
|
+
* @public
|
|
1874
1874
|
*/
|
|
1875
1875
|
messages?: Message[];
|
|
1876
1876
|
/**
|
|
1877
|
-
* @public
|
|
1878
1877
|
* <p>Represents the current state of the dialog between the user and the
|
|
1879
1878
|
* bot. </p>
|
|
1880
1879
|
* <p>Use this to determine the progress of the conversation and what the
|
|
1881
1880
|
* next action may be.</p>
|
|
1881
|
+
* @public
|
|
1882
1882
|
*/
|
|
1883
1883
|
sessionState?: SessionState;
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
|
|
1887
1886
|
* utterance. </p>
|
|
1888
1887
|
* <p>Each interpretation includes the intent, a score that indicates now
|
|
1889
1888
|
* confident Amazon Lex V2 is that the interpretation is the correct one, and an
|
|
1890
1889
|
* optional sentiment response that indicates the sentiment expressed in
|
|
1891
1890
|
* the utterance.</p>
|
|
1891
|
+
* @public
|
|
1892
1892
|
*/
|
|
1893
1893
|
interpretations?: Interpretation[];
|
|
1894
1894
|
/**
|
|
1895
|
-
* @public
|
|
1896
1895
|
* <p>The attributes sent in the request.</p>
|
|
1896
|
+
* @public
|
|
1897
1897
|
*/
|
|
1898
1898
|
requestAttributes?: Record<string, string>;
|
|
1899
1899
|
/**
|
|
1900
|
-
* @public
|
|
1901
1900
|
* <p>The identifier of the session in use.</p>
|
|
1901
|
+
* @public
|
|
1902
1902
|
*/
|
|
1903
1903
|
sessionId?: string;
|
|
1904
1904
|
/**
|
|
1905
|
-
* @public
|
|
1906
1905
|
* <p>The bot member that recognized the text.</p>
|
|
1906
|
+
* @public
|
|
1907
1907
|
*/
|
|
1908
1908
|
recognizedBotMember?: RecognizedBotMember;
|
|
1909
1909
|
}
|
|
1910
1910
|
/**
|
|
1911
|
-
* @public
|
|
1912
1911
|
* <p>Represents a stream of events between Amazon Lex V2 and your
|
|
1913
1912
|
* application.</p>
|
|
1913
|
+
* @public
|
|
1914
1914
|
*/
|
|
1915
1915
|
export type StartConversationResponseEventStream = StartConversationResponseEventStream.AccessDeniedExceptionMember | StartConversationResponseEventStream.AudioResponseEventMember | StartConversationResponseEventStream.BadGatewayExceptionMember | StartConversationResponseEventStream.ConflictExceptionMember | StartConversationResponseEventStream.DependencyFailedExceptionMember | StartConversationResponseEventStream.HeartbeatEventMember | StartConversationResponseEventStream.IntentResultEventMember | StartConversationResponseEventStream.InternalServerExceptionMember | StartConversationResponseEventStream.PlaybackInterruptionEventMember | StartConversationResponseEventStream.ResourceNotFoundExceptionMember | StartConversationResponseEventStream.TextResponseEventMember | StartConversationResponseEventStream.ThrottlingExceptionMember | StartConversationResponseEventStream.TranscriptEventMember | StartConversationResponseEventStream.ValidationExceptionMember | StartConversationResponseEventStream.$UnknownMember;
|
|
1916
1916
|
/**
|
|
@@ -1918,13 +1918,13 @@ export type StartConversationResponseEventStream = StartConversationResponseEven
|
|
|
1918
1918
|
*/
|
|
1919
1919
|
export declare namespace StartConversationResponseEventStream {
|
|
1920
1920
|
/**
|
|
1921
|
-
* @public
|
|
1922
1921
|
* <p>Event sent from Amazon Lex V2 to indicate to the client application should
|
|
1923
1922
|
* stop playback of audio. For example, if the client is playing a prompt
|
|
1924
1923
|
* that asks for the user's telephone number, the user might start to say
|
|
1925
1924
|
* the phone number before the prompt is complete. Amazon Lex V2 sends this event
|
|
1926
1925
|
* to the client application to indicate that the user is responding and
|
|
1927
1926
|
* that Amazon Lex V2 is processing their input.</p>
|
|
1927
|
+
* @public
|
|
1928
1928
|
*/
|
|
1929
1929
|
interface PlaybackInterruptionEventMember {
|
|
1930
1930
|
PlaybackInterruptionEvent: PlaybackInterruptionEvent;
|
|
@@ -1944,9 +1944,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
1944
1944
|
$unknown?: never;
|
|
1945
1945
|
}
|
|
1946
1946
|
/**
|
|
1947
|
-
* @public
|
|
1948
1947
|
* <p>Event sent from Amazon Lex V2 to your client application that contains a
|
|
1949
1948
|
* transcript of voice audio. </p>
|
|
1949
|
+
* @public
|
|
1950
1950
|
*/
|
|
1951
1951
|
interface TranscriptEventMember {
|
|
1952
1952
|
PlaybackInterruptionEvent?: never;
|
|
@@ -1966,9 +1966,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
1966
1966
|
$unknown?: never;
|
|
1967
1967
|
}
|
|
1968
1968
|
/**
|
|
1969
|
-
* @public
|
|
1970
1969
|
* <p>Event sent from Amazon Lex V2 to the client application containing the
|
|
1971
1970
|
* current state of the conversation between the user and Amazon Lex V2.</p>
|
|
1971
|
+
* @public
|
|
1972
1972
|
*/
|
|
1973
1973
|
interface IntentResultEventMember {
|
|
1974
1974
|
PlaybackInterruptionEvent?: never;
|
|
@@ -1988,9 +1988,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
1988
1988
|
$unknown?: never;
|
|
1989
1989
|
}
|
|
1990
1990
|
/**
|
|
1991
|
-
* @public
|
|
1992
1991
|
* <p>The event sent from Amazon Lex V2 to your application with text to present
|
|
1993
1992
|
* to the user.</p>
|
|
1993
|
+
* @public
|
|
1994
1994
|
*/
|
|
1995
1995
|
interface TextResponseEventMember {
|
|
1996
1996
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2010,9 +2010,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2010
2010
|
$unknown?: never;
|
|
2011
2011
|
}
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>An event sent from Amazon Lex V2 to your client application containing audio
|
|
2015
2014
|
* to play to the user. </p>
|
|
2015
|
+
* @public
|
|
2016
2016
|
*/
|
|
2017
2017
|
interface AudioResponseEventMember {
|
|
2018
2018
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2032,9 +2032,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2032
2032
|
$unknown?: never;
|
|
2033
2033
|
}
|
|
2034
2034
|
/**
|
|
2035
|
-
* @public
|
|
2036
2035
|
* <p>Event that Amazon Lex V2 sends to indicate that the stream is still open
|
|
2037
2036
|
* between the client application and Amazon Lex V2 </p>
|
|
2037
|
+
* @public
|
|
2038
2038
|
*/
|
|
2039
2039
|
interface HeartbeatEventMember {
|
|
2040
2040
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2054,11 +2054,11 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2054
2054
|
$unknown?: never;
|
|
2055
2055
|
}
|
|
2056
2056
|
/**
|
|
2057
|
-
* @public
|
|
2058
2057
|
* <p>Exception thrown when the credentials passed with the request are
|
|
2059
2058
|
* invalid or expired. Also thrown when the credentials in the request do
|
|
2060
2059
|
* not have permission to access the <code>StartConversation</code>
|
|
2061
2060
|
* operation.</p>
|
|
2061
|
+
* @public
|
|
2062
2062
|
*/
|
|
2063
2063
|
interface AccessDeniedExceptionMember {
|
|
2064
2064
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2078,10 +2078,10 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2078
2078
|
$unknown?: never;
|
|
2079
2079
|
}
|
|
2080
2080
|
/**
|
|
2081
|
-
* @public
|
|
2082
2081
|
* <p>Exception thrown if one of the input parameters points to a resource
|
|
2083
2082
|
* that does not exist. For example, if the bot ID specified does not
|
|
2084
2083
|
* exist.</p>
|
|
2084
|
+
* @public
|
|
2085
2085
|
*/
|
|
2086
2086
|
interface ResourceNotFoundExceptionMember {
|
|
2087
2087
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2101,10 +2101,10 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2101
2101
|
$unknown?: never;
|
|
2102
2102
|
}
|
|
2103
2103
|
/**
|
|
2104
|
-
* @public
|
|
2105
2104
|
* <p>Exception thrown when one or more parameters could not be validated.
|
|
2106
2105
|
* The <code>message</code> contains the name of the field that isn't
|
|
2107
2106
|
* valid.</p>
|
|
2107
|
+
* @public
|
|
2108
2108
|
*/
|
|
2109
2109
|
interface ValidationExceptionMember {
|
|
2110
2110
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2124,9 +2124,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2124
2124
|
$unknown?: never;
|
|
2125
2125
|
}
|
|
2126
2126
|
/**
|
|
2127
|
-
* @public
|
|
2128
2127
|
* <p>Exception thrown when your application exceeds the maximum number of
|
|
2129
2128
|
* concurrent requests. </p>
|
|
2129
|
+
* @public
|
|
2130
2130
|
*/
|
|
2131
2131
|
interface ThrottlingExceptionMember {
|
|
2132
2132
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2146,8 +2146,8 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2146
2146
|
$unknown?: never;
|
|
2147
2147
|
}
|
|
2148
2148
|
/**
|
|
2149
|
-
* @public
|
|
2150
2149
|
* <p>An error occurred with Amazon Lex V2.</p>
|
|
2150
|
+
* @public
|
|
2151
2151
|
*/
|
|
2152
2152
|
interface InternalServerExceptionMember {
|
|
2153
2153
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2167,9 +2167,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2167
2167
|
$unknown?: never;
|
|
2168
2168
|
}
|
|
2169
2169
|
/**
|
|
2170
|
-
* @public
|
|
2171
2170
|
* <p>Exception thrown when two clients are using the same AWS account,
|
|
2172
2171
|
* Amazon Lex V2 bot, and session ID.</p>
|
|
2172
|
+
* @public
|
|
2173
2173
|
*/
|
|
2174
2174
|
interface ConflictExceptionMember {
|
|
2175
2175
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2189,8 +2189,8 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2189
2189
|
$unknown?: never;
|
|
2190
2190
|
}
|
|
2191
2191
|
/**
|
|
2192
|
-
* @public
|
|
2193
2192
|
* <p></p>
|
|
2193
|
+
* @public
|
|
2194
2194
|
*/
|
|
2195
2195
|
interface DependencyFailedExceptionMember {
|
|
2196
2196
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2210,8 +2210,8 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2210
2210
|
$unknown?: never;
|
|
2211
2211
|
}
|
|
2212
2212
|
/**
|
|
2213
|
-
* @public
|
|
2214
2213
|
* <p></p>
|
|
2214
|
+
* @public
|
|
2215
2215
|
*/
|
|
2216
2216
|
interface BadGatewayExceptionMember {
|
|
2217
2217
|
PlaybackInterruptionEvent?: never;
|
|
@@ -2274,9 +2274,9 @@ export declare namespace StartConversationResponseEventStream {
|
|
|
2274
2274
|
*/
|
|
2275
2275
|
export interface StartConversationResponse {
|
|
2276
2276
|
/**
|
|
2277
|
-
* @public
|
|
2278
2277
|
* <p>Represents the stream of events from Amazon Lex V2 to your application. The
|
|
2279
2278
|
* events are encoded as HTTP/2 data frames.</p>
|
|
2279
|
+
* @public
|
|
2280
2280
|
*/
|
|
2281
2281
|
responseEventStream?: AsyncIterable<StartConversationResponseEventStream>;
|
|
2282
2282
|
}
|