Skip to content

SessionSpecification

Source code in docs_src/capo_lex_models_v2/types/session_specification.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
class SessionSpecification(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 session was held with.</p>"""
    bot_version: NotRequired[
        "capo_lex_models_v2.types.numerical_bot_version.NumericalBotVersion"
    ]
    """<p>The version of the bot that the session was held with.</p>"""
    locale_id: NotRequired["capo_lex_models_v2.types.locale_id.LocaleId"]
    """<p>The locale of the bot that the session was held with.</p>"""
    channel: NotRequired["capo_lex_models_v2.types.analytics_channel.AnalyticsChannel"]
    """<p>The channel that is integrated with the bot that the session was held with.</p>"""
    session_id: NotRequired[
        "capo_lex_models_v2.types.analytics_session_id.AnalyticsSessionId"
    ]
    """<p>The identifier of the session.</p>"""
    conversation_start_time: NotRequired["capo_lex_models_v2.types.timestamp.Timestamp"]
    """<p>The date and time when the conversation 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 ended. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>"""
    conversation_duration_seconds: NotRequired[
        "capo_lex_models_v2.types.analytics_long_value.AnalyticsLongValue"
    ]
    """<p>The duration of the conversation in seconds. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</p>"""
    conversation_end_state: NotRequired[
        "capo_lex_models_v2.types.conversation_end_state.ConversationEndState"
    ]
    """<p>The final state of the conversation. A conversation is defined as a unique combination of a <code>sessionId</code> and an <code>originatingRequestId</code>.</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 was spoken.</p> </li> <li> <p> <code>Text</code> – The session was written.</p> </li> <li> <p> <code>DTMF</code> – The session used a touch-tone keypad (Dual Tone Multi-Frequency).</p> </li> <li> <p> <code>MultiMode</code> – The session used multiple modes.</p> </li> </ul>"""
    number_of_turns: NotRequired[
        "capo_lex_models_v2.types.analytics_long_value.AnalyticsLongValue"
    ]
    """<p>The number of turns that the session took.</p>"""
    invoked_intent_samples: NotRequired[
        "capo_lex_models_v2.types.invoked_intent_samples.InvokedIntentSamples"
    ]
    """<p>A list of objects containing the name of an intent that was invoked.</p>"""
    originating_request_id: NotRequired[
        "capo_lex_models_v2.types.analytics_originating_request_id.AnalyticsOriginatingRequestId"
    ]
    """<p>The identifier of the first request in a session.</p>"""

bot_alias_id instance-attribute 

bot_alias_id: NotRequired[BotAliasId]

The identifier of the alias of the bot that the session was held with.

bot_version instance-attribute 

bot_version: NotRequired[NumericalBotVersion]

The version of the bot that the session was held with.

channel instance-attribute 

channel: NotRequired[AnalyticsChannel]

The channel that is integrated with the bot that the session was held with.

conversation_duration_seconds instance-attribute 

conversation_duration_seconds: NotRequired[AnalyticsLongValue]

The duration of the conversation in seconds. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

conversation_end_state instance-attribute 

conversation_end_state: NotRequired[ConversationEndState]

The final state of the conversation. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

conversation_end_time instance-attribute 

conversation_end_time: NotRequired[Timestamp]

The date and time when the conversation ended. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

conversation_start_time instance-attribute 

conversation_start_time: NotRequired[Timestamp]

The date and time when the conversation began. A conversation is defined as a unique combination of a sessionId and an originatingRequestId.

invoked_intent_samples instance-attribute 

invoked_intent_samples: NotRequired[InvokedIntentSamples]

A list of objects containing the name of an intent that was invoked.

locale_id instance-attribute 

locale_id: NotRequired[LocaleId]

The locale of the bot that the session was held with.

mode instance-attribute 

mode: NotRequired[AnalyticsModality]

The mode of the session. The possible values are as follows:

  • Speech – The session was spoken.

  • Text – The session was written.

  • DTMF – The session used a touch-tone keypad (Dual Tone Multi-Frequency).

  • MultiMode – The session used multiple modes.

number_of_turns instance-attribute 

number_of_turns: NotRequired[AnalyticsLongValue]

The number of turns that the session took.

originating_request_id instance-attribute 

originating_request_id: NotRequired[AnalyticsOriginatingRequestId]

The identifier of the first request in a session.

session_id instance-attribute 

session_id: NotRequired[AnalyticsSessionId]

The identifier of the session.