@aws-sdk/client-lex-runtime-service 3.379.1 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +119 -0
- package/package.json +5 -5
|
@@ -8,6 +8,7 @@ import { LexRuntimeServiceServiceException as __BaseException } from "./LexRunti
|
|
|
8
8
|
*/
|
|
9
9
|
export interface ActiveContextTimeToLive {
|
|
10
10
|
/**
|
|
11
|
+
* @public
|
|
11
12
|
* <p>The number of seconds that the context should be active after it is
|
|
12
13
|
* first sent in a <code>PostContent</code> or <code>PostText</code>
|
|
13
14
|
* response. You can set the value between 5 and 86,400 seconds (24
|
|
@@ -15,6 +16,7 @@ export interface ActiveContextTimeToLive {
|
|
|
15
16
|
*/
|
|
16
17
|
timeToLiveInSeconds?: number;
|
|
17
18
|
/**
|
|
19
|
+
* @public
|
|
18
20
|
* <p>The number of conversation turns that the context should be active. A
|
|
19
21
|
* conversation turn is one <code>PostContent</code> or <code>PostText</code>
|
|
20
22
|
* request and the corresponding response from Amazon Lex.</p>
|
|
@@ -31,15 +33,18 @@ export interface ActiveContextTimeToLive {
|
|
|
31
33
|
*/
|
|
32
34
|
export interface ActiveContext {
|
|
33
35
|
/**
|
|
36
|
+
* @public
|
|
34
37
|
* <p>The name of the context.</p>
|
|
35
38
|
*/
|
|
36
39
|
name: string | undefined;
|
|
37
40
|
/**
|
|
41
|
+
* @public
|
|
38
42
|
* <p>The length of time or number of turns that a context remains
|
|
39
43
|
* active.</p>
|
|
40
44
|
*/
|
|
41
45
|
timeToLive: ActiveContextTimeToLive | undefined;
|
|
42
46
|
/**
|
|
47
|
+
* @public
|
|
43
48
|
* <p>State variables for the current context. You can use these values as
|
|
44
49
|
* default values for slots in subsequent events.</p>
|
|
45
50
|
*/
|
|
@@ -77,14 +82,17 @@ export declare class ConflictException extends __BaseException {
|
|
|
77
82
|
*/
|
|
78
83
|
export interface DeleteSessionRequest {
|
|
79
84
|
/**
|
|
85
|
+
* @public
|
|
80
86
|
* <p>The name of the bot that contains the session data.</p>
|
|
81
87
|
*/
|
|
82
88
|
botName: string | undefined;
|
|
83
89
|
/**
|
|
90
|
+
* @public
|
|
84
91
|
* <p>The alias in use for the bot that contains the session data.</p>
|
|
85
92
|
*/
|
|
86
93
|
botAlias: string | undefined;
|
|
87
94
|
/**
|
|
95
|
+
* @public
|
|
88
96
|
* <p>The identifier of the user associated with the session data.</p>
|
|
89
97
|
*/
|
|
90
98
|
userId: string | undefined;
|
|
@@ -94,18 +102,22 @@ export interface DeleteSessionRequest {
|
|
|
94
102
|
*/
|
|
95
103
|
export interface DeleteSessionResponse {
|
|
96
104
|
/**
|
|
105
|
+
* @public
|
|
97
106
|
* <p>The name of the bot associated with the session data.</p>
|
|
98
107
|
*/
|
|
99
108
|
botName?: string;
|
|
100
109
|
/**
|
|
110
|
+
* @public
|
|
101
111
|
* <p>The alias in use for the bot associated with the session data.</p>
|
|
102
112
|
*/
|
|
103
113
|
botAlias?: string;
|
|
104
114
|
/**
|
|
115
|
+
* @public
|
|
105
116
|
* <p>The ID of the client application user.</p>
|
|
106
117
|
*/
|
|
107
118
|
userId?: string;
|
|
108
119
|
/**
|
|
120
|
+
* @public
|
|
109
121
|
* <p>The unique identifier for the session.</p>
|
|
110
122
|
*/
|
|
111
123
|
sessionId?: string;
|
|
@@ -153,19 +165,23 @@ export declare class NotFoundException extends __BaseException {
|
|
|
153
165
|
*/
|
|
154
166
|
export interface GetSessionRequest {
|
|
155
167
|
/**
|
|
168
|
+
* @public
|
|
156
169
|
* <p>The name of the bot that contains the session data.</p>
|
|
157
170
|
*/
|
|
158
171
|
botName: string | undefined;
|
|
159
172
|
/**
|
|
173
|
+
* @public
|
|
160
174
|
* <p>The alias in use for the bot that contains the session data.</p>
|
|
161
175
|
*/
|
|
162
176
|
botAlias: string | undefined;
|
|
163
177
|
/**
|
|
178
|
+
* @public
|
|
164
179
|
* <p>The ID of the client application user. Amazon Lex uses this to identify a
|
|
165
180
|
* user's conversation with your bot. </p>
|
|
166
181
|
*/
|
|
167
182
|
userId: string | undefined;
|
|
168
183
|
/**
|
|
184
|
+
* @public
|
|
169
185
|
* <p>A string used to filter the intents returned in the
|
|
170
186
|
* <code>recentIntentSummaryView</code> structure. </p>
|
|
171
187
|
* <p>When you specify a filter, only intents with their
|
|
@@ -226,6 +242,7 @@ export type DialogActionType = (typeof DialogActionType)[keyof typeof DialogActi
|
|
|
226
242
|
*/
|
|
227
243
|
export interface DialogAction {
|
|
228
244
|
/**
|
|
245
|
+
* @public
|
|
229
246
|
* <p>The next action that the bot should take in its interaction with the
|
|
230
247
|
* user. The possible values are:</p>
|
|
231
248
|
* <ul>
|
|
@@ -260,18 +277,22 @@ export interface DialogAction {
|
|
|
260
277
|
*/
|
|
261
278
|
type: DialogActionType | string | undefined;
|
|
262
279
|
/**
|
|
280
|
+
* @public
|
|
263
281
|
* <p>The name of the intent.</p>
|
|
264
282
|
*/
|
|
265
283
|
intentName?: string;
|
|
266
284
|
/**
|
|
285
|
+
* @public
|
|
267
286
|
* <p>Map of the slots that have been gathered and their values. </p>
|
|
268
287
|
*/
|
|
269
288
|
slots?: Record<string, string>;
|
|
270
289
|
/**
|
|
290
|
+
* @public
|
|
271
291
|
* <p>The name of the slot that should be elicited from the user.</p>
|
|
272
292
|
*/
|
|
273
293
|
slotToElicit?: string;
|
|
274
294
|
/**
|
|
295
|
+
* @public
|
|
275
296
|
* <p>The fulfillment state of the intent. The possible values are:</p>
|
|
276
297
|
* <ul>
|
|
277
298
|
* <li>
|
|
@@ -294,11 +315,13 @@ export interface DialogAction {
|
|
|
294
315
|
*/
|
|
295
316
|
fulfillmentState?: FulfillmentState | string;
|
|
296
317
|
/**
|
|
318
|
+
* @public
|
|
297
319
|
* <p>The message that should be shown to the user. If you don't specify a
|
|
298
320
|
* message, Amazon Lex will use the message configured for the intent.</p>
|
|
299
321
|
*/
|
|
300
322
|
message?: string;
|
|
301
323
|
/**
|
|
324
|
+
* @public
|
|
302
325
|
* <ul>
|
|
303
326
|
* <li>
|
|
304
327
|
* <p>
|
|
@@ -347,10 +370,12 @@ export type ConfirmationStatus = (typeof ConfirmationStatus)[keyof typeof Confir
|
|
|
347
370
|
*/
|
|
348
371
|
export interface IntentSummary {
|
|
349
372
|
/**
|
|
373
|
+
* @public
|
|
350
374
|
* <p>The name of the intent.</p>
|
|
351
375
|
*/
|
|
352
376
|
intentName?: string;
|
|
353
377
|
/**
|
|
378
|
+
* @public
|
|
354
379
|
* <p>A user-defined label that identifies a particular intent. You can use
|
|
355
380
|
* this label to return to a previous intent. </p>
|
|
356
381
|
* <p>Use the <code>checkpointLabelFilter</code> parameter of the
|
|
@@ -359,10 +384,12 @@ export interface IntentSummary {
|
|
|
359
384
|
*/
|
|
360
385
|
checkpointLabel?: string;
|
|
361
386
|
/**
|
|
387
|
+
* @public
|
|
362
388
|
* <p>Map of the slots that have been gathered and their values. </p>
|
|
363
389
|
*/
|
|
364
390
|
slots?: Record<string, string>;
|
|
365
391
|
/**
|
|
392
|
+
* @public
|
|
366
393
|
* <p>The status of the intent after the user responds to the confirmation
|
|
367
394
|
* prompt. If the user confirms the intent, Amazon Lex sets this field to
|
|
368
395
|
* <code>Confirmed</code>. If the user denies the intent, Amazon Lex sets this
|
|
@@ -389,6 +416,7 @@ export interface IntentSummary {
|
|
|
389
416
|
*/
|
|
390
417
|
confirmationStatus?: ConfirmationStatus | string;
|
|
391
418
|
/**
|
|
419
|
+
* @public
|
|
392
420
|
* <p>The next action that the bot should take in its interaction with the
|
|
393
421
|
* user. The possible values are:</p>
|
|
394
422
|
* <ul>
|
|
@@ -418,6 +446,7 @@ export interface IntentSummary {
|
|
|
418
446
|
*/
|
|
419
447
|
dialogActionType: DialogActionType | string | undefined;
|
|
420
448
|
/**
|
|
449
|
+
* @public
|
|
421
450
|
* <p>The fulfillment state of the intent. The possible values are:</p>
|
|
422
451
|
* <ul>
|
|
423
452
|
* <li>
|
|
@@ -440,6 +469,7 @@ export interface IntentSummary {
|
|
|
440
469
|
*/
|
|
441
470
|
fulfillmentState?: FulfillmentState | string;
|
|
442
471
|
/**
|
|
472
|
+
* @public
|
|
443
473
|
* <p>The next slot to elicit from the user. If there is not slot to elicit,
|
|
444
474
|
* the field is blank.</p>
|
|
445
475
|
*/
|
|
@@ -450,6 +480,7 @@ export interface IntentSummary {
|
|
|
450
480
|
*/
|
|
451
481
|
export interface GetSessionResponse {
|
|
452
482
|
/**
|
|
483
|
+
* @public
|
|
453
484
|
* <p>An array of information about the intents used in the session. The
|
|
454
485
|
* array can contain a maximum of three summaries. If more than three intents
|
|
455
486
|
* are used in the session, the <code>recentIntentSummaryView</code>
|
|
@@ -460,20 +491,24 @@ export interface GetSessionResponse {
|
|
|
460
491
|
*/
|
|
461
492
|
recentIntentSummaryView?: IntentSummary[];
|
|
462
493
|
/**
|
|
494
|
+
* @public
|
|
463
495
|
* <p>Map of key/value pairs representing the session-specific context
|
|
464
496
|
* information. It contains application information passed between Amazon Lex and
|
|
465
497
|
* a client application.</p>
|
|
466
498
|
*/
|
|
467
499
|
sessionAttributes?: Record<string, string>;
|
|
468
500
|
/**
|
|
501
|
+
* @public
|
|
469
502
|
* <p>A unique identifier for the session.</p>
|
|
470
503
|
*/
|
|
471
504
|
sessionId?: string;
|
|
472
505
|
/**
|
|
506
|
+
* @public
|
|
473
507
|
* <p>Describes the current state of the bot.</p>
|
|
474
508
|
*/
|
|
475
509
|
dialogAction?: DialogAction;
|
|
476
510
|
/**
|
|
511
|
+
* @public
|
|
477
512
|
* <p>A list of active contexts for the session. A context can be set when
|
|
478
513
|
* an intent is fulfilled or by calling the <code>PostContent</code>,
|
|
479
514
|
* <code>PostText</code>, or <code>PutSession</code> operation.</p>
|
|
@@ -555,14 +590,17 @@ export declare class NotAcceptableException extends __BaseException {
|
|
|
555
590
|
*/
|
|
556
591
|
export interface PostContentRequest {
|
|
557
592
|
/**
|
|
593
|
+
* @public
|
|
558
594
|
* <p>Name of the Amazon Lex bot.</p>
|
|
559
595
|
*/
|
|
560
596
|
botName: string | undefined;
|
|
561
597
|
/**
|
|
598
|
+
* @public
|
|
562
599
|
* <p>Alias of the Amazon Lex bot.</p>
|
|
563
600
|
*/
|
|
564
601
|
botAlias: string | undefined;
|
|
565
602
|
/**
|
|
603
|
+
* @public
|
|
566
604
|
* <p>The ID of the client application user. Amazon Lex uses this to identify a
|
|
567
605
|
* user's conversation with your bot. At runtime, each request must contain
|
|
568
606
|
* the <code>userID</code> field.</p>
|
|
@@ -595,6 +633,7 @@ export interface PostContentRequest {
|
|
|
595
633
|
*/
|
|
596
634
|
userId: string | undefined;
|
|
597
635
|
/**
|
|
636
|
+
* @public
|
|
598
637
|
* <p>You pass this value as the <code>x-amz-lex-session-attributes</code>
|
|
599
638
|
* HTTP header.</p>
|
|
600
639
|
* <p>Application-specific information passed between Amazon Lex and a client
|
|
@@ -606,6 +645,7 @@ export interface PostContentRequest {
|
|
|
606
645
|
*/
|
|
607
646
|
sessionAttributes?: __LazyJsonString | string;
|
|
608
647
|
/**
|
|
648
|
+
* @public
|
|
609
649
|
* <p>You pass this value as the <code>x-amz-lex-request-attributes</code>
|
|
610
650
|
* HTTP header.</p>
|
|
611
651
|
* <p>Request-specific information passed between Amazon Lex and a client
|
|
@@ -620,6 +660,7 @@ export interface PostContentRequest {
|
|
|
620
660
|
*/
|
|
621
661
|
requestAttributes?: __LazyJsonString | string;
|
|
622
662
|
/**
|
|
663
|
+
* @public
|
|
623
664
|
* <p> You pass this value as the <code>Content-Type</code> HTTP header. </p>
|
|
624
665
|
* <p> Indicates the audio format or text. The header value must start with
|
|
625
666
|
* one of the following prefixes: </p>
|
|
@@ -660,6 +701,7 @@ export interface PostContentRequest {
|
|
|
660
701
|
*/
|
|
661
702
|
contentType: string | undefined;
|
|
662
703
|
/**
|
|
704
|
+
* @public
|
|
663
705
|
* <p> You pass this value as the <code>Accept</code> HTTP header. </p>
|
|
664
706
|
* <p> The message Amazon Lex returns in the response can be either text or
|
|
665
707
|
* speech based on the <code>Accept</code> HTTP header value in the request. </p>
|
|
@@ -704,6 +746,7 @@ export interface PostContentRequest {
|
|
|
704
746
|
*/
|
|
705
747
|
accept?: string;
|
|
706
748
|
/**
|
|
749
|
+
* @public
|
|
707
750
|
* <p> User input in PCM or Opus audio format or text format as described in
|
|
708
751
|
* the <code>Content-Type</code> HTTP header. </p>
|
|
709
752
|
* <p>You can stream audio data to Amazon Lex or you can create a local buffer
|
|
@@ -713,6 +756,7 @@ export interface PostContentRequest {
|
|
|
713
756
|
*/
|
|
714
757
|
inputStream: StreamingBlobTypes | undefined;
|
|
715
758
|
/**
|
|
759
|
+
* @public
|
|
716
760
|
* <p>A list of contexts active for the request. A context can be activated
|
|
717
761
|
* when a previous intent is fulfilled, or by including the context in the
|
|
718
762
|
* request,</p>
|
|
@@ -743,15 +787,18 @@ export type DialogState = (typeof DialogState)[keyof typeof DialogState];
|
|
|
743
787
|
*/
|
|
744
788
|
export interface PostContentResponse {
|
|
745
789
|
/**
|
|
790
|
+
* @public
|
|
746
791
|
* <p>Content type as specified in the <code>Accept</code> HTTP header in
|
|
747
792
|
* the request.</p>
|
|
748
793
|
*/
|
|
749
794
|
contentType?: string;
|
|
750
795
|
/**
|
|
796
|
+
* @public
|
|
751
797
|
* <p>Current user intent that Amazon Lex is aware of.</p>
|
|
752
798
|
*/
|
|
753
799
|
intentName?: string;
|
|
754
800
|
/**
|
|
801
|
+
* @public
|
|
755
802
|
* <p>Provides a score that indicates how confident Amazon Lex is that the
|
|
756
803
|
* returned intent is the one that matches the user's intent. The score is
|
|
757
804
|
* between 0.0 and 1.0.</p>
|
|
@@ -760,6 +807,7 @@ export interface PostContentResponse {
|
|
|
760
807
|
*/
|
|
761
808
|
nluIntentConfidence?: __LazyJsonString | string;
|
|
762
809
|
/**
|
|
810
|
+
* @public
|
|
763
811
|
* <p>One to four alternative intents that may be applicable to the user's
|
|
764
812
|
* intent.</p>
|
|
765
813
|
* <p>Each alternative includes a score that indicates how confident Amazon Lex
|
|
@@ -768,6 +816,7 @@ export interface PostContentResponse {
|
|
|
768
816
|
*/
|
|
769
817
|
alternativeIntents?: __LazyJsonString | string;
|
|
770
818
|
/**
|
|
819
|
+
* @public
|
|
771
820
|
* <p>Map of zero or more intent slots (name/value pairs) Amazon Lex detected
|
|
772
821
|
* from the user input during the conversation. The field is base-64
|
|
773
822
|
* encoded.</p>
|
|
@@ -785,17 +834,20 @@ export interface PostContentResponse {
|
|
|
785
834
|
*/
|
|
786
835
|
slots?: __LazyJsonString | string;
|
|
787
836
|
/**
|
|
837
|
+
* @public
|
|
788
838
|
* <p> Map of key/value pairs representing the session-specific context
|
|
789
839
|
* information. </p>
|
|
790
840
|
*/
|
|
791
841
|
sessionAttributes?: __LazyJsonString | string;
|
|
792
842
|
/**
|
|
843
|
+
* @public
|
|
793
844
|
* <p>The sentiment expressed in an utterance.</p>
|
|
794
845
|
* <p>When the bot is configured to send utterances to Amazon Comprehend for
|
|
795
846
|
* sentiment analysis, this field contains the result of the analysis.</p>
|
|
796
847
|
*/
|
|
797
848
|
sentimentResponse?: string;
|
|
798
849
|
/**
|
|
850
|
+
* @public
|
|
799
851
|
* @deprecated
|
|
800
852
|
*
|
|
801
853
|
* <p>You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419,
|
|
@@ -821,6 +873,7 @@ export interface PostContentResponse {
|
|
|
821
873
|
*/
|
|
822
874
|
message?: string;
|
|
823
875
|
/**
|
|
876
|
+
* @public
|
|
824
877
|
* <p>The message to convey to the user. The message can come from the bot's
|
|
825
878
|
* configuration or from a Lambda function.</p>
|
|
826
879
|
* <p>If the intent is not configured with a Lambda function, or if the Lambda
|
|
@@ -842,6 +895,7 @@ export interface PostContentResponse {
|
|
|
842
895
|
*/
|
|
843
896
|
encodedMessage?: string;
|
|
844
897
|
/**
|
|
898
|
+
* @public
|
|
845
899
|
* <p>The format of the response message. One of the following
|
|
846
900
|
* values:</p>
|
|
847
901
|
* <ul>
|
|
@@ -870,6 +924,7 @@ export interface PostContentResponse {
|
|
|
870
924
|
*/
|
|
871
925
|
messageFormat?: MessageFormatType | string;
|
|
872
926
|
/**
|
|
927
|
+
* @public
|
|
873
928
|
* <p>Identifies the current state of the user interaction. Amazon Lex returns
|
|
874
929
|
* one of the following values as <code>dialogState</code>. The client can
|
|
875
930
|
* optionally use this information to customize the user interface. </p>
|
|
@@ -928,11 +983,13 @@ export interface PostContentResponse {
|
|
|
928
983
|
*/
|
|
929
984
|
dialogState?: DialogState | string;
|
|
930
985
|
/**
|
|
986
|
+
* @public
|
|
931
987
|
* <p> If the <code>dialogState</code> value is <code>ElicitSlot</code>,
|
|
932
988
|
* returns the name of the slot for which Amazon Lex is eliciting a value. </p>
|
|
933
989
|
*/
|
|
934
990
|
slotToElicit?: string;
|
|
935
991
|
/**
|
|
992
|
+
* @public
|
|
936
993
|
* @deprecated
|
|
937
994
|
*
|
|
938
995
|
* <p>The text used to process the request.</p>
|
|
@@ -948,6 +1005,7 @@ export interface PostContentResponse {
|
|
|
948
1005
|
*/
|
|
949
1006
|
inputTranscript?: string;
|
|
950
1007
|
/**
|
|
1008
|
+
* @public
|
|
951
1009
|
* <p>The text used to process the request.</p>
|
|
952
1010
|
* <p>If the input was an audio stream, the
|
|
953
1011
|
* <code>encodedInputTranscript</code> field contains the text extracted
|
|
@@ -959,6 +1017,7 @@ export interface PostContentResponse {
|
|
|
959
1017
|
*/
|
|
960
1018
|
encodedInputTranscript?: string;
|
|
961
1019
|
/**
|
|
1020
|
+
* @public
|
|
962
1021
|
* <p>The prompt (or statement) to convey to the user. This is based on the
|
|
963
1022
|
* bot configuration and context. For example, if Amazon Lex did not understand
|
|
964
1023
|
* the user intent, it sends the <code>clarificationPrompt</code> configured
|
|
@@ -970,16 +1029,19 @@ export interface PostContentResponse {
|
|
|
970
1029
|
*/
|
|
971
1030
|
audioStream?: StreamingBlobTypes;
|
|
972
1031
|
/**
|
|
1032
|
+
* @public
|
|
973
1033
|
* <p>The version of the bot that responded to the conversation. You can use
|
|
974
1034
|
* this information to help determine if one version of a bot is performing
|
|
975
1035
|
* better than another version.</p>
|
|
976
1036
|
*/
|
|
977
1037
|
botVersion?: string;
|
|
978
1038
|
/**
|
|
1039
|
+
* @public
|
|
979
1040
|
* <p>The unique identifier for the session.</p>
|
|
980
1041
|
*/
|
|
981
1042
|
sessionId?: string;
|
|
982
1043
|
/**
|
|
1044
|
+
* @public
|
|
983
1045
|
* <p>A list of active contexts for the session. A context can be set when
|
|
984
1046
|
* an intent is fulfilled or by calling the <code>PostContent</code>,
|
|
985
1047
|
* <code>PostText</code>, or <code>PutSession</code> operation.</p>
|
|
@@ -1018,14 +1080,17 @@ export declare class UnsupportedMediaTypeException extends __BaseException {
|
|
|
1018
1080
|
*/
|
|
1019
1081
|
export interface PostTextRequest {
|
|
1020
1082
|
/**
|
|
1083
|
+
* @public
|
|
1021
1084
|
* <p>The name of the Amazon Lex bot.</p>
|
|
1022
1085
|
*/
|
|
1023
1086
|
botName: string | undefined;
|
|
1024
1087
|
/**
|
|
1088
|
+
* @public
|
|
1025
1089
|
* <p>The alias of the Amazon Lex bot.</p>
|
|
1026
1090
|
*/
|
|
1027
1091
|
botAlias: string | undefined;
|
|
1028
1092
|
/**
|
|
1093
|
+
* @public
|
|
1029
1094
|
* <p>The ID of the client application user. Amazon Lex uses this to identify a
|
|
1030
1095
|
* user's conversation with your bot. At runtime, each request must contain
|
|
1031
1096
|
* the <code>userID</code> field.</p>
|
|
@@ -1058,12 +1123,14 @@ export interface PostTextRequest {
|
|
|
1058
1123
|
*/
|
|
1059
1124
|
userId: string | undefined;
|
|
1060
1125
|
/**
|
|
1126
|
+
* @public
|
|
1061
1127
|
* <p>Application-specific information passed between Amazon Lex and a client
|
|
1062
1128
|
* application.</p>
|
|
1063
1129
|
* <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>
|
|
1064
1130
|
*/
|
|
1065
1131
|
sessionAttributes?: Record<string, string>;
|
|
1066
1132
|
/**
|
|
1133
|
+
* @public
|
|
1067
1134
|
* <p>Request-specific information passed between Amazon Lex and a client
|
|
1068
1135
|
* application.</p>
|
|
1069
1136
|
* <p>The namespace <code>x-amz-lex:</code> is reserved for special
|
|
@@ -1073,10 +1140,12 @@ export interface PostTextRequest {
|
|
|
1073
1140
|
*/
|
|
1074
1141
|
requestAttributes?: Record<string, string>;
|
|
1075
1142
|
/**
|
|
1143
|
+
* @public
|
|
1076
1144
|
* <p>The text that the user entered (Amazon Lex interprets this text).</p>
|
|
1077
1145
|
*/
|
|
1078
1146
|
inputText: string | undefined;
|
|
1079
1147
|
/**
|
|
1148
|
+
* @public
|
|
1080
1149
|
* <p>A list of contexts active for the request. A context can be activated
|
|
1081
1150
|
* when a previous intent is fulfilled, or by including the context in the
|
|
1082
1151
|
* request,</p>
|
|
@@ -1093,6 +1162,7 @@ export interface PostTextRequest {
|
|
|
1093
1162
|
*/
|
|
1094
1163
|
export interface IntentConfidence {
|
|
1095
1164
|
/**
|
|
1165
|
+
* @public
|
|
1096
1166
|
* <p>A score that indicates how confident Amazon Lex is that an intent satisfies
|
|
1097
1167
|
* the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate
|
|
1098
1168
|
* higher confidence.</p>
|
|
@@ -1107,16 +1177,19 @@ export interface IntentConfidence {
|
|
|
1107
1177
|
*/
|
|
1108
1178
|
export interface PredictedIntent {
|
|
1109
1179
|
/**
|
|
1180
|
+
* @public
|
|
1110
1181
|
* <p>The name of the intent that Amazon Lex suggests satisfies the user's
|
|
1111
1182
|
* intent.</p>
|
|
1112
1183
|
*/
|
|
1113
1184
|
intentName?: string;
|
|
1114
1185
|
/**
|
|
1186
|
+
* @public
|
|
1115
1187
|
* <p>Indicates how confident Amazon Lex is that an intent satisfies the user's
|
|
1116
1188
|
* intent.</p>
|
|
1117
1189
|
*/
|
|
1118
1190
|
nluIntentConfidence?: IntentConfidence;
|
|
1119
1191
|
/**
|
|
1192
|
+
* @public
|
|
1120
1193
|
* <p>The slot and slot values associated with the predicted intent.</p>
|
|
1121
1194
|
*/
|
|
1122
1195
|
slots?: Record<string, string>;
|
|
@@ -1139,10 +1212,12 @@ export type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
|
1139
1212
|
*/
|
|
1140
1213
|
export interface Button {
|
|
1141
1214
|
/**
|
|
1215
|
+
* @public
|
|
1142
1216
|
* <p>Text that is visible to the user on the button.</p>
|
|
1143
1217
|
*/
|
|
1144
1218
|
text: string | undefined;
|
|
1145
1219
|
/**
|
|
1220
|
+
* @public
|
|
1146
1221
|
* <p>The value sent to Amazon Lex when a user chooses the button. For
|
|
1147
1222
|
* example, consider button text "NYC." When the user chooses the button, the
|
|
1148
1223
|
* value sent can be "New York City."</p>
|
|
@@ -1156,22 +1231,27 @@ export interface Button {
|
|
|
1156
1231
|
*/
|
|
1157
1232
|
export interface GenericAttachment {
|
|
1158
1233
|
/**
|
|
1234
|
+
* @public
|
|
1159
1235
|
* <p>The title of the option.</p>
|
|
1160
1236
|
*/
|
|
1161
1237
|
title?: string;
|
|
1162
1238
|
/**
|
|
1239
|
+
* @public
|
|
1163
1240
|
* <p>The subtitle shown below the title.</p>
|
|
1164
1241
|
*/
|
|
1165
1242
|
subTitle?: string;
|
|
1166
1243
|
/**
|
|
1244
|
+
* @public
|
|
1167
1245
|
* <p>The URL of an attachment to the response card.</p>
|
|
1168
1246
|
*/
|
|
1169
1247
|
attachmentLinkUrl?: string;
|
|
1170
1248
|
/**
|
|
1249
|
+
* @public
|
|
1171
1250
|
* <p>The URL of an image that is displayed to the user.</p>
|
|
1172
1251
|
*/
|
|
1173
1252
|
imageUrl?: string;
|
|
1174
1253
|
/**
|
|
1254
|
+
* @public
|
|
1175
1255
|
* <p>The list of options to show to the user.</p>
|
|
1176
1256
|
*/
|
|
1177
1257
|
buttons?: Button[];
|
|
@@ -1186,14 +1266,17 @@ export interface GenericAttachment {
|
|
|
1186
1266
|
*/
|
|
1187
1267
|
export interface ResponseCard {
|
|
1188
1268
|
/**
|
|
1269
|
+
* @public
|
|
1189
1270
|
* <p>The version of the response card format.</p>
|
|
1190
1271
|
*/
|
|
1191
1272
|
version?: string;
|
|
1192
1273
|
/**
|
|
1274
|
+
* @public
|
|
1193
1275
|
* <p>The content type of the response.</p>
|
|
1194
1276
|
*/
|
|
1195
1277
|
contentType?: ContentType | string;
|
|
1196
1278
|
/**
|
|
1279
|
+
* @public
|
|
1197
1280
|
* <p>An array of attachment objects representing options.</p>
|
|
1198
1281
|
*/
|
|
1199
1282
|
genericAttachments?: GenericAttachment[];
|
|
@@ -1207,11 +1290,13 @@ export interface ResponseCard {
|
|
|
1207
1290
|
*/
|
|
1208
1291
|
export interface SentimentResponse {
|
|
1209
1292
|
/**
|
|
1293
|
+
* @public
|
|
1210
1294
|
* <p>The inferred sentiment that Amazon Comprehend has the highest
|
|
1211
1295
|
* confidence in.</p>
|
|
1212
1296
|
*/
|
|
1213
1297
|
sentimentLabel?: string;
|
|
1214
1298
|
/**
|
|
1299
|
+
* @public
|
|
1215
1300
|
* <p>The likelihood that the sentiment was correctly inferred.</p>
|
|
1216
1301
|
*/
|
|
1217
1302
|
sentimentScore?: string;
|
|
@@ -1221,10 +1306,12 @@ export interface SentimentResponse {
|
|
|
1221
1306
|
*/
|
|
1222
1307
|
export interface PostTextResponse {
|
|
1223
1308
|
/**
|
|
1309
|
+
* @public
|
|
1224
1310
|
* <p>The current user intent that Amazon Lex is aware of.</p>
|
|
1225
1311
|
*/
|
|
1226
1312
|
intentName?: string;
|
|
1227
1313
|
/**
|
|
1314
|
+
* @public
|
|
1228
1315
|
* <p>Provides a score that indicates how confident Amazon Lex is that the
|
|
1229
1316
|
* returned intent is the one that matches the user's intent. The score is
|
|
1230
1317
|
* 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>
|
|
@@ -1233,6 +1320,7 @@ export interface PostTextResponse {
|
|
|
1233
1320
|
*/
|
|
1234
1321
|
nluIntentConfidence?: IntentConfidence;
|
|
1235
1322
|
/**
|
|
1323
|
+
* @public
|
|
1236
1324
|
* <p>One to four alternative intents that may be applicable to the user's
|
|
1237
1325
|
* intent.</p>
|
|
1238
1326
|
* <p>Each alternative includes a score that indicates how confident Amazon Lex
|
|
@@ -1241,6 +1329,7 @@ export interface PostTextResponse {
|
|
|
1241
1329
|
*/
|
|
1242
1330
|
alternativeIntents?: PredictedIntent[];
|
|
1243
1331
|
/**
|
|
1332
|
+
* @public
|
|
1244
1333
|
* <p> The intent slots that Amazon Lex detected from the user input in the
|
|
1245
1334
|
* conversation. </p>
|
|
1246
1335
|
* <p>Amazon Lex creates a resolution list containing likely values for a slot.
|
|
@@ -1257,11 +1346,13 @@ export interface PostTextResponse {
|
|
|
1257
1346
|
*/
|
|
1258
1347
|
slots?: Record<string, string>;
|
|
1259
1348
|
/**
|
|
1349
|
+
* @public
|
|
1260
1350
|
* <p>A map of key-value pairs representing the session-specific context
|
|
1261
1351
|
* information.</p>
|
|
1262
1352
|
*/
|
|
1263
1353
|
sessionAttributes?: Record<string, string>;
|
|
1264
1354
|
/**
|
|
1355
|
+
* @public
|
|
1265
1356
|
* <p>The message to convey to the user. The message can come from the bot's
|
|
1266
1357
|
* configuration or from a Lambda function.</p>
|
|
1267
1358
|
* <p>If the intent is not configured with a Lambda function, or if the Lambda
|
|
@@ -1281,12 +1372,14 @@ export interface PostTextResponse {
|
|
|
1281
1372
|
*/
|
|
1282
1373
|
message?: string;
|
|
1283
1374
|
/**
|
|
1375
|
+
* @public
|
|
1284
1376
|
* <p>The sentiment expressed in and utterance.</p>
|
|
1285
1377
|
* <p>When the bot is configured to send utterances to Amazon Comprehend for
|
|
1286
1378
|
* sentiment analysis, this field contains the result of the analysis.</p>
|
|
1287
1379
|
*/
|
|
1288
1380
|
sentimentResponse?: SentimentResponse;
|
|
1289
1381
|
/**
|
|
1382
|
+
* @public
|
|
1290
1383
|
* <p>The format of the response message. One of the following
|
|
1291
1384
|
* values:</p>
|
|
1292
1385
|
* <ul>
|
|
@@ -1315,6 +1408,7 @@ export interface PostTextResponse {
|
|
|
1315
1408
|
*/
|
|
1316
1409
|
messageFormat?: MessageFormatType | string;
|
|
1317
1410
|
/**
|
|
1411
|
+
* @public
|
|
1318
1412
|
* <p> Identifies the current state of the user interaction. Amazon Lex returns
|
|
1319
1413
|
* one of the following values as <code>dialogState</code>. The client can
|
|
1320
1414
|
* optionally use this information to customize the user interface. </p>
|
|
@@ -1374,11 +1468,13 @@ export interface PostTextResponse {
|
|
|
1374
1468
|
*/
|
|
1375
1469
|
dialogState?: DialogState | string;
|
|
1376
1470
|
/**
|
|
1471
|
+
* @public
|
|
1377
1472
|
* <p>If the <code>dialogState</code> value is <code>ElicitSlot</code>,
|
|
1378
1473
|
* returns the name of the slot for which Amazon Lex is eliciting a value. </p>
|
|
1379
1474
|
*/
|
|
1380
1475
|
slotToElicit?: string;
|
|
1381
1476
|
/**
|
|
1477
|
+
* @public
|
|
1382
1478
|
* <p>Represents the options that the user has to respond to the current
|
|
1383
1479
|
* prompt. Response Card can come from the bot configuration (in the
|
|
1384
1480
|
* Amazon Lex console, choose the settings button next to a slot) or from a
|
|
@@ -1386,16 +1482,19 @@ export interface PostTextResponse {
|
|
|
1386
1482
|
*/
|
|
1387
1483
|
responseCard?: ResponseCard;
|
|
1388
1484
|
/**
|
|
1485
|
+
* @public
|
|
1389
1486
|
* <p>A unique identifier for the session.</p>
|
|
1390
1487
|
*/
|
|
1391
1488
|
sessionId?: string;
|
|
1392
1489
|
/**
|
|
1490
|
+
* @public
|
|
1393
1491
|
* <p>The version of the bot that responded to the conversation. You can use
|
|
1394
1492
|
* this information to help determine if one version of a bot is performing
|
|
1395
1493
|
* better than another version.</p>
|
|
1396
1494
|
*/
|
|
1397
1495
|
botVersion?: string;
|
|
1398
1496
|
/**
|
|
1497
|
+
* @public
|
|
1399
1498
|
* <p>A list of active contexts for the session. A context can be set when
|
|
1400
1499
|
* an intent is fulfilled or by calling the <code>PostContent</code>,
|
|
1401
1500
|
* <code>PostText</code>, or <code>PutSession</code> operation.</p>
|
|
@@ -1409,30 +1508,36 @@ export interface PostTextResponse {
|
|
|
1409
1508
|
*/
|
|
1410
1509
|
export interface PutSessionRequest {
|
|
1411
1510
|
/**
|
|
1511
|
+
* @public
|
|
1412
1512
|
* <p>The name of the bot that contains the session data.</p>
|
|
1413
1513
|
*/
|
|
1414
1514
|
botName: string | undefined;
|
|
1415
1515
|
/**
|
|
1516
|
+
* @public
|
|
1416
1517
|
* <p>The alias in use for the bot that contains the session data.</p>
|
|
1417
1518
|
*/
|
|
1418
1519
|
botAlias: string | undefined;
|
|
1419
1520
|
/**
|
|
1521
|
+
* @public
|
|
1420
1522
|
* <p>The ID of the client application user. Amazon Lex uses this to identify a
|
|
1421
1523
|
* user's conversation with your bot. </p>
|
|
1422
1524
|
*/
|
|
1423
1525
|
userId: string | undefined;
|
|
1424
1526
|
/**
|
|
1527
|
+
* @public
|
|
1425
1528
|
* <p>Map of key/value pairs representing the session-specific context
|
|
1426
1529
|
* information. It contains application information passed between Amazon Lex and
|
|
1427
1530
|
* a client application.</p>
|
|
1428
1531
|
*/
|
|
1429
1532
|
sessionAttributes?: Record<string, string>;
|
|
1430
1533
|
/**
|
|
1534
|
+
* @public
|
|
1431
1535
|
* <p>Sets the next action that the bot should take to fulfill the
|
|
1432
1536
|
* conversation.</p>
|
|
1433
1537
|
*/
|
|
1434
1538
|
dialogAction?: DialogAction;
|
|
1435
1539
|
/**
|
|
1540
|
+
* @public
|
|
1436
1541
|
* <p>A summary of the recent intents for the bot. You can use the intent
|
|
1437
1542
|
* summary view to set a checkpoint label on an intent and modify attributes
|
|
1438
1543
|
* of intents. You can also use it to remove or add intent summary objects to
|
|
@@ -1464,6 +1569,7 @@ export interface PutSessionRequest {
|
|
|
1464
1569
|
*/
|
|
1465
1570
|
recentIntentSummaryView?: IntentSummary[];
|
|
1466
1571
|
/**
|
|
1572
|
+
* @public
|
|
1467
1573
|
* <p>The message that Amazon Lex returns in the response can be either text or
|
|
1468
1574
|
* speech based depending on the value of this field.</p>
|
|
1469
1575
|
* <ul>
|
|
@@ -1515,6 +1621,7 @@ export interface PutSessionRequest {
|
|
|
1515
1621
|
*/
|
|
1516
1622
|
accept?: string;
|
|
1517
1623
|
/**
|
|
1624
|
+
* @public
|
|
1518
1625
|
* <p>A list of contexts active for the request. A context can be activated
|
|
1519
1626
|
* when a previous intent is fulfilled, or by including the context in the
|
|
1520
1627
|
* request,</p>
|
|
@@ -1529,15 +1636,18 @@ export interface PutSessionRequest {
|
|
|
1529
1636
|
*/
|
|
1530
1637
|
export interface PutSessionResponse {
|
|
1531
1638
|
/**
|
|
1639
|
+
* @public
|
|
1532
1640
|
* <p>Content type as specified in the <code>Accept</code> HTTP header in
|
|
1533
1641
|
* the request.</p>
|
|
1534
1642
|
*/
|
|
1535
1643
|
contentType?: string;
|
|
1536
1644
|
/**
|
|
1645
|
+
* @public
|
|
1537
1646
|
* <p>The name of the current intent.</p>
|
|
1538
1647
|
*/
|
|
1539
1648
|
intentName?: string;
|
|
1540
1649
|
/**
|
|
1650
|
+
* @public
|
|
1541
1651
|
* <p>Map of zero or more intent slots Amazon Lex detected from the user input
|
|
1542
1652
|
* during the conversation.</p>
|
|
1543
1653
|
* <p>Amazon Lex creates a resolution list containing likely values for a slot.
|
|
@@ -1554,11 +1664,13 @@ export interface PutSessionResponse {
|
|
|
1554
1664
|
*/
|
|
1555
1665
|
slots?: __LazyJsonString | string;
|
|
1556
1666
|
/**
|
|
1667
|
+
* @public
|
|
1557
1668
|
* <p>Map of key/value pairs representing session-specific context
|
|
1558
1669
|
* information.</p>
|
|
1559
1670
|
*/
|
|
1560
1671
|
sessionAttributes?: __LazyJsonString | string;
|
|
1561
1672
|
/**
|
|
1673
|
+
* @public
|
|
1562
1674
|
* @deprecated
|
|
1563
1675
|
*
|
|
1564
1676
|
* <p>The next message that should be presented to the user.</p>
|
|
@@ -1569,12 +1681,14 @@ export interface PutSessionResponse {
|
|
|
1569
1681
|
*/
|
|
1570
1682
|
message?: string;
|
|
1571
1683
|
/**
|
|
1684
|
+
* @public
|
|
1572
1685
|
* <p>The next message that should be presented to the user.</p>
|
|
1573
1686
|
* <p>The <code>encodedMessage</code> field is base-64 encoded. You must
|
|
1574
1687
|
* decode the field before you can use the value.</p>
|
|
1575
1688
|
*/
|
|
1576
1689
|
encodedMessage?: string;
|
|
1577
1690
|
/**
|
|
1691
|
+
* @public
|
|
1578
1692
|
* <p>The format of the response message. One of the following
|
|
1579
1693
|
* values:</p>
|
|
1580
1694
|
* <ul>
|
|
@@ -1603,6 +1717,7 @@ export interface PutSessionResponse {
|
|
|
1603
1717
|
*/
|
|
1604
1718
|
messageFormat?: MessageFormatType | string;
|
|
1605
1719
|
/**
|
|
1720
|
+
* @public
|
|
1606
1721
|
* <p></p>
|
|
1607
1722
|
* <ul>
|
|
1608
1723
|
* <li>
|
|
@@ -1641,19 +1756,23 @@ export interface PutSessionResponse {
|
|
|
1641
1756
|
*/
|
|
1642
1757
|
dialogState?: DialogState | string;
|
|
1643
1758
|
/**
|
|
1759
|
+
* @public
|
|
1644
1760
|
* <p>If the <code>dialogState</code> is <code>ElicitSlot</code>, returns
|
|
1645
1761
|
* the name of the slot for which Amazon Lex is eliciting a value.</p>
|
|
1646
1762
|
*/
|
|
1647
1763
|
slotToElicit?: string;
|
|
1648
1764
|
/**
|
|
1765
|
+
* @public
|
|
1649
1766
|
* <p>The audio version of the message to convey to the user.</p>
|
|
1650
1767
|
*/
|
|
1651
1768
|
audioStream?: StreamingBlobTypes;
|
|
1652
1769
|
/**
|
|
1770
|
+
* @public
|
|
1653
1771
|
* <p>A unique identifier for the session.</p>
|
|
1654
1772
|
*/
|
|
1655
1773
|
sessionId?: string;
|
|
1656
1774
|
/**
|
|
1775
|
+
* @public
|
|
1657
1776
|
* <p>A list of active contexts for the session.</p>
|
|
1658
1777
|
*/
|
|
1659
1778
|
activeContexts?: __LazyJsonString | string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-lex-runtime-service",
|
|
3
3
|
"description": "AWS SDK for JavaScript Lex Runtime Service Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -23,15 +23,15 @@
|
|
|
23
23
|
"dependencies": {
|
|
24
24
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
25
25
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
26
|
-
"@aws-sdk/client-sts": "3.
|
|
27
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
27
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
28
28
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
29
29
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
30
30
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
31
31
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
32
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
32
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
33
33
|
"@aws-sdk/types": "3.378.0",
|
|
34
|
-
"@aws-sdk/util-endpoints": "3.
|
|
34
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
35
35
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
36
36
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
37
37
|
"@smithy/config-resolver": "^2.0.1",
|