QueryMetricsResponse

The response for querying metrics.

JSON representation 
{
  "location": string,
  "updateTime": string,
  "slices": [
    {
      object (Slice)
    }
  ],
  "macroAverageSlice": {
    object (Slice)
  }
}
Fields
location

string

Required. The location of the data. "projects/{project}/locations/{location}"
updateTime

string (Timestamp format)

The metrics last update time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
slices[]

object (Slice)

A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.
macroAverageSlice

object (Slice)

The macro average slice contains aggregated averages across the selected dimension. i.e. if group_by agent is specified this field will contain the average across all agents. This field is only populated if the request specifies a Dimension.

Slice

A slice contains a total and (if the request specified a time granularity) a time series of metric values. Each slice contains a unique combination of the cardinality of dimensions from the request.

For example, if the request specifies a single ISSUE dimension and it has a cardinality of 2 (i.e. the data used to compute the metrics has 2 issues in total), the response will have 2 slices:

  • Slice 1 -> dimensions=[Issue 1]
  • Slice 2 -> dimensions=[Issue 2]
JSON representation 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "total": {
    object (DataPoint)
  },
  "timeSeries": {
    object (TimeSeries)
  }
}
Fields
dimensions[]

object (Dimension)

A unique combination of dimensions that this slice represents.
total

object (DataPoint)

The total metric value. The interval of this data point is [starting create time, ending create time) from the request.
timeSeries

object (TimeSeries)

A time series of metric values. This is only populated if the request specifies a time granularity other than NONE.

DataPoint

A data point contains the metric values mapped to an interval.

JSON representation 
{
  "interval": {
    object (Interval)
  },

  // Union field measure can be only one of the following:
  "conversationMeasure": {
    object (ConversationMeasure)
  }
  // End of list of possible types for union field measure.
}
Fields
interval

object (Interval)

The interval that this data point represents.

  • If this is the total data point, the interval is [starting create time, ending create time) from the request.
  • If this a data point from the time series, the interval is [time, time + time granularity from the request).
Union field measure. The measure included in this data point. measure can be only one of the following:
conversationMeasure

object (ConversationMeasure)

The measure related to conversations.

ConversationMeasure

The measure related to conversations.

JSON representation 
{
  "qaTagScores": [
    {
      object (QaTagScore)
    }
  ],
  "conversationCount": integer,
  "averageSilencePercentage": number,
  "averageDuration": string,
  "averageTurnCount": number,
  "averageAgentSentimentScore": number,
  "averageClientSentimentScore": number,
  "averageCustomerSatisfactionRating": number,
  "averageQaNormalizedScore": number,
  "averageQaQuestionNormalizedScore": number,
  "knowledgeSearchResultCount": integer,
  "knowledgeSearchAgentQuerySourceRatio": number,
  "knowledgeSearchSuggestedQuerySourceRatio": number,
  "knowledgeAssistResultCount": integer,
  "knowledgeSearchUriClickRatio": number,
  "knowledgeAssistUriClickRatio": number,
  "knowledgeSearchPositiveFeedbackRatio": number,
  "knowledgeSearchNegativeFeedbackRatio": number,
  "knowledgeAssistPositiveFeedbackRatio": number,
  "knowledgeAssistNegativeFeedbackRatio": number,
  "summarizationSuggestionEditRatio": number,
  "averageSummarizationSuggestionEditDistance": number,
  "conversationSuggestedSummaryRatio": number
}
Fields
qaTagScores[]

object (QaTagScore)

Average QA normalized score for all the tags.
conversationCount

integer

The conversation count.
averageSilencePercentage

number

The average silence percentage.
averageDuration

string (Duration format)

The average duration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
averageTurnCount

number

The average turn count.
averageAgentSentimentScore

number

The average agent's sentiment score.
averageClientSentimentScore

number

The average client's sentiment score.
averageCustomerSatisfactionRating

number

The average customer satisfaction rating.
averageQaNormalizedScore

number

Average QA normalized score. Will exclude 0's in average calculation.
averageQaQuestionNormalizedScore

number

Average QA normalized score averaged for questions averaged across all revisions of the parent scorecard. Will be only populated if the request specifies a dimension of QA_QUESTION_ID.
knowledgeSearchResultCount

integer

Count of knowledge search results (Generative Knowledge Assist) shown to the user.
knowledgeSearchAgentQuerySourceRatio

number

Proportion of knowledge search (Generative Knowledge Assist) queries made by the agent compared to the total number of knowledge search queries made.
knowledgeSearchSuggestedQuerySourceRatio

number

Proportion of knowledge search (Generative Knowledge Assist) queries suggested compared to the total number of knowledge search queries made.
knowledgeAssistResultCount

integer

Count of knowledge assist results (Proactive Generative Knowledge Assist) shown to the user.
knowledgeSearchUriClickRatio

number

Proportion of knowledge search (Generative Knowledge Assist) queries that had a URL clicked.
knowledgeAssistUriClickRatio

number

Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had a URL clicked.
knowledgeSearchPositiveFeedbackRatio

number

Proportion of knowledge search (Generative Knowledge Assist) queries that had positive feedback.
knowledgeSearchNegativeFeedbackRatio

number

Proportion of knowledge search (Generative Knowledge Assist) queries that had negative feedback.
knowledgeAssistPositiveFeedbackRatio

number

Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had positive feedback.
knowledgeAssistNegativeFeedbackRatio

number

Proportion of knowledge assist (Proactive Generative Knowledge Assist) queries that had negative feedback.
summarizationSuggestionEditRatio

number

Proportion of summarization suggestions that were manually edited.
averageSummarizationSuggestionEditDistance

number

Average edit distance of the summarization suggestions. Edit distance (also called as levenshtein distance) is calculated by summing up number of insertions, deletions and substitutions required to transform the summization feedback to the original summary suggestion.
conversationSuggestedSummaryRatio

number

Proportion of conversations that had a suggested summary.

QaTagScore

Average QA normalized score for the tag.

JSON representation 
{
  "tag": string,
  "averageTagNormalizedScore": number
}
Fields
tag

string

Tag name.
averageTagNormalizedScore

number

Average tag normalized score per tag.

TimeSeries

A time series of metric values.

JSON representation 
{
  "dataPoints": [
    {
      object (DataPoint)
    }
  ]
}
Fields
dataPoints[]

object (DataPoint)

The data points that make up the time series .