start_test_execution ¶

start_test_execution(
    test_set_id: Id,
    target: TestExecutionTarget,
    api_mode: TestExecutionApiMode,
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
    test_execution_modality: Optional[TestExecutionModality] = None,
) -> StartTestExecutionResponse

The action to start test set execution.

Parameters:

test_set_id (Id) –

The test set Id for the test set execution.
target (TestExecutionTarget) –

The target bot for the test set execution.
api_mode (TestExecutionApiMode) –

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.
test_execution_modality (Optional[TestExecutionModality], default: None ) –

Indicates whether audio or text is used.

Raises:

ConflictException –

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
InternalServerException –

The service encountered an unexpected condition. Try your request again.
ResourceNotFoundException –

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
ServiceQuotaExceededException –

You have reached a quota for your bot.
ThrottlingException –

Your request rate is too high. Reduce the frequency of requests.
ValidationException –

One of the input parameters in your request isn't valid. Check the parameters and try your request again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lex_models_v2/_services/lex_models_v2.py

def start_test_execution(
    self,
    test_set_id: "capo_lex_models_v2.types.id.Id",
    target: "capo_lex_models_v2.types.test_execution_target.TestExecutionTarget",
    api_mode: "capo_lex_models_v2.types.test_execution_api_mode.TestExecutionApiMode",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
    test_execution_modality: Optional[
        "capo_lex_models_v2.types.test_execution_modality.TestExecutionModality"
    ] = None,
) -> "capo_lex_models_v2.types.start_test_execution_response.StartTestExecutionResponse":
    """<p>The action to start test set execution.</p>

    Args:
        test_set_id: <p>The test set Id for the test set execution.</p>
        target: <p>The target bot for the test set execution.</p>
        api_mode: <p>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.</p>
        test_execution_modality: <p>Indicates whether audio or text is used.</p>

    Raises:
        capo_lex_models_v2.errors.conflict_exception.ConflictException: <p>The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again. </p>
        capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
        capo_lex_models_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.</p>
        capo_lex_models_v2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have reached a quota for your bot. </p>
        capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
        capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
        capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lex_models_v2.types.start_test_execution_request.StartTestExecutionRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.start_test_execution_response.StartTestExecutionResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.start_test_execution

        output, http_response = (
            capo_lex_models_v2._operations.lex_model_building_service_v2.start_test_execution.start_test_execution(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartTestExecution")
    )
    input_: capo_lex_models_v2.types.start_test_execution_request.StartTestExecutionRequest = {
        "test_set_id": test_set_id,
        "target": target,
        "api_mode": api_mode,
    }
    if test_execution_modality is not None:
        input_["test_execution_modality"] = test_execution_modality

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output