Module: Aws::LexRuntimeV2::Types

Defined in:
gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb

Defined Under Namespace

Classes: AccessDeniedException, ActiveContext, ActiveContextTimeToLive, AudioInputEvent, AudioResponseEvent, BadGatewayException, Button, ConfidenceScore, ConfigurationEvent, ConflictException, DTMFInputEvent, DeleteSessionRequest, DeleteSessionResponse, DependencyFailedException, DialogAction, DisconnectionEvent, ElicitSubSlot, GetSessionRequest, GetSessionResponse, HeartbeatEvent, ImageResponseCard, Intent, IntentResultEvent, InternalServerException, Interpretation, Message, PlaybackCompletionEvent, PlaybackInterruptionEvent, PutSessionRequest, PutSessionResponse, RecognizeTextRequest, RecognizeTextResponse, RecognizeUtteranceRequest, RecognizeUtteranceResponse, RecognizedBotMember, ResourceNotFoundException, RuntimeHintDetails, RuntimeHintValue, RuntimeHints, SentimentResponse, SentimentScore, SessionState, Slot, StartConversationRequest, StartConversationRequestEventStream, StartConversationResponse, StartConversationResponseEventStream, TextInputEvent, TextResponseEvent, ThrottlingException, TranscriptEvent, ValidationException, Value

Instance Attribute Summary collapse

Instance Attribute Details

#audio_chunk ⇒ String

A chunk of the audio to play.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 117

class AudioInputEvent < Struct.new(
  :audio_chunk,
  :content_type,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#caused_by_event_id ⇒ String

The identifier of the event that contained the audio, DTMF, or text that caused the interruption.

Returns:

  • (String) 


873
874
875
876
877
878
879
880
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 873

class PlaybackInterruptionEvent < Struct.new(
  :event_reason,
  :caused_by_event_id,
  :event_id,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#client_timestamp_millis ⇒ Integer

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

Returns:

  • (Integer) 


117
118
119
120
121
122
123
124
125
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 117

class AudioInputEvent < Struct.new(
  :audio_chunk,
  :content_type,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#content_type ⇒ String

The encoding of the audio chunk. This is the same as the encoding configure in the contentType field of the ConfigurationEvent.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 117

class AudioInputEvent < Struct.new(
  :audio_chunk,
  :content_type,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#disable_playback ⇒ Boolean

Determines whether Amazon Lex V2 should send audio responses to the client application.

Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.

Returns:

  • (Boolean) 


286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 286

class ConfigurationEvent < Struct.new(
  :request_attributes,
  :response_content_type,
  :session_state,
  :welcome_messages,
  :disable_playback,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_id ⇒ String

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

Returns:

  • (String) 


117
118
119
120
121
122
123
124
125
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 117

class AudioInputEvent < Struct.new(
  :audio_chunk,
  :content_type,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_reason ⇒ String

Indicates the type of user input that Amazon Lex V2 detected.

Returns:

  • (String) 


873
874
875
876
877
878
879
880
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 873

class PlaybackInterruptionEvent < Struct.new(
  :event_reason,
  :caused_by_event_id,
  :event_id,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#input_character ⇒ String

The DTMF character that the user pressed. The allowed characters are A - D, 0 - 9, # and *.

Returns:

  • (String) 


333
334
335
336
337
338
339
340
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 333

class DTMFInputEvent < Struct.new(
  :input_character,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = [:input_character]
  include Aws::Structure
end

#input_mode ⇒ String

Indicates whether the input to the operation was text, speech, or from a touch-tone keypad.

Returns:

  • (String) 


731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 731

class IntentResultEvent < Struct.new(
  :input_mode,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :event_id,
  :recognized_bot_member,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#interpretations ⇒ Array<Types::Interpretation>

A list of intents that Amazon Lex V2 determined might satisfy the user's utterance.

Each interpretation includes the intent, a score that indicates how confident Amazon Lex V2 is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.

Returns:



731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 731

class IntentResultEvent < Struct.new(
  :input_mode,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :event_id,
  :recognized_bot_member,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

Returns:

  • (String) 


18
19
20
21
22
23
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 18

class AccessDeniedException < Struct.new(
  :message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#messages ⇒ Array<Types::Message>

A list of messages to send to the user. Messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.

Returns:



1665
1666
1667
1668
1669
1670
1671
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1665

class TextResponseEvent < Struct.new(
  :messages,
  :event_id,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#recognized_bot_member ⇒ Types::RecognizedBotMember

The bot member that is processing the intent.

Returns:



731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 731

class IntentResultEvent < Struct.new(
  :input_mode,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :event_id,
  :recognized_bot_member,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#request_attributes ⇒ Hash<String,String>

The attributes sent in the request.

Returns:

  • (Hash<String,String>) 


286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 286

class ConfigurationEvent < Struct.new(
  :request_attributes,
  :response_content_type,
  :session_state,
  :welcome_messages,
  :disable_playback,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#response_content_type ⇒ String

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

  • If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

  • If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 returns speech in the MPEG format.

  • If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little-endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • audio/* (defaults to mpeg)

    • text/plain; charset=utf-8

Returns:

  • (String) 


286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 286

class ConfigurationEvent < Struct.new(
  :request_attributes,
  :response_content_type,
  :session_state,
  :welcome_messages,
  :disable_playback,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the session in use.

Returns:

  • (String) 


731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 731

class IntentResultEvent < Struct.new(
  :input_mode,
  :interpretations,
  :session_state,
  :request_attributes,
  :session_id,
  :event_id,
  :recognized_bot_member,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#session_state ⇒ Types::SessionState

The state of the user's session with Amazon Lex V2.

Returns:



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 286

class ConfigurationEvent < Struct.new(
  :request_attributes,
  :response_content_type,
  :session_state,
  :welcome_messages,
  :disable_playback,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#text ⇒ String

The text from the user. Amazon Lex V2 processes this as a complete statement.

Returns:

  • (String) 


1638
1639
1640
1641
1642
1643
1644
1645
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1638

class TextInputEvent < Struct.new(
  :text,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = [:text]
  include Aws::Structure
end

#transcript ⇒ String

The transcript of the voice audio from the user.

Returns:

  • (String) 


1701
1702
1703
1704
1705
1706
1707
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1701

class TranscriptEvent < Struct.new(
  :transcript,
  :event_id,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#welcome_messages ⇒ Array<Types::Message>

A list of messages to send to the user.

If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

Returns:



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 286

class ConfigurationEvent < Struct.new(
  :request_attributes,
  :response_content_type,
  :session_state,
  :welcome_messages,
  :disable_playback,
  :event_id,
  :client_timestamp_millis,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end