Class: Aws::LexRuntimeV2::Types::ConfigurationEvent

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lexruntimev2/types.rb

Overview

The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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) 


286
287
288
289
290
291
292
293
294
295
296
297
 
# File '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

#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 '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 that your application assigns to the event. You can use this to identify events in logs.

Returns:

  • (String) 


286
287
288
289
290
291
292
293
294
295
296
297
 
# File '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_type ⇒ Object

Returns the value of attribute event_type

Returns:

  • (Object) —

    the current value of event_type



286
287
288
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 286

def event_type
  @event_type
end

#request_attributes ⇒ Hash<String,String>

Request-specific information passed between the client application and Amazon Lex V2.

The namespace ‘x-amz-lex:` is reserved for special attributes. Don’t create any request attributes for prefix ‘x-amz-lex:`.

Returns:

  • (Hash<String,String>) 


286
287
288
289
290
291
292
293
294
295
296
297
 
# File '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 '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_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 '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

#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` ][1] structure’s [ ‘type` ][2] field.

[1]: docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html [2]: docs.aws.amazon.com/lexv2/latest/dg/API_runtime_DialogAction.html#lexv2-Type-runtime_DialogAction-type

Returns:



286
287
288
289
290
291
292
293
294
295
296
297
 
# File '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