LexModelsV2 / Client / describe_test_set_discrepancy_report

describe_test_set_discrepancy_report#

LexModelsV2.Client.describe_test_set_discrepancy_report(**kwargs)#

Gets metadata information about the test set discrepancy report.

Request Syntax

response = client.describe_test_set_discrepancy_report(
    testSetDiscrepancyReportId='string'
)

Parameters:

testSetDiscrepancyReportId (string) –

[REQUIRED]

The unique identifier of the test set discrepancy report.

Return type:

dict

Returns:

Response Syntax

{
    'testSetDiscrepancyReportId': 'string',
    'testSetId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'target': {
        'botAliasTarget': {
            'botId': 'string',
            'botAliasId': 'string',
            'localeId': 'string'
        }
    },
    'testSetDiscrepancyReportStatus': 'InProgress'|'Completed'|'Failed',
    'lastUpdatedDataTime': datetime(2015, 1, 1),
    'testSetDiscrepancyTopErrors': {
        'intentDiscrepancies': [
            {
                'intentName': 'string',
                'errorMessage': 'string'
            },
        ],
        'slotDiscrepancies': [
            {
                'intentName': 'string',
                'slotName': 'string',
                'errorMessage': 'string'
            },
        ]
    },
    'testSetDiscrepancyRawOutputUrl': 'string',
    'failureReasons': [
        'string',
    ]
}

Response Structure

(dict) –
- testSetDiscrepancyReportId (string) –
  
  The unique identifier of the test set discrepancy report to describe.
- testSetId (string) –
  
  The test set Id for the test set discrepancy report.
- creationDateTime (datetime) –
  
  The time and date of creation for the test set discrepancy report.
- target (dict) –
  
  The target bot location for the test set discrepancy report.
  - botAliasTarget (dict) –
    
    Contains information about the bot alias used as the resource for the test set discrepancy report.
    - botId (string) –
      
      The unique identifier for the bot alias.
    - botAliasId (string) –
      
      The unique identifier for the bot associated with the bot alias.
    - localeId (string) –
      
      The unique identifier of the locale associated with the bot alias.
- testSetDiscrepancyReportStatus (string) –
  
  The status for the test set discrepancy report.
- lastUpdatedDataTime (datetime) –
  
  The date and time of the last update for the test set discrepancy report.
- testSetDiscrepancyTopErrors (dict) –
  
  The top 200 error results from the test set discrepancy report.
  - intentDiscrepancies (list) –
    
    Contains information about discrepancies found for intents between the test set and the bot.
    - (dict) –
      
      Contains information about discrepancy in an intent information between the test set and the bot.
      - intentName (string) –
        
        The name of the intent in the discrepancy report.
      - errorMessage (string) –
        
        The error message for a discrepancy for an intent between the test set and the bot.
  - slotDiscrepancies (list) –
    
    Contains information about discrepancies found for slots between the test set and the bot.
    - (dict) –
      
      Contains information about discrepancy in a slot information between the test set and the bot.
      - intentName (string) –
        
        The name of the intent associated with the slot in the discrepancy report.
      - slotName (string) –
        
        The name of the slot in the discrepancy report.
      - errorMessage (string) –
        
        The error message for a discrepancy for an intent between the test set and the bot.
- testSetDiscrepancyRawOutputUrl (string) –
  
  Pre-signed Amazon S3 URL to download the test set discrepancy report.
- failureReasons (list) –
  
  The failure report for the test set discrepancy report generation action.
  - (string) –

Exceptions

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