Skip to content

StartConversationRequest

Source code in docs_src/capo_lex_runtime_v2/types/start_conversation_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class StartConversationRequest(TypedDict, closed=True):
    bot_id: "capo_lex_runtime_v2.types.bot_identifier.BotIdentifier"
    """<p>The identifier of the bot to process the request.</p>"""
    bot_alias_id: "capo_lex_runtime_v2.types.bot_alias_identifier.BotAliasIdentifier"
    """<p>The alias identifier in use for the bot that processes the request.</p>"""
    locale_id: "capo_lex_runtime_v2.types.locale_id.LocaleId"
    """<p>The locale where the session is in use.</p>"""
    session_id: "capo_lex_runtime_v2.types.session_id.SessionId"
    """<p>The identifier of the user session that is having the conversation.</p>"""
    conversation_mode: NotRequired[
        "capo_lex_runtime_v2.types.conversation_mode.ConversationMode"
    ]
    """<p>The conversation type that you are using the Amazon Lex V2. If the conversation mode is <code>AUDIO</code> you can send both audio and DTMF information. If the mode is <code>TEXT</code> you can only send text.</p>"""
    request_event_stream: "capo_lex_runtime_v2.types.start_conversation_request_event_stream.StartConversationRequestEventStream"
    """<p>Represents the stream of events to Amazon Lex V2 from your application. The events are encoded as HTTP/2 data frames.</p>"""

bot_alias_id instance-attribute 

bot_alias_id: BotAliasIdentifier

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

bot_id instance-attribute 

bot_id: BotIdentifier

The identifier of the bot to process the request.

conversation_mode instance-attribute 

conversation_mode: NotRequired[ConversationMode]

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.

locale_id instance-attribute 

locale_id: LocaleId

The locale where the session is in use.

request_event_stream instance-attribute 

request_event_stream: StartConversationRequestEventStream

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

session_id instance-attribute 

session_id: SessionId

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