List Utterance Metrics

lexmodelsv2_list_utterance_metrics

R Documentation

To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics

Description

To use this API operation, your IAM role must have permissions to perform the list_aggregated_utterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.

Retrieves summary metrics for the utterances in your bot. The following fields are required:

• metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order.

• startDateTime and endDateTime – Define a time range for which you want to retrieve results.

Of the optional fields, you can organize the results in the following ways:

• Use the filters field to filter the results, the groupBy field to specify categories by which to group the results, and the binBy field to specify time intervals by which to group the results.

• Use the maxResults field to limit the number of results to return in a single response and the nextToken field to return the next batch of results if the response does not return the full set of results.

Note that an order field exists in both binBy and metrics. Currently, you can specify it in either field, but not in both.

Usage

lexmodelsv2_list_utterance_metrics(botId, startDateTime, endDateTime,
  metrics, binBy, groupBy, attributes, filters, maxResults, nextToken)

Arguments

botId

[required] The identifier for the bot for which you want to retrieve utterance metrics.

startDateTime

[required] The date and time that marks the beginning of the range of time for which you want to see utterance metrics.

endDateTime

[required] The date and time that marks the end of the range of time for which you want to see utterance metrics.

metrics

[required] 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.

binBy

A list of objects, each of which contains specifications for organizing the results by time.

groupBy

A list of objects, each of which specifies how to group the results. You can group by the following criteria:

• UtteranceText – The transcription of the utterance.

• UtteranceState – The state of the utterance. The possible states are detailed in Key definitions in the user guide.

attributes

A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:

• LastUsedIntent – The last used intent at the time of the utterance.

filters

A list of objects, each of which describes a condition by which you want to filter the results.

maxResults

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.

nextToken

If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.

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.

Value

A list with the following syntax:

list(
  botId = "string",
  results = list(
    list(
      binKeys = list(
        list(
          name = "ConversationStartTime"|"UtteranceTimestamp",
          value = 123
        )
      ),
      groupByKeys = list(
        list(
          name = "UtteranceText"|"UtteranceState",
          value = "string"
        )
      ),
      metricsResults = list(
        list(
          name = "Count"|"Missed"|"Detected"|"UtteranceTimestamp",
          statistic = "Sum"|"Avg"|"Max",
          value = 123.0
        )
      ),
      attributeResults = list(
        list(
          lastUsedIntent = "string"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_utterance_metrics(
  botId = "string",
  startDateTime = as.POSIXct(
    "2015-01-01"
  ),
  endDateTime = as.POSIXct(
    "2015-01-01"
  ),
  metrics = list(
    list(
      name = "Count"|"Missed"|"Detected"|"UtteranceTimestamp",
      statistic = "Sum"|"Avg"|"Max",
      order = "Ascending"|"Descending"
    )
  ),
  binBy = list(
    list(
      name = "ConversationStartTime"|"UtteranceTimestamp",
      interval = "OneHour"|"OneDay",
      order = "Ascending"|"Descending"
    )
  ),
  groupBy = list(
    list(
      name = "UtteranceText"|"UtteranceState"
    )
  ),
  attributes = list(
    list(
      name = "LastUsedIntent"
    )
  ),
  filters = list(
    list(
      name = "BotAliasId"|"BotVersion"|"LocaleId"|"Modality"|"Channel"|"SessionId"|"OriginatingRequestId"|"UtteranceState"|"UtteranceText",
      operator = "EQ"|"GT"|"LT",
      values = list(
        "string"
      )
    )
  ),
  maxResults = 123,
  nextToken = "string"
)