Interface AnalyticsIntentStageMetric.Builder

    • Method Detail

      • name

        AnalyticsIntentStageMetric.Builder name​(String name)

        The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.

        • Count – The number of times the intent stage occurred.

        • Success – The number of times the intent stage succeeded.

        • Failure – The number of times the intent stage failed.

        • Dropped – The number of times the user dropped the intent stage.

        • Retry – The number of times the bot tried to elicit a response from the user at this stage.

        Parameters:
        name - The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.

        • Count – The number of times the intent stage occurred.

        • Success – The number of times the intent stage succeeded.

        • Failure – The number of times the intent stage failed.

        • Dropped – The number of times the user dropped the intent stage.

        • Retry – The number of times the bot tried to elicit a response from the user at this stage.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalyticsIntentStageMetricName, AnalyticsIntentStageMetricName
      • name

        AnalyticsIntentStageMetric.Builder name​(AnalyticsIntentStageMetricName name)

        The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.

        • Count – The number of times the intent stage occurred.

        • Success – The number of times the intent stage succeeded.

        • Failure – The number of times the intent stage failed.

        • Dropped – The number of times the user dropped the intent stage.

        • Retry – The number of times the bot tried to elicit a response from the user at this stage.

        Parameters:
        name - The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.

        • Count – The number of times the intent stage occurred.

        • Success – The number of times the intent stage succeeded.

        • Failure – The number of times the intent stage failed.

        • Dropped – The number of times the user dropped the intent stage.

        • Retry – The number of times the bot tried to elicit a response from the user at this stage.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalyticsIntentStageMetricName, AnalyticsIntentStageMetricName
      • statistic

        AnalyticsIntentStageMetric.Builder statistic​(String statistic)

        The summary statistic to calculate.

        • Sum – The total count for the category you provide in name.

        • Average – The total count divided by the number of intent stages in the category you provide in name.

        • Max – The highest count in the category you provide in name.

        Parameters:
        statistic - The summary statistic to calculate.

        • Sum – The total count for the category you provide in name.

        • Average – The total count divided by the number of intent stages in the category you provide in name.

        • Max – The highest count in the category you provide in name.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalyticsMetricStatistic, AnalyticsMetricStatistic
      • statistic

        AnalyticsIntentStageMetric.Builder statistic​(AnalyticsMetricStatistic statistic)

        The summary statistic to calculate.

        • Sum – The total count for the category you provide in name.

        • Average – The total count divided by the number of intent stages in the category you provide in name.

        • Max – The highest count in the category you provide in name.

        Parameters:
        statistic - The summary statistic to calculate.

        • Sum – The total count for the category you provide in name.

        • Average – The total count divided by the number of intent stages in the category you provide in name.

        • Max – The highest count in the category you provide in name.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalyticsMetricStatistic, AnalyticsMetricStatistic
      • order

        AnalyticsIntentStageMetric.Builder order​(String order)

        Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).

        Parameters:
        order - Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalyticsSortOrder, AnalyticsSortOrder
      • order

        AnalyticsIntentStageMetric.Builder order​(AnalyticsSortOrder order)

        Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).

        Parameters:
        order - Specifies whether to sort the results in ascending or descending order of the summary statistic ( value in the response).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalyticsSortOrder, AnalyticsSortOrder