Skip to content

UtteranceBotResponse

Source code in docs_src/capo_lex_models_v2/types/utterance_bot_response.py 
13
14
15
16
17
18
19
20
21
22
class UtteranceBotResponse(TypedDict, closed=True):
    content: NotRequired["capo_lex_models_v2.types.string.String"]
    """<p>The text of the response to the utterance from the bot.</p>"""
    content_type: NotRequired[
        "capo_lex_models_v2.types.utterance_content_type.UtteranceContentType"
    ]
    """<p>The type of the response. The following values are possible:</p> <ul> <li> <p> <code>PlainText</code> – A plain text string.</p> </li> <li> <p> <code>CustomPayload</code> – A response string that you can customize to include data or metadata for your application.</p> </li> <li> <p> <code>SSML</code> – A string that includes Speech Synthesis Markup Language to customize the audio response.</p> </li> <li> <p> <code>ImageResponseCard</code> – An image with buttons that the customer can select. See <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html">ImageResponseCard</a> for more information.</p> </li> </ul>"""
    image_response_card: NotRequired[
        "capo_lex_models_v2.types.image_response_card.ImageResponseCard"
    ]

content instance-attribute 

content: NotRequired[String]

The text of the response to the utterance from the bot.

content_type instance-attribute 

content_type: NotRequired[UtteranceContentType]

The type of the response. The following values are possible:

  • PlainText – A plain text string.

  • CustomPayload – A response string that you can customize to include data or metadata for your application.

  • SSML – A string that includes Speech Synthesis Markup Language to customize the audio response.

  • ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.

image_response_card instance-attribute 

image_response_card: NotRequired[ImageResponseCard]