/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace LexModelsV2 { namespace Model { /** *

Contains the metric and the summary statistic you want to calculate, and the * order in which to sort the results, for the intents in the bot.

See * Also:

AWS * API Reference

*/ class AnalyticsIntentMetric { public: AWS_LEXMODELSV2_API AnalyticsIntentMetric(); AWS_LEXMODELSV2_API AnalyticsIntentMetric(Aws::Utils::Json::JsonView jsonValue); AWS_LEXMODELSV2_API AnalyticsIntentMetric& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_LEXMODELSV2_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The metric for which you want to get intent summary statistics.

  • *

    Count – The number of times the intent was invoked.

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

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

    *
  • Switched – The number of times there was a switch to * a different intent.

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

*/ inline const AnalyticsIntentMetricName& GetName() const{ return m_name; } /** *

The metric for which you want to get intent summary statistics.

  • *

    Count – The number of times the intent was invoked.

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

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

    *
  • Switched – The number of times there was a switch to * a different intent.

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

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The metric for which you want to get intent summary statistics.

  • *

    Count – The number of times the intent was invoked.

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

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

    *
  • Switched – The number of times there was a switch to * a different intent.

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

*/ inline void SetName(const AnalyticsIntentMetricName& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The metric for which you want to get intent summary statistics.

  • *

    Count – The number of times the intent was invoked.

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

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

    *
  • Switched – The number of times there was a switch to * a different intent.

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

*/ inline void SetName(AnalyticsIntentMetricName&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The metric for which you want to get intent summary statistics.

  • *

    Count – The number of times the intent was invoked.

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

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

    *
  • Switched – The number of times there was a switch to * a different intent.

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

*/ inline AnalyticsIntentMetric& WithName(const AnalyticsIntentMetricName& value) { SetName(value); return *this;} /** *

The metric for which you want to get intent summary statistics.

  • *

    Count – The number of times the intent was invoked.

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

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

    *
  • Switched – The number of times there was a switch to * a different intent.

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

*/ inline AnalyticsIntentMetric& WithName(AnalyticsIntentMetricName&& value) { SetName(std::move(value)); return *this;} /** *

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 intents in * the category you provide in name.

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

*/ inline const AnalyticsMetricStatistic& GetStatistic() const{ return m_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 intents in * the category you provide in name.

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

*/ inline bool StatisticHasBeenSet() const { return m_statisticHasBeenSet; } /** *

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 intents in * the category you provide in name.

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

*/ inline void SetStatistic(const AnalyticsMetricStatistic& value) { m_statisticHasBeenSet = true; m_statistic = value; } /** *

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 intents in * the category you provide in name.

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

*/ inline void SetStatistic(AnalyticsMetricStatistic&& value) { m_statisticHasBeenSet = true; m_statistic = std::move(value); } /** *

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 intents in * the category you provide in name.

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

*/ inline AnalyticsIntentMetric& WithStatistic(const AnalyticsMetricStatistic& value) { SetStatistic(value); return *this;} /** *

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 intents in * the category you provide in name.

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

*/ inline AnalyticsIntentMetric& WithStatistic(AnalyticsMetricStatistic&& value) { SetStatistic(std::move(value)); return *this;} /** *

Specifies whether to sort the results in ascending or descending order.

*/ inline const AnalyticsSortOrder& GetOrder() const{ return m_order; } /** *

Specifies whether to sort the results in ascending or descending order.

*/ inline bool OrderHasBeenSet() const { return m_orderHasBeenSet; } /** *

Specifies whether to sort the results in ascending or descending order.

*/ inline void SetOrder(const AnalyticsSortOrder& value) { m_orderHasBeenSet = true; m_order = value; } /** *

Specifies whether to sort the results in ascending or descending order.

*/ inline void SetOrder(AnalyticsSortOrder&& value) { m_orderHasBeenSet = true; m_order = std::move(value); } /** *

Specifies whether to sort the results in ascending or descending order.

*/ inline AnalyticsIntentMetric& WithOrder(const AnalyticsSortOrder& value) { SetOrder(value); return *this;} /** *

Specifies whether to sort the results in ascending or descending order.

*/ inline AnalyticsIntentMetric& WithOrder(AnalyticsSortOrder&& value) { SetOrder(std::move(value)); return *this;} private: AnalyticsIntentMetricName m_name; bool m_nameHasBeenSet = false; AnalyticsMetricStatistic m_statistic; bool m_statisticHasBeenSet = false; AnalyticsSortOrder m_order; bool m_orderHasBeenSet = false; }; } // namespace Model } // namespace LexModelsV2 } // namespace Aws