Class: Aws::LexModelsV2::Types::ListAggregatedUtterancesRequest

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

Overview

Note:

When making an API call, you may pass ListAggregatedUtterancesRequest data as a hash:

{
  bot_id: "Id", # required
  bot_alias_id: "BotAliasId",
  bot_version: "BotVersion",
  locale_id: "LocaleId", # required
  aggregation_duration: { # required
    relative_aggregation_duration: { # required
      time_dimension: "Hours", # required, accepts Hours, Days, Weeks
      time_value: 1, # required
    },
  },
  sort_by: {
    attribute: "HitCount", # required, accepts HitCount, MissedCount
    order: "Ascending", # required, accepts Ascending, Descending
  },
  filters: [
    {
      name: "Utterance", # required, accepts Utterance
      values: ["FilterValue"], # required
      operator: "CO", # required, accepts CO, EQ
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation_durationTypes::UtteranceAggregationDuration

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.



6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_alias_idString

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

Returns:

  • (String)


6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_idString

The unique identifier of the bot associated with this request.

Returns:

  • (String)


6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#bot_versionString

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

Returns:

  • (String)


6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::AggregatedUtterancesFilter>

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.



6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#locale_idString

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

Returns:

  • (String)


6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of utterances 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. If you don't specify the maxResults parameter, 1,000 results are returned.

Returns:

  • (Integer)


6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Returns:

  • (String)


6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_byTypes::AggregatedUtterancesSortBy

Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.



6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 6527

class ListAggregatedUtterancesRequest < Struct.new(
  :bot_id,
  :bot_alias_id,
  :bot_version,
  :locale_id,
  :aggregation_duration,
  :sort_by,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end