Class: Aws::LexModelsV2::Types::ListAggregatedUtterancesResponse

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::ListAggregatedUtterancesResponse

Defined in:

gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregated_utterances_summaries ⇒ Array<Types::AggregatedUtterancesSummary>

  Summaries of the aggregated utterance data.

• #aggregation_duration ⇒ Types::UtteranceAggregationDuration

  The time period used to aggregate the utterance data.

• #aggregation_last_refreshed_date_time ⇒ Time

  The last date and time that the aggregated data was collected.

• #aggregation_window_end_time ⇒ Time

  The date and time that the aggregation window ends.

• #aggregation_window_start_time ⇒ Time

  The date and time that the aggregation window begins.

• #bot_alias_id ⇒ String

  The identifier of the bot alias that contains the utterances.

• #bot_id ⇒ String

  The identifier of the bot that contains the utterances.

• #bot_version ⇒ String

  The identifier of the bot version that contains the utterances.

• #locale_id ⇒ String

  The identifier of the language and locale that the utterances are in.

• #next_token ⇒ String

  A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation.

Instance Attribute Details

#aggregated_utterances_summaries ⇒ Array<Types::AggregatedUtterancesSummary>

Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.

Returns:

• (Array<Types::AggregatedUtterancesSummary>)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_duration ⇒ Types::UtteranceAggregationDuration

The time period used to aggregate the utterance data.

Returns:

• (Types::UtteranceAggregationDuration)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_last_refreshed_date_time ⇒ Time

The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.

• Hours - for 1 hour time window, every half hour; otherwise every hour.

• Days - every 6 hours

• Weeks - for a one week time window, every 12 hours; otherwise, every day

Returns:

• (Time)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_window_end_time ⇒ Time

The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.

Returns:

• (Time)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_window_start_time ⇒ Time

The date and time that the aggregation window begins. Only data collected after this time is returned in the results.

Returns:

• (Time)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_alias_id ⇒ String

The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_id ⇒ String

The identifier of the bot that contains the utterances.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_version ⇒ String

The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#locale_id ⇒ String

The identifier of the language and locale that the utterances are in.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9214

class ListAggregatedUtterancesResponse < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :aggregation_window_start_time,
  :aggregation_window_end_time,
  :aggregation_last_refreshed_date_time,
  :aggregated_utterances_summaries,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end