aws-sdk-lexruntimev2 1.16.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lexruntimev2/async_client.rb +22 -5
- data/lib/aws-sdk-lexruntimev2/client.rb +20 -3
- data/lib/aws-sdk-lexruntimev2/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-lexruntimev2/endpoint_provider.rb +51 -0
- data/lib/aws-sdk-lexruntimev2/endpoints.rb +99 -0
- data/lib/aws-sdk-lexruntimev2/plugins/endpoints.rb +80 -0
- data/lib/aws-sdk-lexruntimev2/types.rb +0 -792
- data/lib/aws-sdk-lexruntimev2.rb +5 -1
- metadata +8 -4
@@ -32,20 +32,6 @@ module Aws::LexRuntimeV2
|
|
32
32
|
# `order-fulfilled`, only intents that have `order-fulfilled` configured
|
33
33
|
# as a trigger are considered for follow up.
|
34
34
|
#
|
35
|
-
# @note When making an API call, you may pass ActiveContext
|
36
|
-
# data as a hash:
|
37
|
-
#
|
38
|
-
# {
|
39
|
-
# name: "ActiveContextName", # required
|
40
|
-
# time_to_live: { # required
|
41
|
-
# time_to_live_in_seconds: 1, # required
|
42
|
-
# turns_to_live: 1, # required
|
43
|
-
# },
|
44
|
-
# context_attributes: { # required
|
45
|
-
# "ParameterName" => "Text",
|
46
|
-
# },
|
47
|
-
# }
|
48
|
-
#
|
49
35
|
# @!attribute [rw] name
|
50
36
|
# The name of the context.
|
51
37
|
# @return [String]
|
@@ -79,14 +65,6 @@ module Aws::LexRuntimeV2
|
|
79
65
|
# The time that a context is active. You can specify the time to live in
|
80
66
|
# seconds or in conversation turns.
|
81
67
|
#
|
82
|
-
# @note When making an API call, you may pass ActiveContextTimeToLive
|
83
|
-
# data as a hash:
|
84
|
-
#
|
85
|
-
# {
|
86
|
-
# time_to_live_in_seconds: 1, # required
|
87
|
-
# turns_to_live: 1, # required
|
88
|
-
# }
|
89
|
-
#
|
90
68
|
# @!attribute [rw] time_to_live_in_seconds
|
91
69
|
# The number of seconds that the context is active. You can specify
|
92
70
|
# between 5 and 86400 seconds (24 hours).
|
@@ -112,16 +90,6 @@ module Aws::LexRuntimeV2
|
|
112
90
|
# Amazon Lex V2 accumulates audio chunks until it recognizes a natural
|
113
91
|
# pause in speech before processing the input.
|
114
92
|
#
|
115
|
-
# @note When making an API call, you may pass AudioInputEvent
|
116
|
-
# data as a hash:
|
117
|
-
#
|
118
|
-
# {
|
119
|
-
# audio_chunk: "data",
|
120
|
-
# content_type: "NonEmptyString", # required
|
121
|
-
# event_id: "EventId",
|
122
|
-
# client_timestamp_millis: 1,
|
123
|
-
# }
|
124
|
-
#
|
125
93
|
# @!attribute [rw] audio_chunk
|
126
94
|
# An encoded stream of audio.
|
127
95
|
# @return [String]
|
@@ -200,14 +168,6 @@ module Aws::LexRuntimeV2
|
|
200
168
|
|
201
169
|
# A button that appears on a response card show to the user.
|
202
170
|
#
|
203
|
-
# @note When making an API call, you may pass Button
|
204
|
-
# data as a hash:
|
205
|
-
#
|
206
|
-
# {
|
207
|
-
# text: "ButtonText", # required
|
208
|
-
# value: "ButtonValue", # required
|
209
|
-
# }
|
210
|
-
#
|
211
171
|
# @!attribute [rw] text
|
212
172
|
# The text that is displayed on the button.
|
213
173
|
# @return [String]
|
@@ -246,104 +206,6 @@ module Aws::LexRuntimeV2
|
|
246
206
|
# configure the conversation, including session and request attributes
|
247
207
|
# and the response content type.
|
248
208
|
#
|
249
|
-
# @note When making an API call, you may pass ConfigurationEvent
|
250
|
-
# data as a hash:
|
251
|
-
#
|
252
|
-
# {
|
253
|
-
# request_attributes: {
|
254
|
-
# "NonEmptyString" => "String",
|
255
|
-
# },
|
256
|
-
# response_content_type: "NonEmptyString", # required
|
257
|
-
# session_state: {
|
258
|
-
# dialog_action: {
|
259
|
-
# type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
|
260
|
-
# slot_to_elicit: "NonEmptyString",
|
261
|
-
# slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
|
262
|
-
# sub_slot_to_elicit: {
|
263
|
-
# name: "NonEmptyString", # required
|
264
|
-
# sub_slot_to_elicit: {
|
265
|
-
# # recursive ElicitSubSlot
|
266
|
-
# },
|
267
|
-
# },
|
268
|
-
# },
|
269
|
-
# intent: {
|
270
|
-
# name: "NonEmptyString", # required
|
271
|
-
# slots: {
|
272
|
-
# "NonEmptyString" => {
|
273
|
-
# value: {
|
274
|
-
# original_value: "NonEmptyString",
|
275
|
-
# interpreted_value: "NonEmptyString", # required
|
276
|
-
# resolved_values: ["NonEmptyString"],
|
277
|
-
# },
|
278
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
279
|
-
# values: [
|
280
|
-
# {
|
281
|
-
# # recursive Slot
|
282
|
-
# },
|
283
|
-
# ],
|
284
|
-
# sub_slots: {
|
285
|
-
# # recursive Slots
|
286
|
-
# },
|
287
|
-
# },
|
288
|
-
# },
|
289
|
-
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting, FulfillmentInProgress
|
290
|
-
# confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
|
291
|
-
# },
|
292
|
-
# active_contexts: [
|
293
|
-
# {
|
294
|
-
# name: "ActiveContextName", # required
|
295
|
-
# time_to_live: { # required
|
296
|
-
# time_to_live_in_seconds: 1, # required
|
297
|
-
# turns_to_live: 1, # required
|
298
|
-
# },
|
299
|
-
# context_attributes: { # required
|
300
|
-
# "ParameterName" => "Text",
|
301
|
-
# },
|
302
|
-
# },
|
303
|
-
# ],
|
304
|
-
# session_attributes: {
|
305
|
-
# "NonEmptyString" => "String",
|
306
|
-
# },
|
307
|
-
# originating_request_id: "NonEmptyString",
|
308
|
-
# runtime_hints: {
|
309
|
-
# slot_hints: {
|
310
|
-
# "Name" => {
|
311
|
-
# "Name" => {
|
312
|
-
# runtime_hint_values: [
|
313
|
-
# {
|
314
|
-
# phrase: "RuntimeHintPhrase", # required
|
315
|
-
# },
|
316
|
-
# ],
|
317
|
-
# sub_slot_hints: {
|
318
|
-
# # recursive SlotHintsSlotMap
|
319
|
-
# },
|
320
|
-
# },
|
321
|
-
# },
|
322
|
-
# },
|
323
|
-
# },
|
324
|
-
# },
|
325
|
-
# welcome_messages: [
|
326
|
-
# {
|
327
|
-
# content: "Text",
|
328
|
-
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
329
|
-
# image_response_card: {
|
330
|
-
# title: "AttachmentTitle", # required
|
331
|
-
# subtitle: "AttachmentTitle",
|
332
|
-
# image_url: "AttachmentUrl",
|
333
|
-
# buttons: [
|
334
|
-
# {
|
335
|
-
# text: "ButtonText", # required
|
336
|
-
# value: "ButtonValue", # required
|
337
|
-
# },
|
338
|
-
# ],
|
339
|
-
# },
|
340
|
-
# },
|
341
|
-
# ],
|
342
|
-
# disable_playback: false,
|
343
|
-
# event_id: "EventId",
|
344
|
-
# client_timestamp_millis: 1,
|
345
|
-
# }
|
346
|
-
#
|
347
209
|
# @!attribute [rw] request_attributes
|
348
210
|
# Request-specific information passed between the client application
|
349
211
|
# and Amazon Lex V2.
|
@@ -451,15 +313,6 @@ module Aws::LexRuntimeV2
|
|
451
313
|
# you can have Amazon Lex V2 process a credit card number input from a
|
452
314
|
# phone.
|
453
315
|
#
|
454
|
-
# @note When making an API call, you may pass DTMFInputEvent
|
455
|
-
# data as a hash:
|
456
|
-
#
|
457
|
-
# {
|
458
|
-
# input_character: "DTMFRegex", # required
|
459
|
-
# event_id: "EventId",
|
460
|
-
# client_timestamp_millis: 1,
|
461
|
-
# }
|
462
|
-
#
|
463
316
|
# @!attribute [rw] input_character
|
464
317
|
# The DTMF character that the user pressed. The allowed characters are
|
465
318
|
# A - D, 0 - 9, # and *.
|
@@ -486,16 +339,6 @@ module Aws::LexRuntimeV2
|
|
486
339
|
include Aws::Structure
|
487
340
|
end
|
488
341
|
|
489
|
-
# @note When making an API call, you may pass DeleteSessionRequest
|
490
|
-
# data as a hash:
|
491
|
-
#
|
492
|
-
# {
|
493
|
-
# bot_id: "BotIdentifier", # required
|
494
|
-
# bot_alias_id: "BotAliasIdentifier", # required
|
495
|
-
# locale_id: "LocaleId", # required
|
496
|
-
# session_id: "SessionId", # required
|
497
|
-
# }
|
498
|
-
#
|
499
342
|
# @!attribute [rw] bot_id
|
500
343
|
# The identifier of the bot that contains the session data.
|
501
344
|
# @return [String]
|
@@ -566,21 +409,6 @@ module Aws::LexRuntimeV2
|
|
566
409
|
|
567
410
|
# The next action that Amazon Lex V2 should take.
|
568
411
|
#
|
569
|
-
# @note When making an API call, you may pass DialogAction
|
570
|
-
# data as a hash:
|
571
|
-
#
|
572
|
-
# {
|
573
|
-
# type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
|
574
|
-
# slot_to_elicit: "NonEmptyString",
|
575
|
-
# slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
|
576
|
-
# sub_slot_to_elicit: {
|
577
|
-
# name: "NonEmptyString", # required
|
578
|
-
# sub_slot_to_elicit: {
|
579
|
-
# # recursive ElicitSubSlot
|
580
|
-
# },
|
581
|
-
# },
|
582
|
-
# }
|
583
|
-
#
|
584
412
|
# @!attribute [rw] type
|
585
413
|
# The next action that the bot should take in its interaction with the
|
586
414
|
# user. The possible values are:
|
@@ -643,14 +471,6 @@ module Aws::LexRuntimeV2
|
|
643
471
|
# Lex V2. Sending a `DisconnectionEvent` event is optional, but can help
|
644
472
|
# identify a conversation in logs.
|
645
473
|
#
|
646
|
-
# @note When making an API call, you may pass DisconnectionEvent
|
647
|
-
# data as a hash:
|
648
|
-
#
|
649
|
-
# {
|
650
|
-
# event_id: "EventId",
|
651
|
-
# client_timestamp_millis: 1,
|
652
|
-
# }
|
653
|
-
#
|
654
474
|
# @!attribute [rw] event_id
|
655
475
|
# A unique identifier that your application assigns to the event. You
|
656
476
|
# can use this to identify events in logs.
|
@@ -674,19 +494,6 @@ module Aws::LexRuntimeV2
|
|
674
494
|
# The specific constituent sub slot of the composite slot to elicit in
|
675
495
|
# dialog action.
|
676
496
|
#
|
677
|
-
# @note When making an API call, you may pass ElicitSubSlot
|
678
|
-
# data as a hash:
|
679
|
-
#
|
680
|
-
# {
|
681
|
-
# name: "NonEmptyString", # required
|
682
|
-
# sub_slot_to_elicit: {
|
683
|
-
# name: "NonEmptyString", # required
|
684
|
-
# sub_slot_to_elicit: {
|
685
|
-
# # recursive ElicitSubSlot
|
686
|
-
# },
|
687
|
-
# },
|
688
|
-
# }
|
689
|
-
#
|
690
497
|
# @!attribute [rw] name
|
691
498
|
# The name of the slot that should be elicited from the user.
|
692
499
|
# @return [String]
|
@@ -704,16 +511,6 @@ module Aws::LexRuntimeV2
|
|
704
511
|
include Aws::Structure
|
705
512
|
end
|
706
513
|
|
707
|
-
# @note When making an API call, you may pass GetSessionRequest
|
708
|
-
# data as a hash:
|
709
|
-
#
|
710
|
-
# {
|
711
|
-
# bot_id: "BotIdentifier", # required
|
712
|
-
# bot_alias_id: "BotAliasIdentifier", # required
|
713
|
-
# locale_id: "LocaleId", # required
|
714
|
-
# session_id: "SessionId", # required
|
715
|
-
# }
|
716
|
-
#
|
717
514
|
# @!attribute [rw] bot_id
|
718
515
|
# The identifier of the bot that contains the session data.
|
719
516
|
# @return [String]
|
@@ -806,21 +603,6 @@ module Aws::LexRuntimeV2
|
|
806
603
|
# When you use a response card, the response from the user is
|
807
604
|
# constrained to the text associated with a button on the card.
|
808
605
|
#
|
809
|
-
# @note When making an API call, you may pass ImageResponseCard
|
810
|
-
# data as a hash:
|
811
|
-
#
|
812
|
-
# {
|
813
|
-
# title: "AttachmentTitle", # required
|
814
|
-
# subtitle: "AttachmentTitle",
|
815
|
-
# image_url: "AttachmentUrl",
|
816
|
-
# buttons: [
|
817
|
-
# {
|
818
|
-
# text: "ButtonText", # required
|
819
|
-
# value: "ButtonValue", # required
|
820
|
-
# },
|
821
|
-
# ],
|
822
|
-
# }
|
823
|
-
#
|
824
606
|
# @!attribute [rw] title
|
825
607
|
# The title to display on the response card. The format of the title
|
826
608
|
# is determined by the platform displaying the response card.
|
@@ -856,33 +638,6 @@ module Aws::LexRuntimeV2
|
|
856
638
|
|
857
639
|
# The current intent that Amazon Lex V2 is attempting to fulfill.
|
858
640
|
#
|
859
|
-
# @note When making an API call, you may pass Intent
|
860
|
-
# data as a hash:
|
861
|
-
#
|
862
|
-
# {
|
863
|
-
# name: "NonEmptyString", # required
|
864
|
-
# slots: {
|
865
|
-
# "NonEmptyString" => {
|
866
|
-
# value: {
|
867
|
-
# original_value: "NonEmptyString",
|
868
|
-
# interpreted_value: "NonEmptyString", # required
|
869
|
-
# resolved_values: ["NonEmptyString"],
|
870
|
-
# },
|
871
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
872
|
-
# values: [
|
873
|
-
# {
|
874
|
-
# # recursive Slot
|
875
|
-
# },
|
876
|
-
# ],
|
877
|
-
# sub_slots: {
|
878
|
-
# # recursive Slots
|
879
|
-
# },
|
880
|
-
# },
|
881
|
-
# },
|
882
|
-
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting, FulfillmentInProgress
|
883
|
-
# confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
|
884
|
-
# }
|
885
|
-
#
|
886
641
|
# @!attribute [rw] name
|
887
642
|
# The name of the intent.
|
888
643
|
# @return [String]
|
@@ -1011,25 +766,6 @@ module Aws::LexRuntimeV2
|
|
1011
766
|
|
1012
767
|
# Container for text that is returned to the customer..
|
1013
768
|
#
|
1014
|
-
# @note When making an API call, you may pass Message
|
1015
|
-
# data as a hash:
|
1016
|
-
#
|
1017
|
-
# {
|
1018
|
-
# content: "Text",
|
1019
|
-
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
1020
|
-
# image_response_card: {
|
1021
|
-
# title: "AttachmentTitle", # required
|
1022
|
-
# subtitle: "AttachmentTitle",
|
1023
|
-
# image_url: "AttachmentUrl",
|
1024
|
-
# buttons: [
|
1025
|
-
# {
|
1026
|
-
# text: "ButtonText", # required
|
1027
|
-
# value: "ButtonValue", # required
|
1028
|
-
# },
|
1029
|
-
# ],
|
1030
|
-
# },
|
1031
|
-
# }
|
1032
|
-
#
|
1033
769
|
# @!attribute [rw] content
|
1034
770
|
# The text of the message.
|
1035
771
|
# @return [String]
|
@@ -1060,14 +796,6 @@ module Aws::LexRuntimeV2
|
|
1060
796
|
# that playback of audio is complete and that Amazon Lex V2 should start
|
1061
797
|
# processing the user's input.
|
1062
798
|
#
|
1063
|
-
# @note When making an API call, you may pass PlaybackCompletionEvent
|
1064
|
-
# data as a hash:
|
1065
|
-
#
|
1066
|
-
# {
|
1067
|
-
# event_id: "EventId",
|
1068
|
-
# client_timestamp_millis: 1,
|
1069
|
-
# }
|
1070
|
-
#
|
1071
799
|
# @!attribute [rw] event_id
|
1072
800
|
# A unique identifier that your application assigns to the event. You
|
1073
801
|
# can use this to identify events in logs.
|
@@ -1122,105 +850,6 @@ module Aws::LexRuntimeV2
|
|
1122
850
|
include Aws::Structure
|
1123
851
|
end
|
1124
852
|
|
1125
|
-
# @note When making an API call, you may pass PutSessionRequest
|
1126
|
-
# data as a hash:
|
1127
|
-
#
|
1128
|
-
# {
|
1129
|
-
# bot_id: "BotIdentifier", # required
|
1130
|
-
# bot_alias_id: "BotAliasIdentifier", # required
|
1131
|
-
# locale_id: "LocaleId", # required
|
1132
|
-
# session_id: "SessionId", # required
|
1133
|
-
# messages: [
|
1134
|
-
# {
|
1135
|
-
# content: "Text",
|
1136
|
-
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
1137
|
-
# image_response_card: {
|
1138
|
-
# title: "AttachmentTitle", # required
|
1139
|
-
# subtitle: "AttachmentTitle",
|
1140
|
-
# image_url: "AttachmentUrl",
|
1141
|
-
# buttons: [
|
1142
|
-
# {
|
1143
|
-
# text: "ButtonText", # required
|
1144
|
-
# value: "ButtonValue", # required
|
1145
|
-
# },
|
1146
|
-
# ],
|
1147
|
-
# },
|
1148
|
-
# },
|
1149
|
-
# ],
|
1150
|
-
# session_state: { # required
|
1151
|
-
# dialog_action: {
|
1152
|
-
# type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
|
1153
|
-
# slot_to_elicit: "NonEmptyString",
|
1154
|
-
# slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
|
1155
|
-
# sub_slot_to_elicit: {
|
1156
|
-
# name: "NonEmptyString", # required
|
1157
|
-
# sub_slot_to_elicit: {
|
1158
|
-
# # recursive ElicitSubSlot
|
1159
|
-
# },
|
1160
|
-
# },
|
1161
|
-
# },
|
1162
|
-
# intent: {
|
1163
|
-
# name: "NonEmptyString", # required
|
1164
|
-
# slots: {
|
1165
|
-
# "NonEmptyString" => {
|
1166
|
-
# value: {
|
1167
|
-
# original_value: "NonEmptyString",
|
1168
|
-
# interpreted_value: "NonEmptyString", # required
|
1169
|
-
# resolved_values: ["NonEmptyString"],
|
1170
|
-
# },
|
1171
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
1172
|
-
# values: [
|
1173
|
-
# {
|
1174
|
-
# # recursive Slot
|
1175
|
-
# },
|
1176
|
-
# ],
|
1177
|
-
# sub_slots: {
|
1178
|
-
# # recursive Slots
|
1179
|
-
# },
|
1180
|
-
# },
|
1181
|
-
# },
|
1182
|
-
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting, FulfillmentInProgress
|
1183
|
-
# confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
|
1184
|
-
# },
|
1185
|
-
# active_contexts: [
|
1186
|
-
# {
|
1187
|
-
# name: "ActiveContextName", # required
|
1188
|
-
# time_to_live: { # required
|
1189
|
-
# time_to_live_in_seconds: 1, # required
|
1190
|
-
# turns_to_live: 1, # required
|
1191
|
-
# },
|
1192
|
-
# context_attributes: { # required
|
1193
|
-
# "ParameterName" => "Text",
|
1194
|
-
# },
|
1195
|
-
# },
|
1196
|
-
# ],
|
1197
|
-
# session_attributes: {
|
1198
|
-
# "NonEmptyString" => "String",
|
1199
|
-
# },
|
1200
|
-
# originating_request_id: "NonEmptyString",
|
1201
|
-
# runtime_hints: {
|
1202
|
-
# slot_hints: {
|
1203
|
-
# "Name" => {
|
1204
|
-
# "Name" => {
|
1205
|
-
# runtime_hint_values: [
|
1206
|
-
# {
|
1207
|
-
# phrase: "RuntimeHintPhrase", # required
|
1208
|
-
# },
|
1209
|
-
# ],
|
1210
|
-
# sub_slot_hints: {
|
1211
|
-
# # recursive SlotHintsSlotMap
|
1212
|
-
# },
|
1213
|
-
# },
|
1214
|
-
# },
|
1215
|
-
# },
|
1216
|
-
# },
|
1217
|
-
# },
|
1218
|
-
# request_attributes: {
|
1219
|
-
# "NonEmptyString" => "String",
|
1220
|
-
# },
|
1221
|
-
# response_content_type: "NonEmptyString",
|
1222
|
-
# }
|
1223
|
-
#
|
1224
853
|
# @!attribute [rw] bot_id
|
1225
854
|
# The identifier of the bot that receives the session data.
|
1226
855
|
# @return [String]
|
@@ -1329,88 +958,6 @@ module Aws::LexRuntimeV2
|
|
1329
958
|
include Aws::Structure
|
1330
959
|
end
|
1331
960
|
|
1332
|
-
# @note When making an API call, you may pass RecognizeTextRequest
|
1333
|
-
# data as a hash:
|
1334
|
-
#
|
1335
|
-
# {
|
1336
|
-
# bot_id: "BotIdentifier", # required
|
1337
|
-
# bot_alias_id: "BotAliasIdentifier", # required
|
1338
|
-
# locale_id: "LocaleId", # required
|
1339
|
-
# session_id: "SessionId", # required
|
1340
|
-
# text: "Text", # required
|
1341
|
-
# session_state: {
|
1342
|
-
# dialog_action: {
|
1343
|
-
# type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
|
1344
|
-
# slot_to_elicit: "NonEmptyString",
|
1345
|
-
# slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
|
1346
|
-
# sub_slot_to_elicit: {
|
1347
|
-
# name: "NonEmptyString", # required
|
1348
|
-
# sub_slot_to_elicit: {
|
1349
|
-
# # recursive ElicitSubSlot
|
1350
|
-
# },
|
1351
|
-
# },
|
1352
|
-
# },
|
1353
|
-
# intent: {
|
1354
|
-
# name: "NonEmptyString", # required
|
1355
|
-
# slots: {
|
1356
|
-
# "NonEmptyString" => {
|
1357
|
-
# value: {
|
1358
|
-
# original_value: "NonEmptyString",
|
1359
|
-
# interpreted_value: "NonEmptyString", # required
|
1360
|
-
# resolved_values: ["NonEmptyString"],
|
1361
|
-
# },
|
1362
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
1363
|
-
# values: [
|
1364
|
-
# {
|
1365
|
-
# # recursive Slot
|
1366
|
-
# },
|
1367
|
-
# ],
|
1368
|
-
# sub_slots: {
|
1369
|
-
# # recursive Slots
|
1370
|
-
# },
|
1371
|
-
# },
|
1372
|
-
# },
|
1373
|
-
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting, FulfillmentInProgress
|
1374
|
-
# confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
|
1375
|
-
# },
|
1376
|
-
# active_contexts: [
|
1377
|
-
# {
|
1378
|
-
# name: "ActiveContextName", # required
|
1379
|
-
# time_to_live: { # required
|
1380
|
-
# time_to_live_in_seconds: 1, # required
|
1381
|
-
# turns_to_live: 1, # required
|
1382
|
-
# },
|
1383
|
-
# context_attributes: { # required
|
1384
|
-
# "ParameterName" => "Text",
|
1385
|
-
# },
|
1386
|
-
# },
|
1387
|
-
# ],
|
1388
|
-
# session_attributes: {
|
1389
|
-
# "NonEmptyString" => "String",
|
1390
|
-
# },
|
1391
|
-
# originating_request_id: "NonEmptyString",
|
1392
|
-
# runtime_hints: {
|
1393
|
-
# slot_hints: {
|
1394
|
-
# "Name" => {
|
1395
|
-
# "Name" => {
|
1396
|
-
# runtime_hint_values: [
|
1397
|
-
# {
|
1398
|
-
# phrase: "RuntimeHintPhrase", # required
|
1399
|
-
# },
|
1400
|
-
# ],
|
1401
|
-
# sub_slot_hints: {
|
1402
|
-
# # recursive SlotHintsSlotMap
|
1403
|
-
# },
|
1404
|
-
# },
|
1405
|
-
# },
|
1406
|
-
# },
|
1407
|
-
# },
|
1408
|
-
# },
|
1409
|
-
# request_attributes: {
|
1410
|
-
# "NonEmptyString" => "String",
|
1411
|
-
# },
|
1412
|
-
# }
|
1413
|
-
#
|
1414
961
|
# @!attribute [rw] bot_id
|
1415
962
|
# The identifier of the bot that processes the request.
|
1416
963
|
# @return [String]
|
@@ -1501,21 +1048,6 @@ module Aws::LexRuntimeV2
|
|
1501
1048
|
include Aws::Structure
|
1502
1049
|
end
|
1503
1050
|
|
1504
|
-
# @note When making an API call, you may pass RecognizeUtteranceRequest
|
1505
|
-
# data as a hash:
|
1506
|
-
#
|
1507
|
-
# {
|
1508
|
-
# bot_id: "BotIdentifier", # required
|
1509
|
-
# bot_alias_id: "BotAliasIdentifier", # required
|
1510
|
-
# locale_id: "LocaleId", # required
|
1511
|
-
# session_id: "SessionId", # required
|
1512
|
-
# session_state: "SensitiveNonEmptyString",
|
1513
|
-
# request_attributes: "SensitiveNonEmptyString",
|
1514
|
-
# request_content_type: "NonEmptyString", # required
|
1515
|
-
# response_content_type: "NonEmptyString",
|
1516
|
-
# input_stream: "data",
|
1517
|
-
# }
|
1518
|
-
#
|
1519
1051
|
# @!attribute [rw] bot_id
|
1520
1052
|
# The identifier of the bot that should receive the request.
|
1521
1053
|
# @return [String]
|
@@ -1750,29 +1282,6 @@ module Aws::LexRuntimeV2
|
|
1750
1282
|
# Provides an array of phrases that should be given preference when
|
1751
1283
|
# resolving values for a slot.
|
1752
1284
|
#
|
1753
|
-
# @note When making an API call, you may pass RuntimeHintDetails
|
1754
|
-
# data as a hash:
|
1755
|
-
#
|
1756
|
-
# {
|
1757
|
-
# runtime_hint_values: [
|
1758
|
-
# {
|
1759
|
-
# phrase: "RuntimeHintPhrase", # required
|
1760
|
-
# },
|
1761
|
-
# ],
|
1762
|
-
# sub_slot_hints: {
|
1763
|
-
# "Name" => {
|
1764
|
-
# runtime_hint_values: [
|
1765
|
-
# {
|
1766
|
-
# phrase: "RuntimeHintPhrase", # required
|
1767
|
-
# },
|
1768
|
-
# ],
|
1769
|
-
# sub_slot_hints: {
|
1770
|
-
# # recursive SlotHintsSlotMap
|
1771
|
-
# },
|
1772
|
-
# },
|
1773
|
-
# },
|
1774
|
-
# }
|
1775
|
-
#
|
1776
1285
|
# @!attribute [rw] runtime_hint_values
|
1777
1286
|
# One or more strings that Amazon Lex V2 should look for in the input
|
1778
1287
|
# to the bot. Each phrase is given preference when deciding on slot
|
@@ -1800,13 +1309,6 @@ module Aws::LexRuntimeV2
|
|
1800
1309
|
# Provides the phrase that Amazon Lex V2 should look for in the user's
|
1801
1310
|
# input to the bot.
|
1802
1311
|
#
|
1803
|
-
# @note When making an API call, you may pass RuntimeHintValue
|
1804
|
-
# data as a hash:
|
1805
|
-
#
|
1806
|
-
# {
|
1807
|
-
# phrase: "RuntimeHintPhrase", # required
|
1808
|
-
# }
|
1809
|
-
#
|
1810
1312
|
# @!attribute [rw] phrase
|
1811
1313
|
# The phrase that Amazon Lex V2 should look for in the user's input
|
1812
1314
|
# to the bot.
|
@@ -1836,26 +1338,6 @@ module Aws::LexRuntimeV2
|
|
1836
1338
|
#
|
1837
1339
|
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html
|
1838
1340
|
#
|
1839
|
-
# @note When making an API call, you may pass RuntimeHints
|
1840
|
-
# data as a hash:
|
1841
|
-
#
|
1842
|
-
# {
|
1843
|
-
# slot_hints: {
|
1844
|
-
# "Name" => {
|
1845
|
-
# "Name" => {
|
1846
|
-
# runtime_hint_values: [
|
1847
|
-
# {
|
1848
|
-
# phrase: "RuntimeHintPhrase", # required
|
1849
|
-
# },
|
1850
|
-
# ],
|
1851
|
-
# sub_slot_hints: {
|
1852
|
-
# # recursive SlotHintsSlotMap
|
1853
|
-
# },
|
1854
|
-
# },
|
1855
|
-
# },
|
1856
|
-
# },
|
1857
|
-
# }
|
1858
|
-
#
|
1859
1341
|
# @!attribute [rw] slot_hints
|
1860
1342
|
# A list of the slots in the intent that should have runtime hints
|
1861
1343
|
# added, and the phrases that should be added for each slot.
|
@@ -1945,78 +1427,6 @@ module Aws::LexRuntimeV2
|
|
1945
1427
|
|
1946
1428
|
# The state of the user's session with Amazon Lex V2.
|
1947
1429
|
#
|
1948
|
-
# @note When making an API call, you may pass SessionState
|
1949
|
-
# data as a hash:
|
1950
|
-
#
|
1951
|
-
# {
|
1952
|
-
# dialog_action: {
|
1953
|
-
# type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
|
1954
|
-
# slot_to_elicit: "NonEmptyString",
|
1955
|
-
# slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
|
1956
|
-
# sub_slot_to_elicit: {
|
1957
|
-
# name: "NonEmptyString", # required
|
1958
|
-
# sub_slot_to_elicit: {
|
1959
|
-
# # recursive ElicitSubSlot
|
1960
|
-
# },
|
1961
|
-
# },
|
1962
|
-
# },
|
1963
|
-
# intent: {
|
1964
|
-
# name: "NonEmptyString", # required
|
1965
|
-
# slots: {
|
1966
|
-
# "NonEmptyString" => {
|
1967
|
-
# value: {
|
1968
|
-
# original_value: "NonEmptyString",
|
1969
|
-
# interpreted_value: "NonEmptyString", # required
|
1970
|
-
# resolved_values: ["NonEmptyString"],
|
1971
|
-
# },
|
1972
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
1973
|
-
# values: [
|
1974
|
-
# {
|
1975
|
-
# # recursive Slot
|
1976
|
-
# },
|
1977
|
-
# ],
|
1978
|
-
# sub_slots: {
|
1979
|
-
# # recursive Slots
|
1980
|
-
# },
|
1981
|
-
# },
|
1982
|
-
# },
|
1983
|
-
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting, FulfillmentInProgress
|
1984
|
-
# confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
|
1985
|
-
# },
|
1986
|
-
# active_contexts: [
|
1987
|
-
# {
|
1988
|
-
# name: "ActiveContextName", # required
|
1989
|
-
# time_to_live: { # required
|
1990
|
-
# time_to_live_in_seconds: 1, # required
|
1991
|
-
# turns_to_live: 1, # required
|
1992
|
-
# },
|
1993
|
-
# context_attributes: { # required
|
1994
|
-
# "ParameterName" => "Text",
|
1995
|
-
# },
|
1996
|
-
# },
|
1997
|
-
# ],
|
1998
|
-
# session_attributes: {
|
1999
|
-
# "NonEmptyString" => "String",
|
2000
|
-
# },
|
2001
|
-
# originating_request_id: "NonEmptyString",
|
2002
|
-
# runtime_hints: {
|
2003
|
-
# slot_hints: {
|
2004
|
-
# "Name" => {
|
2005
|
-
# "Name" => {
|
2006
|
-
# runtime_hint_values: [
|
2007
|
-
# {
|
2008
|
-
# phrase: "RuntimeHintPhrase", # required
|
2009
|
-
# },
|
2010
|
-
# ],
|
2011
|
-
# sub_slot_hints: {
|
2012
|
-
# # recursive SlotHintsSlotMap
|
2013
|
-
# },
|
2014
|
-
# },
|
2015
|
-
# },
|
2016
|
-
# },
|
2017
|
-
# },
|
2018
|
-
# }
|
2019
|
-
#
|
2020
1430
|
# @!attribute [rw] dialog_action
|
2021
1431
|
# The next step that Amazon Lex V2 should take in the conversation
|
2022
1432
|
# with a user.
|
@@ -2064,54 +1474,6 @@ module Aws::LexRuntimeV2
|
|
2064
1474
|
|
2065
1475
|
# A value that Amazon Lex V2 uses to fulfill an intent.
|
2066
1476
|
#
|
2067
|
-
# @note When making an API call, you may pass Slot
|
2068
|
-
# data as a hash:
|
2069
|
-
#
|
2070
|
-
# {
|
2071
|
-
# value: {
|
2072
|
-
# original_value: "NonEmptyString",
|
2073
|
-
# interpreted_value: "NonEmptyString", # required
|
2074
|
-
# resolved_values: ["NonEmptyString"],
|
2075
|
-
# },
|
2076
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
2077
|
-
# values: [
|
2078
|
-
# {
|
2079
|
-
# value: {
|
2080
|
-
# original_value: "NonEmptyString",
|
2081
|
-
# interpreted_value: "NonEmptyString", # required
|
2082
|
-
# resolved_values: ["NonEmptyString"],
|
2083
|
-
# },
|
2084
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
2085
|
-
# values: {
|
2086
|
-
# # recursive Values
|
2087
|
-
# },
|
2088
|
-
# sub_slots: {
|
2089
|
-
# "NonEmptyString" => {
|
2090
|
-
# # recursive Slot
|
2091
|
-
# },
|
2092
|
-
# },
|
2093
|
-
# },
|
2094
|
-
# ],
|
2095
|
-
# sub_slots: {
|
2096
|
-
# "NonEmptyString" => {
|
2097
|
-
# value: {
|
2098
|
-
# original_value: "NonEmptyString",
|
2099
|
-
# interpreted_value: "NonEmptyString", # required
|
2100
|
-
# resolved_values: ["NonEmptyString"],
|
2101
|
-
# },
|
2102
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
2103
|
-
# values: [
|
2104
|
-
# {
|
2105
|
-
# # recursive Slot
|
2106
|
-
# },
|
2107
|
-
# ],
|
2108
|
-
# sub_slots: {
|
2109
|
-
# # recursive Slots
|
2110
|
-
# },
|
2111
|
-
# },
|
2112
|
-
# },
|
2113
|
-
# }
|
2114
|
-
#
|
2115
1477
|
# @!attribute [rw] value
|
2116
1478
|
# The current value of the slot.
|
2117
1479
|
# @return [Types::Value]
|
@@ -2143,18 +1505,6 @@ module Aws::LexRuntimeV2
|
|
2143
1505
|
include Aws::Structure
|
2144
1506
|
end
|
2145
1507
|
|
2146
|
-
# @note When making an API call, you may pass StartConversationRequest
|
2147
|
-
# data as a hash:
|
2148
|
-
#
|
2149
|
-
# {
|
2150
|
-
# bot_id: "BotIdentifier", # required
|
2151
|
-
# bot_alias_id: "BotAliasIdentifier", # required
|
2152
|
-
# locale_id: "LocaleId", # required
|
2153
|
-
# session_id: "SessionId", # required
|
2154
|
-
# conversation_mode: "AUDIO", # accepts AUDIO, TEXT
|
2155
|
-
# input_event_stream_hander: EventStreams::StartConversationRequestEventStream.new,
|
2156
|
-
# }
|
2157
|
-
#
|
2158
1508
|
# @!attribute [rw] bot_id
|
2159
1509
|
# The identifier of the bot to process the request.
|
2160
1510
|
# @return [String]
|
@@ -2211,15 +1561,6 @@ module Aws::LexRuntimeV2
|
|
2211
1561
|
# The event sent from your client application to Amazon Lex V2 with text
|
2212
1562
|
# input from the user.
|
2213
1563
|
#
|
2214
|
-
# @note When making an API call, you may pass TextInputEvent
|
2215
|
-
# data as a hash:
|
2216
|
-
#
|
2217
|
-
# {
|
2218
|
-
# text: "Text", # required
|
2219
|
-
# event_id: "EventId",
|
2220
|
-
# client_timestamp_millis: 1,
|
2221
|
-
# }
|
2222
|
-
#
|
2223
1564
|
# @!attribute [rw] text
|
2224
1565
|
# The text from the user. Amazon Lex V2 processes this as a complete
|
2225
1566
|
# statement.
|
@@ -2322,15 +1663,6 @@ module Aws::LexRuntimeV2
|
|
2322
1663
|
|
2323
1664
|
# The value of a slot.
|
2324
1665
|
#
|
2325
|
-
# @note When making an API call, you may pass Value
|
2326
|
-
# data as a hash:
|
2327
|
-
#
|
2328
|
-
# {
|
2329
|
-
# original_value: "NonEmptyString",
|
2330
|
-
# interpreted_value: "NonEmptyString", # required
|
2331
|
-
# resolved_values: ["NonEmptyString"],
|
2332
|
-
# }
|
2333
|
-
#
|
2334
1666
|
# @!attribute [rw] original_value
|
2335
1667
|
# The text of the utterance from the user that was entered for the
|
2336
1668
|
# slot.
|
@@ -2361,130 +1693,6 @@ module Aws::LexRuntimeV2
|
|
2361
1693
|
# Represents a stream of events between your application and Amazon Lex
|
2362
1694
|
# V2.
|
2363
1695
|
#
|
2364
|
-
# @note When making an API call, you may pass StartConversationRequestEventStream
|
2365
|
-
# data as a hash:
|
2366
|
-
#
|
2367
|
-
# {
|
2368
|
-
# configuration_event: {
|
2369
|
-
# request_attributes: {
|
2370
|
-
# "NonEmptyString" => "String",
|
2371
|
-
# },
|
2372
|
-
# response_content_type: "NonEmptyString", # required
|
2373
|
-
# session_state: {
|
2374
|
-
# dialog_action: {
|
2375
|
-
# type: "Close", # required, accepts Close, ConfirmIntent, Delegate, ElicitIntent, ElicitSlot, None
|
2376
|
-
# slot_to_elicit: "NonEmptyString",
|
2377
|
-
# slot_elicitation_style: "Default", # accepts Default, SpellByLetter, SpellByWord
|
2378
|
-
# sub_slot_to_elicit: {
|
2379
|
-
# name: "NonEmptyString", # required
|
2380
|
-
# sub_slot_to_elicit: {
|
2381
|
-
# # recursive ElicitSubSlot
|
2382
|
-
# },
|
2383
|
-
# },
|
2384
|
-
# },
|
2385
|
-
# intent: {
|
2386
|
-
# name: "NonEmptyString", # required
|
2387
|
-
# slots: {
|
2388
|
-
# "NonEmptyString" => {
|
2389
|
-
# value: {
|
2390
|
-
# original_value: "NonEmptyString",
|
2391
|
-
# interpreted_value: "NonEmptyString", # required
|
2392
|
-
# resolved_values: ["NonEmptyString"],
|
2393
|
-
# },
|
2394
|
-
# shape: "Scalar", # accepts Scalar, List, Composite
|
2395
|
-
# values: [
|
2396
|
-
# {
|
2397
|
-
# # recursive Slot
|
2398
|
-
# },
|
2399
|
-
# ],
|
2400
|
-
# sub_slots: {
|
2401
|
-
# # recursive Slots
|
2402
|
-
# },
|
2403
|
-
# },
|
2404
|
-
# },
|
2405
|
-
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting, FulfillmentInProgress
|
2406
|
-
# confirmation_state: "Confirmed", # accepts Confirmed, Denied, None
|
2407
|
-
# },
|
2408
|
-
# active_contexts: [
|
2409
|
-
# {
|
2410
|
-
# name: "ActiveContextName", # required
|
2411
|
-
# time_to_live: { # required
|
2412
|
-
# time_to_live_in_seconds: 1, # required
|
2413
|
-
# turns_to_live: 1, # required
|
2414
|
-
# },
|
2415
|
-
# context_attributes: { # required
|
2416
|
-
# "ParameterName" => "Text",
|
2417
|
-
# },
|
2418
|
-
# },
|
2419
|
-
# ],
|
2420
|
-
# session_attributes: {
|
2421
|
-
# "NonEmptyString" => "String",
|
2422
|
-
# },
|
2423
|
-
# originating_request_id: "NonEmptyString",
|
2424
|
-
# runtime_hints: {
|
2425
|
-
# slot_hints: {
|
2426
|
-
# "Name" => {
|
2427
|
-
# "Name" => {
|
2428
|
-
# runtime_hint_values: [
|
2429
|
-
# {
|
2430
|
-
# phrase: "RuntimeHintPhrase", # required
|
2431
|
-
# },
|
2432
|
-
# ],
|
2433
|
-
# sub_slot_hints: {
|
2434
|
-
# # recursive SlotHintsSlotMap
|
2435
|
-
# },
|
2436
|
-
# },
|
2437
|
-
# },
|
2438
|
-
# },
|
2439
|
-
# },
|
2440
|
-
# },
|
2441
|
-
# welcome_messages: [
|
2442
|
-
# {
|
2443
|
-
# content: "Text",
|
2444
|
-
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
2445
|
-
# image_response_card: {
|
2446
|
-
# title: "AttachmentTitle", # required
|
2447
|
-
# subtitle: "AttachmentTitle",
|
2448
|
-
# image_url: "AttachmentUrl",
|
2449
|
-
# buttons: [
|
2450
|
-
# {
|
2451
|
-
# text: "ButtonText", # required
|
2452
|
-
# value: "ButtonValue", # required
|
2453
|
-
# },
|
2454
|
-
# ],
|
2455
|
-
# },
|
2456
|
-
# },
|
2457
|
-
# ],
|
2458
|
-
# disable_playback: false,
|
2459
|
-
# event_id: "EventId",
|
2460
|
-
# client_timestamp_millis: 1,
|
2461
|
-
# },
|
2462
|
-
# audio_input_event: {
|
2463
|
-
# audio_chunk: "data",
|
2464
|
-
# content_type: "NonEmptyString", # required
|
2465
|
-
# event_id: "EventId",
|
2466
|
-
# client_timestamp_millis: 1,
|
2467
|
-
# },
|
2468
|
-
# dtmf_input_event: {
|
2469
|
-
# input_character: "DTMFRegex", # required
|
2470
|
-
# event_id: "EventId",
|
2471
|
-
# client_timestamp_millis: 1,
|
2472
|
-
# },
|
2473
|
-
# text_input_event: {
|
2474
|
-
# text: "Text", # required
|
2475
|
-
# event_id: "EventId",
|
2476
|
-
# client_timestamp_millis: 1,
|
2477
|
-
# },
|
2478
|
-
# playback_completion_event: {
|
2479
|
-
# event_id: "EventId",
|
2480
|
-
# client_timestamp_millis: 1,
|
2481
|
-
# },
|
2482
|
-
# disconnection_event: {
|
2483
|
-
# event_id: "EventId",
|
2484
|
-
# client_timestamp_millis: 1,
|
2485
|
-
# },
|
2486
|
-
# }
|
2487
|
-
#
|
2488
1696
|
# EventStream is an Enumerator of Events.
|
2489
1697
|
# #event_types #=> Array, returns all modeled event types in the stream
|
2490
1698
|
#
|