Class: Aws::LexModelsV2::Types::ListIntentStageMetricsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bin_byArray<Types::AnalyticsBinBySpecification>

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



9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_idString

The identifier for the bot for which you want to retrieve intent stage metrics.

Returns:

  • (String)


9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#end_date_timeTime

The date and time that marks the end of the range of time for which you want to see intent stage metrics.

Returns:

  • (Time)


9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::AnalyticsIntentStageFilter>

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



9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#group_byArray<Types::AnalyticsIntentStageGroupBySpecification>

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

  • IntentStageName – The name of the intent stage.

  • SwitchedToIntent – The intent to which the conversation was switched (if any).



9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#metricsArray<Types::AnalyticsIntentStageMetric>

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.



9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If the response from the ListIntentStageMetrics 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 ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.

Returns:

  • (String)


9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_date_timeTime

The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.

Returns:

  • (Time)


9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9805

class ListIntentStageMetricsRequest < Struct.new(
  :bot_id,
  :start_date_time,
  :end_date_time,
  :metrics,
  :bin_by,
  :group_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end