@aws-sdk/client-lex-runtime-service 3.170.0 → 3.171.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.
@@ -1,1642 +1,330 @@
1
- /// <reference types="node" />
2
- import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
3
- import { Readable } from "stream";
4
- import { LexRuntimeServiceServiceException as __BaseException } from "./LexRuntimeServiceServiceException";
5
- /**
6
- * <p>The length of time or number of turns that a context remains
7
- * active.</p>
8
- */
9
- export interface ActiveContextTimeToLive {
10
- /**
11
- * <p>The number of seconds that the context should be active after it is
12
- * first sent in a <code>PostContent</code> or <code>PostText</code>
13
- * response. You can set the value between 5 and 86,400 seconds (24
14
- * hours).</p>
15
- */
16
- timeToLiveInSeconds?: number;
17
- /**
18
- * <p>The number of conversation turns that the context should be active. A
19
- * conversation turn is one <code>PostContent</code> or <code>PostText</code>
20
- * request and the corresponding response from Amazon Lex.</p>
21
- */
22
- turnsToLive?: number;
23
- }
24
- /**
25
- * <p>A context is a variable that contains information about the current
26
- * state of the conversation between a user and Amazon Lex. Context can be set
27
- * automatically by Amazon Lex when an intent is fulfilled, or it can be set at
28
- * runtime using the <code>PutContent</code>, <code>PutText</code>, or
29
- * <code>PutSession</code> operation.</p>
30
- */
31
- export interface ActiveContext {
32
- /**
33
- * <p>The name of the context.</p>
34
- */
35
- name: string | undefined;
36
- /**
37
- * <p>The length of time or number of turns that a context remains
38
- * active.</p>
39
- */
40
- timeToLive: ActiveContextTimeToLive | undefined;
41
- /**
42
- * <p>State variables for the current context. You can use these values as
43
- * default values for slots in subsequent events.</p>
44
- */
45
- parameters: Record<string, string> | undefined;
46
- }
47
- /**
48
- * <p> Request validation failed, there is no usable message in the context,
49
- * or the bot build failed, is still in progress, or contains unbuilt
50
- * changes. </p>
51
- */
52
- export declare class BadRequestException extends __BaseException {
53
- readonly name: "BadRequestException";
54
- readonly $fault: "client";
55
- /**
56
- * @internal
57
- */
58
- constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
59
- }
60
- /**
61
- * <p> Two clients are using the same AWS account, Amazon Lex bot, and user
62
- * ID. </p>
63
- */
64
- export declare class ConflictException extends __BaseException {
65
- readonly name: "ConflictException";
66
- readonly $fault: "client";
67
- /**
68
- * @internal
69
- */
70
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
71
- }
72
- export interface DeleteSessionRequest {
73
- /**
74
- * <p>The name of the bot that contains the session data.</p>
75
- */
76
- botName: string | undefined;
77
- /**
78
- * <p>The alias in use for the bot that contains the session data.</p>
79
- */
80
- botAlias: string | undefined;
81
- /**
82
- * <p>The identifier of the user associated with the session data.</p>
83
- */
84
- userId: string | undefined;
85
- }
86
- export interface DeleteSessionResponse {
87
- /**
88
- * <p>The name of the bot associated with the session data.</p>
89
- */
90
- botName?: string;
91
- /**
92
- * <p>The alias in use for the bot associated with the session data.</p>
93
- */
94
- botAlias?: string;
95
- /**
96
- * <p>The ID of the client application user.</p>
97
- */
98
- userId?: string;
99
- /**
100
- * <p>The unique identifier for the session.</p>
101
- */
102
- sessionId?: string;
103
- }
104
- /**
105
- * <p>Internal service error. Retry the call.</p>
106
- */
107
- export declare class InternalFailureException extends __BaseException {
108
- readonly name: "InternalFailureException";
109
- readonly $fault: "server";
110
- /**
111
- * @internal
112
- */
113
- constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
114
- }
115
- /**
116
- * <p>Exceeded a limit.</p>
117
- */
118
- export declare class LimitExceededException extends __BaseException {
119
- readonly name: "LimitExceededException";
120
- readonly $fault: "client";
121
- retryAfterSeconds?: string;
122
- /**
123
- * @internal
124
- */
125
- constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
126
- }
127
- /**
128
- * <p>The resource (such as the Amazon Lex bot or an alias) that is referred
129
- * to is not found.</p>
130
- */
131
- export declare class NotFoundException extends __BaseException {
132
- readonly name: "NotFoundException";
133
- readonly $fault: "client";
134
- /**
135
- * @internal
136
- */
137
- constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
138
- }
139
- export interface GetSessionRequest {
140
- /**
141
- * <p>The name of the bot that contains the session data.</p>
142
- */
143
- botName: string | undefined;
144
- /**
145
- * <p>The alias in use for the bot that contains the session data.</p>
146
- */
147
- botAlias: string | undefined;
148
- /**
149
- * <p>The ID of the client application user. Amazon Lex uses this to identify a
150
- * user's conversation with your bot. </p>
151
- */
152
- userId: string | undefined;
153
- /**
154
- * <p>A string used to filter the intents returned in the
155
- * <code>recentIntentSummaryView</code> structure. </p>
156
- * <p>When you specify a filter, only intents with their
157
- * <code>checkpointLabel</code> field set to that string are
158
- * returned.</p>
159
- */
160
- checkpointLabelFilter?: string;
161
- }
162
- export declare enum FulfillmentState {
163
- FAILED = "Failed",
164
- FULFILLED = "Fulfilled",
165
- READY_FOR_FULFILLMENT = "ReadyForFulfillment"
166
- }
167
- export declare enum MessageFormatType {
168
- COMPOSITE = "Composite",
169
- CUSTOM_PAYLOAD = "CustomPayload",
170
- PLAIN_TEXT = "PlainText",
171
- SSML = "SSML"
172
- }
173
- export declare enum DialogActionType {
174
- CLOSE = "Close",
175
- CONFIRM_INTENT = "ConfirmIntent",
176
- DELEGATE = "Delegate",
177
- ELICIT_INTENT = "ElicitIntent",
178
- ELICIT_SLOT = "ElicitSlot"
179
- }
180
- /**
181
- * <p>Describes the next action that the bot should take in its interaction
182
- * with the user and provides information about the context in which the
183
- * action takes place. Use the <code>DialogAction</code> data type to set the
184
- * interaction to a specific state, or to return the interaction to a
185
- * previous state.</p>
186
- */
187
- export interface DialogAction {
188
- /**
189
- * <p>The next action that the bot should take in its interaction with the
190
- * user. The possible values are:</p>
191
- * <ul>
192
- * <li>
193
- * <p>
194
- * <code>ConfirmIntent</code> - The next action is asking the user if
195
- * the intent is complete and ready to be fulfilled. This is a yes/no
196
- * question such as "Place the order?"</p>
197
- * </li>
198
- * <li>
199
- * <p>
200
- * <code>Close</code> - Indicates that the there will not be a
201
- * response from the user. For example, the statement "Your order has
202
- * been placed" does not require a response.</p>
203
- * </li>
204
- * <li>
205
- * <p>
206
- * <code>Delegate</code> - The next action is determined by
207
- * Amazon Lex.</p>
208
- * </li>
209
- * <li>
210
- * <p>
211
- * <code>ElicitIntent</code> - The next action is to determine the
212
- * intent that the user wants to fulfill.</p>
213
- * </li>
214
- * <li>
215
- * <p>
216
- * <code>ElicitSlot</code> - The next action is to elicit a slot
217
- * value from the user.</p>
218
- * </li>
219
- * </ul>
220
- */
221
- type: DialogActionType | string | undefined;
222
- /**
223
- * <p>The name of the intent.</p>
224
- */
225
- intentName?: string;
226
- /**
227
- * <p>Map of the slots that have been gathered and their values. </p>
228
- */
229
- slots?: Record<string, string>;
230
- /**
231
- * <p>The name of the slot that should be elicited from the user.</p>
232
- */
233
- slotToElicit?: string;
234
- /**
235
- * <p>The fulfillment state of the intent. The possible values are:</p>
236
- * <ul>
237
- * <li>
238
- * <p>
239
- * <code>Failed</code> - The Lambda function associated with the
240
- * intent failed to fulfill the intent.</p>
241
- * </li>
242
- * <li>
243
- * <p>
244
- * <code>Fulfilled</code> - The intent has fulfilled by the Lambda
245
- * function associated with the intent. </p>
246
- * </li>
247
- * <li>
248
- * <p>
249
- * <code>ReadyForFulfillment</code> - All of the information
250
- * necessary for the intent is present and the intent ready to be
251
- * fulfilled by the client application.</p>
252
- * </li>
253
- * </ul>
254
- */
255
- fulfillmentState?: FulfillmentState | string;
256
- /**
257
- * <p>The message that should be shown to the user. If you don't specify a
258
- * message, Amazon Lex will use the message configured for the intent.</p>
259
- */
260
- message?: string;
261
- /**
262
- * <ul>
263
- * <li>
264
- * <p>
265
- * <code>PlainText</code> - The message contains plain UTF-8
266
- * text.</p>
267
- * </li>
268
- * <li>
269
- * <p>
270
- * <code>CustomPayload</code> - The message is a custom format for
271
- * the client.</p>
272
- * </li>
273
- * <li>
274
- * <p>
275
- * <code>SSML</code> - The message contains text formatted for voice
276
- * output.</p>
277
- * </li>
278
- * <li>
279
- * <p>
280
- * <code>Composite</code> - The message contains an escaped JSON
281
- * object containing one or more messages. For more information, see
282
- * <a href="https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html">Message Groups</a>. </p>
283
- * </li>
284
- * </ul>
285
- */
286
- messageFormat?: MessageFormatType | string;
287
- }
288
- export declare enum ConfirmationStatus {
289
- CONFIRMED = "Confirmed",
290
- DENIED = "Denied",
291
- NONE = "None"
292
- }
293
- /**
294
- * <p>Provides information about the state of an intent. You can use this
295
- * information to get the current state of an intent so that you can process
296
- * the intent, or so that you can return the intent to its previous
297
- * state.</p>
298
- */
299
- export interface IntentSummary {
300
- /**
301
- * <p>The name of the intent.</p>
302
- */
303
- intentName?: string;
304
- /**
305
- * <p>A user-defined label that identifies a particular intent. You can use
306
- * this label to return to a previous intent. </p>
307
- * <p>Use the <code>checkpointLabelFilter</code> parameter of the
308
- * <code>GetSessionRequest</code> operation to filter the intents returned
309
- * by the operation to those with only the specified label.</p>
310
- */
311
- checkpointLabel?: string;
312
- /**
313
- * <p>Map of the slots that have been gathered and their values. </p>
314
- */
315
- slots?: Record<string, string>;
316
- /**
317
- * <p>The status of the intent after the user responds to the confirmation
318
- * prompt. If the user confirms the intent, Amazon Lex sets this field to
319
- * <code>Confirmed</code>. If the user denies the intent, Amazon Lex sets this
320
- * value to <code>Denied</code>. The possible values are:</p>
321
- * <ul>
322
- * <li>
323
- * <p>
324
- * <code>Confirmed</code> - The user has responded "Yes" to the
325
- * confirmation prompt, confirming that the intent is complete and that
326
- * it is ready to be fulfilled.</p>
327
- * </li>
328
- * <li>
329
- * <p>
330
- * <code>Denied</code> - The user has responded "No" to the
331
- * confirmation prompt.</p>
332
- * </li>
333
- * <li>
334
- * <p>
335
- * <code>None</code> - The user has never been prompted for
336
- * confirmation; or, the user was prompted but did not confirm or deny
337
- * the prompt.</p>
338
- * </li>
339
- * </ul>
340
- */
341
- confirmationStatus?: ConfirmationStatus | string;
342
- /**
343
- * <p>The next action that the bot should take in its interaction with the
344
- * user. The possible values are:</p>
345
- * <ul>
346
- * <li>
347
- * <p>
348
- * <code>ConfirmIntent</code> - The next action is asking the user if
349
- * the intent is complete and ready to be fulfilled. This is a yes/no
350
- * question such as "Place the order?"</p>
351
- * </li>
352
- * <li>
353
- * <p>
354
- * <code>Close</code> - Indicates that the there will not be a
355
- * response from the user. For example, the statement "Your order has
356
- * been placed" does not require a response.</p>
357
- * </li>
358
- * <li>
359
- * <p>
360
- * <code>ElicitIntent</code> - The next action is to determine the
361
- * intent that the user wants to fulfill.</p>
362
- * </li>
363
- * <li>
364
- * <p>
365
- * <code>ElicitSlot</code> - The next action is to elicit a slot
366
- * value from the user.</p>
367
- * </li>
368
- * </ul>
369
- */
370
- dialogActionType: DialogActionType | string | undefined;
371
- /**
372
- * <p>The fulfillment state of the intent. The possible values are:</p>
373
- * <ul>
374
- * <li>
375
- * <p>
376
- * <code>Failed</code> - The Lambda function associated with the
377
- * intent failed to fulfill the intent.</p>
378
- * </li>
379
- * <li>
380
- * <p>
381
- * <code>Fulfilled</code> - The intent has fulfilled by the Lambda
382
- * function associated with the intent. </p>
383
- * </li>
384
- * <li>
385
- * <p>
386
- * <code>ReadyForFulfillment</code> - All of the information
387
- * necessary for the intent is present and the intent ready to be
388
- * fulfilled by the client application.</p>
389
- * </li>
390
- * </ul>
391
- */
392
- fulfillmentState?: FulfillmentState | string;
393
- /**
394
- * <p>The next slot to elicit from the user. If there is not slot to elicit,
395
- * the field is blank.</p>
396
- */
397
- slotToElicit?: string;
398
- }
399
- export interface GetSessionResponse {
400
- /**
401
- * <p>An array of information about the intents used in the session. The
402
- * array can contain a maximum of three summaries. If more than three intents
403
- * are used in the session, the <code>recentIntentSummaryView</code>
404
- * operation contains information about the last three intents used.</p>
405
- * <p>If you set the <code>checkpointLabelFilter</code> parameter in the
406
- * request, the array contains only the intents with the specified
407
- * label.</p>
408
- */
409
- recentIntentSummaryView?: IntentSummary[];
410
- /**
411
- * <p>Map of key/value pairs representing the session-specific context
412
- * information. It contains application information passed between Amazon Lex and
413
- * a client application.</p>
414
- */
415
- sessionAttributes?: Record<string, string>;
416
- /**
417
- * <p>A unique identifier for the session.</p>
418
- */
419
- sessionId?: string;
420
- /**
421
- * <p>Describes the current state of the bot.</p>
422
- */
423
- dialogAction?: DialogAction;
424
- /**
425
- * <p>A list of active contexts for the session. A context can be set when
426
- * an intent is fulfilled or by calling the <code>PostContent</code>,
427
- * <code>PostText</code>, or <code>PutSession</code> operation.</p>
428
- * <p>You can use a context to control the intents that can follow up an
429
- * intent, or to modify the operation of your application.</p>
430
- */
431
- activeContexts?: ActiveContext[];
432
- }
433
- /**
434
- * <p>Either the Amazon Lex bot is still building, or one of the dependent
435
- * services (Amazon Polly, AWS Lambda) failed with an internal service
436
- * error.</p>
437
- */
438
- export declare class BadGatewayException extends __BaseException {
439
- readonly name: "BadGatewayException";
440
- readonly $fault: "server";
441
- Message?: string;
442
- /**
443
- * @internal
444
- */
445
- constructor(opts: __ExceptionOptionType<BadGatewayException, __BaseException>);
446
- }
447
- /**
448
- * <p> One of the dependencies, such as AWS Lambda or Amazon Polly, threw an
449
- * exception. For example, </p>
450
- * <ul>
451
- * <li>
452
- * <p>If Amazon Lex does not have sufficient permissions to call a Lambda
453
- * function.</p>
454
- * </li>
455
- * <li>
456
- * <p>If a Lambda function takes longer than 30 seconds to
457
- * execute.</p>
458
- * </li>
459
- * <li>
460
- * <p>If a fulfillment Lambda function returns a <code>Delegate</code>
461
- * dialog action without removing any slot values.</p>
462
- * </li>
463
- * </ul>
464
- */
465
- export declare class DependencyFailedException extends __BaseException {
466
- readonly name: "DependencyFailedException";
467
- readonly $fault: "client";
468
- Message?: string;
469
- /**
470
- * @internal
471
- */
472
- constructor(opts: __ExceptionOptionType<DependencyFailedException, __BaseException>);
473
- }
474
- /**
475
- * <p>This exception is not used.</p>
476
- */
477
- export declare class LoopDetectedException extends __BaseException {
478
- readonly name: "LoopDetectedException";
479
- readonly $fault: "server";
480
- Message?: string;
481
- /**
482
- * @internal
483
- */
484
- constructor(opts: __ExceptionOptionType<LoopDetectedException, __BaseException>);
485
- }
486
- /**
487
- * <p>The accept header in the request does not have a valid value.</p>
488
- */
489
- export declare class NotAcceptableException extends __BaseException {
490
- readonly name: "NotAcceptableException";
491
- readonly $fault: "client";
492
- /**
493
- * @internal
494
- */
495
- constructor(opts: __ExceptionOptionType<NotAcceptableException, __BaseException>);
496
- }
497
- export interface PostContentRequest {
498
- /**
499
- * <p>Name of the Amazon Lex bot.</p>
500
- */
501
- botName: string | undefined;
502
- /**
503
- * <p>Alias of the Amazon Lex bot.</p>
504
- */
505
- botAlias: string | undefined;
506
- /**
507
- * <p>The ID of the client application user. Amazon Lex uses this to identify a
508
- * user's conversation with your bot. At runtime, each request must contain
509
- * the <code>userID</code> field.</p>
510
- * <p>To decide the user ID to use for your application, consider the
511
- * following factors.</p>
512
- * <ul>
513
- * <li>
514
- * <p>The <code>userID</code> field must not contain any personally
515
- * identifiable information of the user, for example, name, personal
516
- * identification numbers, or other end user personal information.</p>
517
- * </li>
518
- * <li>
519
- * <p>If you want a user to start a conversation on one device and
520
- * continue on another device, use a user-specific identifier.</p>
521
- * </li>
522
- * <li>
523
- * <p>If you want the same user to be able to have two independent
524
- * conversations on two different devices, choose a device-specific
525
- * identifier.</p>
526
- * </li>
527
- * <li>
528
- * <p>A user can't have two independent conversations with two different
529
- * versions of the same bot. For example, a user can't have a
530
- * conversation with the PROD and BETA versions of the same bot. If you
531
- * anticipate that a user will need to have conversation with two
532
- * different versions, for example, while testing, include the bot alias
533
- * in the user ID to separate the two conversations.</p>
534
- * </li>
535
- * </ul>
536
- */
537
- userId: string | undefined;
538
- /**
539
- * <p>You pass this value as the <code>x-amz-lex-session-attributes</code>
540
- * HTTP header.</p>
541
- * <p>Application-specific information passed between Amazon Lex and a client
542
- * application. The value must be a JSON serialized and base64 encoded map
543
- * with string keys and values. The total size of the
544
- * <code>sessionAttributes</code> and <code>requestAttributes</code>
545
- * headers is limited to 12 KB.</p>
546
- * <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs">Setting Session Attributes</a>.</p>
547
- */
548
- sessionAttributes?: __LazyJsonString | string;
549
- /**
550
- * <p>You pass this value as the <code>x-amz-lex-request-attributes</code>
551
- * HTTP header.</p>
552
- * <p>Request-specific information passed between Amazon Lex and a client
553
- * application. The value must be a JSON serialized and base64 encoded map
554
- * with string keys and values. The total size of the
555
- * <code>requestAttributes</code> and <code>sessionAttributes</code>
556
- * headers is limited to 12 KB.</p>
557
- * <p>The namespace <code>x-amz-lex:</code> is reserved for special
558
- * attributes. Don't create any request attributes with the prefix
559
- * <code>x-amz-lex:</code>.</p>
560
- * <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs">Setting Request Attributes</a>.</p>
561
- */
562
- requestAttributes?: __LazyJsonString | string;
563
- /**
564
- * <p> You pass this value as the <code>Content-Type</code> HTTP header. </p>
565
- * <p> Indicates the audio format or text. The header value must start with
566
- * one of the following prefixes: </p>
567
- * <ul>
568
- * <li>
569
- * <p>PCM format, audio data must be in little-endian byte order.</p>
570
- * <ul>
571
- * <li>
572
- * <p>audio/l16; rate=16000; channels=1</p>
573
- * </li>
574
- * <li>
575
- * <p>audio/x-l16; sample-rate=16000; channel-count=1</p>
576
- * </li>
577
- * <li>
578
- * <p>audio/lpcm; sample-rate=8000; sample-size-bits=16;
579
- * channel-count=1; is-big-endian=false </p>
580
- * </li>
581
- * </ul>
582
- * </li>
583
- * <li>
584
- * <p>Opus format</p>
585
- * <ul>
586
- * <li>
587
- * <p>audio/x-cbr-opus-with-preamble; preamble-size=0;
588
- * bit-rate=256000; frame-size-milliseconds=4</p>
589
- * </li>
590
- * </ul>
591
- * </li>
592
- * <li>
593
- * <p>Text format</p>
594
- * <ul>
595
- * <li>
596
- * <p>text/plain; charset=utf-8</p>
597
- * </li>
598
- * </ul>
599
- * </li>
600
- * </ul>
601
- */
602
- contentType: string | undefined;
603
- /**
604
- * <p> You pass this value as the <code>Accept</code> HTTP header. </p>
605
- * <p> The message Amazon Lex returns in the response can be either text or
606
- * speech based on the <code>Accept</code> HTTP header value in the request. </p>
607
- * <ul>
608
- * <li>
609
- * <p> If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex
610
- * returns text in the response. </p>
611
- * </li>
612
- * <li>
613
- * <p> If the value begins with <code>audio/</code>, Amazon Lex returns
614
- * speech in the response. Amazon Lex uses Amazon Polly to generate the speech
615
- * (using the configuration you specified in the <code>Accept</code>
616
- * header). For example, if you specify <code>audio/mpeg</code> as the
617
- * value, Amazon Lex returns speech in the MPEG format.</p>
618
- * </li>
619
- * <li>
620
- * <p>If the value is <code>audio/pcm</code>, the speech returned is
621
- * <code>audio/pcm</code> in 16-bit, little endian format.
622
- * </p>
623
- * </li>
624
- * <li>
625
- * <p>The following are the accepted values:</p>
626
- * <ul>
627
- * <li>
628
- * <p>audio/mpeg</p>
629
- * </li>
630
- * <li>
631
- * <p>audio/ogg</p>
632
- * </li>
633
- * <li>
634
- * <p>audio/pcm</p>
635
- * </li>
636
- * <li>
637
- * <p>text/plain; charset=utf-8</p>
638
- * </li>
639
- * <li>
640
- * <p>audio/* (defaults to mpeg)</p>
641
- * </li>
642
- * </ul>
643
- * </li>
644
- * </ul>
645
- */
646
- accept?: string;
647
- /**
648
- * <p> User input in PCM or Opus audio format or text format as described in
649
- * the <code>Content-Type</code> HTTP header. </p>
650
- * <p>You can stream audio data to Amazon Lex or you can create a local buffer
651
- * that captures all of the audio data before sending. In general, you get
652
- * better performance if you stream audio data rather than buffering the data
653
- * locally.</p>
654
- */
655
- inputStream: Readable | ReadableStream | Blob | undefined;
656
- /**
657
- * <p>A list of contexts active for the request. A context can be activated
658
- * when a previous intent is fulfilled, or by including the context in the
659
- * request,</p>
660
- * <p>If you don't specify a list of contexts, Amazon Lex will use the current
661
- * list of contexts for the session. If you specify an empty list, all
662
- * contexts for the session are cleared.</p>
663
- */
664
- activeContexts?: __LazyJsonString | string;
665
- }
666
- export declare enum DialogState {
667
- CONFIRM_INTENT = "ConfirmIntent",
668
- ELICIT_INTENT = "ElicitIntent",
669
- ELICIT_SLOT = "ElicitSlot",
670
- FAILED = "Failed",
671
- FULFILLED = "Fulfilled",
672
- READY_FOR_FULFILLMENT = "ReadyForFulfillment"
673
- }
674
- export interface PostContentResponse {
675
- /**
676
- * <p>Content type as specified in the <code>Accept</code> HTTP header in
677
- * the request.</p>
678
- */
679
- contentType?: string;
680
- /**
681
- * <p>Current user intent that Amazon Lex is aware of.</p>
682
- */
683
- intentName?: string;
684
- /**
685
- * <p>Provides a score that indicates how confident Amazon Lex is that the
686
- * returned intent is the one that matches the user's intent. The score is
687
- * between 0.0 and 1.0.</p>
688
- * <p>The score is a relative score, not an absolute score. The score may
689
- * change based on improvements to Amazon Lex. </p>
690
- */
691
- nluIntentConfidence?: __LazyJsonString | string;
692
- /**
693
- * <p>One to four alternative intents that may be applicable to the user's
694
- * intent.</p>
695
- * <p>Each alternative includes a score that indicates how confident Amazon Lex
696
- * is that the intent matches the user's intent. The intents are sorted by
697
- * the confidence score.</p>
698
- */
699
- alternativeIntents?: __LazyJsonString | string;
700
- /**
701
- * <p>Map of zero or more intent slots (name/value pairs) Amazon Lex detected
702
- * from the user input during the conversation. The field is base-64
703
- * encoded.</p>
704
- * <p>Amazon Lex creates a resolution list containing likely values for a slot.
705
- * The value that it returns is determined by the
706
- * <code>valueSelectionStrategy</code> selected when the slot type was
707
- * created or updated. If <code>valueSelectionStrategy</code> is set to
708
- * <code>ORIGINAL_VALUE</code>, the value provided by the user is returned,
709
- * if the user value is similar to the slot values. If
710
- * <code>valueSelectionStrategy</code> is set to
711
- * <code>TOP_RESOLUTION</code> Amazon Lex returns the first value in the
712
- * resolution list or, if there is no resolution list, null. If you don't
713
- * specify a <code>valueSelectionStrategy</code>, the default is
714
- * <code>ORIGINAL_VALUE</code>.</p>
715
- */
716
- slots?: __LazyJsonString | string;
717
- /**
718
- * <p> Map of key/value pairs representing the session-specific context
719
- * information. </p>
720
- */
721
- sessionAttributes?: __LazyJsonString | string;
722
- /**
723
- * <p>The sentiment expressed in an utterance.</p>
724
- * <p>When the bot is configured to send utterances to Amazon Comprehend for
725
- * sentiment analysis, this field contains the result of the analysis.</p>
726
- */
727
- sentimentResponse?: string;
728
- /**
729
- * @deprecated
730
- *
731
- * <p>You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419,
732
- * es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the
733
- * <code>message</code> field is null. You should use the
734
- * <code>encodedMessage</code> field instead.</p>
735
- * <p>The message to convey to the user. The message can come from the bot's
736
- * configuration or from a Lambda function.</p>
737
- * <p>If the intent is not configured with a Lambda function, or if the Lambda
738
- * function returned <code>Delegate</code> as the
739
- * <code>dialogAction.type</code> in its response, Amazon Lex decides on the
740
- * next course of action and selects an appropriate message from the bot's
741
- * configuration based on the current interaction context. For example, if
742
- * Amazon Lex isn't able to understand user input, it uses a clarification prompt
743
- * message.</p>
744
- * <p>When you create an intent you can assign messages to groups. When
745
- * messages are assigned to groups Amazon Lex returns one message from each group
746
- * in the response. The message field is an escaped JSON string containing
747
- * the messages. For more information about the structure of the JSON string
748
- * returned, see <a>msg-prompts-formats</a>.</p>
749
- * <p>If the Lambda function returns a message, Amazon Lex passes it to the client
750
- * in its response.</p>
751
- */
752
- message?: string;
753
- /**
754
- * <p>The message to convey to the user. The message can come from the bot's
755
- * configuration or from a Lambda function.</p>
756
- * <p>If the intent is not configured with a Lambda function, or if the Lambda
757
- * function returned <code>Delegate</code> as the
758
- * <code>dialogAction.type</code> in its response, Amazon Lex decides on the
759
- * next course of action and selects an appropriate message from the bot's
760
- * configuration based on the current interaction context. For example, if
761
- * Amazon Lex isn't able to understand user input, it uses a clarification prompt
762
- * message.</p>
763
- * <p>When you create an intent you can assign messages to groups. When
764
- * messages are assigned to groups Amazon Lex returns one message from each group
765
- * in the response. The message field is an escaped JSON string containing
766
- * the messages. For more information about the structure of the JSON string
767
- * returned, see <a>msg-prompts-formats</a>.</p>
768
- * <p>If the Lambda function returns a message, Amazon Lex passes it to the client
769
- * in its response.</p>
770
- * <p>The <code>encodedMessage</code> field is base-64 encoded. You must
771
- * decode the field before you can use the value.</p>
772
- */
773
- encodedMessage?: string;
774
- /**
775
- * <p>The format of the response message. One of the following
776
- * values:</p>
777
- * <ul>
778
- * <li>
779
- * <p>
780
- * <code>PlainText</code> - The message contains plain UTF-8
781
- * text.</p>
782
- * </li>
783
- * <li>
784
- * <p>
785
- * <code>CustomPayload</code> - The message is a custom format for
786
- * the client.</p>
787
- * </li>
788
- * <li>
789
- * <p>
790
- * <code>SSML</code> - The message contains text formatted for voice
791
- * output.</p>
792
- * </li>
793
- * <li>
794
- * <p>
795
- * <code>Composite</code> - The message contains an escaped JSON
796
- * object containing one or more messages from the groups that messages
797
- * were assigned to when the intent was created.</p>
798
- * </li>
799
- * </ul>
800
- */
801
- messageFormat?: MessageFormatType | string;
802
- /**
803
- * <p>Identifies the current state of the user interaction. Amazon Lex returns
804
- * one of the following values as <code>dialogState</code>. The client can
805
- * optionally use this information to customize the user interface. </p>
806
- * <ul>
807
- * <li>
808
- * <p>
809
- * <code>ElicitIntent</code> - Amazon Lex wants to elicit the user's intent.
810
- * Consider the following examples: </p>
811
- * <p> For example, a user might utter an intent ("I want to order a
812
- * pizza"). If Amazon Lex cannot infer the user intent from this utterance, it
813
- * will return this dialog state. </p>
814
- * </li>
815
- * <li>
816
- * <p>
817
- * <code>ConfirmIntent</code> - Amazon Lex is expecting a "yes" or "no"
818
- * response. </p>
819
- * <p>For example, Amazon Lex wants user confirmation before fulfilling an
820
- * intent. Instead of a simple "yes" or "no" response, a user might
821
- * respond with additional information. For example, "yes, but make it a
822
- * thick crust pizza" or "no, I want to order a drink." Amazon Lex can process
823
- * such additional information (in these examples, update the crust type
824
- * slot or change the intent from OrderPizza to OrderDrink). </p>
825
- * </li>
826
- * <li>
827
- * <p>
828
- * <code>ElicitSlot</code> - Amazon Lex is expecting the value of a slot for
829
- * the current intent. </p>
830
- * <p> For example, suppose that in the response Amazon Lex sends this
831
- * message: "What size pizza would you like?". A user might reply with
832
- * the slot value (e.g., "medium"). The user might also provide
833
- * additional information in the response (e.g., "medium thick crust
834
- * pizza"). Amazon Lex can process such additional information appropriately.
835
- * </p>
836
- * </li>
837
- * <li>
838
- * <p>
839
- * <code>Fulfilled</code> - Conveys that the Lambda function has
840
- * successfully fulfilled the intent. </p>
841
- * </li>
842
- * <li>
843
- * <p>
844
- * <code>ReadyForFulfillment</code> - Conveys that the client has to
845
- * fulfill the request. </p>
846
- * </li>
847
- * <li>
848
- * <p>
849
- * <code>Failed</code> - Conveys that the conversation with the user
850
- * failed. </p>
851
- * <p> This can happen for various reasons, including that the user does
852
- * not provide an appropriate response to prompts from the service (you
853
- * can configure how many times Amazon Lex can prompt a user for specific
854
- * information), or if the Lambda function fails to fulfill the intent.
855
- * </p>
856
- * </li>
857
- * </ul>
858
- */
859
- dialogState?: DialogState | string;
860
- /**
861
- * <p> If the <code>dialogState</code> value is <code>ElicitSlot</code>,
862
- * returns the name of the slot for which Amazon Lex is eliciting a value. </p>
863
- */
864
- slotToElicit?: string;
865
- /**
866
- * @deprecated
867
- *
868
- * <p>The text used to process the request.</p>
869
- * <p>You can use this field only in the de-DE, en-AU, en-GB, en-US, es-419,
870
- * es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the
871
- * <code>inputTranscript</code> field is null. You should use the
872
- * <code>encodedInputTranscript</code> field instead.</p>
873
- * <p>If the input was an audio stream, the <code>inputTranscript</code>
874
- * field contains the text extracted from the audio stream. This is the text
875
- * that is actually processed to recognize intents and slot values. You can
876
- * use this information to determine if Amazon Lex is correctly processing the
877
- * audio that you send.</p>
878
- */
879
- inputTranscript?: string;
880
- /**
881
- * <p>The text used to process the request.</p>
882
- * <p>If the input was an audio stream, the
883
- * <code>encodedInputTranscript</code> field contains the text extracted
884
- * from the audio stream. This is the text that is actually processed to
885
- * recognize intents and slot values. You can use this information to
886
- * determine if Amazon Lex is correctly processing the audio that you send.</p>
887
- * <p>The <code>encodedInputTranscript</code> field is base-64 encoded. You must
888
- * decode the field before you can use the value.</p>
889
- */
890
- encodedInputTranscript?: string;
891
- /**
892
- * <p>The prompt (or statement) to convey to the user. This is based on the
893
- * bot configuration and context. For example, if Amazon Lex did not understand
894
- * the user intent, it sends the <code>clarificationPrompt</code> configured
895
- * for the bot. If the intent requires confirmation before taking the
896
- * fulfillment action, it sends the <code>confirmationPrompt</code>. Another
897
- * example: Suppose that the Lambda function successfully fulfilled the
898
- * intent, and sent a message to convey to the user. Then Amazon Lex sends that
899
- * message in the response. </p>
900
- */
901
- audioStream?: Readable | ReadableStream | Blob;
902
- /**
903
- * <p>The version of the bot that responded to the conversation. You can use
904
- * this information to help determine if one version of a bot is performing
905
- * better than another version.</p>
906
- */
907
- botVersion?: string;
908
- /**
909
- * <p>The unique identifier for the session.</p>
910
- */
911
- sessionId?: string;
912
- /**
913
- * <p>A list of active contexts for the session. A context can be set when
914
- * an intent is fulfilled or by calling the <code>PostContent</code>,
915
- * <code>PostText</code>, or <code>PutSession</code> operation.</p>
916
- * <p>You can use a context to control the intents that can follow up an
917
- * intent, or to modify the operation of your application.</p>
918
- */
919
- activeContexts?: __LazyJsonString | string;
920
- }
921
- /**
922
- * <p>The input speech is too long.</p>
923
- */
924
- export declare class RequestTimeoutException extends __BaseException {
925
- readonly name: "RequestTimeoutException";
926
- readonly $fault: "client";
927
- /**
928
- * @internal
929
- */
930
- constructor(opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>);
931
- }
932
- /**
933
- * <p>The Content-Type header (<code>PostContent</code> API) has an invalid
934
- * value. </p>
935
- */
936
- export declare class UnsupportedMediaTypeException extends __BaseException {
937
- readonly name: "UnsupportedMediaTypeException";
938
- readonly $fault: "client";
939
- /**
940
- * @internal
941
- */
942
- constructor(opts: __ExceptionOptionType<UnsupportedMediaTypeException, __BaseException>);
943
- }
944
- export interface PostTextRequest {
945
- /**
946
- * <p>The name of the Amazon Lex bot.</p>
947
- */
948
- botName: string | undefined;
949
- /**
950
- * <p>The alias of the Amazon Lex bot.</p>
951
- */
952
- botAlias: string | undefined;
953
- /**
954
- * <p>The ID of the client application user. Amazon Lex uses this to identify a
955
- * user's conversation with your bot. At runtime, each request must contain
956
- * the <code>userID</code> field.</p>
957
- * <p>To decide the user ID to use for your application, consider the
958
- * following factors.</p>
959
- * <ul>
960
- * <li>
961
- * <p>The <code>userID</code> field must not contain any personally
962
- * identifiable information of the user, for example, name, personal
963
- * identification numbers, or other end user personal information.</p>
964
- * </li>
965
- * <li>
966
- * <p>If you want a user to start a conversation on one device and
967
- * continue on another device, use a user-specific identifier.</p>
968
- * </li>
969
- * <li>
970
- * <p>If you want the same user to be able to have two independent
971
- * conversations on two different devices, choose a device-specific
972
- * identifier.</p>
973
- * </li>
974
- * <li>
975
- * <p>A user can't have two independent conversations with two different
976
- * versions of the same bot. For example, a user can't have a
977
- * conversation with the PROD and BETA versions of the same bot. If you
978
- * anticipate that a user will need to have conversation with two
979
- * different versions, for example, while testing, include the bot alias
980
- * in the user ID to separate the two conversations.</p>
981
- * </li>
982
- * </ul>
983
- */
984
- userId: string | undefined;
985
- /**
986
- * <p>Application-specific information passed between Amazon Lex and a client
987
- * application.</p>
988
- * <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs">Setting Session Attributes</a>.</p>
989
- */
990
- sessionAttributes?: Record<string, string>;
991
- /**
992
- * <p>Request-specific information passed between Amazon Lex and a client
993
- * application.</p>
994
- * <p>The namespace <code>x-amz-lex:</code> is reserved for special
995
- * attributes. Don't create any request attributes with the prefix
996
- * <code>x-amz-lex:</code>.</p>
997
- * <p>For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs">Setting Request Attributes</a>.</p>
998
- */
999
- requestAttributes?: Record<string, string>;
1000
- /**
1001
- * <p>The text that the user entered (Amazon Lex interprets this text).</p>
1002
- */
1003
- inputText: string | undefined;
1004
- /**
1005
- * <p>A list of contexts active for the request. A context can be activated
1006
- * when a previous intent is fulfilled, or by including the context in the
1007
- * request,</p>
1008
- * <p>If you don't specify a list of contexts, Amazon Lex will use the current
1009
- * list of contexts for the session. If you specify an empty list, all
1010
- * contexts for the session are cleared.</p>
1011
- */
1012
- activeContexts?: ActiveContext[];
1013
- }
1014
- /**
1015
- * <p>Provides a score that indicates the confidence that Amazon Lex has that an
1016
- * intent is the one that satisfies the user's intent.</p>
1017
- */
1018
- export interface IntentConfidence {
1019
- /**
1020
- * <p>A score that indicates how confident Amazon Lex is that an intent satisfies
1021
- * the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate
1022
- * higher confidence.</p>
1023
- */
1024
- score?: number;
1025
- }
1026
- /**
1027
- * <p>An intent that Amazon Lex suggests satisfies the user's intent. Includes
1028
- * the name of the intent, the confidence that Amazon Lex has that the user's
1029
- * intent is satisfied, and the slots defined for the intent.</p>
1030
- */
1031
- export interface PredictedIntent {
1032
- /**
1033
- * <p>The name of the intent that Amazon Lex suggests satisfies the user's
1034
- * intent.</p>
1035
- */
1036
- intentName?: string;
1037
- /**
1038
- * <p>Indicates how confident Amazon Lex is that an intent satisfies the user's
1039
- * intent.</p>
1040
- */
1041
- nluIntentConfidence?: IntentConfidence;
1042
- /**
1043
- * <p>The slot and slot values associated with the predicted intent.</p>
1044
- */
1045
- slots?: Record<string, string>;
1046
- }
1047
- export declare enum ContentType {
1048
- GENERIC = "application/vnd.amazonaws.card.generic"
1049
- }
1050
- /**
1051
- * <p>Represents an option to be shown on the client platform (Facebook,
1052
- * Slack, etc.)</p>
1053
- */
1054
- export interface Button {
1055
- /**
1056
- * <p>Text that is visible to the user on the button.</p>
1057
- */
1058
- text: string | undefined;
1059
- /**
1060
- * <p>The value sent to Amazon Lex when a user chooses the button. For
1061
- * example, consider button text "NYC." When the user chooses the button, the
1062
- * value sent can be "New York City."</p>
1063
- */
1064
- value: string | undefined;
1065
- }
1066
- /**
1067
- * <p>Represents an option rendered to the user when a prompt is shown. It
1068
- * could be an image, a button, a link, or text. </p>
1069
- */
1070
- export interface GenericAttachment {
1071
- /**
1072
- * <p>The title of the option.</p>
1073
- */
1074
- title?: string;
1075
- /**
1076
- * <p>The subtitle shown below the title.</p>
1077
- */
1078
- subTitle?: string;
1079
- /**
1080
- * <p>The URL of an attachment to the response card.</p>
1081
- */
1082
- attachmentLinkUrl?: string;
1083
- /**
1084
- * <p>The URL of an image that is displayed to the user.</p>
1085
- */
1086
- imageUrl?: string;
1087
- /**
1088
- * <p>The list of options to show to the user.</p>
1089
- */
1090
- buttons?: Button[];
1091
- }
1092
- /**
1093
- * <p>If you configure a response card when creating your bots, Amazon Lex
1094
- * substitutes the session attributes and slot values that are available, and
1095
- * then returns it. The response card can also come from a Lambda function (
1096
- * <code>dialogCodeHook</code> and <code>fulfillmentActivity</code> on an
1097
- * intent).</p>
1098
- */
1099
- export interface ResponseCard {
1100
- /**
1101
- * <p>The version of the response card format.</p>
1102
- */
1103
- version?: string;
1104
- /**
1105
- * <p>The content type of the response.</p>
1106
- */
1107
- contentType?: ContentType | string;
1108
- /**
1109
- * <p>An array of attachment objects representing options.</p>
1110
- */
1111
- genericAttachments?: GenericAttachment[];
1112
- }
1113
- /**
1114
- * <p>The sentiment expressed in an utterance.</p>
1115
- * <p>When the bot is configured to send utterances to Amazon Comprehend for
1116
- * sentiment analysis, this field structure contains the result of the
1117
- * analysis.</p>
1118
- */
1119
- export interface SentimentResponse {
1120
- /**
1121
- * <p>The inferred sentiment that Amazon Comprehend has the highest
1122
- * confidence in.</p>
1123
- */
1124
- sentimentLabel?: string;
1125
- /**
1126
- * <p>The likelihood that the sentiment was correctly inferred.</p>
1127
- */
1128
- sentimentScore?: string;
1129
- }
1130
- export interface PostTextResponse {
1131
- /**
1132
- * <p>The current user intent that Amazon Lex is aware of.</p>
1133
- */
1134
- intentName?: string;
1135
- /**
1136
- * <p>Provides a score that indicates how confident Amazon Lex is that the
1137
- * returned intent is the one that matches the user's intent. The score is
1138
- * between 0.0 and 1.0. For more information, see <a href="https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html">Confidence Scores</a>.</p>
1139
- * <p>The score is a relative score, not an absolute score. The score may
1140
- * change based on improvements to Amazon Lex.</p>
1141
- */
1142
- nluIntentConfidence?: IntentConfidence;
1143
- /**
1144
- * <p>One to four alternative intents that may be applicable to the user's
1145
- * intent.</p>
1146
- * <p>Each alternative includes a score that indicates how confident Amazon Lex
1147
- * is that the intent matches the user's intent. The intents are sorted by
1148
- * the confidence score.</p>
1149
- */
1150
- alternativeIntents?: PredictedIntent[];
1151
- /**
1152
- * <p> The intent slots that Amazon Lex detected from the user input in the
1153
- * conversation. </p>
1154
- * <p>Amazon Lex creates a resolution list containing likely values for a slot.
1155
- * The value that it returns is determined by the
1156
- * <code>valueSelectionStrategy</code> selected when the slot type was
1157
- * created or updated. If <code>valueSelectionStrategy</code> is set to
1158
- * <code>ORIGINAL_VALUE</code>, the value provided by the user is returned,
1159
- * if the user value is similar to the slot values. If
1160
- * <code>valueSelectionStrategy</code> is set to
1161
- * <code>TOP_RESOLUTION</code> Amazon Lex returns the first value in the
1162
- * resolution list or, if there is no resolution list, null. If you don't
1163
- * specify a <code>valueSelectionStrategy</code>, the default is
1164
- * <code>ORIGINAL_VALUE</code>.</p>
1165
- */
1166
- slots?: Record<string, string>;
1167
- /**
1168
- * <p>A map of key-value pairs representing the session-specific context
1169
- * information.</p>
1170
- */
1171
- sessionAttributes?: Record<string, string>;
1172
- /**
1173
- * <p>The message to convey to the user. The message can come from the bot's
1174
- * configuration or from a Lambda function.</p>
1175
- * <p>If the intent is not configured with a Lambda function, or if the Lambda
1176
- * function returned <code>Delegate</code> as the
1177
- * <code>dialogAction.type</code> its response, Amazon Lex decides on the next
1178
- * course of action and selects an appropriate message from the bot's
1179
- * configuration based on the current interaction context. For example, if
1180
- * Amazon Lex isn't able to understand user input, it uses a clarification prompt
1181
- * message.</p>
1182
- * <p>When you create an intent you can assign messages to groups. When
1183
- * messages are assigned to groups Amazon Lex returns one message from each group
1184
- * in the response. The message field is an escaped JSON string containing
1185
- * the messages. For more information about the structure of the JSON string
1186
- * returned, see <a>msg-prompts-formats</a>.</p>
1187
- * <p>If the Lambda function returns a message, Amazon Lex passes it to the client
1188
- * in its response.</p>
1189
- */
1190
- message?: string;
1191
- /**
1192
- * <p>The sentiment expressed in and utterance.</p>
1193
- * <p>When the bot is configured to send utterances to Amazon Comprehend for
1194
- * sentiment analysis, this field contains the result of the analysis.</p>
1195
- */
1196
- sentimentResponse?: SentimentResponse;
1197
- /**
1198
- * <p>The format of the response message. One of the following
1199
- * values:</p>
1200
- * <ul>
1201
- * <li>
1202
- * <p>
1203
- * <code>PlainText</code> - The message contains plain UTF-8
1204
- * text.</p>
1205
- * </li>
1206
- * <li>
1207
- * <p>
1208
- * <code>CustomPayload</code> - The message is a custom format
1209
- * defined by the Lambda function.</p>
1210
- * </li>
1211
- * <li>
1212
- * <p>
1213
- * <code>SSML</code> - The message contains text formatted for voice
1214
- * output.</p>
1215
- * </li>
1216
- * <li>
1217
- * <p>
1218
- * <code>Composite</code> - The message contains an escaped JSON
1219
- * object containing one or more messages from the groups that messages
1220
- * were assigned to when the intent was created.</p>
1221
- * </li>
1222
- * </ul>
1223
- */
1224
- messageFormat?: MessageFormatType | string;
1225
- /**
1226
- * <p> Identifies the current state of the user interaction. Amazon Lex returns
1227
- * one of the following values as <code>dialogState</code>. The client can
1228
- * optionally use this information to customize the user interface. </p>
1229
- * <ul>
1230
- * <li>
1231
- * <p>
1232
- * <code>ElicitIntent</code> - Amazon Lex wants to elicit user intent. </p>
1233
- * <p>For example, a user might utter an intent ("I want to order a
1234
- * pizza"). If Amazon Lex cannot infer the user intent from this utterance, it
1235
- * will return this dialogState.</p>
1236
- * </li>
1237
- * <li>
1238
- * <p>
1239
- * <code>ConfirmIntent</code> - Amazon Lex is expecting a "yes" or "no"
1240
- * response. </p>
1241
- * <p> For example, Amazon Lex wants user confirmation before fulfilling an
1242
- * intent. </p>
1243
- * <p>Instead of a simple "yes" or "no," a user might respond with
1244
- * additional information. For example, "yes, but make it thick crust
1245
- * pizza" or "no, I want to order a drink". Amazon Lex can process such
1246
- * additional information (in these examples, update the crust type slot
1247
- * value, or change intent from OrderPizza to OrderDrink).</p>
1248
- * </li>
1249
- * <li>
1250
- * <p>
1251
- * <code>ElicitSlot</code> - Amazon Lex is expecting a slot value for the
1252
- * current intent. </p>
1253
- * <p>For example, suppose that in the response Amazon Lex sends this
1254
- * message: "What size pizza would you like?". A user might reply with
1255
- * the slot value (e.g., "medium"). The user might also provide
1256
- * additional information in the response (e.g., "medium thick crust
1257
- * pizza"). Amazon Lex can process such additional information appropriately.
1258
- * </p>
1259
- * </li>
1260
- * <li>
1261
- * <p>
1262
- * <code>Fulfilled</code> - Conveys that the Lambda function configured
1263
- * for the intent has successfully fulfilled the intent. </p>
1264
- *
1265
- * </li>
1266
- * <li>
1267
- * <p>
1268
- * <code>ReadyForFulfillment</code> - Conveys that the client has to
1269
- * fulfill the intent. </p>
1270
- * </li>
1271
- * <li>
1272
- * <p>
1273
- * <code>Failed</code> - Conveys that the conversation with the user
1274
- * failed. </p>
1275
- * <p> This can happen for various reasons including that the user did
1276
- * not provide an appropriate response to prompts from the service (you
1277
- * can configure how many times Amazon Lex can prompt a user for specific
1278
- * information), or the Lambda function failed to fulfill the intent.
1279
- * </p>
1280
- * </li>
1281
- * </ul>
1282
- */
1283
- dialogState?: DialogState | string;
1284
- /**
1285
- * <p>If the <code>dialogState</code> value is <code>ElicitSlot</code>,
1286
- * returns the name of the slot for which Amazon Lex is eliciting a value. </p>
1287
- */
1288
- slotToElicit?: string;
1289
- /**
1290
- * <p>Represents the options that the user has to respond to the current
1291
- * prompt. Response Card can come from the bot configuration (in the
1292
- * Amazon Lex console, choose the settings button next to a slot) or from a
1293
- * code hook (Lambda function). </p>
1294
- */
1295
- responseCard?: ResponseCard;
1296
- /**
1297
- * <p>A unique identifier for the session.</p>
1298
- */
1299
- sessionId?: string;
1300
- /**
1301
- * <p>The version of the bot that responded to the conversation. You can use
1302
- * this information to help determine if one version of a bot is performing
1303
- * better than another version.</p>
1304
- */
1305
- botVersion?: string;
1306
- /**
1307
- * <p>A list of active contexts for the session. A context can be set when
1308
- * an intent is fulfilled or by calling the <code>PostContent</code>,
1309
- * <code>PostText</code>, or <code>PutSession</code> operation.</p>
1310
- * <p>You can use a context to control the intents that can follow up an
1311
- * intent, or to modify the operation of your application.</p>
1312
- */
1313
- activeContexts?: ActiveContext[];
1314
- }
1315
- export interface PutSessionRequest {
1316
- /**
1317
- * <p>The name of the bot that contains the session data.</p>
1318
- */
1319
- botName: string | undefined;
1320
- /**
1321
- * <p>The alias in use for the bot that contains the session data.</p>
1322
- */
1323
- botAlias: string | undefined;
1324
- /**
1325
- * <p>The ID of the client application user. Amazon Lex uses this to identify a
1326
- * user's conversation with your bot. </p>
1327
- */
1328
- userId: string | undefined;
1329
- /**
1330
- * <p>Map of key/value pairs representing the session-specific context
1331
- * information. It contains application information passed between Amazon Lex and
1332
- * a client application.</p>
1333
- */
1334
- sessionAttributes?: Record<string, string>;
1335
- /**
1336
- * <p>Sets the next action that the bot should take to fulfill the
1337
- * conversation.</p>
1338
- */
1339
- dialogAction?: DialogAction;
1340
- /**
1341
- * <p>A summary of the recent intents for the bot. You can use the intent
1342
- * summary view to set a checkpoint label on an intent and modify attributes
1343
- * of intents. You can also use it to remove or add intent summary objects to
1344
- * the list.</p>
1345
- * <p>An intent that you modify or add to the list must make sense for the
1346
- * bot. For example, the intent name must be valid for the bot. You must
1347
- * provide valid values for:</p>
1348
- * <ul>
1349
- * <li>
1350
- * <p>
1351
- * <code>intentName</code>
1352
- * </p>
1353
- * </li>
1354
- * <li>
1355
- * <p>slot names</p>
1356
- * </li>
1357
- * <li>
1358
- * <p>
1359
- * <code>slotToElict</code>
1360
- * </p>
1361
- * </li>
1362
- * </ul>
1363
- * <p>If you send the <code>recentIntentSummaryView</code> parameter in a
1364
- * <code>PutSession</code> request, the contents of the new summary view
1365
- * replaces the old summary view. For example, if a <code>GetSession</code>
1366
- * request returns three intents in the summary view and you call
1367
- * <code>PutSession</code> with one intent in the summary view, the next
1368
- * call to <code>GetSession</code> will only return one intent.</p>
1369
- */
1370
- recentIntentSummaryView?: IntentSummary[];
1371
- /**
1372
- * <p>The message that Amazon Lex returns in the response can be either text or
1373
- * speech based depending on the value of this field.</p>
1374
- * <ul>
1375
- * <li>
1376
- * <p>If the value is <code>text/plain; charset=utf-8</code>, Amazon Lex
1377
- * returns text in the response.</p>
1378
- * </li>
1379
- * <li>
1380
- * <p>If the value begins with <code>audio/</code>, Amazon Lex returns speech
1381
- * in the response. Amazon Lex uses Amazon Polly to generate the speech in the
1382
- * configuration that you specify. For example, if you specify
1383
- * <code>audio/mpeg</code> as the value, Amazon Lex returns speech in the
1384
- * MPEG format.</p>
1385
- * </li>
1386
- * <li>
1387
- * <p>If the value is <code>audio/pcm</code>, the speech is returned as
1388
- * <code>audio/pcm</code> in 16-bit, little endian format.</p>
1389
- * </li>
1390
- * <li>
1391
- * <p>The following are the accepted values:</p>
1392
- * <ul>
1393
- * <li>
1394
- * <p>
1395
- * <code>audio/mpeg</code>
1396
- * </p>
1397
- * </li>
1398
- * <li>
1399
- * <p>
1400
- * <code>audio/ogg</code>
1401
- * </p>
1402
- * </li>
1403
- * <li>
1404
- * <p>
1405
- * <code>audio/pcm</code>
1406
- * </p>
1407
- * </li>
1408
- * <li>
1409
- * <p>
1410
- * <code>audio/*</code> (defaults to mpeg)</p>
1411
- * </li>
1412
- * <li>
1413
- * <p>
1414
- * <code>text/plain; charset=utf-8</code>
1415
- * </p>
1416
- * </li>
1417
- * </ul>
1418
- * </li>
1419
- * </ul>
1420
- */
1421
- accept?: string;
1422
- /**
1423
- * <p>A list of contexts active for the request. A context can be activated
1424
- * when a previous intent is fulfilled, or by including the context in the
1425
- * request,</p>
1426
- * <p>If you don't specify a list of contexts, Amazon Lex will use the current
1427
- * list of contexts for the session. If you specify an empty list, all
1428
- * contexts for the session are cleared.</p>
1429
- */
1430
- activeContexts?: ActiveContext[];
1431
- }
1432
- export interface PutSessionResponse {
1433
- /**
1434
- * <p>Content type as specified in the <code>Accept</code> HTTP header in
1435
- * the request.</p>
1436
- */
1437
- contentType?: string;
1438
- /**
1439
- * <p>The name of the current intent.</p>
1440
- */
1441
- intentName?: string;
1442
- /**
1443
- * <p>Map of zero or more intent slots Amazon Lex detected from the user input
1444
- * during the conversation.</p>
1445
- * <p>Amazon Lex creates a resolution list containing likely values for a slot.
1446
- * The value that it returns is determined by the
1447
- * <code>valueSelectionStrategy</code> selected when the slot type was
1448
- * created or updated. If <code>valueSelectionStrategy</code> is set to
1449
- * <code>ORIGINAL_VALUE</code>, the value provided by the user is returned,
1450
- * if the user value is similar to the slot values. If
1451
- * <code>valueSelectionStrategy</code> is set to
1452
- * <code>TOP_RESOLUTION</code> Amazon Lex returns the first value in the
1453
- * resolution list or, if there is no resolution list, null. If you don't
1454
- * specify a <code>valueSelectionStrategy</code> the default is
1455
- * <code>ORIGINAL_VALUE</code>. </p>
1456
- */
1457
- slots?: __LazyJsonString | string;
1458
- /**
1459
- * <p>Map of key/value pairs representing session-specific context
1460
- * information.</p>
1461
- */
1462
- sessionAttributes?: __LazyJsonString | string;
1463
- /**
1464
- * @deprecated
1465
- *
1466
- * <p>The next message that should be presented to the user.</p>
1467
- * <p>You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419,
1468
- * es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the
1469
- * <code>message</code> field is null. You should use the
1470
- * <code>encodedMessage</code> field instead.</p>
1471
- */
1472
- message?: string;
1473
- /**
1474
- * <p>The next message that should be presented to the user.</p>
1475
- * <p>The <code>encodedMessage</code> field is base-64 encoded. You must
1476
- * decode the field before you can use the value.</p>
1477
- */
1478
- encodedMessage?: string;
1479
- /**
1480
- * <p>The format of the response message. One of the following
1481
- * values:</p>
1482
- * <ul>
1483
- * <li>
1484
- * <p>
1485
- * <code>PlainText</code> - The message contains plain UTF-8
1486
- * text.</p>
1487
- * </li>
1488
- * <li>
1489
- * <p>
1490
- * <code>CustomPayload</code> - The message is a custom format for
1491
- * the client.</p>
1492
- * </li>
1493
- * <li>
1494
- * <p>
1495
- * <code>SSML</code> - The message contains text formatted for voice
1496
- * output.</p>
1497
- * </li>
1498
- * <li>
1499
- * <p>
1500
- * <code>Composite</code> - The message contains an escaped JSON
1501
- * object containing one or more messages from the groups that messages
1502
- * were assigned to when the intent was created.</p>
1503
- * </li>
1504
- * </ul>
1505
- */
1506
- messageFormat?: MessageFormatType | string;
1507
- /**
1508
- * <p></p>
1509
- * <ul>
1510
- * <li>
1511
- * <p>
1512
- * <code>ConfirmIntent</code> - Amazon Lex is expecting a "yes" or "no"
1513
- * response to confirm the intent before fulfilling an intent.</p>
1514
- * </li>
1515
- * <li>
1516
- * <p>
1517
- * <code>ElicitIntent</code> - Amazon Lex wants to elicit the user's
1518
- * intent.</p>
1519
- * </li>
1520
- * <li>
1521
- * <p>
1522
- * <code>ElicitSlot</code> - Amazon Lex is expecting the value of a slot
1523
- * for the current intent.</p>
1524
- * </li>
1525
- * <li>
1526
- * <p>
1527
- * <code>Failed</code> - Conveys that the conversation with the user
1528
- * has failed. This can happen for various reasons, including the user
1529
- * does not provide an appropriate response to prompts from the service,
1530
- * or if the Lambda function fails to fulfill the intent.</p>
1531
- * </li>
1532
- * <li>
1533
- * <p>
1534
- * <code>Fulfilled</code> - Conveys that the Lambda function has
1535
- * sucessfully fulfilled the intent.</p>
1536
- * </li>
1537
- * <li>
1538
- * <p>
1539
- * <code>ReadyForFulfillment</code> - Conveys that the client has to
1540
- * fulfill the intent.</p>
1541
- * </li>
1542
- * </ul>
1543
- */
1544
- dialogState?: DialogState | string;
1545
- /**
1546
- * <p>If the <code>dialogState</code> is <code>ElicitSlot</code>, returns
1547
- * the name of the slot for which Amazon Lex is eliciting a value.</p>
1548
- */
1549
- slotToElicit?: string;
1550
- /**
1551
- * <p>The audio version of the message to convey to the user.</p>
1552
- */
1553
- audioStream?: Readable | ReadableStream | Blob;
1554
- /**
1555
- * <p>A unique identifier for the session.</p>
1556
- */
1557
- sessionId?: string;
1558
- /**
1559
- * <p>A list of active contexts for the session.</p>
1560
- */
1561
- activeContexts?: __LazyJsonString | string;
1562
- }
1563
- /**
1564
- * @internal
1565
- */
1566
- export declare const ActiveContextTimeToLiveFilterSensitiveLog: (obj: ActiveContextTimeToLive) => any;
1567
- /**
1568
- * @internal
1569
- */
1570
- export declare const ActiveContextFilterSensitiveLog: (obj: ActiveContext) => any;
1571
- /**
1572
- * @internal
1573
- */
1574
- export declare const DeleteSessionRequestFilterSensitiveLog: (obj: DeleteSessionRequest) => any;
1575
- /**
1576
- * @internal
1577
- */
1578
- export declare const DeleteSessionResponseFilterSensitiveLog: (obj: DeleteSessionResponse) => any;
1579
- /**
1580
- * @internal
1581
- */
1582
- export declare const GetSessionRequestFilterSensitiveLog: (obj: GetSessionRequest) => any;
1583
- /**
1584
- * @internal
1585
- */
1586
- export declare const DialogActionFilterSensitiveLog: (obj: DialogAction) => any;
1587
- /**
1588
- * @internal
1589
- */
1590
- export declare const IntentSummaryFilterSensitiveLog: (obj: IntentSummary) => any;
1591
- /**
1592
- * @internal
1593
- */
1594
- export declare const GetSessionResponseFilterSensitiveLog: (obj: GetSessionResponse) => any;
1595
- /**
1596
- * @internal
1597
- */
1598
- export declare const PostContentRequestFilterSensitiveLog: (obj: PostContentRequest) => any;
1599
- /**
1600
- * @internal
1601
- */
1602
- export declare const PostContentResponseFilterSensitiveLog: (obj: PostContentResponse) => any;
1603
- /**
1604
- * @internal
1605
- */
1606
- export declare const PostTextRequestFilterSensitiveLog: (obj: PostTextRequest) => any;
1607
- /**
1608
- * @internal
1609
- */
1610
- export declare const IntentConfidenceFilterSensitiveLog: (obj: IntentConfidence) => any;
1611
- /**
1612
- * @internal
1613
- */
1614
- export declare const PredictedIntentFilterSensitiveLog: (obj: PredictedIntent) => any;
1615
- /**
1616
- * @internal
1617
- */
1618
- export declare const ButtonFilterSensitiveLog: (obj: Button) => any;
1619
- /**
1620
- * @internal
1621
- */
1622
- export declare const GenericAttachmentFilterSensitiveLog: (obj: GenericAttachment) => any;
1623
- /**
1624
- * @internal
1625
- */
1626
- export declare const ResponseCardFilterSensitiveLog: (obj: ResponseCard) => any;
1627
- /**
1628
- * @internal
1629
- */
1630
- export declare const SentimentResponseFilterSensitiveLog: (obj: SentimentResponse) => any;
1631
- /**
1632
- * @internal
1633
- */
1634
- export declare const PostTextResponseFilterSensitiveLog: (obj: PostTextResponse) => any;
1635
- /**
1636
- * @internal
1637
- */
1638
- export declare const PutSessionRequestFilterSensitiveLog: (obj: PutSessionRequest) => any;
1639
- /**
1640
- * @internal
1641
- */
1642
- export declare const PutSessionResponseFilterSensitiveLog: (obj: PutSessionResponse) => any;
1
+ import {
2
+ ExceptionOptionType as __ExceptionOptionType,
3
+ LazyJsonString as __LazyJsonString,
4
+ } from "@aws-sdk/smithy-client";
5
+ import { Readable } from "stream";
6
+ import { LexRuntimeServiceServiceException as __BaseException } from "./LexRuntimeServiceServiceException";
7
+ export interface ActiveContextTimeToLive {
8
+ timeToLiveInSeconds?: number;
9
+ turnsToLive?: number;
10
+ }
11
+ export interface ActiveContext {
12
+ name: string | undefined;
13
+ timeToLive: ActiveContextTimeToLive | undefined;
14
+ parameters: Record<string, string> | undefined;
15
+ }
16
+ export declare class BadRequestException extends __BaseException {
17
+ readonly name: "BadRequestException";
18
+ readonly $fault: "client";
19
+ constructor(
20
+ opts: __ExceptionOptionType<BadRequestException, __BaseException>
21
+ );
22
+ }
23
+ export declare class ConflictException extends __BaseException {
24
+ readonly name: "ConflictException";
25
+ readonly $fault: "client";
26
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
27
+ }
28
+ export interface DeleteSessionRequest {
29
+ botName: string | undefined;
30
+ botAlias: string | undefined;
31
+ userId: string | undefined;
32
+ }
33
+ export interface DeleteSessionResponse {
34
+ botName?: string;
35
+ botAlias?: string;
36
+ userId?: string;
37
+ sessionId?: string;
38
+ }
39
+ export declare class InternalFailureException extends __BaseException {
40
+ readonly name: "InternalFailureException";
41
+ readonly $fault: "server";
42
+ constructor(
43
+ opts: __ExceptionOptionType<InternalFailureException, __BaseException>
44
+ );
45
+ }
46
+ export declare class LimitExceededException extends __BaseException {
47
+ readonly name: "LimitExceededException";
48
+ readonly $fault: "client";
49
+ retryAfterSeconds?: string;
50
+ constructor(
51
+ opts: __ExceptionOptionType<LimitExceededException, __BaseException>
52
+ );
53
+ }
54
+ export declare class NotFoundException extends __BaseException {
55
+ readonly name: "NotFoundException";
56
+ readonly $fault: "client";
57
+ constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
58
+ }
59
+ export interface GetSessionRequest {
60
+ botName: string | undefined;
61
+ botAlias: string | undefined;
62
+ userId: string | undefined;
63
+ checkpointLabelFilter?: string;
64
+ }
65
+ export declare enum FulfillmentState {
66
+ FAILED = "Failed",
67
+ FULFILLED = "Fulfilled",
68
+ READY_FOR_FULFILLMENT = "ReadyForFulfillment",
69
+ }
70
+ export declare enum MessageFormatType {
71
+ COMPOSITE = "Composite",
72
+ CUSTOM_PAYLOAD = "CustomPayload",
73
+ PLAIN_TEXT = "PlainText",
74
+ SSML = "SSML",
75
+ }
76
+ export declare enum DialogActionType {
77
+ CLOSE = "Close",
78
+ CONFIRM_INTENT = "ConfirmIntent",
79
+ DELEGATE = "Delegate",
80
+ ELICIT_INTENT = "ElicitIntent",
81
+ ELICIT_SLOT = "ElicitSlot",
82
+ }
83
+ export interface DialogAction {
84
+ type: DialogActionType | string | undefined;
85
+ intentName?: string;
86
+ slots?: Record<string, string>;
87
+ slotToElicit?: string;
88
+ fulfillmentState?: FulfillmentState | string;
89
+ message?: string;
90
+ messageFormat?: MessageFormatType | string;
91
+ }
92
+ export declare enum ConfirmationStatus {
93
+ CONFIRMED = "Confirmed",
94
+ DENIED = "Denied",
95
+ NONE = "None",
96
+ }
97
+ export interface IntentSummary {
98
+ intentName?: string;
99
+ checkpointLabel?: string;
100
+ slots?: Record<string, string>;
101
+ confirmationStatus?: ConfirmationStatus | string;
102
+ dialogActionType: DialogActionType | string | undefined;
103
+ fulfillmentState?: FulfillmentState | string;
104
+ slotToElicit?: string;
105
+ }
106
+ export interface GetSessionResponse {
107
+ recentIntentSummaryView?: IntentSummary[];
108
+ sessionAttributes?: Record<string, string>;
109
+ sessionId?: string;
110
+ dialogAction?: DialogAction;
111
+ activeContexts?: ActiveContext[];
112
+ }
113
+ export declare class BadGatewayException extends __BaseException {
114
+ readonly name: "BadGatewayException";
115
+ readonly $fault: "server";
116
+ Message?: string;
117
+ constructor(
118
+ opts: __ExceptionOptionType<BadGatewayException, __BaseException>
119
+ );
120
+ }
121
+ export declare class DependencyFailedException extends __BaseException {
122
+ readonly name: "DependencyFailedException";
123
+ readonly $fault: "client";
124
+ Message?: string;
125
+ constructor(
126
+ opts: __ExceptionOptionType<DependencyFailedException, __BaseException>
127
+ );
128
+ }
129
+ export declare class LoopDetectedException extends __BaseException {
130
+ readonly name: "LoopDetectedException";
131
+ readonly $fault: "server";
132
+ Message?: string;
133
+ constructor(
134
+ opts: __ExceptionOptionType<LoopDetectedException, __BaseException>
135
+ );
136
+ }
137
+ export declare class NotAcceptableException extends __BaseException {
138
+ readonly name: "NotAcceptableException";
139
+ readonly $fault: "client";
140
+ constructor(
141
+ opts: __ExceptionOptionType<NotAcceptableException, __BaseException>
142
+ );
143
+ }
144
+ export interface PostContentRequest {
145
+ botName: string | undefined;
146
+ botAlias: string | undefined;
147
+ userId: string | undefined;
148
+ sessionAttributes?: __LazyJsonString | string;
149
+ requestAttributes?: __LazyJsonString | string;
150
+ contentType: string | undefined;
151
+ accept?: string;
152
+ inputStream: Readable | ReadableStream | Blob | undefined;
153
+ activeContexts?: __LazyJsonString | string;
154
+ }
155
+ export declare enum DialogState {
156
+ CONFIRM_INTENT = "ConfirmIntent",
157
+ ELICIT_INTENT = "ElicitIntent",
158
+ ELICIT_SLOT = "ElicitSlot",
159
+ FAILED = "Failed",
160
+ FULFILLED = "Fulfilled",
161
+ READY_FOR_FULFILLMENT = "ReadyForFulfillment",
162
+ }
163
+ export interface PostContentResponse {
164
+ contentType?: string;
165
+ intentName?: string;
166
+ nluIntentConfidence?: __LazyJsonString | string;
167
+ alternativeIntents?: __LazyJsonString | string;
168
+ slots?: __LazyJsonString | string;
169
+ sessionAttributes?: __LazyJsonString | string;
170
+ sentimentResponse?: string;
171
+ message?: string;
172
+ encodedMessage?: string;
173
+ messageFormat?: MessageFormatType | string;
174
+ dialogState?: DialogState | string;
175
+ slotToElicit?: string;
176
+ inputTranscript?: string;
177
+ encodedInputTranscript?: string;
178
+ audioStream?: Readable | ReadableStream | Blob;
179
+ botVersion?: string;
180
+ sessionId?: string;
181
+ activeContexts?: __LazyJsonString | string;
182
+ }
183
+ export declare class RequestTimeoutException extends __BaseException {
184
+ readonly name: "RequestTimeoutException";
185
+ readonly $fault: "client";
186
+ constructor(
187
+ opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>
188
+ );
189
+ }
190
+ export declare class UnsupportedMediaTypeException extends __BaseException {
191
+ readonly name: "UnsupportedMediaTypeException";
192
+ readonly $fault: "client";
193
+ constructor(
194
+ opts: __ExceptionOptionType<UnsupportedMediaTypeException, __BaseException>
195
+ );
196
+ }
197
+ export interface PostTextRequest {
198
+ botName: string | undefined;
199
+ botAlias: string | undefined;
200
+ userId: string | undefined;
201
+ sessionAttributes?: Record<string, string>;
202
+ requestAttributes?: Record<string, string>;
203
+ inputText: string | undefined;
204
+ activeContexts?: ActiveContext[];
205
+ }
206
+ export interface IntentConfidence {
207
+ score?: number;
208
+ }
209
+ export interface PredictedIntent {
210
+ intentName?: string;
211
+ nluIntentConfidence?: IntentConfidence;
212
+ slots?: Record<string, string>;
213
+ }
214
+ export declare enum ContentType {
215
+ GENERIC = "application/vnd.amazonaws.card.generic",
216
+ }
217
+ export interface Button {
218
+ text: string | undefined;
219
+ value: string | undefined;
220
+ }
221
+ export interface GenericAttachment {
222
+ title?: string;
223
+ subTitle?: string;
224
+ attachmentLinkUrl?: string;
225
+ imageUrl?: string;
226
+ buttons?: Button[];
227
+ }
228
+ export interface ResponseCard {
229
+ version?: string;
230
+ contentType?: ContentType | string;
231
+ genericAttachments?: GenericAttachment[];
232
+ }
233
+ export interface SentimentResponse {
234
+ sentimentLabel?: string;
235
+ sentimentScore?: string;
236
+ }
237
+ export interface PostTextResponse {
238
+ intentName?: string;
239
+ nluIntentConfidence?: IntentConfidence;
240
+ alternativeIntents?: PredictedIntent[];
241
+ slots?: Record<string, string>;
242
+ sessionAttributes?: Record<string, string>;
243
+ message?: string;
244
+ sentimentResponse?: SentimentResponse;
245
+ messageFormat?: MessageFormatType | string;
246
+ dialogState?: DialogState | string;
247
+ slotToElicit?: string;
248
+ responseCard?: ResponseCard;
249
+ sessionId?: string;
250
+ botVersion?: string;
251
+ activeContexts?: ActiveContext[];
252
+ }
253
+ export interface PutSessionRequest {
254
+ botName: string | undefined;
255
+ botAlias: string | undefined;
256
+ userId: string | undefined;
257
+ sessionAttributes?: Record<string, string>;
258
+ dialogAction?: DialogAction;
259
+ recentIntentSummaryView?: IntentSummary[];
260
+ accept?: string;
261
+ activeContexts?: ActiveContext[];
262
+ }
263
+ export interface PutSessionResponse {
264
+ contentType?: string;
265
+ intentName?: string;
266
+ slots?: __LazyJsonString | string;
267
+ sessionAttributes?: __LazyJsonString | string;
268
+ message?: string;
269
+ encodedMessage?: string;
270
+ messageFormat?: MessageFormatType | string;
271
+ dialogState?: DialogState | string;
272
+ slotToElicit?: string;
273
+ audioStream?: Readable | ReadableStream | Blob;
274
+ sessionId?: string;
275
+ activeContexts?: __LazyJsonString | string;
276
+ }
277
+ export declare const ActiveContextTimeToLiveFilterSensitiveLog: (
278
+ obj: ActiveContextTimeToLive
279
+ ) => any;
280
+ export declare const ActiveContextFilterSensitiveLog: (
281
+ obj: ActiveContext
282
+ ) => any;
283
+ export declare const DeleteSessionRequestFilterSensitiveLog: (
284
+ obj: DeleteSessionRequest
285
+ ) => any;
286
+ export declare const DeleteSessionResponseFilterSensitiveLog: (
287
+ obj: DeleteSessionResponse
288
+ ) => any;
289
+ export declare const GetSessionRequestFilterSensitiveLog: (
290
+ obj: GetSessionRequest
291
+ ) => any;
292
+ export declare const DialogActionFilterSensitiveLog: (obj: DialogAction) => any;
293
+ export declare const IntentSummaryFilterSensitiveLog: (
294
+ obj: IntentSummary
295
+ ) => any;
296
+ export declare const GetSessionResponseFilterSensitiveLog: (
297
+ obj: GetSessionResponse
298
+ ) => any;
299
+ export declare const PostContentRequestFilterSensitiveLog: (
300
+ obj: PostContentRequest
301
+ ) => any;
302
+ export declare const PostContentResponseFilterSensitiveLog: (
303
+ obj: PostContentResponse
304
+ ) => any;
305
+ export declare const PostTextRequestFilterSensitiveLog: (
306
+ obj: PostTextRequest
307
+ ) => any;
308
+ export declare const IntentConfidenceFilterSensitiveLog: (
309
+ obj: IntentConfidence
310
+ ) => any;
311
+ export declare const PredictedIntentFilterSensitiveLog: (
312
+ obj: PredictedIntent
313
+ ) => any;
314
+ export declare const ButtonFilterSensitiveLog: (obj: Button) => any;
315
+ export declare const GenericAttachmentFilterSensitiveLog: (
316
+ obj: GenericAttachment
317
+ ) => any;
318
+ export declare const ResponseCardFilterSensitiveLog: (obj: ResponseCard) => any;
319
+ export declare const SentimentResponseFilterSensitiveLog: (
320
+ obj: SentimentResponse
321
+ ) => any;
322
+ export declare const PostTextResponseFilterSensitiveLog: (
323
+ obj: PostTextResponse
324
+ ) => any;
325
+ export declare const PutSessionRequestFilterSensitiveLog: (
326
+ obj: PutSessionRequest
327
+ ) => any;
328
+ export declare const PutSessionResponseFilterSensitiveLog: (
329
+ obj: PutSessionResponse
330
+ ) => any;