LexModelsV2 / Client / start_test_execution

start_test_execution#

LexModelsV2.Client.start_test_execution(**kwargs)#

The action to start test set execution.

Request Syntax

response = client.start_test_execution(
    testSetId='string',
    target={
        'botAliasTarget': {
            'botId': 'string',
            'botAliasId': 'string',
            'localeId': 'string'
        }
    },
    apiMode='Streaming'|'NonStreaming',
    testExecutionModality='Text'|'Audio'
)

Parameters:

testSetId (string) –
[REQUIRED]

The test set Id for the test set execution.
target (dict) –
[REQUIRED]

The target bot for the test set execution.
- botAliasTarget (dict) –
  
  Contains information about the bot alias used for the test execution.
  - botId (string) – [REQUIRED]
    
    The bot Id of the bot alias used in the test set execution.
  - botAliasId (string) – [REQUIRED]
    
    The bot alias Id of the bot alias used in the test set execution.
  - localeId (string) – [REQUIRED]
    
    The locale Id of the bot alias used in the test set execution.
apiMode (string) –
[REQUIRED]

Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
testExecutionModality (string) – Indicates whether audio or text is used.

Return type:

dict

Returns:

Response Syntax

{
    'testExecutionId': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'testSetId': 'string',
    'target': {
        'botAliasTarget': {
            'botId': 'string',
            'botAliasId': 'string',
            'localeId': 'string'
        }
    },
    'apiMode': 'Streaming'|'NonStreaming',
    'testExecutionModality': 'Text'|'Audio'
}

Response Structure

(dict) –
- testExecutionId (string) –
  
  The unique identifier of the test set execution.
- creationDateTime (datetime) –
  
  The creation date and time for the test set execution.
- testSetId (string) –
  
  The test set Id for the test set execution.
- target (dict) –
  
  The target bot for the test set execution.
  - botAliasTarget (dict) –
    
    Contains information about the bot alias used for the test execution.
    - botId (string) –
      
      The bot Id of the bot alias used in the test set execution.
    - botAliasId (string) –
      
      The bot alias Id of the bot alias used in the test set execution.
    - localeId (string) –
      
      The locale Id of the bot alias used in the test set execution.
- apiMode (string) –
  
  Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
- testExecutionModality (string) –
  
  Indicates whether audio or text is used.

Exceptions

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