Skip to content

AnalyticsIntentMetric

Source code in docs_src/capo_lex_models_v2/types/analytics_intent_metric.py
class AnalyticsIntentMetric(TypedDict, closed=True):
    name: "capo_lex_models_v2.types.analytics_intent_metric_name.AnalyticsIntentMetricName"
    """<p>The metric for which you want to get intent summary statistics.</p> <ul> <li> <p> <code>Count</code> – The number of times the intent was invoked.</p> </li> <li> <p> <code>Success</code> – The number of times the intent succeeded.</p> </li> <li> <p> <code>Failure</code> – The number of times the intent failed.</p> </li> <li> <p> <code>Switched</code> – The number of times there was a switch to a different intent.</p> </li> <li> <p> <code>Dropped</code> – The number of times the user dropped the intent.</p> </li> </ul>"""
    statistic: (
        "capo_lex_models_v2.types.analytics_metric_statistic.AnalyticsMetricStatistic"
    )
    """<p>The summary statistic to calculate.</p> <ul> <li> <p> <code>Sum</code> – The total count for the category you provide in <code>name</code>.</p> </li> <li> <p> <code>Average</code> – The total count divided by the number of intents in the category you provide in <code>name</code>.</p> </li> <li> <p> <code>Max</code> – The highest count in the category you provide in <code>name</code>.</p> </li> </ul>"""
    order: NotRequired[
        "capo_lex_models_v2.types.analytics_sort_order.AnalyticsSortOrder"
    ]
    """<p>Specifies whether to sort the results in ascending or descending order.</p>"""

name instance-attribute

The metric for which you want to get intent summary statistics.

  • Count – The number of times the intent was invoked.

  • Success – The number of times the intent succeeded.

  • Failure – The number of times the intent failed.

  • Switched – The number of times there was a switch to a different intent.

  • Dropped – The number of times the user dropped the intent.

order instance-attribute

order: NotRequired[AnalyticsSortOrder]

Specifies whether to sort the results in ascending or descending order.

statistic instance-attribute

The summary statistic to calculate.

  • Sum – The total count for the category you provide in name.

  • Average – The total count divided by the number of intents in the category you provide in name.

  • Max – The highest count in the category you provide in name.