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

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::ListAggregatedUtterancesRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregation_duration ⇒ Types::UtteranceAggregationDuration

  The time window for aggregating the utterance information.

• #bot_alias_id ⇒ String

  The identifier of the bot alias associated with this request.

• #bot_id ⇒ String

  The unique identifier of the bot associated with this request.

• #bot_version ⇒ String

  The identifier of the bot version associated with this request.

• #filters ⇒ Array<Types::AggregatedUtterancesFilter>

  Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification.

• #locale_id ⇒ String

  The identifier of the language and locale where the utterances were collected.

• #max_results ⇒ Integer

  The maximum number of utterances to return in each page of results.

• #next_token ⇒ String

  If the response from the ListAggregatedUtterances operation contains more results that specified in the maxResults parameter, a token is returned in the response.

• #sort_by ⇒ Types::AggregatedUtterancesSortBy

  Specifies sorting parameters for the list of utterances.

Instance Attribute Details

#aggregation_duration ⇒ Types::UtteranceAggregationDuration

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

Returns:

• (Types::UtteranceAggregationDuration)

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

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_id ⇒ String

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)

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

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_id ⇒ String

The unique identifier of the bot associated with this request.

Returns:

• (String)

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

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_version ⇒ String

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)

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

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

#filters ⇒ Array<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.

Returns:

• (Array<Types::AggregatedUtterancesFilter>)

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

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_id ⇒ String

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

Returns:

• (String)

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

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_results ⇒ Integer

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)

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

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_token ⇒ String

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)

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

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_by ⇒ Types::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.

Returns:

• (Types::AggregatedUtterancesSortBy)

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

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