Class: Aws::LexRuntimeV2::Types::StartConversationRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_alias_id ⇒ String

The alias identifier in use for the bot that processes the request.

Returns:

  • (String) 


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1594

class StartConversationRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :conversation_mode,
  :request_event_stream)
  SENSITIVE = []
  include Aws::Structure
end

#bot_id ⇒ String

The identifier of the bot to process the request.

Returns:

  • (String) 


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1594

class StartConversationRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :conversation_mode,
  :request_event_stream)
  SENSITIVE = []
  include Aws::Structure
end

#conversation_mode ⇒ String

The conversation type that you are using the Amazon Lex V2. If the conversation mode is ‘AUDIO` you can send both audio and DTMF information. If the mode is `TEXT` you can only send text.

Returns:

  • (String) 


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1594

class StartConversationRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :conversation_mode,
  :request_event_stream)
  SENSITIVE = []
  include Aws::Structure
end

#locale_id ⇒ String

The locale where the session is in use.

Returns:

  • (String) 


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1594

class StartConversationRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :conversation_mode,
  :request_event_stream)
  SENSITIVE = []
  include Aws::Structure
end

#request_event_stream ⇒ Types::StartConversationRequestEventStream

Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1594

class StartConversationRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :conversation_mode,
  :request_event_stream)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the user session that is having the conversation.

Returns:

  • (String) 


1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/aws-sdk-lexruntimev2/types.rb', line 1594

class StartConversationRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :locale_id,
  :session_id,
  :conversation_mode,
  :request_event_stream)
  SENSITIVE = []
  include Aws::Structure
end