Start Bot Analyzer

lexmodelsv2_start_bot_analyzer

R Documentation

Description¶

Initiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS best practices.

The analysis examines your bot's configuration, including intents, utterances, slots, and conversation flows, to provide actionable recommendations for optimization.

Usage¶

lexmodelsv2_start_bot_analyzer(botId, analysisScope, localeId,
  botVersion)

Arguments¶

botId

[required] The unique identifier of the bot to analyze.

analysisScope

[required] The scope of analysis to perform. Currently only BotLocale scope is supported.

Valid Values: BotLocale

localeId

The locale identifier for the bot locale to analyze. Required when analysisScope is BotLocale.

botVersion

The version of the bot to analyze. Defaults to DRAFT if not specified.

Value¶

A list with the following syntax:

list(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  botAnalyzerStatus = "Processing"|"Available"|"Failed"|"Stopping"|"Stopped",
  botAnalyzerRequestId = "string",
  creationDateTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$start_bot_analyzer(
  botId = "string",
  analysisScope = "BotLocale",
  localeId = "string",
  botVersion = "string"
)