UtteranceSpecification ¶

class UtteranceSpecification(TypedDict, closed=True):
    bot_alias_id: NotRequired["capo_lex_models_v2.types.bot_alias_id.BotAliasId"]
    """<p>The identifier of the alias of the bot that the utterance was made to.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.numerical_bot_version.NumericalBotVersion"
    ]
    """<p>The version of the bot that the utterance was made to.</p>"""
    locale_id: NotRequired["capo_lex_models_v2.types.locale_id.LocaleId"]
    """<p>The locale of the bot that the utterance was made to.</p>"""
    session_id: NotRequired[
        "capo_lex_models_v2.types.analytics_session_id.AnalyticsSessionId"
    ]
    """<p>The identifier of the session that the utterance was made in.</p>"""
    channel: NotRequired["capo_lex_models_v2.types.analytics_channel.AnalyticsChannel"]
    """<p>The channel that is integrated with the bot that the utterance was made to.</p>"""
    mode: NotRequired["capo_lex_models_v2.types.analytics_modality.AnalyticsModality"]
    """<p>The mode of the session. The possible values are as follows:</p> <ul> <li> <p> <code>Speech</code> – The session consisted of spoken dialogue.</p> </li> <li> <p> <code>Text</code> – The session consisted of written dialogue.</p> </li> <li> <p> <code>DTMF</code> – The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses.</p> </li> <li> <p> <code>MultiMode</code> – The session consisted of multiple modes.</p> </li> </ul>"""
    conversation_start_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>"""
    conversation_end_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>"""
    utterance: NotRequired["capo_lex_models_v2.types.string.String"]
    """<p>The text of the utterance.</p>"""
    utterance_timestamp: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the utterance took place.</p>"""
    audio_voice_duration_millis: NotRequired[
        "capo_lex_models_v2.types.analytics_long_value.AnalyticsLongValue"
    ]
    """<p>The duration in milliseconds of the audio associated with the utterance.</p>"""
    utterance_understood: (
        "capo_lex_models_v2.types.utterance_understood.UtteranceUnderstood"
    )
    """<p>Specifies whether the bot understood the utterance or not.</p>"""
    input_type: NotRequired["capo_lex_models_v2.types.string.String"]
    """<p>The input type of the utterance. The possible values are as follows:</p> <ul> <li> <p>PCM format: audio data must be in little-endian byte order.</p> <ul> <li> <p> <code>audio/l16; rate=16000; channels=1</code> </p> </li> <li> <p> <code>audio/x-l16; sample-rate=16000; channel-count=1</code> </p> </li> <li> <p> <code>audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false</code> </p> </li> </ul> </li> <li> <p>Opus format</p> <ul> <li> <p> <code>audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4</code> </p> </li> </ul> </li> <li> <p>Text format</p> <ul> <li> <p> <code>text/plain; charset=utf-8</code> </p> </li> </ul> </li> </ul>"""
    output_type: NotRequired["capo_lex_models_v2.types.string.String"]
    """<p>The output type of the utterance. The possible values are as follows:</p> <ul> <li> <p> <code>audio/mpeg</code> </p> </li> <li> <p> <code>audio/ogg</code> </p> </li> <li> <p> <code>audio/pcm (16 KHz)</code> </p> </li> <li> <p> <code>audio/</code> (defaults to <code>mpeg</code>)</p> </li> <li> <p> <code>text/plain; charset=utf-8</code> </p> </li> </ul>"""
    associated_intent_name: NotRequired["capo_lex_models_v2.types.name.Name"]
    """<p>The name of the intent that the utterance is associated to.</p>"""
    associated_slot_name: NotRequired["capo_lex_models_v2.types.name.Name"]
    """<p>The name of the slot that the utterance is associated to.</p>"""
    intent_state: NotRequired["capo_lex_models_v2.types.intent_state.IntentState"]
    """<p>The state of the intent that the utterance is associated to.</p>"""
    dialog_action_type: NotRequired["capo_lex_models_v2.types.string.String"]
    """<p>The type of dialog action that the utterance is associated to. See the <code>type</code> field in <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html">DialogAction</a> for more information.</p>"""
    bot_response_audio_voice_id: NotRequired["capo_lex_models_v2.types.string.String"]
    """<p>The identifier for the audio of the bot response.</p>"""
    slots_filled_in_session: NotRequired["capo_lex_models_v2.types.string.String"]
    """<p>The slots that have been filled in the session by the time of the utterance.</p>"""
    utterance_request_id: NotRequired["capo_lex_models_v2.types.id.Id"]
    """<p>The identifier of the request associated with the utterance.</p>"""
    bot_responses: NotRequired[
        "capo_lex_models_v2.types.utterance_bot_responses.UtteranceBotResponses"
    ]
    """<p>A list of objects containing information about the bot response to the utterance.</p>"""