Search Associated Transcripts

lexmodelsv2_search_associated_transcripts

R Documentation

Search for associated transcripts that meet the specified criteria¶

Description¶

Search for associated transcripts that meet the specified criteria.

Usage¶

lexmodelsv2_search_associated_transcripts(botId, botVersion, localeId,
  botRecommendationId, searchOrder, filters, maxResults, nextIndex)

Arguments¶

botId: [required] The unique identifier of the bot associated with the transcripts that you are searching.
botVersion: [required] The version of the bot containing the transcripts that you are searching.
localeId: [required] 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
botRecommendationId: [required] The unique identifier of the bot recommendation associated with the transcripts to search.
searchOrder: How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
filters: [required] A list of filter objects.
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.
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.

Value¶

A list with the following syntax:

list(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  botRecommendationId = "string",
  nextIndex = 123,
  associatedTranscripts = list(
    list(
      transcript = "string"
    )
  ),
  totalResults = 123
)

Request syntax¶

svc$search_associated_transcripts(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  botRecommendationId = "string",
  searchOrder = "Ascending"|"Descending",
  filters = list(
    list(
      name = "IntentId"|"SlotTypeId",
      values = list(
        "string"
      )
    )
  ),
  maxResults = 123,
  nextIndex = 123
)