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, GetSessionRequest, GetSessionResponse, HeartbeatEvent, ImageResponseCard, Intent, IntentResultEvent, InternalServerException, Interpretation, Message, PlaybackCompletionEvent, PlaybackInterruptionEvent, PutSessionRequest, PutSessionResponse, RecognizeTextRequest, RecognizeTextResponse, RecognizeUtteranceRequest, RecognizeUtteranceResponse, ResourceNotFoundException, SentimentResponse, SentimentScore, SessionState, Slot, StartConversationRequest, StartConversationRequestEventStream, StartConversationResponse, StartConversationResponseEventStream, TextInputEvent, TextResponseEvent, ThrottlingException, TranscriptEvent, ValidationException, Value

Instance Attribute Summary collapse

Instance Attribute Details

#audio_chunkString

A chunk of the audio to play.

Returns:

  • (String)


149
150
151
152
153
154
155
156
157
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 149

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

#caused_by_event_idString

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

Returns:

  • (String)


1032
1033
1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1032

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

#client_timestamp_millisInteger

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

Returns:

  • (Integer)


149
150
151
152
153
154
155
156
157
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 149

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

#content_typeString

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

Returns:

  • (String)


149
150
151
152
153
154
155
156
157
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 149

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

#disable_playbackBoolean

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)


391
392
393
394
395
396
397
398
399
400
401
402
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 391

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_idString

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)


149
150
151
152
153
154
155
156
157
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 149

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

#event_reasonString

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

Returns:

  • (String)


1032
1033
1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1032

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

#input_characterString

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

Returns:

  • (String)


447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 447

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

#input_modeString

Indicates whether the input to the operation was text or speech.

Returns:

  • (String)


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

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

#interpretationsArray<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:



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

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

#messageString

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

#messagesArray<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:



1940
1941
1942
1943
1944
1945
1946
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1940

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

#request_attributesHash<String,String>

The attributes sent in the request.

Returns:

  • (Hash<String,String>)


391
392
393
394
395
396
397
398
399
400
401
402
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 391

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_typeString

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)


391
392
393
394
395
396
397
398
399
400
401
402
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 391

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_idString

The identifier of the session in use.

Returns:

  • (String)


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

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

#session_stateTypes::SessionState

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

Returns:



391
392
393
394
395
396
397
398
399
400
401
402
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 391

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

#textString

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

Returns:

  • (String)


1913
1914
1915
1916
1917
1918
1919
1920
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1913

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

#transcriptString

The transcript of the voice audio from the user.

Returns:

  • (String)


1976
1977
1978
1979
1980
1981
1982
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 1976

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

#welcome_messagesArray<Types::Message>

A list of messages to send to the user.

Returns:



391
392
393
394
395
396
397
398
399
400
401
402
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 391

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