Describe Bot Analyzer Recommendation

lexmodelsv2_describe_bot_analyzer_recommendation

R Documentation

Retrieves the analysis results and recommendations for bot optimization¶

Description¶

Retrieves the analysis results and recommendations for bot optimization. The analysis must be in Available status before recommendations can be retrieved.

Recommendations are returned with pagination support. Each recommendation includes the issue location, priority level, detailed description, and proposed fix.

Usage¶

lexmodelsv2_describe_bot_analyzer_recommendation(botId,
  botAnalyzerRequestId, nextToken, maxResults)

Arguments¶

botId

[required] The unique identifier of the bot.

botAnalyzerRequestId

[required] The unique identifier of the analysis request.

nextToken

If the response from a previous request was truncated, the nextToken value is used to retrieve the next page of recommendations.

maxResults

The maximum number of recommendations to return in the response. The default is 5.

Value¶

A list with the following syntax:

list(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  botAnalyzerStatus = "Processing"|"Available"|"Failed"|"Stopping"|"Stopped",
  creationDateTime = as.POSIXct(
    "2015-01-01"
  ),
  botAnalyzerRecommendationList = list(
    list(
      issueLocation = list(
        botLocale = "string",
        intentId = "string",
        slotId = "string"
      ),
      priority = "High"|"Medium"|"Low",
      issueDescription = "string",
      proposedFix = "string"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_bot_analyzer_recommendation(
  botId = "string",
  botAnalyzerRequestId = "string",
  nextToken = "string",
  maxResults = 123
)