Class: Aws::LexModelsV2::Types::SearchAssociatedTranscriptsRequest

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::SearchAssociatedTranscriptsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bot_id ⇒ String

  The unique identifier of the bot associated with the transcripts that you are searching.

• #bot_recommendation_id ⇒ String

  The unique identifier of the bot recommendation associated with the transcripts to search.

• #bot_version ⇒ String

  The version of the bot containing the transcripts that you are searching.

• #filters ⇒ Array<Types::AssociatedTranscriptFilter>

  A list of filter objects.

• #locale_id ⇒ String

  The identifier of the language and locale of the transcripts to search.

• #max_results ⇒ Integer

  The maximum number of bot recommendations to return in each page of results.

• #next_index ⇒ Integer

  If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response.

• #search_order ⇒ String

  How SearchResults are ordered.

Instance Attribute Details

#bot_id ⇒ String

The unique identifier of the bot associated with the transcripts that you are searching.

Returns:

• (String)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end

#bot_recommendation_id ⇒ String

The unique identifier of the bot recommendation associated with the transcripts to search.

Returns:

• (String)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end

#bot_version ⇒ String

The version of the bot containing the transcripts that you are searching.

Returns:

• (String)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::AssociatedTranscriptFilter>

A list of filter objects.

Returns:

• (Array<Types::AssociatedTranscriptFilter>)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end

#locale_id ⇒ String

The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see [Supported languages]

[1]: docs.aws.amazon.com/lexv2/latest/dg/how-languages.html

Returns:

• (String)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

Returns:

• (Integer)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end

#next_index ⇒ Integer

If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.

Returns:

• (Integer)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end

#search_order ⇒ String

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Returns:

• (String)

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

class SearchAssociatedTranscriptsRequest < Struct.new(
  :bot_id,
  :bot_version,
  :locale_id,
  :bot_recommendation_id,
  :search_order,
  :filters,
  :max_results,
  :next_index)
  SENSITIVE = []
  include Aws::Structure
end