Skip to content

AnalyticsIntentMetricResult

Source code in docs_src/capo_lex_models_v2/types/analytics_intent_metric_result.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class AnalyticsIntentMetricResult(TypedDict, closed=True):
    name: NotRequired[
        "capo_lex_models_v2.types.analytics_intent_metric_name.AnalyticsIntentMetricName"
    ]
    """<p>The metric that you requested. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html">Key definitions</a> for more details about these metrics.</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: NotRequired[
        "capo_lex_models_v2.types.analytics_metric_statistic.AnalyticsMetricStatistic"
    ]
    """<p>The statistic that you requested 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>"""
    value: NotRequired[
        "capo_lex_models_v2.types.analytics_metric_value.AnalyticsMetricValue"
    ]
    """<p>The value of the summary statistic for the metric that you requested.</p>"""

name instance-attribute 

name: NotRequired[AnalyticsIntentMetricName]

The metric that you requested. See Key definitions for more details about these metrics.

  • 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.

statistic instance-attribute 

statistic: NotRequired[AnalyticsMetricStatistic]

The statistic that you requested 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.

value instance-attribute 

value: NotRequired[AnalyticsMetricValue]

The value of the summary statistic for the metric that you requested.