aws-sdk-lexruntimev2 1.1.0 → 1.4.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 +32 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-lexruntimev2.rb +2 -2
- data/lib/aws-sdk-lexruntimev2/async_client.rb +31 -8
- data/lib/aws-sdk-lexruntimev2/client.rb +95 -38
- data/lib/aws-sdk-lexruntimev2/client_api.rb +9 -3
- data/lib/aws-sdk-lexruntimev2/errors.rb +1 -1
- data/lib/aws-sdk-lexruntimev2/event_streams.rb +21 -20
- data/lib/aws-sdk-lexruntimev2/resource.rb +1 -1
- data/lib/aws-sdk-lexruntimev2/types.rb +239 -140
- metadata +11 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -84,6 +84,7 @@ module Aws::LexRuntimeV2
|
|
84
84
|
SentimentType = Shapes::StringShape.new(name: 'SentimentType')
|
85
85
|
SessionId = Shapes::StringShape.new(name: 'SessionId')
|
86
86
|
SessionState = Shapes::StructureShape.new(name: 'SessionState')
|
87
|
+
Shape = Shapes::StringShape.new(name: 'Shape')
|
87
88
|
Slot = Shapes::StructureShape.new(name: 'Slot')
|
88
89
|
Slots = Shapes::MapShape.new(name: 'Slots')
|
89
90
|
StartConversationRequest = Shapes::StructureShape.new(name: 'StartConversationRequest')
|
@@ -100,13 +101,14 @@ module Aws::LexRuntimeV2
|
|
100
101
|
TranscriptEvent = Shapes::StructureShape.new(name: 'TranscriptEvent')
|
101
102
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
102
103
|
Value = Shapes::StructureShape.new(name: 'Value')
|
104
|
+
Values = Shapes::ListShape.new(name: 'Values')
|
103
105
|
|
104
106
|
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
105
107
|
AccessDeniedException.struct_class = Types::AccessDeniedException
|
106
108
|
|
107
109
|
ActiveContext.add_member(:name, Shapes::ShapeRef.new(shape: ActiveContextName, required: true, location_name: "name"))
|
108
110
|
ActiveContext.add_member(:time_to_live, Shapes::ShapeRef.new(shape: ActiveContextTimeToLive, required: true, location_name: "timeToLive"))
|
109
|
-
ActiveContext.add_member(:context_attributes, Shapes::ShapeRef.new(shape: ActiveContextParametersMap, location_name: "contextAttributes"))
|
111
|
+
ActiveContext.add_member(:context_attributes, Shapes::ShapeRef.new(shape: ActiveContextParametersMap, required: true, location_name: "contextAttributes"))
|
110
112
|
ActiveContext.struct_class = Types::ActiveContext
|
111
113
|
|
112
114
|
ActiveContextParametersMap.key = Shapes::ShapeRef.new(shape: ParameterName)
|
@@ -227,7 +229,7 @@ module Aws::LexRuntimeV2
|
|
227
229
|
Interpretations.member = Shapes::ShapeRef.new(shape: Interpretation)
|
228
230
|
|
229
231
|
Message.add_member(:content, Shapes::ShapeRef.new(shape: Text, location_name: "content"))
|
230
|
-
Message.add_member(:content_type, Shapes::ShapeRef.new(shape: MessageContentType, location_name: "contentType"))
|
232
|
+
Message.add_member(:content_type, Shapes::ShapeRef.new(shape: MessageContentType, required: true, location_name: "contentType"))
|
231
233
|
Message.add_member(:image_response_card, Shapes::ShapeRef.new(shape: ImageResponseCard, location_name: "imageResponseCard"))
|
232
234
|
Message.struct_class = Types::Message
|
233
235
|
|
@@ -325,6 +327,8 @@ module Aws::LexRuntimeV2
|
|
325
327
|
SessionState.struct_class = Types::SessionState
|
326
328
|
|
327
329
|
Slot.add_member(:value, Shapes::ShapeRef.new(shape: Value, location_name: "value"))
|
330
|
+
Slot.add_member(:shape, Shapes::ShapeRef.new(shape: Shape, location_name: "shape"))
|
331
|
+
Slot.add_member(:values, Shapes::ShapeRef.new(shape: Values, location_name: "values"))
|
328
332
|
Slot.struct_class = Types::Slot
|
329
333
|
|
330
334
|
Slots.key = Shapes::ShapeRef.new(shape: NonEmptyString)
|
@@ -398,6 +402,8 @@ module Aws::LexRuntimeV2
|
|
398
402
|
Value.add_member(:resolved_values, Shapes::ShapeRef.new(shape: StringList, location_name: "resolvedValues"))
|
399
403
|
Value.struct_class = Types::Value
|
400
404
|
|
405
|
+
Values.member = Shapes::ShapeRef.new(shape: Slot)
|
406
|
+
|
401
407
|
|
402
408
|
# @api private
|
403
409
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -17,23 +17,24 @@ module Aws::LexRuntimeV2
|
|
17
17
|
|
18
18
|
# @option params [Hash<String,String>] :request_attributes
|
19
19
|
# Request-specific information passed between the client application and
|
20
|
-
# Amazon Lex.
|
20
|
+
# Amazon Lex V2.
|
21
21
|
#
|
22
22
|
# The namespace `x-amz-lex:` is reserved for special attributes. Don't
|
23
23
|
# create any request attributes for prefix `x-amz-lex:`.
|
24
24
|
#
|
25
25
|
# @option params [String] :response_content_type
|
26
|
-
# The message that Amazon Lex returns in the response can be either
|
27
|
-
# or speech based on the `responseContentType` value.
|
26
|
+
# The message that Amazon Lex V2 returns in the response can be either
|
27
|
+
# text or speech based on the `responseContentType` value.
|
28
28
|
#
|
29
|
-
# * If the value is `text/plain;charset=utf-8`, Amazon Lex returns
|
30
|
-
# in the response.
|
29
|
+
# * If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns
|
30
|
+
# text in the response.
|
31
31
|
#
|
32
|
-
# * If the value begins with `audio/`, Amazon Lex returns speech in
|
33
|
-
# response. Amazon Lex uses Amazon Polly to generate the speech
|
34
|
-
# the configuration that you specified in the
|
35
|
-
# parameter. For example, if you specify
|
36
|
-
# Amazon Lex returns speech in the MPEG
|
32
|
+
# * If the value begins with `audio/`, Amazon Lex V2 returns speech in
|
33
|
+
# the response. Amazon Lex V2 uses Amazon Polly to generate the speech
|
34
|
+
# using the configuration that you specified in the
|
35
|
+
# `requestContentType` parameter. For example, if you specify
|
36
|
+
# `audio/mpeg` as the value, Amazon Lex V2 returns speech in the MPEG
|
37
|
+
# format.
|
37
38
|
#
|
38
39
|
# * If the value is `audio/pcm`, the speech returned is audio/pcm in
|
39
40
|
# 16-bit, little-endian format.
|
@@ -51,13 +52,13 @@ module Aws::LexRuntimeV2
|
|
51
52
|
# * text/plain; charset=utf-8
|
52
53
|
#
|
53
54
|
# @option params [Types::SessionState] :session_state
|
54
|
-
# The state of the user's session with Amazon Lex.
|
55
|
+
# The state of the user's session with Amazon Lex V2.
|
55
56
|
#
|
56
57
|
# @option params [Array<Types::Message>] :welcome_messages
|
57
58
|
# A list of messages to send to the user.
|
58
59
|
#
|
59
60
|
# @option params [Boolean] :disable_playback
|
60
|
-
# Determines whether Amazon Lex should send audio responses to the
|
61
|
+
# Determines whether Amazon Lex V2 should send audio responses to the
|
61
62
|
# client application. When this parameter if `false`, the client
|
62
63
|
# application needs to create responses for the user.
|
63
64
|
#
|
@@ -67,7 +68,7 @@ module Aws::LexRuntimeV2
|
|
67
68
|
#
|
68
69
|
# @option params [Integer] :client_timestamp_millis
|
69
70
|
# A timestamp set by the client of the date and time that the event was
|
70
|
-
# sent to Amazon Lex.
|
71
|
+
# sent to Amazon Lex V2.
|
71
72
|
#
|
72
73
|
def signal_configuration_event_event(params = {})
|
73
74
|
@event_emitter.emit(:configuration_event, params)
|
@@ -89,7 +90,7 @@ module Aws::LexRuntimeV2
|
|
89
90
|
#
|
90
91
|
# @option params [Integer] :client_timestamp_millis
|
91
92
|
# A timestamp set by the client of the date and time that the event was
|
92
|
-
# sent to Amazon Lex.
|
93
|
+
# sent to Amazon Lex V2.
|
93
94
|
#
|
94
95
|
def signal_audio_input_event_event(params = {})
|
95
96
|
@event_emitter.emit(:audio_input_event, params)
|
@@ -105,14 +106,14 @@ module Aws::LexRuntimeV2
|
|
105
106
|
#
|
106
107
|
# @option params [Integer] :client_timestamp_millis
|
107
108
|
# A timestamp set by the client of the date and time that the event was
|
108
|
-
# sent to Amazon Lex.
|
109
|
+
# sent to Amazon Lex V2.
|
109
110
|
#
|
110
111
|
def signal_dtmf_input_event_event(params = {})
|
111
112
|
@event_emitter.emit(:dtmf_input_event, params)
|
112
113
|
end
|
113
114
|
|
114
115
|
# @option params [String] :text
|
115
|
-
# The text from the user. Amazon Lex processes this as a complete
|
116
|
+
# The text from the user. Amazon Lex V2 processes this as a complete
|
116
117
|
# statement.
|
117
118
|
#
|
118
119
|
# @option params [String] :event_id
|
@@ -121,7 +122,7 @@ module Aws::LexRuntimeV2
|
|
121
122
|
#
|
122
123
|
# @option params [Integer] :client_timestamp_millis
|
123
124
|
# A timestamp set by the client of the date and time that the event was
|
124
|
-
# sent to Amazon Lex.
|
125
|
+
# sent to Amazon Lex V2.
|
125
126
|
#
|
126
127
|
def signal_text_input_event_event(params = {})
|
127
128
|
@event_emitter.emit(:text_input_event, params)
|
@@ -133,7 +134,7 @@ module Aws::LexRuntimeV2
|
|
133
134
|
#
|
134
135
|
# @option params [Integer] :client_timestamp_millis
|
135
136
|
# A timestamp set by the client of the date and time that the event was
|
136
|
-
# sent to Amazon Lex.
|
137
|
+
# sent to Amazon Lex V2.
|
137
138
|
#
|
138
139
|
def signal_playback_completion_event_event(params = {})
|
139
140
|
@event_emitter.emit(:playback_completion_event, params)
|
@@ -145,7 +146,7 @@ module Aws::LexRuntimeV2
|
|
145
146
|
#
|
146
147
|
# @option params [Integer] :client_timestamp_millis
|
147
148
|
# A timestamp set by the client of the date and time that the event was
|
148
|
-
# sent to Amazon Lex.
|
149
|
+
# sent to Amazon Lex V2.
|
149
150
|
#
|
150
151
|
def signal_disconnection_event_event(params = {})
|
151
152
|
@event_emitter.emit(:disconnection_event, params)
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -23,11 +23,12 @@ module Aws::LexRuntimeV2
|
|
23
23
|
end
|
24
24
|
|
25
25
|
# Contains information about the contexts that a user is using in a
|
26
|
-
# session. You can configure Amazon Lex to set a context when an
|
27
|
-
# is fulfilled, or you can set a context using the , , or
|
26
|
+
# session. You can configure Amazon Lex V2 to set a context when an
|
27
|
+
# intent is fulfilled, or you can set a context using the , , or
|
28
|
+
# operations.
|
28
29
|
#
|
29
|
-
# Use a context to indicate to Amazon Lex intents that should be used
|
30
|
-
# follow-up intents. For example, if the active context is
|
30
|
+
# Use a context to indicate to Amazon Lex V2 intents that should be used
|
31
|
+
# as follow-up intents. For example, if the active context is
|
31
32
|
# `order-fulfilled`, only intents that have `order-fulfilled` configured
|
32
33
|
# as a trigger are considered for follow up.
|
33
34
|
#
|
@@ -40,7 +41,7 @@ module Aws::LexRuntimeV2
|
|
40
41
|
# time_to_live_in_seconds: 1, # required
|
41
42
|
# turns_to_live: 1, # required
|
42
43
|
# },
|
43
|
-
# context_attributes: {
|
44
|
+
# context_attributes: { # required
|
44
45
|
# "ParameterName" => "Text",
|
45
46
|
# },
|
46
47
|
# }
|
@@ -106,9 +107,9 @@ module Aws::LexRuntimeV2
|
|
106
107
|
end
|
107
108
|
|
108
109
|
# Represents a chunk of audio sent from the client application to Amazon
|
109
|
-
# Lex. The audio is all or part of an utterance from the user.
|
110
|
+
# Lex V2. The audio is all or part of an utterance from the user.
|
110
111
|
#
|
111
|
-
# Amazon Lex accumulates audio chunks until it recognizes a natural
|
112
|
+
# Amazon Lex V2 accumulates audio chunks until it recognizes a natural
|
112
113
|
# pause in speech before processing the input.
|
113
114
|
#
|
114
115
|
# @note When making an API call, you may pass AudioInputEvent
|
@@ -140,7 +141,7 @@ module Aws::LexRuntimeV2
|
|
140
141
|
#
|
141
142
|
# @!attribute [rw] client_timestamp_millis
|
142
143
|
# A timestamp set by the client of the date and time that the event
|
143
|
-
# was sent to Amazon Lex.
|
144
|
+
# was sent to Amazon Lex V2.
|
144
145
|
# @return [Integer]
|
145
146
|
#
|
146
147
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/AudioInputEvent AWS API Documentation
|
@@ -155,7 +156,7 @@ module Aws::LexRuntimeV2
|
|
155
156
|
include Aws::Structure
|
156
157
|
end
|
157
158
|
|
158
|
-
# An event sent from Amazon Lex to your client application containing
|
159
|
+
# An event sent from Amazon Lex V2 to your client application containing
|
159
160
|
# audio to play to the user.
|
160
161
|
#
|
161
162
|
# @!attribute [rw] audio_chunk
|
@@ -168,10 +169,10 @@ module Aws::LexRuntimeV2
|
|
168
169
|
# @return [String]
|
169
170
|
#
|
170
171
|
# @!attribute [rw] event_id
|
171
|
-
# A unique identifier of the event sent by Amazon Lex. The
|
172
|
-
# is in the form `RESPONSE-N`, where N is a number starting
|
173
|
-
# and incremented for each event sent by Amazon Lex in the
|
174
|
-
# session.
|
172
|
+
# A unique identifier of the event sent by Amazon Lex V2. The
|
173
|
+
# identifier is in the form `RESPONSE-N`, where N is a number starting
|
174
|
+
# with one and incremented for each event sent by Amazon Lex V2 in the
|
175
|
+
# current session.
|
175
176
|
# @return [String]
|
176
177
|
#
|
177
178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/AudioResponseEvent AWS API Documentation
|
@@ -212,7 +213,7 @@ module Aws::LexRuntimeV2
|
|
212
213
|
# @return [String]
|
213
214
|
#
|
214
215
|
# @!attribute [rw] value
|
215
|
-
# The value returned to Amazon Lex when a user chooses the button.
|
216
|
+
# The value returned to Amazon Lex V2 when a user chooses the button.
|
216
217
|
# @return [String]
|
217
218
|
#
|
218
219
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/Button AWS API Documentation
|
@@ -224,11 +225,11 @@ module Aws::LexRuntimeV2
|
|
224
225
|
include Aws::Structure
|
225
226
|
end
|
226
227
|
|
227
|
-
# Provides a score that indicates the confidence that Amazon Lex has
|
228
|
+
# Provides a score that indicates the confidence that Amazon Lex V2 has
|
228
229
|
# that an intent is the one that satisfies the user's intent.
|
229
230
|
#
|
230
231
|
# @!attribute [rw] score
|
231
|
-
# A score that indicates how confident Amazon Lex is that an intent
|
232
|
+
# A score that indicates how confident Amazon Lex V2 is that an intent
|
232
233
|
# satisfies the user's intent. Ranges between 0.00 and 1.00. Higher
|
233
234
|
# scores indicate higher confidence.
|
234
235
|
# @return [Float]
|
@@ -241,9 +242,9 @@ module Aws::LexRuntimeV2
|
|
241
242
|
include Aws::Structure
|
242
243
|
end
|
243
244
|
|
244
|
-
# The initial event sent from the application to Amazon Lex to
|
245
|
-
# the conversation, including session and request attributes
|
246
|
-
# response content type.
|
245
|
+
# The initial event sent from the application to Amazon Lex V2 to
|
246
|
+
# configure the conversation, including session and request attributes
|
247
|
+
# and the response content type.
|
247
248
|
#
|
248
249
|
# @note When making an API call, you may pass ConfigurationEvent
|
249
250
|
# data as a hash:
|
@@ -267,6 +268,12 @@ module Aws::LexRuntimeV2
|
|
267
268
|
# interpreted_value: "NonEmptyString", # required
|
268
269
|
# resolved_values: ["NonEmptyString"],
|
269
270
|
# },
|
271
|
+
# shape: "Scalar", # accepts Scalar, List
|
272
|
+
# values: [
|
273
|
+
# {
|
274
|
+
# # recursive Slot
|
275
|
+
# },
|
276
|
+
# ],
|
270
277
|
# },
|
271
278
|
# },
|
272
279
|
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting
|
@@ -279,7 +286,7 @@ module Aws::LexRuntimeV2
|
|
279
286
|
# time_to_live_in_seconds: 1, # required
|
280
287
|
# turns_to_live: 1, # required
|
281
288
|
# },
|
282
|
-
# context_attributes: {
|
289
|
+
# context_attributes: { # required
|
283
290
|
# "ParameterName" => "Text",
|
284
291
|
# },
|
285
292
|
# },
|
@@ -292,7 +299,7 @@ module Aws::LexRuntimeV2
|
|
292
299
|
# welcome_messages: [
|
293
300
|
# {
|
294
301
|
# content: "Text",
|
295
|
-
# content_type: "CustomPayload", # accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
302
|
+
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
296
303
|
# image_response_card: {
|
297
304
|
# title: "AttachmentTitle", # required
|
298
305
|
# subtitle: "AttachmentTitle",
|
@@ -313,25 +320,25 @@ module Aws::LexRuntimeV2
|
|
313
320
|
#
|
314
321
|
# @!attribute [rw] request_attributes
|
315
322
|
# Request-specific information passed between the client application
|
316
|
-
# and Amazon Lex.
|
323
|
+
# and Amazon Lex V2.
|
317
324
|
#
|
318
325
|
# The namespace `x-amz-lex:` is reserved for special attributes.
|
319
326
|
# Don't create any request attributes for prefix `x-amz-lex:`.
|
320
327
|
# @return [Hash<String,String>]
|
321
328
|
#
|
322
329
|
# @!attribute [rw] response_content_type
|
323
|
-
# The message that Amazon Lex returns in the response can be either
|
330
|
+
# The message that Amazon Lex V2 returns in the response can be either
|
324
331
|
# text or speech based on the `responseContentType` value.
|
325
332
|
#
|
326
|
-
# * If the value is `text/plain;charset=utf-8`, Amazon Lex returns
|
333
|
+
# * If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns
|
327
334
|
# text in the response.
|
328
335
|
#
|
329
|
-
# * If the value begins with `audio/`, Amazon Lex returns speech in
|
330
|
-
# the response. Amazon Lex uses Amazon Polly to generate the
|
331
|
-
# using the configuration that you specified in the
|
336
|
+
# * If the value begins with `audio/`, Amazon Lex V2 returns speech in
|
337
|
+
# the response. Amazon Lex V2 uses Amazon Polly to generate the
|
338
|
+
# speech using the configuration that you specified in the
|
332
339
|
# `requestContentType` parameter. For example, if you specify
|
333
|
-
# `audio/mpeg` as the value, Amazon Lex returns speech in the
|
334
|
-
# format.
|
340
|
+
# `audio/mpeg` as the value, Amazon Lex V2 returns speech in the
|
341
|
+
# MPEG format.
|
335
342
|
#
|
336
343
|
# * If the value is `audio/pcm`, the speech returned is audio/pcm in
|
337
344
|
# 16-bit, little-endian format.
|
@@ -350,7 +357,7 @@ module Aws::LexRuntimeV2
|
|
350
357
|
# @return [String]
|
351
358
|
#
|
352
359
|
# @!attribute [rw] session_state
|
353
|
-
# The state of the user's session with Amazon Lex.
|
360
|
+
# The state of the user's session with Amazon Lex V2.
|
354
361
|
# @return [Types::SessionState]
|
355
362
|
#
|
356
363
|
# @!attribute [rw] welcome_messages
|
@@ -358,7 +365,7 @@ module Aws::LexRuntimeV2
|
|
358
365
|
# @return [Array<Types::Message>]
|
359
366
|
#
|
360
367
|
# @!attribute [rw] disable_playback
|
361
|
-
# Determines whether Amazon Lex should send audio responses to the
|
368
|
+
# Determines whether Amazon Lex V2 should send audio responses to the
|
362
369
|
# client application. When this parameter if `false`, the client
|
363
370
|
# application needs to create responses for the user.
|
364
371
|
# @return [Boolean]
|
@@ -370,7 +377,7 @@ module Aws::LexRuntimeV2
|
|
370
377
|
#
|
371
378
|
# @!attribute [rw] client_timestamp_millis
|
372
379
|
# A timestamp set by the client of the date and time that the event
|
373
|
-
# was sent to Amazon Lex.
|
380
|
+
# was sent to Amazon Lex V2.
|
374
381
|
# @return [Integer]
|
375
382
|
#
|
376
383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/ConfigurationEvent AWS API Documentation
|
@@ -402,7 +409,7 @@ module Aws::LexRuntimeV2
|
|
402
409
|
|
403
410
|
# A DTMF character sent from the client application. DTMF characters are
|
404
411
|
# typically sent from a phone keypad to represent numbers. For example,
|
405
|
-
# you can have Amazon Lex process a credit card number input from a
|
412
|
+
# you can have Amazon Lex V2 process a credit card number input from a
|
406
413
|
# phone.
|
407
414
|
#
|
408
415
|
# @note When making an API call, you may pass DTMFInputEvent
|
@@ -426,7 +433,7 @@ module Aws::LexRuntimeV2
|
|
426
433
|
#
|
427
434
|
# @!attribute [rw] client_timestamp_millis
|
428
435
|
# A timestamp set by the client of the date and time that the event
|
429
|
-
# was sent to Amazon Lex.
|
436
|
+
# was sent to Amazon Lex V2.
|
430
437
|
# @return [Integer]
|
431
438
|
#
|
432
439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/DTMFInputEvent AWS API Documentation
|
@@ -518,7 +525,7 @@ module Aws::LexRuntimeV2
|
|
518
525
|
include Aws::Structure
|
519
526
|
end
|
520
527
|
|
521
|
-
# The next action that Amazon Lex should take.
|
528
|
+
# The next action that Amazon Lex V2 should take.
|
522
529
|
#
|
523
530
|
# @note When making an API call, you may pass DialogAction
|
524
531
|
# data as a hash:
|
@@ -540,7 +547,7 @@ module Aws::LexRuntimeV2
|
|
540
547
|
# is complete and ready to be fulfilled. This is a yes/no question
|
541
548
|
# such as "Place the order?"
|
542
549
|
#
|
543
|
-
# * `Delegate` - The next action is determined by Amazon Lex.
|
550
|
+
# * `Delegate` - The next action is determined by Amazon Lex V2.
|
544
551
|
#
|
545
552
|
# * `ElicitSlot` - The next action is to elicit a slot value from the
|
546
553
|
# user.
|
@@ -560,7 +567,7 @@ module Aws::LexRuntimeV2
|
|
560
567
|
end
|
561
568
|
|
562
569
|
# A notification from the client that it is disconnecting from Amazon
|
563
|
-
# Lex. Sending a `DisconnectionEvent` event is optional, but can help
|
570
|
+
# Lex V2. Sending a `DisconnectionEvent` event is optional, but can help
|
564
571
|
# identify a conversation in logs.
|
565
572
|
#
|
566
573
|
# @note When making an API call, you may pass DisconnectionEvent
|
@@ -578,7 +585,7 @@ module Aws::LexRuntimeV2
|
|
578
585
|
#
|
579
586
|
# @!attribute [rw] client_timestamp_millis
|
580
587
|
# A timestamp set by the client of the date and time that the event
|
581
|
-
# was sent to Amazon Lex.
|
588
|
+
# was sent to Amazon Lex V2.
|
582
589
|
# @return [Integer]
|
583
590
|
#
|
584
591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/DisconnectionEvent AWS API Documentation
|
@@ -640,12 +647,12 @@ module Aws::LexRuntimeV2
|
|
640
647
|
# @return [Array<Types::Message>]
|
641
648
|
#
|
642
649
|
# @!attribute [rw] interpretations
|
643
|
-
# A list of intents that Amazon Lex determined might satisfy the
|
650
|
+
# A list of intents that Amazon Lex V2 determined might satisfy the
|
644
651
|
# user's utterance.
|
645
652
|
#
|
646
653
|
# Each interpretation includes the intent, a score that indicates how
|
647
|
-
# confident Amazon Lex is that the interpretation is the correct
|
648
|
-
# and an optional sentiment response that indicates the sentiment
|
654
|
+
# confident Amazon Lex V2 is that the interpretation is the correct
|
655
|
+
# one, and an optional sentiment response that indicates the sentiment
|
649
656
|
# expressed in the utterance.
|
650
657
|
# @return [Array<Types::Interpretation>]
|
651
658
|
#
|
@@ -668,14 +675,14 @@ module Aws::LexRuntimeV2
|
|
668
675
|
include Aws::Structure
|
669
676
|
end
|
670
677
|
|
671
|
-
# Event that Amazon Lex sends to indicate that the stream is still
|
672
|
-
# between the client application and Amazon Lex
|
678
|
+
# Event that Amazon Lex V2 sends to indicate that the stream is still
|
679
|
+
# open between the client application and Amazon Lex V2
|
673
680
|
#
|
674
681
|
# @!attribute [rw] event_id
|
675
|
-
# A unique identifier of the event sent by Amazon Lex. The
|
676
|
-
# is in the form `RESPONSE-N`, where N is a number starting
|
677
|
-
# and incremented for each event sent by Amazon Lex in the
|
678
|
-
# session.
|
682
|
+
# A unique identifier of the event sent by Amazon Lex V2. The
|
683
|
+
# identifier is in the form `RESPONSE-N`, where N is a number starting
|
684
|
+
# with one and incremented for each event sent by Amazon Lex V2 in the
|
685
|
+
# current session.
|
679
686
|
# @return [String]
|
680
687
|
#
|
681
688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/HeartbeatEvent AWS API Documentation
|
@@ -741,7 +748,7 @@ module Aws::LexRuntimeV2
|
|
741
748
|
include Aws::Structure
|
742
749
|
end
|
743
750
|
|
744
|
-
# The current intent that Amazon Lex is attempting to fulfill.
|
751
|
+
# The current intent that Amazon Lex V2 is attempting to fulfill.
|
745
752
|
#
|
746
753
|
# @note When making an API call, you may pass Intent
|
747
754
|
# data as a hash:
|
@@ -755,6 +762,12 @@ module Aws::LexRuntimeV2
|
|
755
762
|
# interpreted_value: "NonEmptyString", # required
|
756
763
|
# resolved_values: ["NonEmptyString"],
|
757
764
|
# },
|
765
|
+
# shape: "Scalar", # accepts Scalar, List
|
766
|
+
# values: [
|
767
|
+
# {
|
768
|
+
# # recursive Slot
|
769
|
+
# },
|
770
|
+
# ],
|
758
771
|
# },
|
759
772
|
# },
|
760
773
|
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting
|
@@ -792,24 +805,24 @@ module Aws::LexRuntimeV2
|
|
792
805
|
end
|
793
806
|
|
794
807
|
# Contains the current state of the conversation between the client
|
795
|
-
# application and Amazon Lex.
|
808
|
+
# application and Amazon Lex V2.
|
796
809
|
#
|
797
810
|
# @!attribute [rw] input_mode
|
798
811
|
# Indicates whether the input to the operation was text or speech.
|
799
812
|
# @return [String]
|
800
813
|
#
|
801
814
|
# @!attribute [rw] interpretations
|
802
|
-
# A list of intents that Amazon Lex determined might satisfy the
|
815
|
+
# A list of intents that Amazon Lex V2 determined might satisfy the
|
803
816
|
# user's utterance.
|
804
817
|
#
|
805
818
|
# Each interpretation includes the intent, a score that indicates how
|
806
|
-
# confident Amazon Lex is that the interpretation is the correct
|
807
|
-
# and an optional sentiment response that indicates the sentiment
|
819
|
+
# confident Amazon Lex V2 is that the interpretation is the correct
|
820
|
+
# one, and an optional sentiment response that indicates the sentiment
|
808
821
|
# expressed in the utterance.
|
809
822
|
# @return [Array<Types::Interpretation>]
|
810
823
|
#
|
811
824
|
# @!attribute [rw] session_state
|
812
|
-
# The state of the user's session with Amazon Lex.
|
825
|
+
# The state of the user's session with Amazon Lex V2.
|
813
826
|
# @return [Types::SessionState]
|
814
827
|
#
|
815
828
|
# @!attribute [rw] request_attributes
|
@@ -821,10 +834,10 @@ module Aws::LexRuntimeV2
|
|
821
834
|
# @return [String]
|
822
835
|
#
|
823
836
|
# @!attribute [rw] event_id
|
824
|
-
# A unique identifier of the event sent by Amazon Lex. The
|
825
|
-
# is in the form `RESPONSE-N`, where N is a number starting
|
826
|
-
# and incremented for each event sent by Amazon Lex in the
|
827
|
-
# session.
|
837
|
+
# A unique identifier of the event sent by Amazon Lex V2. The
|
838
|
+
# identifier is in the form `RESPONSE-N`, where N is a number starting
|
839
|
+
# with one and incremented for each event sent by Amazon Lex V2 in the
|
840
|
+
# current session.
|
828
841
|
# @return [String]
|
829
842
|
#
|
830
843
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/IntentResultEvent AWS API Documentation
|
@@ -853,11 +866,11 @@ module Aws::LexRuntimeV2
|
|
853
866
|
include Aws::Structure
|
854
867
|
end
|
855
868
|
|
856
|
-
# An intent that Amazon Lex determined might satisfy the user's
|
869
|
+
# An intent that Amazon Lex V2 determined might satisfy the user's
|
857
870
|
# utterance. The intents are ordered by the confidence score.
|
858
871
|
#
|
859
872
|
# @!attribute [rw] nlu_confidence
|
860
|
-
# Determines the threshold where Amazon Lex will insert the
|
873
|
+
# Determines the threshold where Amazon Lex V2 will insert the
|
861
874
|
# `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when
|
862
875
|
# returning alternative intents in a response. `AMAZON.FallbackIntent`
|
863
876
|
# and `AMAZON.KendraSearchIntent` are only inserted if they are
|
@@ -894,7 +907,7 @@ module Aws::LexRuntimeV2
|
|
894
907
|
#
|
895
908
|
# {
|
896
909
|
# content: "Text",
|
897
|
-
# content_type: "CustomPayload", # accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
910
|
+
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
898
911
|
# image_response_card: {
|
899
912
|
# title: "AttachmentTitle", # required
|
900
913
|
# subtitle: "AttachmentTitle",
|
@@ -934,8 +947,8 @@ module Aws::LexRuntimeV2
|
|
934
947
|
include Aws::Structure
|
935
948
|
end
|
936
949
|
|
937
|
-
# Event sent from the client application to Amazon Lex to indicate
|
938
|
-
# playback of audio is complete and that Amazon Lex should start
|
950
|
+
# Event sent from the client application to Amazon Lex V2 to indicate
|
951
|
+
# that playback of audio is complete and that Amazon Lex V2 should start
|
939
952
|
# processing the user's input.
|
940
953
|
#
|
941
954
|
# @note When making an API call, you may pass PlaybackCompletionEvent
|
@@ -953,7 +966,7 @@ module Aws::LexRuntimeV2
|
|
953
966
|
#
|
954
967
|
# @!attribute [rw] client_timestamp_millis
|
955
968
|
# A timestamp set by the client of the date and time that the event
|
956
|
-
# was sent to Amazon Lex.
|
969
|
+
# was sent to Amazon Lex V2.
|
957
970
|
# @return [Integer]
|
958
971
|
#
|
959
972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/PlaybackCompletionEvent AWS API Documentation
|
@@ -966,15 +979,15 @@ module Aws::LexRuntimeV2
|
|
966
979
|
include Aws::Structure
|
967
980
|
end
|
968
981
|
|
969
|
-
# Event sent from Amazon Lex to indicate to the client application
|
982
|
+
# Event sent from Amazon Lex V2 to indicate to the client application
|
970
983
|
# should stop playback of audio. For example, if the client is playing a
|
971
984
|
# prompt that asks for the user's telephone number, the user might
|
972
985
|
# start to say the phone number before the prompt is complete. Amazon
|
973
|
-
# Lex sends this event to the client application to indicate that the
|
974
|
-
# user is responding and that Amazon Lex is processing their input.
|
986
|
+
# Lex V2 sends this event to the client application to indicate that the
|
987
|
+
# user is responding and that Amazon Lex V2 is processing their input.
|
975
988
|
#
|
976
989
|
# @!attribute [rw] event_reason
|
977
|
-
# Indicates the type of user input that Amazon Lex detected.
|
990
|
+
# Indicates the type of user input that Amazon Lex V2 detected.
|
978
991
|
# @return [String]
|
979
992
|
#
|
980
993
|
# @!attribute [rw] caused_by_event_id
|
@@ -983,10 +996,10 @@ module Aws::LexRuntimeV2
|
|
983
996
|
# @return [String]
|
984
997
|
#
|
985
998
|
# @!attribute [rw] event_id
|
986
|
-
# A unique identifier of the event sent by Amazon Lex. The
|
987
|
-
# is in the form `RESPONSE-N`, where N is a number starting
|
988
|
-
# and incremented for each event sent by Amazon Lex in the
|
989
|
-
# session.
|
999
|
+
# A unique identifier of the event sent by Amazon Lex V2. The
|
1000
|
+
# identifier is in the form `RESPONSE-N`, where N is a number starting
|
1001
|
+
# with one and incremented for each event sent by Amazon Lex V2 in the
|
1002
|
+
# current session.
|
990
1003
|
# @return [String]
|
991
1004
|
#
|
992
1005
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/PlaybackInterruptionEvent AWS API Documentation
|
@@ -1011,7 +1024,7 @@ module Aws::LexRuntimeV2
|
|
1011
1024
|
# messages: [
|
1012
1025
|
# {
|
1013
1026
|
# content: "Text",
|
1014
|
-
# content_type: "CustomPayload", # accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
1027
|
+
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
1015
1028
|
# image_response_card: {
|
1016
1029
|
# title: "AttachmentTitle", # required
|
1017
1030
|
# subtitle: "AttachmentTitle",
|
@@ -1039,6 +1052,12 @@ module Aws::LexRuntimeV2
|
|
1039
1052
|
# interpreted_value: "NonEmptyString", # required
|
1040
1053
|
# resolved_values: ["NonEmptyString"],
|
1041
1054
|
# },
|
1055
|
+
# shape: "Scalar", # accepts Scalar, List
|
1056
|
+
# values: [
|
1057
|
+
# {
|
1058
|
+
# # recursive Slot
|
1059
|
+
# },
|
1060
|
+
# ],
|
1042
1061
|
# },
|
1043
1062
|
# },
|
1044
1063
|
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting
|
@@ -1051,7 +1070,7 @@ module Aws::LexRuntimeV2
|
|
1051
1070
|
# time_to_live_in_seconds: 1, # required
|
1052
1071
|
# turns_to_live: 1, # required
|
1053
1072
|
# },
|
1054
|
-
# context_attributes: {
|
1073
|
+
# context_attributes: { # required
|
1055
1074
|
# "ParameterName" => "Text",
|
1056
1075
|
# },
|
1057
1076
|
# },
|
@@ -1091,12 +1110,12 @@ module Aws::LexRuntimeV2
|
|
1091
1110
|
# @!attribute [rw] session_state
|
1092
1111
|
# Sets the state of the session with the user. You can use this to set
|
1093
1112
|
# the current intent, attributes, context, and dialog action. Use the
|
1094
|
-
# dialog action to determine the next step that Amazon Lex should
|
1095
|
-
# in the conversation with the user.
|
1113
|
+
# dialog action to determine the next step that Amazon Lex V2 should
|
1114
|
+
# use in the conversation with the user.
|
1096
1115
|
# @return [Types::SessionState]
|
1097
1116
|
#
|
1098
1117
|
# @!attribute [rw] request_attributes
|
1099
|
-
# Request-specific information passed between Amazon Lex and the
|
1118
|
+
# Request-specific information passed between Amazon Lex V2 and the
|
1100
1119
|
# client application.
|
1101
1120
|
#
|
1102
1121
|
# The namespace `x-amz-lex:` is reserved for special attributes.
|
@@ -1104,10 +1123,10 @@ module Aws::LexRuntimeV2
|
|
1104
1123
|
# @return [Hash<String,String>]
|
1105
1124
|
#
|
1106
1125
|
# @!attribute [rw] response_content_type
|
1107
|
-
# The message that Amazon Lex returns in the response can be either
|
1126
|
+
# The message that Amazon Lex V2 returns in the response can be either
|
1108
1127
|
# text or speech depending on the value of this parameter.
|
1109
1128
|
#
|
1110
|
-
# * If the value is `text/plain; charset=utf-8`, Amazon Lex returns
|
1129
|
+
# * If the value is `text/plain; charset=utf-8`, Amazon Lex V2 returns
|
1111
1130
|
# text in the response.
|
1112
1131
|
#
|
1113
1132
|
# ^
|
@@ -1149,7 +1168,7 @@ module Aws::LexRuntimeV2
|
|
1149
1168
|
#
|
1150
1169
|
# @!attribute [rw] request_attributes
|
1151
1170
|
# Request-specific information passed between the client application
|
1152
|
-
# and Amazon Lex. These are the same as the `requestAttribute`
|
1171
|
+
# and Amazon Lex V2. These are the same as the `requestAttribute`
|
1153
1172
|
# parameter in the call to the `PutSession` operation.
|
1154
1173
|
# @return [String]
|
1155
1174
|
#
|
@@ -1198,6 +1217,12 @@ module Aws::LexRuntimeV2
|
|
1198
1217
|
# interpreted_value: "NonEmptyString", # required
|
1199
1218
|
# resolved_values: ["NonEmptyString"],
|
1200
1219
|
# },
|
1220
|
+
# shape: "Scalar", # accepts Scalar, List
|
1221
|
+
# values: [
|
1222
|
+
# {
|
1223
|
+
# # recursive Slot
|
1224
|
+
# },
|
1225
|
+
# ],
|
1201
1226
|
# },
|
1202
1227
|
# },
|
1203
1228
|
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting
|
@@ -1210,7 +1235,7 @@ module Aws::LexRuntimeV2
|
|
1210
1235
|
# time_to_live_in_seconds: 1, # required
|
1211
1236
|
# turns_to_live: 1, # required
|
1212
1237
|
# },
|
1213
|
-
# context_attributes: {
|
1238
|
+
# context_attributes: { # required
|
1214
1239
|
# "ParameterName" => "Text",
|
1215
1240
|
# },
|
1216
1241
|
# },
|
@@ -1242,7 +1267,7 @@ module Aws::LexRuntimeV2
|
|
1242
1267
|
# @return [String]
|
1243
1268
|
#
|
1244
1269
|
# @!attribute [rw] text
|
1245
|
-
# The text that the user entered. Amazon Lex interprets this text.
|
1270
|
+
# The text that the user entered. Amazon Lex V2 interprets this text.
|
1246
1271
|
# @return [String]
|
1247
1272
|
#
|
1248
1273
|
# @!attribute [rw] session_state
|
@@ -1251,7 +1276,7 @@ module Aws::LexRuntimeV2
|
|
1251
1276
|
#
|
1252
1277
|
# @!attribute [rw] request_attributes
|
1253
1278
|
# Request-specific information passed between the client application
|
1254
|
-
# and Amazon Lex
|
1279
|
+
# and Amazon Lex V2
|
1255
1280
|
#
|
1256
1281
|
# The namespace `x-amz-lex:` is reserved for special attributes.
|
1257
1282
|
# Don't create any request attributes with the prefix `x-amz-lex:`.
|
@@ -1286,12 +1311,12 @@ module Aws::LexRuntimeV2
|
|
1286
1311
|
# @return [Types::SessionState]
|
1287
1312
|
#
|
1288
1313
|
# @!attribute [rw] interpretations
|
1289
|
-
# A list of intents that Amazon Lex determined might satisfy the
|
1314
|
+
# A list of intents that Amazon Lex V2 determined might satisfy the
|
1290
1315
|
# user's utterance.
|
1291
1316
|
#
|
1292
1317
|
# Each interpretation includes the intent, a score that indicates now
|
1293
|
-
# confident Amazon Lex is that the interpretation is the correct
|
1294
|
-
# and an optional sentiment response that indicates the sentiment
|
1318
|
+
# confident Amazon Lex V2 is that the interpretation is the correct
|
1319
|
+
# one, and an optional sentiment response that indicates the sentiment
|
1295
1320
|
# expressed in the utterance.
|
1296
1321
|
# @return [Array<Types::Interpretation>]
|
1297
1322
|
#
|
@@ -1350,16 +1375,22 @@ module Aws::LexRuntimeV2
|
|
1350
1375
|
# @!attribute [rw] session_state
|
1351
1376
|
# Sets the state of the session with the user. You can use this to set
|
1352
1377
|
# the current intent, attributes, context, and dialog action. Use the
|
1353
|
-
# dialog action to determine the next step that Amazon Lex should
|
1354
|
-
# in the conversation with the user.
|
1378
|
+
# dialog action to determine the next step that Amazon Lex V2 should
|
1379
|
+
# use in the conversation with the user.
|
1380
|
+
#
|
1381
|
+
# The `sessionState` field must be compressed using gzip and then
|
1382
|
+
# base64 encoded before sending to Amazon Lex V2.
|
1355
1383
|
# @return [String]
|
1356
1384
|
#
|
1357
1385
|
# @!attribute [rw] request_attributes
|
1358
1386
|
# Request-specific information passed between the client application
|
1359
|
-
# and Amazon Lex
|
1387
|
+
# and Amazon Lex V2
|
1360
1388
|
#
|
1361
1389
|
# The namespace `x-amz-lex:` is reserved for special attributes.
|
1362
1390
|
# Don't create any request attributes for prefix `x-amz-lex:`.
|
1391
|
+
#
|
1392
|
+
# The `requestAttributes` field must be compressed using gzip and then
|
1393
|
+
# base64 encoded before sending to Amazon Lex V2.
|
1363
1394
|
# @return [String]
|
1364
1395
|
#
|
1365
1396
|
# @!attribute [rw] request_content_type
|
@@ -1389,18 +1420,18 @@ module Aws::LexRuntimeV2
|
|
1389
1420
|
# @return [String]
|
1390
1421
|
#
|
1391
1422
|
# @!attribute [rw] response_content_type
|
1392
|
-
# The message that Amazon Lex returns in the response can be either
|
1423
|
+
# The message that Amazon Lex V2 returns in the response can be either
|
1393
1424
|
# text or speech based on the `responseContentType` value.
|
1394
1425
|
#
|
1395
|
-
# * If the value is `text/plain;charset=utf-8`, Amazon Lex returns
|
1426
|
+
# * If the value is `text/plain;charset=utf-8`, Amazon Lex V2 returns
|
1396
1427
|
# text in the response.
|
1397
1428
|
#
|
1398
|
-
# * If the value begins with `audio/`, Amazon Lex returns speech in
|
1399
|
-
# the response. Amazon Lex uses Amazon Polly to generate the
|
1400
|
-
# using the configuration that you specified in the
|
1429
|
+
# * If the value begins with `audio/`, Amazon Lex V2 returns speech in
|
1430
|
+
# the response. Amazon Lex V2 uses Amazon Polly to generate the
|
1431
|
+
# speech using the configuration that you specified in the
|
1401
1432
|
# `requestContentType` parameter. For example, if you specify
|
1402
|
-
# `audio/mpeg` as the value, Amazon Lex returns speech in the
|
1403
|
-
# format.
|
1433
|
+
# `audio/mpeg` as the value, Amazon Lex V2 returns speech in the
|
1434
|
+
# MPEG format.
|
1404
1435
|
#
|
1405
1436
|
# * If the value is `audio/pcm`, the speech returned is `audio/pcm` at
|
1406
1437
|
# 16 KHz in 16-bit, little-endian format.
|
@@ -1454,16 +1485,26 @@ module Aws::LexRuntimeV2
|
|
1454
1485
|
# ordered based on the order that you returned the messages from your
|
1455
1486
|
# Lambda function or the order that the messages are defined in the
|
1456
1487
|
# bot.
|
1488
|
+
#
|
1489
|
+
# The `messages` field is compressed with gzip and then base64
|
1490
|
+
# encoded. Before you can use the contents of the field, you must
|
1491
|
+
# decode and decompress the contents. See the example for a simple
|
1492
|
+
# function to decode and decompress the contents.
|
1457
1493
|
# @return [String]
|
1458
1494
|
#
|
1459
1495
|
# @!attribute [rw] interpretations
|
1460
|
-
# A list of intents that Amazon Lex determined might satisfy the
|
1496
|
+
# A list of intents that Amazon Lex V2 determined might satisfy the
|
1461
1497
|
# user's utterance.
|
1462
1498
|
#
|
1463
1499
|
# Each interpretation includes the intent, a score that indicates how
|
1464
|
-
# confident Amazon Lex is that the interpretation is the correct
|
1465
|
-
# and an optional sentiment response that indicates the sentiment
|
1500
|
+
# confident Amazon Lex V2 is that the interpretation is the correct
|
1501
|
+
# one, and an optional sentiment response that indicates the sentiment
|
1466
1502
|
# expressed in the utterance.
|
1503
|
+
#
|
1504
|
+
# The `interpretations` field is compressed with gzip and then base64
|
1505
|
+
# encoded. Before you can use the contents of the field, you must
|
1506
|
+
# decode and decompress the contents. See the example for a simple
|
1507
|
+
# function to decode and decompress the contents.
|
1467
1508
|
# @return [String]
|
1468
1509
|
#
|
1469
1510
|
# @!attribute [rw] session_state
|
@@ -1472,10 +1513,19 @@ module Aws::LexRuntimeV2
|
|
1472
1513
|
#
|
1473
1514
|
# Use this to determine the progress of the conversation and what the
|
1474
1515
|
# next action might be.
|
1516
|
+
#
|
1517
|
+
# The `sessionState` field is compressed with gzip and then base64
|
1518
|
+
# encoded. Before you can use the contents of the field, you must
|
1519
|
+
# decode and decompress the contents. See the example for a simple
|
1520
|
+
# function to decode and decompress the contents.
|
1475
1521
|
# @return [String]
|
1476
1522
|
#
|
1477
1523
|
# @!attribute [rw] request_attributes
|
1478
1524
|
# The attributes sent in the request.
|
1525
|
+
#
|
1526
|
+
# The `requestAttributes` field is compressed with gzip and then
|
1527
|
+
# base64 encoded. Before you can use the contents of the field, you
|
1528
|
+
# must decode and decompress the contents.
|
1479
1529
|
# @return [String]
|
1480
1530
|
#
|
1481
1531
|
# @!attribute [rw] session_id
|
@@ -1488,19 +1538,24 @@ module Aws::LexRuntimeV2
|
|
1488
1538
|
# If the input was an audio stream, the `inputTranscript` field
|
1489
1539
|
# contains the text extracted from the audio stream. This is the text
|
1490
1540
|
# that is actually processed to recognize intents and slot values. You
|
1491
|
-
# can use this information to determine if Amazon Lex is correctly
|
1541
|
+
# can use this information to determine if Amazon Lex V2 is correctly
|
1492
1542
|
# processing the audio that you send.
|
1543
|
+
#
|
1544
|
+
# The `inputTranscript` field is compressed with gzip and then base64
|
1545
|
+
# encoded. Before you can use the contents of the field, you must
|
1546
|
+
# decode and decompress the contents. See the example for a simple
|
1547
|
+
# function to decode and decompress the contents.
|
1493
1548
|
# @return [String]
|
1494
1549
|
#
|
1495
1550
|
# @!attribute [rw] audio_stream
|
1496
1551
|
# The prompt or statement to send to the user. This is based on the
|
1497
|
-
# bot configuration and context. For example, if Amazon Lex did not
|
1552
|
+
# bot configuration and context. For example, if Amazon Lex V2 did not
|
1498
1553
|
# understand the user intent, it sends the `clarificationPrompt`
|
1499
1554
|
# configured for the bot. If the intent requires confirmation before
|
1500
1555
|
# taking the fulfillment action, it sends the `confirmationPrompt`.
|
1501
1556
|
# Another example: Suppose that the Lambda function successfully
|
1502
1557
|
# fulfilled the intent, and sent a message to convey to the user. Then
|
1503
|
-
# Amazon Lex sends that message in the response.
|
1558
|
+
# Amazon Lex V2 sends that message in the response.
|
1504
1559
|
# @return [IO]
|
1505
1560
|
#
|
1506
1561
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/RecognizeUtteranceResponse AWS API Documentation
|
@@ -1595,7 +1650,7 @@ module Aws::LexRuntimeV2
|
|
1595
1650
|
include Aws::Structure
|
1596
1651
|
end
|
1597
1652
|
|
1598
|
-
# The state of the user's session with Amazon Lex.
|
1653
|
+
# The state of the user's session with Amazon Lex V2.
|
1599
1654
|
#
|
1600
1655
|
# @note When making an API call, you may pass SessionState
|
1601
1656
|
# data as a hash:
|
@@ -1614,6 +1669,12 @@ module Aws::LexRuntimeV2
|
|
1614
1669
|
# interpreted_value: "NonEmptyString", # required
|
1615
1670
|
# resolved_values: ["NonEmptyString"],
|
1616
1671
|
# },
|
1672
|
+
# shape: "Scalar", # accepts Scalar, List
|
1673
|
+
# values: [
|
1674
|
+
# {
|
1675
|
+
# # recursive Slot
|
1676
|
+
# },
|
1677
|
+
# ],
|
1617
1678
|
# },
|
1618
1679
|
# },
|
1619
1680
|
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting
|
@@ -1626,7 +1687,7 @@ module Aws::LexRuntimeV2
|
|
1626
1687
|
# time_to_live_in_seconds: 1, # required
|
1627
1688
|
# turns_to_live: 1, # required
|
1628
1689
|
# },
|
1629
|
-
# context_attributes: {
|
1690
|
+
# context_attributes: { # required
|
1630
1691
|
# "ParameterName" => "Text",
|
1631
1692
|
# },
|
1632
1693
|
# },
|
@@ -1638,24 +1699,25 @@ module Aws::LexRuntimeV2
|
|
1638
1699
|
# }
|
1639
1700
|
#
|
1640
1701
|
# @!attribute [rw] dialog_action
|
1641
|
-
# The next step that Amazon Lex should take in the conversation
|
1642
|
-
# user.
|
1702
|
+
# The next step that Amazon Lex V2 should take in the conversation
|
1703
|
+
# with a user.
|
1643
1704
|
# @return [Types::DialogAction]
|
1644
1705
|
#
|
1645
1706
|
# @!attribute [rw] intent
|
1646
|
-
# The active intent that Amazon Lex is processing.
|
1707
|
+
# The active intent that Amazon Lex V2 is processing.
|
1647
1708
|
# @return [Types::Intent]
|
1648
1709
|
#
|
1649
1710
|
# @!attribute [rw] active_contexts
|
1650
|
-
# One or more contexts that indicate to Amazon Lex the context of a
|
1651
|
-
# request. When a context is active, Amazon Lex considers intents
|
1652
|
-
# the matching context as a trigger as the next intent in a
|
1711
|
+
# One or more contexts that indicate to Amazon Lex V2 the context of a
|
1712
|
+
# request. When a context is active, Amazon Lex V2 considers intents
|
1713
|
+
# with the matching context as a trigger as the next intent in a
|
1714
|
+
# session.
|
1653
1715
|
# @return [Array<Types::ActiveContext>]
|
1654
1716
|
#
|
1655
1717
|
# @!attribute [rw] session_attributes
|
1656
1718
|
# Map of key/value pairs representing session-specific context
|
1657
1719
|
# information. It contains application information passed between
|
1658
|
-
# Amazon Lex and a client application.
|
1720
|
+
# Amazon Lex V2 and a client application.
|
1659
1721
|
# @return [Hash<String,String>]
|
1660
1722
|
#
|
1661
1723
|
# @!attribute [rw] originating_request_id
|
@@ -1673,7 +1735,7 @@ module Aws::LexRuntimeV2
|
|
1673
1735
|
include Aws::Structure
|
1674
1736
|
end
|
1675
1737
|
|
1676
|
-
# A value that Amazon Lex uses to fulfill an intent.
|
1738
|
+
# A value that Amazon Lex V2 uses to fulfill an intent.
|
1677
1739
|
#
|
1678
1740
|
# @note When making an API call, you may pass Slot
|
1679
1741
|
# data as a hash:
|
@@ -1684,16 +1746,44 @@ module Aws::LexRuntimeV2
|
|
1684
1746
|
# interpreted_value: "NonEmptyString", # required
|
1685
1747
|
# resolved_values: ["NonEmptyString"],
|
1686
1748
|
# },
|
1749
|
+
# shape: "Scalar", # accepts Scalar, List
|
1750
|
+
# values: [
|
1751
|
+
# {
|
1752
|
+
# value: {
|
1753
|
+
# original_value: "NonEmptyString",
|
1754
|
+
# interpreted_value: "NonEmptyString", # required
|
1755
|
+
# resolved_values: ["NonEmptyString"],
|
1756
|
+
# },
|
1757
|
+
# shape: "Scalar", # accepts Scalar, List
|
1758
|
+
# values: {
|
1759
|
+
# # recursive Values
|
1760
|
+
# },
|
1761
|
+
# },
|
1762
|
+
# ],
|
1687
1763
|
# }
|
1688
1764
|
#
|
1689
1765
|
# @!attribute [rw] value
|
1690
1766
|
# The current value of the slot.
|
1691
1767
|
# @return [Types::Value]
|
1692
1768
|
#
|
1769
|
+
# @!attribute [rw] shape
|
1770
|
+
# When the `shape` value is `List`, it indicates that the `values`
|
1771
|
+
# field contains a list of slot values. When the value is `Scalar`, it
|
1772
|
+
# indicates that the `value` field contains a single value.
|
1773
|
+
# @return [String]
|
1774
|
+
#
|
1775
|
+
# @!attribute [rw] values
|
1776
|
+
# A list of one or more values that the user provided for the slot.
|
1777
|
+
# For example, if a for a slot that elicits pizza toppings, the values
|
1778
|
+
# might be "pepperoni" and "pineapple."
|
1779
|
+
# @return [Array<Types::Slot>]
|
1780
|
+
#
|
1693
1781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/Slot AWS API Documentation
|
1694
1782
|
#
|
1695
1783
|
class Slot < Struct.new(
|
1696
|
-
:value
|
1784
|
+
:value,
|
1785
|
+
:shape,
|
1786
|
+
:values)
|
1697
1787
|
SENSITIVE = []
|
1698
1788
|
include Aws::Structure
|
1699
1789
|
end
|
@@ -1727,14 +1817,14 @@ module Aws::LexRuntimeV2
|
|
1727
1817
|
# @return [String]
|
1728
1818
|
#
|
1729
1819
|
# @!attribute [rw] conversation_mode
|
1730
|
-
# The conversation type that you are using the Amazon Lex. If the
|
1820
|
+
# The conversation type that you are using the Amazon Lex V2. If the
|
1731
1821
|
# conversation mode is `AUDIO` you can send both audio and DTMF
|
1732
1822
|
# information. If the mode is `TEXT` you can only send text.
|
1733
1823
|
# @return [String]
|
1734
1824
|
#
|
1735
1825
|
# @!attribute [rw] request_event_stream
|
1736
|
-
# Represents the stream of events to Amazon Lex from your
|
1737
|
-
# The events are encoded as HTTP/2 data frames.
|
1826
|
+
# Represents the stream of events to Amazon Lex V2 from your
|
1827
|
+
# application. The events are encoded as HTTP/2 data frames.
|
1738
1828
|
# @return [Types::StartConversationRequestEventStream]
|
1739
1829
|
#
|
1740
1830
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/StartConversationRequest AWS API Documentation
|
@@ -1751,8 +1841,8 @@ module Aws::LexRuntimeV2
|
|
1751
1841
|
end
|
1752
1842
|
|
1753
1843
|
# @!attribute [rw] response_event_stream
|
1754
|
-
# Represents the stream of events from Amazon Lex to your
|
1755
|
-
# The events are encoded as HTTP/2 data frames.
|
1844
|
+
# Represents the stream of events from Amazon Lex V2 to your
|
1845
|
+
# application. The events are encoded as HTTP/2 data frames.
|
1756
1846
|
# @return [Types::StartConversationResponseEventStream]
|
1757
1847
|
#
|
1758
1848
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/StartConversationResponse AWS API Documentation
|
@@ -1763,7 +1853,7 @@ module Aws::LexRuntimeV2
|
|
1763
1853
|
include Aws::Structure
|
1764
1854
|
end
|
1765
1855
|
|
1766
|
-
# The event sent from your client application to Amazon Lex with text
|
1856
|
+
# The event sent from your client application to Amazon Lex V2 with text
|
1767
1857
|
# input from the user.
|
1768
1858
|
#
|
1769
1859
|
# @note When making an API call, you may pass TextInputEvent
|
@@ -1776,7 +1866,7 @@ module Aws::LexRuntimeV2
|
|
1776
1866
|
# }
|
1777
1867
|
#
|
1778
1868
|
# @!attribute [rw] text
|
1779
|
-
# The text from the user. Amazon Lex processes this as a complete
|
1869
|
+
# The text from the user. Amazon Lex V2 processes this as a complete
|
1780
1870
|
# statement.
|
1781
1871
|
# @return [String]
|
1782
1872
|
#
|
@@ -1787,7 +1877,7 @@ module Aws::LexRuntimeV2
|
|
1787
1877
|
#
|
1788
1878
|
# @!attribute [rw] client_timestamp_millis
|
1789
1879
|
# A timestamp set by the client of the date and time that the event
|
1790
|
-
# was sent to Amazon Lex.
|
1880
|
+
# was sent to Amazon Lex V2.
|
1791
1881
|
# @return [Integer]
|
1792
1882
|
#
|
1793
1883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/TextInputEvent AWS API Documentation
|
@@ -1801,7 +1891,7 @@ module Aws::LexRuntimeV2
|
|
1801
1891
|
include Aws::Structure
|
1802
1892
|
end
|
1803
1893
|
|
1804
|
-
# The event sent from Amazon Lex to your application with text to
|
1894
|
+
# The event sent from Amazon Lex V2 to your application with text to
|
1805
1895
|
# present to the user.
|
1806
1896
|
#
|
1807
1897
|
# @!attribute [rw] messages
|
@@ -1811,10 +1901,10 @@ module Aws::LexRuntimeV2
|
|
1811
1901
|
# @return [Array<Types::Message>]
|
1812
1902
|
#
|
1813
1903
|
# @!attribute [rw] event_id
|
1814
|
-
# A unique identifier of the event sent by Amazon Lex. The
|
1815
|
-
# is in the form `RESPONSE-N`, where N is a number starting
|
1816
|
-
# and incremented for each event sent by Amazon Lex in the
|
1817
|
-
# session.
|
1904
|
+
# A unique identifier of the event sent by Amazon Lex V2. The
|
1905
|
+
# identifier is in the form `RESPONSE-N`, where N is a number starting
|
1906
|
+
# with one and incremented for each event sent by Amazon Lex V2 in the
|
1907
|
+
# current session.
|
1818
1908
|
# @return [String]
|
1819
1909
|
#
|
1820
1910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/TextResponseEvent AWS API Documentation
|
@@ -1839,18 +1929,18 @@ module Aws::LexRuntimeV2
|
|
1839
1929
|
include Aws::Structure
|
1840
1930
|
end
|
1841
1931
|
|
1842
|
-
# Event sent from Amazon Lex to your client application that contains
|
1843
|
-
# transcript of voice audio.
|
1932
|
+
# Event sent from Amazon Lex V2 to your client application that contains
|
1933
|
+
# a transcript of voice audio.
|
1844
1934
|
#
|
1845
1935
|
# @!attribute [rw] transcript
|
1846
1936
|
# The transcript of the voice audio from the user.
|
1847
1937
|
# @return [String]
|
1848
1938
|
#
|
1849
1939
|
# @!attribute [rw] event_id
|
1850
|
-
# A unique identifier of the event sent by Amazon Lex. The
|
1851
|
-
# is in the form `RESPONSE-N`, where N is a number starting
|
1852
|
-
# and incremented for each event sent by Amazon Lex in the
|
1853
|
-
# session.
|
1940
|
+
# A unique identifier of the event sent by Amazon Lex V2. The
|
1941
|
+
# identifier is in the form `RESPONSE-N`, where N is a number starting
|
1942
|
+
# with one and incremented for each event sent by Amazon Lex V2 in the
|
1943
|
+
# current session.
|
1854
1944
|
# @return [String]
|
1855
1945
|
#
|
1856
1946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/runtime.lex.v2-2020-08-07/TranscriptEvent AWS API Documentation
|
@@ -1892,10 +1982,11 @@ module Aws::LexRuntimeV2
|
|
1892
1982
|
# @return [String]
|
1893
1983
|
#
|
1894
1984
|
# @!attribute [rw] interpreted_value
|
1895
|
-
# The value that Amazon Lex determines for the slot. The actual
|
1896
|
-
# depends on the setting of the value selection strategy for the
|
1897
|
-
# You can choose to use the value entered by the user, or you can
|
1898
|
-
# Amazon Lex choose the first value in the `resolvedValues`
|
1985
|
+
# The value that Amazon Lex V2 determines for the slot. The actual
|
1986
|
+
# value depends on the setting of the value selection strategy for the
|
1987
|
+
# bot. You can choose to use the value entered by the user, or you can
|
1988
|
+
# have Amazon Lex V2 choose the first value in the `resolvedValues`
|
1989
|
+
# list.
|
1899
1990
|
# @return [String]
|
1900
1991
|
#
|
1901
1992
|
# @!attribute [rw] resolved_values
|
@@ -1912,7 +2003,8 @@ module Aws::LexRuntimeV2
|
|
1912
2003
|
include Aws::Structure
|
1913
2004
|
end
|
1914
2005
|
|
1915
|
-
# Represents a stream of events between your application and Amazon Lex
|
2006
|
+
# Represents a stream of events between your application and Amazon Lex
|
2007
|
+
# V2.
|
1916
2008
|
#
|
1917
2009
|
# @note When making an API call, you may pass StartConversationRequestEventStream
|
1918
2010
|
# data as a hash:
|
@@ -1937,6 +2029,12 @@ module Aws::LexRuntimeV2
|
|
1937
2029
|
# interpreted_value: "NonEmptyString", # required
|
1938
2030
|
# resolved_values: ["NonEmptyString"],
|
1939
2031
|
# },
|
2032
|
+
# shape: "Scalar", # accepts Scalar, List
|
2033
|
+
# values: [
|
2034
|
+
# {
|
2035
|
+
# # recursive Slot
|
2036
|
+
# },
|
2037
|
+
# ],
|
1940
2038
|
# },
|
1941
2039
|
# },
|
1942
2040
|
# state: "Failed", # accepts Failed, Fulfilled, InProgress, ReadyForFulfillment, Waiting
|
@@ -1949,7 +2047,7 @@ module Aws::LexRuntimeV2
|
|
1949
2047
|
# time_to_live_in_seconds: 1, # required
|
1950
2048
|
# turns_to_live: 1, # required
|
1951
2049
|
# },
|
1952
|
-
# context_attributes: {
|
2050
|
+
# context_attributes: { # required
|
1953
2051
|
# "ParameterName" => "Text",
|
1954
2052
|
# },
|
1955
2053
|
# },
|
@@ -1962,7 +2060,7 @@ module Aws::LexRuntimeV2
|
|
1962
2060
|
# welcome_messages: [
|
1963
2061
|
# {
|
1964
2062
|
# content: "Text",
|
1965
|
-
# content_type: "CustomPayload", # accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
2063
|
+
# content_type: "CustomPayload", # required, accepts CustomPayload, ImageResponseCard, PlainText, SSML
|
1966
2064
|
# image_response_card: {
|
1967
2065
|
# title: "AttachmentTitle", # required
|
1968
2066
|
# subtitle: "AttachmentTitle",
|
@@ -2026,7 +2124,8 @@ module Aws::LexRuntimeV2
|
|
2026
2124
|
|
2027
2125
|
end
|
2028
2126
|
|
2029
|
-
# Represents a stream of events between Amazon Lex and your
|
2127
|
+
# Represents a stream of events between Amazon Lex V2 and your
|
2128
|
+
# application.
|
2030
2129
|
#
|
2031
2130
|
# EventStream is an Enumerator of Events.
|
2032
2131
|
# #event_types #=> Array, returns all modeled event types in the stream
|