list_utterance_metrics ¶

def list_utterance_metrics(
    self,
    bot_id: "capo_lex_models_v2.types.id.Id",
    start_date_time: "capo_lex_models_v2.types.timestamp.Timestamp",
    end_date_time: "capo_lex_models_v2.types.timestamp.Timestamp",
    metrics: "capo_lex_models_v2.types.analytics_utterance_metrics.AnalyticsUtteranceMetrics",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
    bin_by: Optional[
        "capo_lex_models_v2.types.analytics_bin_by_list.AnalyticsBinByList"
    ] = None,
    group_by: Optional[
        "capo_lex_models_v2.types.analytics_utterance_group_by_list.AnalyticsUtteranceGroupByList"
    ] = None,
    attributes: Optional[
        "capo_lex_models_v2.types.analytics_utterance_attributes.AnalyticsUtteranceAttributes"
    ] = None,
    filters: Optional[
        "capo_lex_models_v2.types.analytics_utterance_filters.AnalyticsUtteranceFilters"
    ] = None,
    max_results: Optional["capo_lex_models_v2.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_lex_models_v2.types.next_token.NextToken"] = None,
) -> "capo_lex_models_v2.types.list_utterance_metrics_response.ListUtteranceMetricsResponse":
    """<note> <p>To use this API operation, your IAM role must have permissions to perform the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html">ListAggregatedUtterances</a> operation, which provides access to utterance-related analytics. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html">Viewing utterance statistics</a> for the IAM policy to apply to the IAM role.</p> </note> <p>Retrieves summary metrics for the utterances in your bot. The following fields are required:</p> <ul> <li> <p> <code>metrics</code> – A list of <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html">AnalyticsUtteranceMetric</a> objects. In each object, use the <code>name</code> field to specify the metric to calculate, the <code>statistic</code> field to specify whether to calculate the <code>Sum</code>, <code>Average</code>, or <code>Max</code> number, and the <code>order</code> field to specify whether to sort the results in <code>Ascending</code> or <code>Descending</code> order.</p> </li> <li> <p> <code>startDateTime</code> and <code>endDateTime</code> – Define a time range for which you want to retrieve results.</p> </li> </ul> <p>Of the optional fields, you can organize the results in the following ways:</p> <ul> <li> <p>Use the <code>filters</code> field to filter the results, the <code>groupBy</code> field to specify categories by which to group the results, and the <code>binBy</code> field to specify time intervals by which to group the results.</p> </li> <li> <p>Use the <code>maxResults</code> field to limit the number of results to return in a single response and the <code>nextToken</code> field to return the next batch of results if the response does not return the full set of results.</p> </li> </ul> <p>Note that an <code>order</code> field exists in both <code>binBy</code> and <code>metrics</code>. Currently, you can specify it in either field, but not in both.</p>

    Args:
        bot_id: <p>The identifier for the bot for which you want to retrieve utterance metrics.</p>
        start_date_time: <p>The date and time that marks the beginning of the range of time for which you want to see utterance metrics.</p>
        end_date_time: <p>The date and time that marks the end of the range of time for which you want to see utterance metrics.</p>
        metrics: <p>A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.</p>
        bin_by: <p>A list of objects, each of which contains specifications for organizing the results by time.</p>
        group_by: <p>A list of objects, each of which specifies how to group the results. You can group by the following criteria:</p> <ul> <li> <p> <code>UtteranceText</code> – The transcription of the utterance.</p> </li> <li> <p> <code>UtteranceState</code> – The state of the utterance. The possible states are detailed in <a href="https://docs.aws.amazon.com/analytics-key-definitions-utterances">Key definitions</a> in the user guide.</p> </li> </ul>
        attributes: <p>A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:</p> <ul> <li> <p> <code>LastUsedIntent</code> – The last used intent at the time of the utterance.</p> </li> </ul>
        filters: <p>A list of objects, each of which describes a condition by which you want to filter the results.</p>
        max_results: <p>The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.</p>
        next_token: <p>If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.</p> <p>Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.</p>

    Raises:
        capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
        capo_lex_models_v2.errors.precondition_failed_exception.PreconditionFailedException: <p>Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.</p>
        capo_lex_models_v2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have reached a quota for your bot. </p>
        capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
        capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
        capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lex_models_v2.types.list_utterance_metrics_request.ListUtteranceMetricsRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.list_utterance_metrics_response.ListUtteranceMetricsResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.list_utterance_metrics

        output, http_response = (
            capo_lex_models_v2._operations.lex_model_building_service_v2.list_utterance_metrics.list_utterance_metrics(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListUtteranceMetrics")
    )
    input_: capo_lex_models_v2.types.list_utterance_metrics_request.ListUtteranceMetricsRequest = {
        "bot_id": bot_id,
        "start_date_time": start_date_time,
        "end_date_time": end_date_time,
        "metrics": metrics,
    }
    if bin_by is not None:
        input_["bin_by"] = bin_by
    if group_by is not None:
        input_["group_by"] = group_by
    if attributes is not None:
        input_["attributes"] = attributes
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output