LexModelsV2 / Client / describe_bot_analyzer_recommendation

describe_bot_analyzer_recommendation¶

LexModelsV2.Client.describe_bot_analyzer_recommendation(**kwargs)¶

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.

Request Syntax

response = client.describe_bot_analyzer_recommendation(
    botId='string',
    botAnalyzerRequestId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

botId (string) –
[REQUIRED]

The unique identifier of the bot.
botAnalyzerRequestId (string) –
[REQUIRED]

The unique identifier of the analysis request.
nextToken (string) – If the response from a previous request was truncated, the nextToken value is used to retrieve the next page of recommendations.
maxResults (integer) – The maximum number of recommendations to return in the response. The default is 5.

Return type:

dict

Returns:

Response Syntax

{
    'botId': 'string',
    'botVersion': 'string',
    'localeId': 'string',
    'botAnalyzerStatus': 'Processing'|'Available'|'Failed'|'Stopping'|'Stopped',
    'creationDateTime': datetime(2015, 1, 1),
    'botAnalyzerRecommendationList': [
        {
            'issueLocation': {
                'botLocale': 'string',
                'intentId': 'string',
                'slotId': 'string'
            },
            'priority': 'High'|'Medium'|'Low',
            'issueDescription': 'string',
            'proposedFix': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- botId (string) –
  
  The unique identifier of the bot.
- botVersion (string) –
  
  The version of the bot that was analyzed.
- localeId (string) –
  
  The locale identifier of the bot locale that was analyzed.
- botAnalyzerStatus (string) –
  
  The current status of the analysis.
  
  Valid Values: Processing | Available | Failed | Stopping | Stopped
- creationDateTime (datetime) –
  
  The date and time when the analysis was initiated.
- botAnalyzerRecommendationList (list) –
  
  A list of recommendations for optimizing your bot configuration. Each recommendation includes the issue location, priority, description, and proposed fix.
  - (dict) –
    
    Contains a recommendation for bot optimization identified by the Bot Analyzer.
    - issueLocation (dict) –
      
      The location information for the identified issue within the bot configuration.
      - botLocale (string) –
        
        The locale identifier where the issue was found.
      - intentId (string) –
        
        The intent identifier where the issue was found, if applicable.
      - slotId (string) –
        
        The slot identifier where the issue was found, if applicable.
    - priority (string) –
      
      The priority level of the recommendation.
      
      Valid Values: High | Medium | Low
    - issueDescription (string) –
      
      A detailed description of the identified configuration issue.
    - proposedFix (string) –
      
      The recommended solution to address the identified issue.
- nextToken (string) –
  
  If the response is truncated, this token can be used in a subsequent request to retrieve the next page of recommendations.

Exceptions

LexModelsV2.Client.exceptions.ThrottlingException
LexModelsV2.Client.exceptions.ValidationException
LexModelsV2.Client.exceptions.ResourceNotFoundException
LexModelsV2.Client.exceptions.InternalServerException