Skip to content

RecognizeTextRequest

Source code in docs_src/capo_lex_runtime_v2/types/recognize_text_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class RecognizeTextRequest(TypedDict, closed=True):
    bot_id: "capo_lex_runtime_v2.types.bot_identifier.BotIdentifier"
    """<p>The identifier of the bot that processes 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>"""
    text: "capo_lex_runtime_v2.types.text.Text"
    """<p>The text that the user entered. Amazon Lex V2 interprets this text.</p>"""
    session_state: NotRequired["capo_lex_runtime_v2.types.session_state.SessionState"]
    """<p>The current state of the dialog between the user and the bot.</p>"""
    request_attributes: NotRequired["capo_lex_runtime_v2.types.string_map.StringMap"]
    """<p>Request-specific information passed between the client application and Amazon Lex V2 </p> <p>The namespace <code>x-amz-lex:</code> is reserved for special attributes. Don't create any request attributes with the prefix <code>x-amz-lex:</code>.</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 that processes the request.

locale_id instance-attribute 

locale_id: LocaleId

The locale where the session is in use.

request_attributes instance-attribute 

request_attributes: NotRequired[StringMap]

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 with the prefix x-amz-lex:.

session_id instance-attribute 

session_id: SessionId

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

session_state instance-attribute 

session_state: NotRequired[SessionState]

The current state of the dialog between the user and the bot.

text instance-attribute 

text: Text

The text that the user entered. Amazon Lex V2 interprets this text.