Skip to content

AnalyticsUtteranceMetricResult

Source code in docs_src/capo_lex_models_v2/types/analytics_utterance_metric_result.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class AnalyticsUtteranceMetricResult(TypedDict, closed=True):
    name: NotRequired[
        "capo_lex_models_v2.types.analytics_utterance_metric_name.AnalyticsUtteranceMetricName"
    ]
    """<p>The metric that you requested.</p> <ul> <li> <p> <code>Count</code> – The number of utterances.</p> </li> <li> <p> <code>Missed</code> – The number of utterances that Amazon Lex failed to recognize.</p> </li> <li> <p> <code>Detected</code> – The number of utterances that Amazon Lex managed to detect.</p> </li> <li> <p> <code>UtteranceTimestamp</code> – The date and time of the utterance.</p> </li> </ul>"""
    statistic: NotRequired[
        "capo_lex_models_v2.types.analytics_metric_statistic.AnalyticsMetricStatistic"
    ]
    """<p>The summary 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 utterances 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[AnalyticsUtteranceMetricName]

The metric that you requested.

  • Count – The number of utterances.

  • Missed – The number of utterances that Amazon Lex failed to recognize.

  • Detected – The number of utterances that Amazon Lex managed to detect.

  • UtteranceTimestamp – The date and time of the utterance.

statistic instance-attribute 

statistic: NotRequired[AnalyticsMetricStatistic]

The summary 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 utterances 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.