Skip to content

SearchAssociatedTranscriptsRequest

Source code in docs_src/capo_lex_models_v2/types/search_associated_transcripts_request.py
class SearchAssociatedTranscriptsRequest(TypedDict, closed=True):
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the bot associated with the transcripts that you are searching.</p>"""
    bot_version: "capo_lex_models_v2.types.bot_version.BotVersion"
    """<p>The version of the bot containing the transcripts that you are searching.</p>"""
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId"
    """<p>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 <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a> </p>"""
    bot_recommendation_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the bot recommendation associated with the transcripts to search.</p>"""
    search_order: NotRequired["capo_lex_models_v2.types.search_order.SearchOrder"]
    """<p>How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.</p>"""
    filters: "capo_lex_models_v2.types.associated_transcript_filters.AssociatedTranscriptFilters"
    """<p>A list of filter objects.</p>"""
    max_results: NotRequired["capo_lex_models_v2.types.max_results.MaxResults"]
    """<p>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.</p>"""
    next_index: NotRequired["capo_lex_models_v2.types.next_index.NextIndex"]
    """<p>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.</p>"""

bot_id instance-attribute

bot_id: Id

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

bot_recommendation_id instance-attribute

bot_recommendation_id: Id

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

bot_version instance-attribute

bot_version: BotVersion

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

filters instance-attribute

A list of filter objects.

locale_id instance-attribute

locale_id: LocaleId

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

max_results instance-attribute

max_results: NotRequired[MaxResults]

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.

next_index instance-attribute

next_index: NotRequired[NextIndex]

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.

search_order instance-attribute

search_order: NotRequired[SearchOrder]

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