@aws-sdk/client-lex-runtime-v2 3.34.0 → 3.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/LexRuntimeV2.js +1 -5
  3. package/{dist/cjs → dist-cjs}/LexRuntimeV2Client.js +10 -19
  4. package/dist-cjs/commands/DeleteSessionCommand.js +36 -0
  5. package/{dist/cjs → dist-cjs}/commands/GetSessionCommand.js +2 -35
  6. package/{dist/cjs → dist-cjs}/commands/PutSessionCommand.js +2 -29
  7. package/{dist/cjs → dist-cjs}/commands/RecognizeTextCommand.js +2 -31
  8. package/dist-cjs/commands/RecognizeUtteranceCommand.js +36 -0
  9. package/dist-cjs/commands/StartConversationCommand.js +38 -0
  10. package/{dist/cjs → dist-cjs}/endpoints.js +1 -2
  11. package/{dist/cjs → dist-cjs}/index.js +0 -1
  12. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  13. package/{dist/cjs → dist-cjs}/models/models_0.js +2 -145
  14. package/{dist/cjs → dist-cjs}/protocols/Aws_restJson1.js +1 -7
  15. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  16. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  17. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  18. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  19. package/{dist/es → dist-es}/LexRuntimeV2.js +1 -2
  20. package/{dist/es → dist-es}/LexRuntimeV2Client.js +1 -2
  21. package/{dist/es → dist-es}/commands/DeleteSessionCommand.js +2 -3
  22. package/{dist/es → dist-es}/commands/GetSessionCommand.js +2 -3
  23. package/{dist/es → dist-es}/commands/PutSessionCommand.js +2 -3
  24. package/{dist/es → dist-es}/commands/RecognizeTextCommand.js +2 -3
  25. package/{dist/es → dist-es}/commands/RecognizeUtteranceCommand.js +2 -3
  26. package/{dist/es → dist-es}/commands/StartConversationCommand.js +2 -3
  27. package/{dist/es → dist-es}/endpoints.js +1 -2
  28. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  29. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  30. package/{dist/es → dist-es}/models/models_0.js +2 -1
  31. package/{dist/es → dist-es}/protocols/Aws_restJson1.js +1 -2
  32. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -2
  33. package/{dist/es → dist-es}/runtimeConfig.js +1 -2
  34. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -1
  35. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -2
  36. package/{dist/types/ts3.4 → dist-types}/LexRuntimeV2.d.ts +223 -139
  37. package/{dist/types → dist-types}/LexRuntimeV2Client.d.ts +7 -7
  38. package/{dist/types → dist-types}/commands/DeleteSessionCommand.d.ts +2 -2
  39. package/{dist/types → dist-types}/commands/GetSessionCommand.d.ts +2 -2
  40. package/{dist/types → dist-types}/commands/PutSessionCommand.d.ts +2 -2
  41. package/{dist/types → dist-types}/commands/RecognizeTextCommand.d.ts +28 -2
  42. package/{dist/types → dist-types}/commands/RecognizeUtteranceCommand.d.ts +28 -2
  43. package/{dist/types → dist-types}/commands/StartConversationCommand.d.ts +34 -2
  44. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  45. package/{index.ts → dist-types/index.d.ts} +0 -0
  46. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  47. package/{dist/types → dist-types}/models/models_0.d.ts +15 -9
  48. package/{dist/types → dist-types}/protocols/Aws_restJson1.d.ts +2 -2
  49. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  50. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  51. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  52. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  53. package/dist-types/ts3.4/LexRuntimeV2.d.ts +35 -0
  54. package/{dist/types → dist-types}/ts3.4/LexRuntimeV2Client.d.ts +33 -103
  55. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +17 -0
  56. package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +17 -0
  57. package/dist-types/ts3.4/commands/PutSessionCommand.d.ts +17 -0
  58. package/dist-types/ts3.4/commands/RecognizeTextCommand.d.ts +17 -0
  59. package/dist-types/ts3.4/commands/RecognizeUtteranceCommand.d.ts +24 -0
  60. package/dist-types/ts3.4/commands/StartConversationCommand.d.ts +17 -0
  61. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  62. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  63. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  64. package/dist-types/ts3.4/models/models_0.d.ts +348 -0
  65. package/{dist/types → dist-types}/ts3.4/protocols/Aws_restJson1.d.ts +2 -2
  66. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  67. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  68. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  69. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  70. package/package.json +50 -47
  71. package/LexRuntimeV2.ts +0 -299
  72. package/LexRuntimeV2Client.ts +0 -282
  73. package/commands/DeleteSessionCommand.ts +0 -107
  74. package/commands/GetSessionCommand.ts +0 -102
  75. package/commands/PutSessionCommand.ts +0 -96
  76. package/commands/RecognizeTextCommand.ts +0 -98
  77. package/commands/RecognizeUtteranceCommand.ts +0 -139
  78. package/commands/StartConversationCommand.ts +0 -130
  79. package/dist/cjs/LexRuntimeV2.js.map +0 -1
  80. package/dist/cjs/LexRuntimeV2Client.js.map +0 -1
  81. package/dist/cjs/commands/DeleteSessionCommand.js +0 -74
  82. package/dist/cjs/commands/DeleteSessionCommand.js.map +0 -1
  83. package/dist/cjs/commands/GetSessionCommand.js.map +0 -1
  84. package/dist/cjs/commands/PutSessionCommand.js.map +0 -1
  85. package/dist/cjs/commands/RecognizeTextCommand.js.map +0 -1
  86. package/dist/cjs/commands/RecognizeUtteranceCommand.js +0 -97
  87. package/dist/cjs/commands/RecognizeUtteranceCommand.js.map +0 -1
  88. package/dist/cjs/commands/StartConversationCommand.js +0 -90
  89. package/dist/cjs/commands/StartConversationCommand.js.map +0 -1
  90. package/dist/cjs/endpoints.js.map +0 -1
  91. package/dist/cjs/index.js.map +0 -1
  92. package/dist/cjs/models/index.js.map +0 -1
  93. package/dist/cjs/models/models_0.js.map +0 -1
  94. package/dist/cjs/package.json +0 -96
  95. package/dist/cjs/protocols/Aws_restJson1.js.map +0 -1
  96. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  97. package/dist/cjs/runtimeConfig.js.map +0 -1
  98. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  99. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  100. package/dist/es/LexRuntimeV2.js.map +0 -1
  101. package/dist/es/LexRuntimeV2Client.js.map +0 -1
  102. package/dist/es/commands/DeleteSessionCommand.js.map +0 -1
  103. package/dist/es/commands/GetSessionCommand.js.map +0 -1
  104. package/dist/es/commands/PutSessionCommand.js.map +0 -1
  105. package/dist/es/commands/RecognizeTextCommand.js.map +0 -1
  106. package/dist/es/commands/RecognizeUtteranceCommand.js.map +0 -1
  107. package/dist/es/commands/StartConversationCommand.js.map +0 -1
  108. package/dist/es/endpoints.js.map +0 -1
  109. package/dist/es/index.js +0 -10
  110. package/dist/es/index.js.map +0 -1
  111. package/dist/es/models/index.js +0 -2
  112. package/dist/es/models/index.js.map +0 -1
  113. package/dist/es/models/models_0.js.map +0 -1
  114. package/dist/es/package.json +0 -96
  115. package/dist/es/protocols/Aws_restJson1.js.map +0 -1
  116. package/dist/es/runtimeConfig.browser.js.map +0 -1
  117. package/dist/es/runtimeConfig.js.map +0 -1
  118. package/dist/es/runtimeConfig.native.js.map +0 -1
  119. package/dist/es/runtimeConfig.shared.js.map +0 -1
  120. package/dist/types/LexRuntimeV2.d.ts +0 -139
  121. package/dist/types/ts3.4/commands/DeleteSessionCommand.d.ts +0 -48
  122. package/dist/types/ts3.4/commands/GetSessionCommand.d.ts +0 -43
  123. package/dist/types/ts3.4/commands/PutSessionCommand.d.ts +0 -37
  124. package/dist/types/ts3.4/commands/RecognizeTextCommand.d.ts +0 -39
  125. package/dist/types/ts3.4/commands/RecognizeUtteranceCommand.d.ts +0 -82
  126. package/dist/types/ts3.4/commands/StartConversationCommand.d.ts +0 -62
  127. package/dist/types/ts3.4/models/models_0.d.ts +0 -2035
  128. package/endpoints.ts +0 -57
  129. package/jest.config.js +0 -4
  130. package/models/models_0.ts +0 -2458
  131. package/protocols/Aws_restJson1.ts +0 -2458
  132. package/runtimeConfig.browser.ts +0 -45
  133. package/runtimeConfig.native.ts +0 -20
  134. package/runtimeConfig.shared.ts +0 -16
  135. package/runtimeConfig.ts +0 -49
  136. package/tsconfig.es.json +0 -10
  137. package/tsconfig.json +0 -31
  138. package/tsconfig.types.json +0 -8
@@ -1,2035 +0,0 @@
1
- /// <reference types="node" />
2
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
- import { Readable } from "stream";
4
- /**
5
- * <p></p>
6
- */
7
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
8
- name: "AccessDeniedException";
9
- $fault: "client";
10
- message: string | undefined;
11
- }
12
- export declare namespace AccessDeniedException {
13
- /**
14
- * @internal
15
- */
16
- const filterSensitiveLog: (obj: AccessDeniedException) => any;
17
- }
18
- /**
19
- * <p>The time that a context is active. You can specify the time to live
20
- * in seconds or in conversation turns.</p>
21
- */
22
- export interface ActiveContextTimeToLive {
23
- /**
24
- * <p>The number of seconds that the context is active. You can specify
25
- * between 5 and 86400 seconds (24 hours).</p>
26
- */
27
- timeToLiveInSeconds: number | undefined;
28
- /**
29
- * <p>The number of turns that the context is active. You can specify up
30
- * to 20 turns. Each request and response from the bot is a turn.</p>
31
- */
32
- turnsToLive: number | undefined;
33
- }
34
- export declare namespace ActiveContextTimeToLive {
35
- /**
36
- * @internal
37
- */
38
- const filterSensitiveLog: (obj: ActiveContextTimeToLive) => any;
39
- }
40
- /**
41
- * <p>Contains information about the contexts that a user is using in a
42
- * session. You can configure Amazon Lex V2 to set a context when an intent is
43
- * fulfilled, or you can set a context using the , , or operations.</p>
44
- * <p>Use a context to indicate to Amazon Lex V2 intents that should be used as
45
- * follow-up intents. For example, if the active context is
46
- * <code>order-fulfilled</code>, only intents that have
47
- * <code>order-fulfilled</code> configured as a trigger are considered
48
- * for follow up.</p>
49
- */
50
- export interface ActiveContext {
51
- /**
52
- * <p>The name of the context.</p>
53
- */
54
- name: string | undefined;
55
- /**
56
- * <p>Indicates the number of turns or seconds that the context is active.
57
- * Once the time to live expires, the context is no longer returned in a
58
- * response.</p>
59
- */
60
- timeToLive: ActiveContextTimeToLive | undefined;
61
- /**
62
- * <p>A lis tof contexts active for the request. A context can be
63
- * activated when a previous intent is fulfilled, or by including the
64
- * context in the request.</p>
65
- * <p>If you don't specify a list of contexts, Amazon Lex will use the
66
- * current list of contexts for the session. If you specify an empty list,
67
- * all contexts for the session are cleared. </p>
68
- */
69
- contextAttributes: {
70
- [key: string]: string;
71
- } | undefined;
72
- }
73
- export declare namespace ActiveContext {
74
- /**
75
- * @internal
76
- */
77
- const filterSensitiveLog: (obj: ActiveContext) => any;
78
- }
79
- /**
80
- * <p>Represents a chunk of audio sent from the client application to
81
- * Amazon Lex V2. The audio is all or part of an utterance from the user.</p>
82
- * <p>Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause
83
- * in speech before processing the input.</p>
84
- */
85
- export interface AudioInputEvent {
86
- /**
87
- * <p>An encoded stream of audio.</p>
88
- */
89
- audioChunk?: Uint8Array;
90
- /**
91
- * <p>The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit
92
- * mono-channel little-endian format. The value of the field should
93
- * be:</p>
94
- * <p>
95
- * <code>audio/lpcm; sample-rate=8000; sample-size-bits=16;
96
- * channel-count=1; is-big-endian=false</code>
97
- * </p>
98
- */
99
- contentType: string | undefined;
100
- /**
101
- * <p>A unique identifier that your application assigns to the event. You
102
- * can use this to identify events in logs.</p>
103
- */
104
- eventId?: string;
105
- /**
106
- * <p>A timestamp set by the client of the date and time that the event
107
- * was sent to Amazon Lex V2.</p>
108
- */
109
- clientTimestampMillis?: number;
110
- }
111
- export declare namespace AudioInputEvent {
112
- /**
113
- * @internal
114
- */
115
- const filterSensitiveLog: (obj: AudioInputEvent) => any;
116
- }
117
- /**
118
- * <p>An event sent from Amazon Lex V2 to your client application containing audio
119
- * to play to the user. </p>
120
- */
121
- export interface AudioResponseEvent {
122
- /**
123
- * <p>A chunk of the audio to play. </p>
124
- */
125
- audioChunk?: Uint8Array;
126
- /**
127
- * <p>The encoding of the audio chunk. This is the same as the encoding
128
- * configure in the <code>contentType</code> field of the
129
- * <code>ConfigurationEvent</code>.</p>
130
- */
131
- contentType?: string;
132
- /**
133
- * <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
134
- * the form <code>RESPONSE-N</code>, where N is a number starting with one
135
- * and incremented for each event sent by Amazon Lex V2 in the current
136
- * session.</p>
137
- */
138
- eventId?: string;
139
- }
140
- export declare namespace AudioResponseEvent {
141
- /**
142
- * @internal
143
- */
144
- const filterSensitiveLog: (obj: AudioResponseEvent) => any;
145
- }
146
- /**
147
- * <p></p>
148
- */
149
- export interface ConflictException extends __SmithyException, $MetadataBearer {
150
- name: "ConflictException";
151
- $fault: "client";
152
- message: string | undefined;
153
- }
154
- export declare namespace ConflictException {
155
- /**
156
- * @internal
157
- */
158
- const filterSensitiveLog: (obj: ConflictException) => any;
159
- }
160
- export interface DeleteSessionRequest {
161
- /**
162
- * <p>The identifier of the bot that contains the session data.</p>
163
- */
164
- botId: string | undefined;
165
- /**
166
- * <p>The alias identifier in use for the bot that contains the session
167
- * data.</p>
168
- */
169
- botAliasId: string | undefined;
170
- /**
171
- * <p>The locale where the session is in use.</p>
172
- */
173
- localeId: string | undefined;
174
- /**
175
- * <p>The identifier of the session to delete.</p>
176
- */
177
- sessionId: string | undefined;
178
- }
179
- export declare namespace DeleteSessionRequest {
180
- /**
181
- * @internal
182
- */
183
- const filterSensitiveLog: (obj: DeleteSessionRequest) => any;
184
- }
185
- export interface DeleteSessionResponse {
186
- /**
187
- * <p>The identifier of the bot that contained the session data.</p>
188
- */
189
- botId?: string;
190
- /**
191
- * <p>The alias identifier in use for the bot that contained the session
192
- * data.</p>
193
- */
194
- botAliasId?: string;
195
- /**
196
- * <p>The locale where the session was used.</p>
197
- */
198
- localeId?: string;
199
- /**
200
- * <p>The identifier of the deleted session.</p>
201
- */
202
- sessionId?: string;
203
- }
204
- export declare namespace DeleteSessionResponse {
205
- /**
206
- * @internal
207
- */
208
- const filterSensitiveLog: (obj: DeleteSessionResponse) => any;
209
- }
210
- /**
211
- * <p></p>
212
- */
213
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
214
- name: "InternalServerException";
215
- $fault: "server";
216
- message: string | undefined;
217
- }
218
- export declare namespace InternalServerException {
219
- /**
220
- * @internal
221
- */
222
- const filterSensitiveLog: (obj: InternalServerException) => any;
223
- }
224
- /**
225
- * <p></p>
226
- */
227
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
228
- name: "ResourceNotFoundException";
229
- $fault: "client";
230
- message: string | undefined;
231
- }
232
- export declare namespace ResourceNotFoundException {
233
- /**
234
- * @internal
235
- */
236
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
237
- }
238
- /**
239
- * <p></p>
240
- */
241
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
242
- name: "ThrottlingException";
243
- $fault: "client";
244
- message: string | undefined;
245
- }
246
- export declare namespace ThrottlingException {
247
- /**
248
- * @internal
249
- */
250
- const filterSensitiveLog: (obj: ThrottlingException) => any;
251
- }
252
- /**
253
- * <p></p>
254
- */
255
- export interface ValidationException extends __SmithyException, $MetadataBearer {
256
- name: "ValidationException";
257
- $fault: "client";
258
- message: string | undefined;
259
- }
260
- export declare namespace ValidationException {
261
- /**
262
- * @internal
263
- */
264
- const filterSensitiveLog: (obj: ValidationException) => any;
265
- }
266
- export interface GetSessionRequest {
267
- /**
268
- * <p>The identifier of the bot that contains the session data.</p>
269
- */
270
- botId: string | undefined;
271
- /**
272
- * <p>The alias identifier in use for the bot that contains the session
273
- * data.</p>
274
- */
275
- botAliasId: string | undefined;
276
- /**
277
- * <p>The locale where the session is in use.</p>
278
- */
279
- localeId: string | undefined;
280
- /**
281
- * <p>The identifier of the session to return.</p>
282
- */
283
- sessionId: string | undefined;
284
- }
285
- export declare namespace GetSessionRequest {
286
- /**
287
- * @internal
288
- */
289
- const filterSensitiveLog: (obj: GetSessionRequest) => any;
290
- }
291
- export declare enum ConfirmationState {
292
- CONFIRMED = "Confirmed",
293
- DENIED = "Denied",
294
- NONE = "None"
295
- }
296
- export declare enum Shape {
297
- LIST = "List",
298
- SCALAR = "Scalar"
299
- }
300
- /**
301
- * <p>The value of a slot.</p>
302
- */
303
- export interface Value {
304
- /**
305
- * <p>The text of the utterance from the user that was entered for the
306
- * slot.</p>
307
- */
308
- originalValue?: string;
309
- /**
310
- * <p>The value that Amazon Lex V2 determines for the slot. The actual value
311
- * depends on the setting of the value selection strategy for the bot. You
312
- * can choose to use the value entered by the user, or you can have Amazon Lex V2
313
- * choose the first value in the <code>resolvedValues</code> list.</p>
314
- */
315
- interpretedValue: string | undefined;
316
- /**
317
- * <p>A list of additional values that have been recognized for the
318
- * slot.</p>
319
- */
320
- resolvedValues?: string[];
321
- }
322
- export declare namespace Value {
323
- /**
324
- * @internal
325
- */
326
- const filterSensitiveLog: (obj: Value) => any;
327
- }
328
- export declare enum IntentState {
329
- FAILED = "Failed",
330
- FULFILLED = "Fulfilled",
331
- IN_PROGRESS = "InProgress",
332
- READY_FOR_FULFILLMENT = "ReadyForFulfillment",
333
- WAITING = "Waiting"
334
- }
335
- /**
336
- * <p>Provides a score that indicates the confidence that Amazon Lex V2 has that
337
- * an intent is the one that satisfies the user's intent.</p>
338
- */
339
- export interface ConfidenceScore {
340
- /**
341
- * <p>A score that indicates how confident Amazon Lex V2 is that an intent
342
- * satisfies the user's intent. Ranges between 0.00 and 1.00. Higher
343
- * scores indicate higher confidence.</p>
344
- */
345
- score?: number;
346
- }
347
- export declare namespace ConfidenceScore {
348
- /**
349
- * @internal
350
- */
351
- const filterSensitiveLog: (obj: ConfidenceScore) => any;
352
- }
353
- export declare enum SentimentType {
354
- MIXED = "MIXED",
355
- NEGATIVE = "NEGATIVE",
356
- NEUTRAL = "NEUTRAL",
357
- POSITIVE = "POSITIVE"
358
- }
359
- /**
360
- * <p>The individual sentiment responses for the utterance.</p>
361
- */
362
- export interface SentimentScore {
363
- /**
364
- * <p>The level of confidence that Amazon Comprehend has in the accuracy
365
- * of its detection of the <code>POSITIVE</code> sentiment.</p>
366
- */
367
- positive?: number;
368
- /**
369
- * <p>The level of confidence that Amazon Comprehend has in the accuracy
370
- * of its detection of the <code>NEGATIVE</code> sentiment.</p>
371
- */
372
- negative?: number;
373
- /**
374
- * <p>The level of confidence that Amazon Comprehend has in the accuracy
375
- * of its detection of the <code>NEUTRAL</code> sentiment.</p>
376
- */
377
- neutral?: number;
378
- /**
379
- * <p>The level of confidence that Amazon Comprehend has in the accuracy
380
- * of its detection of the <code>MIXED</code> sentiment.</p>
381
- */
382
- mixed?: number;
383
- }
384
- export declare namespace SentimentScore {
385
- /**
386
- * @internal
387
- */
388
- const filterSensitiveLog: (obj: SentimentScore) => any;
389
- }
390
- /**
391
- * <p>Provides information about the sentiment expressed in a user's
392
- * response in a conversation. Sentiments are determined using Amazon
393
- * Comprehend. Sentiments are only returned if they are enabled for the
394
- * bot.</p>
395
- * <p>For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html">
396
- * Determine Sentiment </a> in the <i>Amazon Comprehend
397
- * developer guide</i>.</p>
398
- */
399
- export interface SentimentResponse {
400
- /**
401
- * <p>The overall sentiment expressed in the user's response. This is the
402
- * sentiment most likely expressed by the user based on the analysis by
403
- * Amazon Comprehend.</p>
404
- */
405
- sentiment?: SentimentType | string;
406
- /**
407
- * <p>The individual sentiment responses for the utterance.</p>
408
- */
409
- sentimentScore?: SentimentScore;
410
- }
411
- export declare namespace SentimentResponse {
412
- /**
413
- * @internal
414
- */
415
- const filterSensitiveLog: (obj: SentimentResponse) => any;
416
- }
417
- export declare enum MessageContentType {
418
- CUSTOM_PAYLOAD = "CustomPayload",
419
- IMAGE_RESPONSE_CARD = "ImageResponseCard",
420
- PLAIN_TEXT = "PlainText",
421
- SSML = "SSML"
422
- }
423
- /**
424
- * <p>A button that appears on a response card show to the user.</p>
425
- */
426
- export interface Button {
427
- /**
428
- * <p>The text that is displayed on the button.</p>
429
- */
430
- text: string | undefined;
431
- /**
432
- * <p>The value returned to Amazon Lex V2 when a user chooses the button.</p>
433
- */
434
- value: string | undefined;
435
- }
436
- export declare namespace Button {
437
- /**
438
- * @internal
439
- */
440
- const filterSensitiveLog: (obj: Button) => any;
441
- }
442
- /**
443
- * <p>A card that is shown to the user by a messaging platform. You define
444
- * the contents of the card, the card is displayed by the platform. </p>
445
- * <p>When you use a response card, the response from the user is
446
- * constrained to the text associated with a button on the card.</p>
447
- */
448
- export interface ImageResponseCard {
449
- /**
450
- * <p>The title to display on the response card. The format of the title
451
- * is determined by the platform displaying the response card.</p>
452
- */
453
- title: string | undefined;
454
- /**
455
- * <p>The subtitle to display on the response card. The format of the
456
- * subtitle is determined by the platform displaying the response
457
- * card.</p>
458
- */
459
- subtitle?: string;
460
- /**
461
- * <p>The URL of an image to display on the response card. The image URL
462
- * must be publicly available so that the platform displaying the response
463
- * card has access to the image.</p>
464
- */
465
- imageUrl?: string;
466
- /**
467
- * <p>A list of buttons that should be displayed on the response card. The
468
- * arrangement of the buttons is determined by the platform that displays
469
- * the button.</p>
470
- */
471
- buttons?: Button[];
472
- }
473
- export declare namespace ImageResponseCard {
474
- /**
475
- * @internal
476
- */
477
- const filterSensitiveLog: (obj: ImageResponseCard) => any;
478
- }
479
- /**
480
- * <p>Container for text that is returned to the customer..</p>
481
- */
482
- export interface Message {
483
- /**
484
- * <p>The text of the message.</p>
485
- */
486
- content?: string;
487
- /**
488
- * <p>Indicates the type of response.</p>
489
- */
490
- contentType: MessageContentType | string | undefined;
491
- /**
492
- * <p>A card that is shown to the user by a messaging platform. You define
493
- * the contents of the card, the card is displayed by the platform. </p>
494
- * <p>When you use a response card, the response from the user is
495
- * constrained to the text associated with a button on the card.</p>
496
- */
497
- imageResponseCard?: ImageResponseCard;
498
- }
499
- export declare namespace Message {
500
- /**
501
- * @internal
502
- */
503
- const filterSensitiveLog: (obj: Message) => any;
504
- }
505
- export declare enum DialogActionType {
506
- CLOSE = "Close",
507
- CONFIRM_INTENT = "ConfirmIntent",
508
- DELEGATE = "Delegate",
509
- ELICIT_INTENT = "ElicitIntent",
510
- ELICIT_SLOT = "ElicitSlot"
511
- }
512
- /**
513
- * <p>The next action that Amazon Lex V2 should take.</p>
514
- */
515
- export interface DialogAction {
516
- /**
517
- * <p>The next action that the bot should take in its interaction with the
518
- * user. The possible values are:</p>
519
- * <ul>
520
- * <li>
521
- * <p>
522
- * <code>Close</code> - Indicates that there will not be a
523
- * response from the user. For example, the statement "Your order
524
- * has been placed" does not require a response.</p>
525
- * </li>
526
- * <li>
527
- * <p>
528
- * <code>ConfirmIntent</code> - The next action is asking the
529
- * user if the intent is complete and ready to be fulfilled. This is
530
- * a yes/no question such as "Place the order?"</p>
531
- * </li>
532
- * <li>
533
- * <p>
534
- * <code>Delegate</code> - The next action is determined by
535
- * Amazon Lex V2.</p>
536
- * </li>
537
- * <li>
538
- * <p>
539
- * <code>ElicitSlot</code> - The next action is to elicit a slot
540
- * value from the user.</p>
541
- * </li>
542
- * </ul>
543
- */
544
- type: DialogActionType | string | undefined;
545
- /**
546
- * <p>The name of the slot that should be elicited from the user.</p>
547
- */
548
- slotToElicit?: string;
549
- }
550
- export declare namespace DialogAction {
551
- /**
552
- * @internal
553
- */
554
- const filterSensitiveLog: (obj: DialogAction) => any;
555
- }
556
- /**
557
- * <p></p>
558
- */
559
- export interface BadGatewayException extends __SmithyException, $MetadataBearer {
560
- name: "BadGatewayException";
561
- $fault: "server";
562
- message: string | undefined;
563
- }
564
- export declare namespace BadGatewayException {
565
- /**
566
- * @internal
567
- */
568
- const filterSensitiveLog: (obj: BadGatewayException) => any;
569
- }
570
- /**
571
- * <p></p>
572
- */
573
- export interface DependencyFailedException extends __SmithyException, $MetadataBearer {
574
- name: "DependencyFailedException";
575
- $fault: "client";
576
- message: string | undefined;
577
- }
578
- export declare namespace DependencyFailedException {
579
- /**
580
- * @internal
581
- */
582
- const filterSensitiveLog: (obj: DependencyFailedException) => any;
583
- }
584
- export interface PutSessionResponse {
585
- /**
586
- * <p>The type of response. Same as the type specified in the
587
- * <code>responseContentType</code> field in the request.</p>
588
- */
589
- contentType?: string;
590
- /**
591
- * <p>A list of messages that were last sent to the user. The messages are
592
- * ordered based on how you return the messages from you Lambda function
593
- * or the order that the messages are defined in the bot.</p>
594
- */
595
- messages?: string;
596
- /**
597
- * <p>Represents the current state of the dialog between the user and the
598
- * bot.</p>
599
- * <p>Use this to determine the progress of the conversation and what the
600
- * next action may be.</p>
601
- */
602
- sessionState?: string;
603
- /**
604
- * <p>Request-specific information passed between the client application
605
- * and Amazon Lex V2. These are the same as the <code>requestAttribute</code>
606
- * parameter in the call to the <code>PutSession</code> operation.</p>
607
- */
608
- requestAttributes?: string;
609
- /**
610
- * <p>The identifier of the session that received the data.</p>
611
- */
612
- sessionId?: string;
613
- /**
614
- * <p>If the requested content type was audio, the audio version of the
615
- * message to convey to the user.</p>
616
- */
617
- audioStream?: Readable | ReadableStream | Blob;
618
- }
619
- export declare namespace PutSessionResponse {
620
- /**
621
- * @internal
622
- */
623
- const filterSensitiveLog: (obj: PutSessionResponse) => any;
624
- }
625
- export interface RecognizeUtteranceRequest {
626
- /**
627
- * <p>The identifier of the bot that should receive the request.</p>
628
- */
629
- botId: string | undefined;
630
- /**
631
- * <p>The alias identifier in use for the bot that should receive the
632
- * request.</p>
633
- */
634
- botAliasId: string | undefined;
635
- /**
636
- * <p>The locale where the session is in use.</p>
637
- */
638
- localeId: string | undefined;
639
- /**
640
- * <p>The identifier of the session in use.</p>
641
- */
642
- sessionId: string | undefined;
643
- /**
644
- * <p>Sets the state of the session with the user. You can use this to set
645
- * the current intent, attributes, context, and dialog action. Use the
646
- * dialog action to determine the next step that Amazon Lex V2 should use in the
647
- * conversation with the user.</p>
648
- * <p>The <code>sessionState</code> field must be compressed using gzip
649
- * and then base64 encoded before sending to Amazon Lex V2.</p>
650
- */
651
- sessionState?: string;
652
- /**
653
- * <p>Request-specific information passed between the client application
654
- * and Amazon Lex V2 </p>
655
- * <p>The namespace <code>x-amz-lex:</code> is reserved for special
656
- * attributes. Don't create any request attributes for prefix
657
- * <code>x-amz-lex:</code>.</p>
658
- * <p>The <code>requestAttributes</code> field must be compressed using
659
- * gzip and then base64 encoded before sending to Amazon Lex V2.</p>
660
- */
661
- requestAttributes?: string;
662
- /**
663
- * <p>Indicates the format for audio input or that the content is text.
664
- * The header must start with one of the following prefixes:</p>
665
- * <ul>
666
- * <li>
667
- * <p>PCM format, audio data must be in little-endian byte
668
- * order.</p>
669
- * <ul>
670
- * <li>
671
- * <p>audio/l16; rate=16000; channels=1</p>
672
- * </li>
673
- * <li>
674
- * <p>audio/x-l16; sample-rate=16000; channel-count=1</p>
675
- * </li>
676
- * <li>
677
- * <p>audio/lpcm; sample-rate=8000; sample-size-bits=16;
678
- * channel-count=1; is-big-endian=false</p>
679
- * </li>
680
- * </ul>
681
- * </li>
682
- * <li>
683
- * <p>Opus format</p>
684
- * <ul>
685
- * <li>
686
- * <p>audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4</p>
687
- * </li>
688
- * </ul>
689
- * </li>
690
- * <li>
691
- * <p>Text format</p>
692
- * <ul>
693
- * <li>
694
- * <p>text/plain; charset=utf-8</p>
695
- * </li>
696
- * </ul>
697
- * </li>
698
- * </ul>
699
- */
700
- requestContentType: string | undefined;
701
- /**
702
- * <p>The message that Amazon Lex V2 returns in the response can be either text or
703
- * speech based on the <code>responseContentType</code> value.</p>
704
- * <ul>
705
- * <li>
706
- * <p>If the value is <code>text/plain;charset=utf-8</code>, Amazon Lex V2
707
- * returns text in the response.</p>
708
- * </li>
709
- * <li>
710
- * <p>If the value begins with <code>audio/</code>, Amazon Lex V2 returns
711
- * speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech
712
- * using the configuration that you specified in the
713
- * <code>requestContentType</code> parameter. For example, if you
714
- * specify <code>audio/mpeg</code> as the value, Amazon Lex V2 returns
715
- * speech in the MPEG format.</p>
716
- * </li>
717
- * <li>
718
- * <p>If the value is <code>audio/pcm</code>, the speech returned is
719
- * <code>audio/pcm</code> at 16 KHz in 16-bit, little-endian
720
- * format.</p>
721
- * </li>
722
- * <li>
723
- * <p>The following are the accepted values:</p>
724
- * <ul>
725
- * <li>
726
- * <p>audio/mpeg</p>
727
- * </li>
728
- * <li>
729
- * <p>audio/ogg</p>
730
- * </li>
731
- * <li>
732
- * <p>audio/pcm (16 KHz)</p>
733
- * </li>
734
- * <li>
735
- * <p>audio/* (defaults to mpeg)</p>
736
- * </li>
737
- * <li>
738
- * <p>text/plain; charset=utf-8</p>
739
- * </li>
740
- * </ul>
741
- * </li>
742
- * </ul>
743
- */
744
- responseContentType?: string;
745
- /**
746
- * <p>User input in PCM or Opus audio format or text format as described
747
- * in the <code>requestContentType</code> parameter.</p>
748
- */
749
- inputStream?: Readable | ReadableStream | Blob;
750
- }
751
- export declare namespace RecognizeUtteranceRequest {
752
- /**
753
- * @internal
754
- */
755
- const filterSensitiveLog: (obj: RecognizeUtteranceRequest) => any;
756
- }
757
- export interface RecognizeUtteranceResponse {
758
- /**
759
- * <p>Indicates whether the input mode to the operation was text or
760
- * speech.
761
- * </p>
762
- */
763
- inputMode?: string;
764
- /**
765
- * <p>Content type as specified in the <code>responseContentType</code> in
766
- * the request.</p>
767
- */
768
- contentType?: string;
769
- /**
770
- * <p>A list of messages that were last sent to the user. The messages are
771
- * ordered based on the order that you returned the messages from your
772
- * Lambda function or the order that the messages are defined in the
773
- * bot.</p>
774
- * <p>The <code>messages</code> field is compressed with gzip and then
775
- * base64 encoded. Before you can use the contents of the field, you must
776
- * decode and decompress the contents. See the example for a simple
777
- * function to decode and decompress the contents.</p>
778
- */
779
- messages?: string;
780
- /**
781
- * <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
782
- * utterance.</p>
783
- * <p>Each interpretation includes the intent, a score that indicates how
784
- * confident Amazon Lex V2 is that the interpretation is the correct one, and an
785
- * optional sentiment response that indicates the sentiment expressed in
786
- * the utterance.</p>
787
- * <p>The <code>interpretations</code> field is compressed with gzip and
788
- * then base64 encoded. Before you can use the contents of the field, you
789
- * must decode and decompress the contents. See the example for a simple
790
- * function to decode and decompress the contents.</p>
791
- */
792
- interpretations?: string;
793
- /**
794
- * <p>Represents the current state of the dialog between the user and the
795
- * bot.</p>
796
- * <p>Use this to determine the progress of the conversation and what the
797
- * next action might be.</p>
798
- * <p>The <code>sessionState</code> field is compressed with gzip and then
799
- * base64 encoded. Before you can use the contents of the field, you must
800
- * decode and decompress the contents. See the example for a simple
801
- * function to decode and decompress the contents.</p>
802
- */
803
- sessionState?: string;
804
- /**
805
- * <p>The attributes sent in the request.</p>
806
- * <p>The <code>requestAttributes</code> field is compressed with gzip and
807
- * then base64 encoded. Before you can use the contents of the field, you
808
- * must decode and decompress the contents.</p>
809
- */
810
- requestAttributes?: string;
811
- /**
812
- * <p>The identifier of the session in use.</p>
813
- */
814
- sessionId?: string;
815
- /**
816
- * <p>The text used to process the request.</p>
817
- * <p>If the input was an audio stream, the <code>inputTranscript</code>
818
- * field contains the text extracted from the audio stream. This is the
819
- * text that is actually processed to recognize intents and slot values.
820
- * You can use this information to determine if Amazon Lex V2 is correctly
821
- * processing the audio that you send.</p>
822
- * <p>The <code>inputTranscript</code> field is compressed with gzip and
823
- * then base64 encoded. Before you can use the contents of the field, you
824
- * must decode and decompress the contents. See the example for a simple
825
- * function to decode and decompress the contents.</p>
826
- */
827
- inputTranscript?: string;
828
- /**
829
- * <p>The prompt or statement to send to the user. This is based on the
830
- * bot configuration and context. For example, if Amazon Lex V2 did not understand
831
- * the user intent, it sends the <code>clarificationPrompt</code>
832
- * configured for the bot. If the intent requires confirmation before
833
- * taking the fulfillment action, it sends the
834
- * <code>confirmationPrompt</code>. Another example: Suppose that the
835
- * Lambda function successfully fulfilled the intent, and sent a message
836
- * to convey to the user. Then Amazon Lex V2 sends that message in the
837
- * response.</p>
838
- */
839
- audioStream?: Readable | ReadableStream | Blob;
840
- }
841
- export declare namespace RecognizeUtteranceResponse {
842
- /**
843
- * @internal
844
- */
845
- const filterSensitiveLog: (obj: RecognizeUtteranceResponse) => any;
846
- }
847
- export declare enum ConversationMode {
848
- AUDIO = "AUDIO",
849
- TEXT = "TEXT"
850
- }
851
- /**
852
- * <p>A notification from the client that it is disconnecting from Amazon Lex V2.
853
- * Sending a <code>DisconnectionEvent</code> event is optional, but can
854
- * help identify a conversation in logs.</p>
855
- */
856
- export interface DisconnectionEvent {
857
- /**
858
- * <p>A unique identifier that your application assigns to the event. You
859
- * can use this to identify events in logs.</p>
860
- */
861
- eventId?: string;
862
- /**
863
- * <p>A timestamp set by the client of the date and time that the event
864
- * was sent to Amazon Lex V2.</p>
865
- */
866
- clientTimestampMillis?: number;
867
- }
868
- export declare namespace DisconnectionEvent {
869
- /**
870
- * @internal
871
- */
872
- const filterSensitiveLog: (obj: DisconnectionEvent) => any;
873
- }
874
- /**
875
- * <p>A DTMF character sent from the client application. DTMF characters
876
- * are typically sent from a phone keypad to represent numbers. For
877
- * example, you can have Amazon Lex V2 process a credit card number input from a
878
- * phone.</p>
879
- */
880
- export interface DTMFInputEvent {
881
- /**
882
- * <p>The DTMF character that the user pressed. The allowed characters are
883
- * A - D, 0 - 9, # and *.</p>
884
- */
885
- inputCharacter: string | undefined;
886
- /**
887
- * <p>A unique identifier that your application assigns to the event. You
888
- * can use this to identify events in logs.</p>
889
- */
890
- eventId?: string;
891
- /**
892
- * <p>A timestamp set by the client of the date and time that the event
893
- * was sent to Amazon Lex V2.</p>
894
- */
895
- clientTimestampMillis?: number;
896
- }
897
- export declare namespace DTMFInputEvent {
898
- /**
899
- * @internal
900
- */
901
- const filterSensitiveLog: (obj: DTMFInputEvent) => any;
902
- }
903
- /**
904
- * <p>Event sent from the client application to Amazon Lex V2 to indicate that
905
- * playback of audio is complete and that Amazon Lex V2 should start processing
906
- * the user's input.</p>
907
- */
908
- export interface PlaybackCompletionEvent {
909
- /**
910
- * <p>A unique identifier that your application assigns to the event. You
911
- * can use this to identify events in logs.</p>
912
- */
913
- eventId?: string;
914
- /**
915
- * <p>A timestamp set by the client of the date and time that the event
916
- * was sent to Amazon Lex V2.</p>
917
- */
918
- clientTimestampMillis?: number;
919
- }
920
- export declare namespace PlaybackCompletionEvent {
921
- /**
922
- * @internal
923
- */
924
- const filterSensitiveLog: (obj: PlaybackCompletionEvent) => any;
925
- }
926
- /**
927
- * <p>The event sent from your client application to Amazon Lex V2 with text input
928
- * from the user.</p>
929
- */
930
- export interface TextInputEvent {
931
- /**
932
- * <p>The text from the user. Amazon Lex V2 processes this as a complete
933
- * statement.</p>
934
- */
935
- text: string | undefined;
936
- /**
937
- * <p>A unique identifier that your application assigns to the event. You
938
- * can use this to identify events in logs.</p>
939
- */
940
- eventId?: string;
941
- /**
942
- * <p>A timestamp set by the client of the date and time that the event
943
- * was sent to Amazon Lex V2.</p>
944
- */
945
- clientTimestampMillis?: number;
946
- }
947
- export declare namespace TextInputEvent {
948
- /**
949
- * @internal
950
- */
951
- const filterSensitiveLog: (obj: TextInputEvent) => any;
952
- }
953
- /**
954
- * <p>Event that Amazon Lex V2 sends to indicate that the stream is still open
955
- * between the client application and Amazon Lex V2 </p>
956
- */
957
- export interface HeartbeatEvent {
958
- /**
959
- * <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
960
- * the form <code>RESPONSE-N</code>, where N is a number starting with one
961
- * and incremented for each event sent by Amazon Lex V2 in the current
962
- * session.</p>
963
- */
964
- eventId?: string;
965
- }
966
- export declare namespace HeartbeatEvent {
967
- /**
968
- * @internal
969
- */
970
- const filterSensitiveLog: (obj: HeartbeatEvent) => any;
971
- }
972
- export declare enum InputMode {
973
- DTMF = "DTMF",
974
- SPEECH = "Speech",
975
- TEXT = "Text"
976
- }
977
- export declare enum PlaybackInterruptionReason {
978
- DTMF_START_DETECTED = "DTMF_START_DETECTED",
979
- TEXT_DETECTED = "TEXT_DETECTED",
980
- VOICE_START_DETECTED = "VOICE_START_DETECTED"
981
- }
982
- /**
983
- * <p>Event sent from Amazon Lex V2 to indicate to the client application should
984
- * stop playback of audio. For example, if the client is playing a prompt
985
- * that asks for the user's telephone number, the user might start to say
986
- * the phone number before the prompt is complete. Amazon Lex V2 sends this event
987
- * to the client application to indicate that the user is responding and
988
- * that Amazon Lex V2 is processing their input.</p>
989
- */
990
- export interface PlaybackInterruptionEvent {
991
- /**
992
- * <p>Indicates the type of user input that Amazon Lex V2 detected.</p>
993
- */
994
- eventReason?: PlaybackInterruptionReason | string;
995
- /**
996
- * <p>The identifier of the event that contained the audio, DTMF, or text
997
- * that caused the interruption.</p>
998
- */
999
- causedByEventId?: string;
1000
- /**
1001
- * <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
1002
- * the form <code>RESPONSE-N</code>, where N is a number starting with one
1003
- * and incremented for each event sent by Amazon Lex V2 in the current
1004
- * session.</p>
1005
- */
1006
- eventId?: string;
1007
- }
1008
- export declare namespace PlaybackInterruptionEvent {
1009
- /**
1010
- * @internal
1011
- */
1012
- const filterSensitiveLog: (obj: PlaybackInterruptionEvent) => any;
1013
- }
1014
- /**
1015
- * <p>The event sent from Amazon Lex V2 to your application with text to present
1016
- * to the user.</p>
1017
- */
1018
- export interface TextResponseEvent {
1019
- /**
1020
- * <p>A list of messages to send to the user. Messages are ordered based
1021
- * on the order that you returned the messages from your Lambda function
1022
- * or the order that the messages are defined in the bot.</p>
1023
- */
1024
- messages?: Message[];
1025
- /**
1026
- * <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
1027
- * the form <code>RESPONSE-N</code>, where N is a number starting with one
1028
- * and incremented for each event sent by Amazon Lex V2 in the current
1029
- * session.</p>
1030
- */
1031
- eventId?: string;
1032
- }
1033
- export declare namespace TextResponseEvent {
1034
- /**
1035
- * @internal
1036
- */
1037
- const filterSensitiveLog: (obj: TextResponseEvent) => any;
1038
- }
1039
- /**
1040
- * <p>Event sent from Amazon Lex V2 to your client application that contains a
1041
- * transcript of voice audio. </p>
1042
- */
1043
- export interface TranscriptEvent {
1044
- /**
1045
- * <p>The transcript of the voice audio from the user.</p>
1046
- */
1047
- transcript?: string;
1048
- /**
1049
- * <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
1050
- * the form <code>RESPONSE-N</code>, where N is a number starting with one
1051
- * and incremented for each event sent by Amazon Lex V2 in the current
1052
- * session.</p>
1053
- */
1054
- eventId?: string;
1055
- }
1056
- export declare namespace TranscriptEvent {
1057
- /**
1058
- * @internal
1059
- */
1060
- const filterSensitiveLog: (obj: TranscriptEvent) => any;
1061
- }
1062
- /**
1063
- * <p>A value that Amazon Lex V2 uses to fulfill an intent. </p>
1064
- */
1065
- export interface Slot {
1066
- /**
1067
- * <p>The current value of the slot.</p>
1068
- */
1069
- value?: Value;
1070
- /**
1071
- * <p>When the <code>shape</code> value is <code>List</code>, it indicates
1072
- * that the <code>values</code> field contains a list of slot values. When
1073
- * the value is <code>Scalar</code>, it indicates that the
1074
- * <code>value</code> field contains a single value.</p>
1075
- */
1076
- shape?: Shape | string;
1077
- /**
1078
- * <p>A list of one or more values that the user provided for the slot.
1079
- * For example, if a for a slot that elicits pizza toppings, the values might
1080
- * be "pepperoni" and "pineapple." </p>
1081
- */
1082
- values?: Slot[];
1083
- }
1084
- export declare namespace Slot {
1085
- /**
1086
- * @internal
1087
- */
1088
- const filterSensitiveLog: (obj: Slot) => any;
1089
- }
1090
- /**
1091
- * <p>The current intent that Amazon Lex V2 is attempting to fulfill.</p>
1092
- */
1093
- export interface Intent {
1094
- /**
1095
- * <p>The name of the intent.</p>
1096
- */
1097
- name: string | undefined;
1098
- /**
1099
- * <p>A map of all of the slots for the intent. The name of the slot maps
1100
- * to the value of the slot. If a slot has not been filled, the value is
1101
- * null.</p>
1102
- */
1103
- slots?: {
1104
- [key: string]: Slot;
1105
- };
1106
- /**
1107
- * <p>Contains fulfillment information for the intent. </p>
1108
- */
1109
- state?: IntentState | string;
1110
- /**
1111
- * <p>Contains information about whether fulfillment of the intent has
1112
- * been confirmed.</p>
1113
- */
1114
- confirmationState?: ConfirmationState | string;
1115
- }
1116
- export declare namespace Intent {
1117
- /**
1118
- * @internal
1119
- */
1120
- const filterSensitiveLog: (obj: Intent) => any;
1121
- }
1122
- /**
1123
- * <p>An intent that Amazon Lex V2 determined might satisfy the user's utterance.
1124
- * The intents are ordered by the confidence score. </p>
1125
- */
1126
- export interface Interpretation {
1127
- /**
1128
- * <p>Determines the threshold where Amazon Lex V2 will insert the
1129
- * <code>AMAZON.FallbackIntent</code>,
1130
- * <code>AMAZON.KendraSearchIntent</code>, or both when returning
1131
- * alternative intents in a response. <code>AMAZON.FallbackIntent</code>
1132
- * and <code>AMAZON.KendraSearchIntent</code> are only inserted if they
1133
- * are configured for the bot.</p>
1134
- */
1135
- nluConfidence?: ConfidenceScore;
1136
- /**
1137
- * <p>The sentiment expressed in an utterance. </p>
1138
- * <p>When the bot is configured to send utterances to Amazon Comprehend
1139
- * for sentiment analysis, this field contains the result of the
1140
- * analysis.</p>
1141
- */
1142
- sentimentResponse?: SentimentResponse;
1143
- /**
1144
- * <p>A list of intents that might satisfy the user's utterance. The
1145
- * intents are ordered by the confidence score.</p>
1146
- */
1147
- intent?: Intent;
1148
- }
1149
- export declare namespace Interpretation {
1150
- /**
1151
- * @internal
1152
- */
1153
- const filterSensitiveLog: (obj: Interpretation) => any;
1154
- }
1155
- /**
1156
- * <p>The state of the user's session with Amazon Lex V2.</p>
1157
- */
1158
- export interface SessionState {
1159
- /**
1160
- * <p>The next step that Amazon Lex V2 should take in the conversation with a
1161
- * user.</p>
1162
- */
1163
- dialogAction?: DialogAction;
1164
- /**
1165
- * <p>The active intent that Amazon Lex V2 is processing.</p>
1166
- */
1167
- intent?: Intent;
1168
- /**
1169
- * <p>One or more contexts that indicate to Amazon Lex V2 the context of a
1170
- * request. When a context is active, Amazon Lex V2 considers intents with the
1171
- * matching context as a trigger as the next intent in a session.</p>
1172
- */
1173
- activeContexts?: ActiveContext[];
1174
- /**
1175
- * <p>Map of key/value pairs representing session-specific context
1176
- * information. It contains application information passed between Amazon Lex V2
1177
- * and a client application.</p>
1178
- */
1179
- sessionAttributes?: {
1180
- [key: string]: string;
1181
- };
1182
- /**
1183
- * <p></p>
1184
- */
1185
- originatingRequestId?: string;
1186
- }
1187
- export declare namespace SessionState {
1188
- /**
1189
- * @internal
1190
- */
1191
- const filterSensitiveLog: (obj: SessionState) => any;
1192
- }
1193
- /**
1194
- * <p>The initial event sent from the application to Amazon Lex V2 to configure
1195
- * the conversation, including session and request attributes and the
1196
- * response content type.</p>
1197
- */
1198
- export interface ConfigurationEvent {
1199
- /**
1200
- * <p>Request-specific information passed between the client application
1201
- * and Amazon Lex V2.</p>
1202
- * <p>The namespace <code>x-amz-lex:</code> is reserved for special
1203
- * attributes. Don't create any request attributes for prefix
1204
- * <code>x-amz-lex:</code>.</p>
1205
- */
1206
- requestAttributes?: {
1207
- [key: string]: string;
1208
- };
1209
- /**
1210
- * <p>The message that Amazon Lex V2 returns in the response can be either text or
1211
- * speech based on the <code>responseContentType</code> value.</p>
1212
- * <ul>
1213
- * <li>
1214
- * <p>If the value is <code>text/plain;charset=utf-8</code>, Amazon Lex V2
1215
- * returns text in the response.</p>
1216
- * </li>
1217
- * <li>
1218
- * <p>If the value begins with <code>audio/</code>, Amazon Lex V2 returns
1219
- * speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech
1220
- * using the configuration that you specified in the
1221
- * <code>requestContentType</code> parameter. For example, if you
1222
- * specify <code>audio/mpeg</code> as the value, Amazon Lex V2 returns
1223
- * speech in the MPEG format.</p>
1224
- * </li>
1225
- * <li>
1226
- * <p>If the value is <code>audio/pcm</code>, the speech returned is
1227
- * audio/pcm in 16-bit, little-endian format.</p>
1228
- * </li>
1229
- * <li>
1230
- * <p>The following are the accepted values:</p>
1231
- * <ul>
1232
- * <li>
1233
- * <p>audio/mpeg</p>
1234
- * </li>
1235
- * <li>
1236
- * <p>audio/ogg</p>
1237
- * </li>
1238
- * <li>
1239
- * <p>audio/pcm</p>
1240
- * </li>
1241
- * <li>
1242
- * <p>audio/* (defaults to mpeg)</p>
1243
- * </li>
1244
- * <li>
1245
- * <p>text/plain; charset=utf-8</p>
1246
- * </li>
1247
- * </ul>
1248
- * </li>
1249
- * </ul>
1250
- */
1251
- responseContentType: string | undefined;
1252
- /**
1253
- * <p>The state of the user's session with Amazon Lex V2.</p>
1254
- */
1255
- sessionState?: SessionState;
1256
- /**
1257
- * <p>A list of messages to send to the user.</p>
1258
- */
1259
- welcomeMessages?: Message[];
1260
- /**
1261
- * <p>Determines whether Amazon Lex V2 should send audio responses to the client
1262
- * application. When this parameter if <code>false</code>, the client
1263
- * application needs to create responses for the user.
1264
- * </p>
1265
- */
1266
- disablePlayback?: boolean;
1267
- /**
1268
- * <p>A unique identifier that your application assigns to the event. You
1269
- * can use this to identify events in logs.</p>
1270
- */
1271
- eventId?: string;
1272
- /**
1273
- * <p>A timestamp set by the client of the date and time that the event
1274
- * was sent to Amazon Lex V2.</p>
1275
- */
1276
- clientTimestampMillis?: number;
1277
- }
1278
- export declare namespace ConfigurationEvent {
1279
- /**
1280
- * @internal
1281
- */
1282
- const filterSensitiveLog: (obj: ConfigurationEvent) => any;
1283
- }
1284
- export interface PutSessionRequest {
1285
- /**
1286
- * <p>The identifier of the bot that receives the session data.</p>
1287
- */
1288
- botId: string | undefined;
1289
- /**
1290
- * <p>The alias identifier of the bot that receives the session
1291
- * data.</p>
1292
- */
1293
- botAliasId: string | undefined;
1294
- /**
1295
- * <p>The locale where the session is in use.</p>
1296
- */
1297
- localeId: string | undefined;
1298
- /**
1299
- * <p>The identifier of the session that receives the session data.</p>
1300
- */
1301
- sessionId: string | undefined;
1302
- /**
1303
- * <p>A list of messages to send to the user. Messages are sent in the
1304
- * order that they are defined in the list.</p>
1305
- */
1306
- messages?: Message[];
1307
- /**
1308
- * <p>Sets the state of the session with the user. You can use this to set
1309
- * the current intent, attributes, context, and dialog action. Use the
1310
- * dialog action to determine the next step that Amazon Lex V2 should use in the
1311
- * conversation with the user.</p>
1312
- */
1313
- sessionState: SessionState | undefined;
1314
- /**
1315
- * <p>Request-specific information passed between Amazon Lex V2 and the client
1316
- * application.</p>
1317
- * <p>The namespace <code>x-amz-lex:</code> is reserved for special
1318
- * attributes. Don't create any request attributes with the prefix
1319
- * <code>x-amz-lex:</code>.</p>
1320
- */
1321
- requestAttributes?: {
1322
- [key: string]: string;
1323
- };
1324
- /**
1325
- * <p>The message that Amazon Lex V2 returns in the response can be either text or
1326
- * speech depending on the value of this parameter. </p>
1327
- * <ul>
1328
- * <li>
1329
- * <p>If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex V2
1330
- * returns text in the response.</p>
1331
- * </li>
1332
- * </ul>
1333
- */
1334
- responseContentType?: string;
1335
- }
1336
- export declare namespace PutSessionRequest {
1337
- /**
1338
- * @internal
1339
- */
1340
- const filterSensitiveLog: (obj: PutSessionRequest) => any;
1341
- }
1342
- export interface RecognizeTextRequest {
1343
- /**
1344
- * <p>The identifier of the bot that processes the request.</p>
1345
- */
1346
- botId: string | undefined;
1347
- /**
1348
- * <p>The alias identifier in use for the bot that processes the
1349
- * request.</p>
1350
- */
1351
- botAliasId: string | undefined;
1352
- /**
1353
- * <p>The locale where the session is in use.</p>
1354
- */
1355
- localeId: string | undefined;
1356
- /**
1357
- * <p>The identifier of the user session that is having the
1358
- * conversation.</p>
1359
- */
1360
- sessionId: string | undefined;
1361
- /**
1362
- * <p>The text that the user entered. Amazon Lex V2 interprets this text.</p>
1363
- */
1364
- text: string | undefined;
1365
- /**
1366
- * <p>The current state of the dialog between the user and the bot.</p>
1367
- */
1368
- sessionState?: SessionState;
1369
- /**
1370
- * <p>Request-specific information passed between the client application
1371
- * and Amazon Lex V2 </p>
1372
- * <p>The namespace <code>x-amz-lex:</code> is reserved for special
1373
- * attributes. Don't create any request attributes with the prefix
1374
- * <code>x-amz-lex:</code>.</p>
1375
- */
1376
- requestAttributes?: {
1377
- [key: string]: string;
1378
- };
1379
- }
1380
- export declare namespace RecognizeTextRequest {
1381
- /**
1382
- * @internal
1383
- */
1384
- const filterSensitiveLog: (obj: RecognizeTextRequest) => any;
1385
- }
1386
- /**
1387
- * <p>Represents a stream of events between your application and
1388
- * Amazon Lex V2.</p>
1389
- */
1390
- export declare type StartConversationRequestEventStream = StartConversationRequestEventStream.AudioInputEventMember | StartConversationRequestEventStream.ConfigurationEventMember | StartConversationRequestEventStream.DTMFInputEventMember | StartConversationRequestEventStream.DisconnectionEventMember | StartConversationRequestEventStream.PlaybackCompletionEventMember | StartConversationRequestEventStream.TextInputEventMember | StartConversationRequestEventStream.$UnknownMember;
1391
- export declare namespace StartConversationRequestEventStream {
1392
- /**
1393
- * <p>Configuration information sent from your client application to
1394
- * Amazon Lex V2</p>
1395
- */
1396
- interface ConfigurationEventMember {
1397
- ConfigurationEvent: ConfigurationEvent;
1398
- AudioInputEvent?: never;
1399
- DTMFInputEvent?: never;
1400
- TextInputEvent?: never;
1401
- PlaybackCompletionEvent?: never;
1402
- DisconnectionEvent?: never;
1403
- $unknown?: never;
1404
- }
1405
- /**
1406
- * <p>Speech audio sent from your client application to Amazon Lex V2. Audio
1407
- * starts accumulating when Amazon Lex V2 identifies a voice and continues until a
1408
- * natural pause in the speech is found before processing.</p>
1409
- */
1410
- interface AudioInputEventMember {
1411
- ConfigurationEvent?: never;
1412
- AudioInputEvent: AudioInputEvent;
1413
- DTMFInputEvent?: never;
1414
- TextInputEvent?: never;
1415
- PlaybackCompletionEvent?: never;
1416
- DisconnectionEvent?: never;
1417
- $unknown?: never;
1418
- }
1419
- /**
1420
- * <p>DTMF information sent to Amazon Lex V2 by your application. Amazon Lex V2
1421
- * accumulates the DMTF information from when the user sends the first
1422
- * character and ends</p>
1423
- * <ul>
1424
- * <li>
1425
- * <p>when there's a pause longer that the value configured for the
1426
- * end timeout.</p>
1427
- * </li>
1428
- * <li>
1429
- * <p>when there's a digit that is the configured end
1430
- * character.</p>
1431
- * </li>
1432
- * <li>
1433
- * <p>when Amazon Lex V2 accumulates characters equal to the maximum DTMF
1434
- * character configuration.</p>
1435
- * </li>
1436
- * </ul>
1437
- */
1438
- interface DTMFInputEventMember {
1439
- ConfigurationEvent?: never;
1440
- AudioInputEvent?: never;
1441
- DTMFInputEvent: DTMFInputEvent;
1442
- TextInputEvent?: never;
1443
- PlaybackCompletionEvent?: never;
1444
- DisconnectionEvent?: never;
1445
- $unknown?: never;
1446
- }
1447
- /**
1448
- * <p>Text sent from your client application to Amazon Lex V2. Each
1449
- * <code>TextInputEvent</code> is processed individually.</p>
1450
- */
1451
- interface TextInputEventMember {
1452
- ConfigurationEvent?: never;
1453
- AudioInputEvent?: never;
1454
- DTMFInputEvent?: never;
1455
- TextInputEvent: TextInputEvent;
1456
- PlaybackCompletionEvent?: never;
1457
- DisconnectionEvent?: never;
1458
- $unknown?: never;
1459
- }
1460
- /**
1461
- * <p>Event sent from the client application to Amazon Lex V2 to indicate that it
1462
- * has finished playing audio and that Amazon Lex V2 should start listening for
1463
- * user input.</p>
1464
- */
1465
- interface PlaybackCompletionEventMember {
1466
- ConfigurationEvent?: never;
1467
- AudioInputEvent?: never;
1468
- DTMFInputEvent?: never;
1469
- TextInputEvent?: never;
1470
- PlaybackCompletionEvent: PlaybackCompletionEvent;
1471
- DisconnectionEvent?: never;
1472
- $unknown?: never;
1473
- }
1474
- /**
1475
- * <p>Event sent from the client application to indicate to Amazon Lex V2 that the
1476
- * conversation is over.</p>
1477
- */
1478
- interface DisconnectionEventMember {
1479
- ConfigurationEvent?: never;
1480
- AudioInputEvent?: never;
1481
- DTMFInputEvent?: never;
1482
- TextInputEvent?: never;
1483
- PlaybackCompletionEvent?: never;
1484
- DisconnectionEvent: DisconnectionEvent;
1485
- $unknown?: never;
1486
- }
1487
- interface $UnknownMember {
1488
- ConfigurationEvent?: never;
1489
- AudioInputEvent?: never;
1490
- DTMFInputEvent?: never;
1491
- TextInputEvent?: never;
1492
- PlaybackCompletionEvent?: never;
1493
- DisconnectionEvent?: never;
1494
- $unknown: [
1495
- string,
1496
- any
1497
- ];
1498
- }
1499
- interface Visitor<T> {
1500
- ConfigurationEvent: (value: ConfigurationEvent) => T;
1501
- AudioInputEvent: (value: AudioInputEvent) => T;
1502
- DTMFInputEvent: (value: DTMFInputEvent) => T;
1503
- TextInputEvent: (value: TextInputEvent) => T;
1504
- PlaybackCompletionEvent: (value: PlaybackCompletionEvent) => T;
1505
- DisconnectionEvent: (value: DisconnectionEvent) => T;
1506
- _: (name: string, value: any) => T;
1507
- }
1508
- const visit: <T>(value: StartConversationRequestEventStream, visitor: Visitor<T>) => T;
1509
- /**
1510
- * @internal
1511
- */
1512
- const filterSensitiveLog: (obj: StartConversationRequestEventStream) => any;
1513
- }
1514
- export interface StartConversationRequest {
1515
- /**
1516
- * <p>The identifier of the bot to process the request.</p>
1517
- */
1518
- botId: string | undefined;
1519
- /**
1520
- * <p>The alias identifier in use for the bot that processes the
1521
- * request.</p>
1522
- */
1523
- botAliasId: string | undefined;
1524
- /**
1525
- * <p>The locale where the session is in use.</p>
1526
- */
1527
- localeId: string | undefined;
1528
- /**
1529
- * <p>The identifier of the user session that is having the
1530
- * conversation.</p>
1531
- */
1532
- sessionId: string | undefined;
1533
- /**
1534
- * <p>The conversation type that you are using the Amazon Lex V2. If the
1535
- * conversation mode is <code>AUDIO</code> you can send both audio and
1536
- * DTMF information. If the mode is <code>TEXT</code> you can only send
1537
- * text.</p>
1538
- */
1539
- conversationMode?: ConversationMode | string;
1540
- /**
1541
- * <p>Represents the stream of events to Amazon Lex V2 from your application. The
1542
- * events are encoded as HTTP/2 data frames.</p>
1543
- */
1544
- requestEventStream: AsyncIterable<StartConversationRequestEventStream> | undefined;
1545
- }
1546
- export declare namespace StartConversationRequest {
1547
- /**
1548
- * @internal
1549
- */
1550
- const filterSensitiveLog: (obj: StartConversationRequest) => any;
1551
- }
1552
- export interface GetSessionResponse {
1553
- /**
1554
- * <p>The identifier of the returned session.</p>
1555
- */
1556
- sessionId?: string;
1557
- /**
1558
- * <p>A list of messages that were last sent to the user. The messages are
1559
- * ordered based on the order that your returned the messages from your
1560
- * Lambda function or the order that messages are defined in the bot.
1561
- * </p>
1562
- */
1563
- messages?: Message[];
1564
- /**
1565
- * <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
1566
- * utterance. </p>
1567
- * <p>Each interpretation includes the intent, a score that indicates how
1568
- * confident Amazon Lex V2 is that the interpretation is the correct one, and an
1569
- * optional sentiment response that indicates the sentiment expressed in
1570
- * the utterance.</p>
1571
- */
1572
- interpretations?: Interpretation[];
1573
- /**
1574
- * <p>Represents the current state of the dialog between the user and the
1575
- * bot.</p>
1576
- * <p>You can use this to determine the progress of the conversation and
1577
- * what the next action might be.</p>
1578
- */
1579
- sessionState?: SessionState;
1580
- }
1581
- export declare namespace GetSessionResponse {
1582
- /**
1583
- * @internal
1584
- */
1585
- const filterSensitiveLog: (obj: GetSessionResponse) => any;
1586
- }
1587
- /**
1588
- * <p>Contains the current state of the conversation between the client
1589
- * application and Amazon Lex V2.</p>
1590
- */
1591
- export interface IntentResultEvent {
1592
- /**
1593
- * <p>Indicates whether the input to the operation was text or
1594
- * speech.</p>
1595
- */
1596
- inputMode?: InputMode | string;
1597
- /**
1598
- * <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
1599
- * utterance.</p>
1600
- *
1601
- * <p>Each interpretation includes the intent, a score that indicates how
1602
- * confident Amazon Lex V2 is that the interpretation is the correct one, and an
1603
- * optional sentiment response that indicates the sentiment expressed in
1604
- * the utterance.</p>
1605
- */
1606
- interpretations?: Interpretation[];
1607
- /**
1608
- * <p>The state of the user's session with Amazon Lex V2.</p>
1609
- */
1610
- sessionState?: SessionState;
1611
- /**
1612
- * <p>The attributes sent in the request.</p>
1613
- */
1614
- requestAttributes?: {
1615
- [key: string]: string;
1616
- };
1617
- /**
1618
- * <p>The identifier of the session in use.</p>
1619
- */
1620
- sessionId?: string;
1621
- /**
1622
- * <p>A unique identifier of the event sent by Amazon Lex V2. The identifier is in
1623
- * the form <code>RESPONSE-N</code>, where N is a number starting with one
1624
- * and incremented for each event sent by Amazon Lex V2 in the current
1625
- * session.</p>
1626
- */
1627
- eventId?: string;
1628
- }
1629
- export declare namespace IntentResultEvent {
1630
- /**
1631
- * @internal
1632
- */
1633
- const filterSensitiveLog: (obj: IntentResultEvent) => any;
1634
- }
1635
- export interface RecognizeTextResponse {
1636
- /**
1637
- * <p>A list of messages last sent to the user. The messages are ordered
1638
- * based on the order that you returned the messages from your Lambda
1639
- * function or the order that the messages are defined in the bot.</p>
1640
- */
1641
- messages?: Message[];
1642
- /**
1643
- * <p>Represents the current state of the dialog between the user and the
1644
- * bot. </p>
1645
- * <p>Use this to determine the progress of the conversation and what the
1646
- * next action may be.</p>
1647
- */
1648
- sessionState?: SessionState;
1649
- /**
1650
- * <p>A list of intents that Amazon Lex V2 determined might satisfy the user's
1651
- * utterance. </p>
1652
- * <p>Each interpretation includes the intent, a score that indicates now
1653
- * confident Amazon Lex V2 is that the interpretation is the correct one, and an
1654
- * optional sentiment response that indicates the sentiment expressed in
1655
- * the utterance.</p>
1656
- */
1657
- interpretations?: Interpretation[];
1658
- /**
1659
- * <p>The attributes sent in the request.</p>
1660
- */
1661
- requestAttributes?: {
1662
- [key: string]: string;
1663
- };
1664
- /**
1665
- * <p>The identifier of the session in use.</p>
1666
- */
1667
- sessionId?: string;
1668
- }
1669
- export declare namespace RecognizeTextResponse {
1670
- /**
1671
- * @internal
1672
- */
1673
- const filterSensitiveLog: (obj: RecognizeTextResponse) => any;
1674
- }
1675
- /**
1676
- * <p>Represents a stream of events between Amazon Lex V2 and your
1677
- * application.</p>
1678
- */
1679
- export declare 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;
1680
- export declare namespace StartConversationResponseEventStream {
1681
- /**
1682
- * <p>Event sent from Amazon Lex V2 to indicate to the client application should
1683
- * stop playback of audio. For example, if the client is playing a prompt
1684
- * that asks for the user's telephone number, the user might start to say
1685
- * the phone number before the prompt is complete. Amazon Lex V2 sends this event
1686
- * to the client application to indicate that the user is responding and
1687
- * that Amazon Lex V2 is processing their input.</p>
1688
- */
1689
- interface PlaybackInterruptionEventMember {
1690
- PlaybackInterruptionEvent: PlaybackInterruptionEvent;
1691
- TranscriptEvent?: never;
1692
- IntentResultEvent?: never;
1693
- TextResponseEvent?: never;
1694
- AudioResponseEvent?: never;
1695
- HeartbeatEvent?: never;
1696
- AccessDeniedException?: never;
1697
- ResourceNotFoundException?: never;
1698
- ValidationException?: never;
1699
- ThrottlingException?: never;
1700
- InternalServerException?: never;
1701
- ConflictException?: never;
1702
- DependencyFailedException?: never;
1703
- BadGatewayException?: never;
1704
- $unknown?: never;
1705
- }
1706
- /**
1707
- * <p>Event sent from Amazon Lex V2 to your client application that contains a
1708
- * transcript of voice audio. </p>
1709
- */
1710
- interface TranscriptEventMember {
1711
- PlaybackInterruptionEvent?: never;
1712
- TranscriptEvent: TranscriptEvent;
1713
- IntentResultEvent?: never;
1714
- TextResponseEvent?: never;
1715
- AudioResponseEvent?: never;
1716
- HeartbeatEvent?: never;
1717
- AccessDeniedException?: never;
1718
- ResourceNotFoundException?: never;
1719
- ValidationException?: never;
1720
- ThrottlingException?: never;
1721
- InternalServerException?: never;
1722
- ConflictException?: never;
1723
- DependencyFailedException?: never;
1724
- BadGatewayException?: never;
1725
- $unknown?: never;
1726
- }
1727
- /**
1728
- * <p>Event sent from Amazon Lex V2 to the client application containing the
1729
- * current state of the conversation between the user and Amazon Lex V2.</p>
1730
- */
1731
- interface IntentResultEventMember {
1732
- PlaybackInterruptionEvent?: never;
1733
- TranscriptEvent?: never;
1734
- IntentResultEvent: IntentResultEvent;
1735
- TextResponseEvent?: never;
1736
- AudioResponseEvent?: never;
1737
- HeartbeatEvent?: never;
1738
- AccessDeniedException?: never;
1739
- ResourceNotFoundException?: never;
1740
- ValidationException?: never;
1741
- ThrottlingException?: never;
1742
- InternalServerException?: never;
1743
- ConflictException?: never;
1744
- DependencyFailedException?: never;
1745
- BadGatewayException?: never;
1746
- $unknown?: never;
1747
- }
1748
- /**
1749
- * <p>The event sent from Amazon Lex V2 to your application with text to present
1750
- * to the user.</p>
1751
- */
1752
- interface TextResponseEventMember {
1753
- PlaybackInterruptionEvent?: never;
1754
- TranscriptEvent?: never;
1755
- IntentResultEvent?: never;
1756
- TextResponseEvent: TextResponseEvent;
1757
- AudioResponseEvent?: never;
1758
- HeartbeatEvent?: never;
1759
- AccessDeniedException?: never;
1760
- ResourceNotFoundException?: never;
1761
- ValidationException?: never;
1762
- ThrottlingException?: never;
1763
- InternalServerException?: never;
1764
- ConflictException?: never;
1765
- DependencyFailedException?: never;
1766
- BadGatewayException?: never;
1767
- $unknown?: never;
1768
- }
1769
- /**
1770
- * <p>An event sent from Amazon Lex V2 to your client application containing audio
1771
- * to play to the user. </p>
1772
- */
1773
- interface AudioResponseEventMember {
1774
- PlaybackInterruptionEvent?: never;
1775
- TranscriptEvent?: never;
1776
- IntentResultEvent?: never;
1777
- TextResponseEvent?: never;
1778
- AudioResponseEvent: AudioResponseEvent;
1779
- HeartbeatEvent?: never;
1780
- AccessDeniedException?: never;
1781
- ResourceNotFoundException?: never;
1782
- ValidationException?: never;
1783
- ThrottlingException?: never;
1784
- InternalServerException?: never;
1785
- ConflictException?: never;
1786
- DependencyFailedException?: never;
1787
- BadGatewayException?: never;
1788
- $unknown?: never;
1789
- }
1790
- /**
1791
- * <p>Event that Amazon Lex V2 sends to indicate that the stream is still open
1792
- * between the client application and Amazon Lex V2 </p>
1793
- */
1794
- interface HeartbeatEventMember {
1795
- PlaybackInterruptionEvent?: never;
1796
- TranscriptEvent?: never;
1797
- IntentResultEvent?: never;
1798
- TextResponseEvent?: never;
1799
- AudioResponseEvent?: never;
1800
- HeartbeatEvent: HeartbeatEvent;
1801
- AccessDeniedException?: never;
1802
- ResourceNotFoundException?: never;
1803
- ValidationException?: never;
1804
- ThrottlingException?: never;
1805
- InternalServerException?: never;
1806
- ConflictException?: never;
1807
- DependencyFailedException?: never;
1808
- BadGatewayException?: never;
1809
- $unknown?: never;
1810
- }
1811
- /**
1812
- * <p>Exception thrown when the credentials passed with the request are
1813
- * invalid or expired. Also thrown when the credentials in the request do
1814
- * not have permission to access the <code>StartConversation</code>
1815
- * operation.</p>
1816
- */
1817
- interface AccessDeniedExceptionMember {
1818
- PlaybackInterruptionEvent?: never;
1819
- TranscriptEvent?: never;
1820
- IntentResultEvent?: never;
1821
- TextResponseEvent?: never;
1822
- AudioResponseEvent?: never;
1823
- HeartbeatEvent?: never;
1824
- AccessDeniedException: AccessDeniedException;
1825
- ResourceNotFoundException?: never;
1826
- ValidationException?: never;
1827
- ThrottlingException?: never;
1828
- InternalServerException?: never;
1829
- ConflictException?: never;
1830
- DependencyFailedException?: never;
1831
- BadGatewayException?: never;
1832
- $unknown?: never;
1833
- }
1834
- /**
1835
- * <p>Exception thrown if one of the input parameters points to a resource
1836
- * that does not exist. For example, if the bot ID specified does not
1837
- * exist.</p>
1838
- */
1839
- interface ResourceNotFoundExceptionMember {
1840
- PlaybackInterruptionEvent?: never;
1841
- TranscriptEvent?: never;
1842
- IntentResultEvent?: never;
1843
- TextResponseEvent?: never;
1844
- AudioResponseEvent?: never;
1845
- HeartbeatEvent?: never;
1846
- AccessDeniedException?: never;
1847
- ResourceNotFoundException: ResourceNotFoundException;
1848
- ValidationException?: never;
1849
- ThrottlingException?: never;
1850
- InternalServerException?: never;
1851
- ConflictException?: never;
1852
- DependencyFailedException?: never;
1853
- BadGatewayException?: never;
1854
- $unknown?: never;
1855
- }
1856
- /**
1857
- * <p>Exception thrown when one or more parameters could not be validated.
1858
- * The <code>message</code> contains the name of the field that isn't
1859
- * valid.</p>
1860
- */
1861
- interface ValidationExceptionMember {
1862
- PlaybackInterruptionEvent?: never;
1863
- TranscriptEvent?: never;
1864
- IntentResultEvent?: never;
1865
- TextResponseEvent?: never;
1866
- AudioResponseEvent?: never;
1867
- HeartbeatEvent?: never;
1868
- AccessDeniedException?: never;
1869
- ResourceNotFoundException?: never;
1870
- ValidationException: ValidationException;
1871
- ThrottlingException?: never;
1872
- InternalServerException?: never;
1873
- ConflictException?: never;
1874
- DependencyFailedException?: never;
1875
- BadGatewayException?: never;
1876
- $unknown?: never;
1877
- }
1878
- /**
1879
- * <p>Exception thrown when your application exceeds the maximum number of
1880
- * concurrent requests. </p>
1881
- */
1882
- interface ThrottlingExceptionMember {
1883
- PlaybackInterruptionEvent?: never;
1884
- TranscriptEvent?: never;
1885
- IntentResultEvent?: never;
1886
- TextResponseEvent?: never;
1887
- AudioResponseEvent?: never;
1888
- HeartbeatEvent?: never;
1889
- AccessDeniedException?: never;
1890
- ResourceNotFoundException?: never;
1891
- ValidationException?: never;
1892
- ThrottlingException: ThrottlingException;
1893
- InternalServerException?: never;
1894
- ConflictException?: never;
1895
- DependencyFailedException?: never;
1896
- BadGatewayException?: never;
1897
- $unknown?: never;
1898
- }
1899
- /**
1900
- * <p>An error occurred with Amazon Lex V2.</p>
1901
- */
1902
- interface InternalServerExceptionMember {
1903
- PlaybackInterruptionEvent?: never;
1904
- TranscriptEvent?: never;
1905
- IntentResultEvent?: never;
1906
- TextResponseEvent?: never;
1907
- AudioResponseEvent?: never;
1908
- HeartbeatEvent?: never;
1909
- AccessDeniedException?: never;
1910
- ResourceNotFoundException?: never;
1911
- ValidationException?: never;
1912
- ThrottlingException?: never;
1913
- InternalServerException: InternalServerException;
1914
- ConflictException?: never;
1915
- DependencyFailedException?: never;
1916
- BadGatewayException?: never;
1917
- $unknown?: never;
1918
- }
1919
- /**
1920
- * <p>Exception thrown when two clients are using the same AWS account,
1921
- * Amazon Lex V2 bot, and session ID.</p>
1922
- */
1923
- interface ConflictExceptionMember {
1924
- PlaybackInterruptionEvent?: never;
1925
- TranscriptEvent?: never;
1926
- IntentResultEvent?: never;
1927
- TextResponseEvent?: never;
1928
- AudioResponseEvent?: never;
1929
- HeartbeatEvent?: never;
1930
- AccessDeniedException?: never;
1931
- ResourceNotFoundException?: never;
1932
- ValidationException?: never;
1933
- ThrottlingException?: never;
1934
- InternalServerException?: never;
1935
- ConflictException: ConflictException;
1936
- DependencyFailedException?: never;
1937
- BadGatewayException?: never;
1938
- $unknown?: never;
1939
- }
1940
- /**
1941
- * <p></p>
1942
- */
1943
- interface DependencyFailedExceptionMember {
1944
- PlaybackInterruptionEvent?: never;
1945
- TranscriptEvent?: never;
1946
- IntentResultEvent?: never;
1947
- TextResponseEvent?: never;
1948
- AudioResponseEvent?: never;
1949
- HeartbeatEvent?: never;
1950
- AccessDeniedException?: never;
1951
- ResourceNotFoundException?: never;
1952
- ValidationException?: never;
1953
- ThrottlingException?: never;
1954
- InternalServerException?: never;
1955
- ConflictException?: never;
1956
- DependencyFailedException: DependencyFailedException;
1957
- BadGatewayException?: never;
1958
- $unknown?: never;
1959
- }
1960
- /**
1961
- * <p></p>
1962
- */
1963
- interface BadGatewayExceptionMember {
1964
- PlaybackInterruptionEvent?: never;
1965
- TranscriptEvent?: never;
1966
- IntentResultEvent?: never;
1967
- TextResponseEvent?: never;
1968
- AudioResponseEvent?: never;
1969
- HeartbeatEvent?: never;
1970
- AccessDeniedException?: never;
1971
- ResourceNotFoundException?: never;
1972
- ValidationException?: never;
1973
- ThrottlingException?: never;
1974
- InternalServerException?: never;
1975
- ConflictException?: never;
1976
- DependencyFailedException?: never;
1977
- BadGatewayException: BadGatewayException;
1978
- $unknown?: never;
1979
- }
1980
- interface $UnknownMember {
1981
- PlaybackInterruptionEvent?: never;
1982
- TranscriptEvent?: never;
1983
- IntentResultEvent?: never;
1984
- TextResponseEvent?: never;
1985
- AudioResponseEvent?: never;
1986
- HeartbeatEvent?: never;
1987
- AccessDeniedException?: never;
1988
- ResourceNotFoundException?: never;
1989
- ValidationException?: never;
1990
- ThrottlingException?: never;
1991
- InternalServerException?: never;
1992
- ConflictException?: never;
1993
- DependencyFailedException?: never;
1994
- BadGatewayException?: never;
1995
- $unknown: [
1996
- string,
1997
- any
1998
- ];
1999
- }
2000
- interface Visitor<T> {
2001
- PlaybackInterruptionEvent: (value: PlaybackInterruptionEvent) => T;
2002
- TranscriptEvent: (value: TranscriptEvent) => T;
2003
- IntentResultEvent: (value: IntentResultEvent) => T;
2004
- TextResponseEvent: (value: TextResponseEvent) => T;
2005
- AudioResponseEvent: (value: AudioResponseEvent) => T;
2006
- HeartbeatEvent: (value: HeartbeatEvent) => T;
2007
- AccessDeniedException: (value: AccessDeniedException) => T;
2008
- ResourceNotFoundException: (value: ResourceNotFoundException) => T;
2009
- ValidationException: (value: ValidationException) => T;
2010
- ThrottlingException: (value: ThrottlingException) => T;
2011
- InternalServerException: (value: InternalServerException) => T;
2012
- ConflictException: (value: ConflictException) => T;
2013
- DependencyFailedException: (value: DependencyFailedException) => T;
2014
- BadGatewayException: (value: BadGatewayException) => T;
2015
- _: (name: string, value: any) => T;
2016
- }
2017
- const visit: <T>(value: StartConversationResponseEventStream, visitor: Visitor<T>) => T;
2018
- /**
2019
- * @internal
2020
- */
2021
- const filterSensitiveLog: (obj: StartConversationResponseEventStream) => any;
2022
- }
2023
- export interface StartConversationResponse {
2024
- /**
2025
- * <p>Represents the stream of events from Amazon Lex V2 to your application. The
2026
- * events are encoded as HTTP/2 data frames.</p>
2027
- */
2028
- responseEventStream?: AsyncIterable<StartConversationResponseEventStream>;
2029
- }
2030
- export declare namespace StartConversationResponse {
2031
- /**
2032
- * @internal
2033
- */
2034
- const filterSensitiveLog: (obj: StartConversationResponse) => any;
2035
- }