Connect / Client / start_evaluation_form_validation

start_evaluation_form_validation

Connect.Client.start_evaluation_form_validation(**kwargs)

Starts an asynchronous validation process for an evaluation form version in the specified Connect Customer instance. The validation first performs structural checks on the form content (such as verifying required fields, valid scoring configuration, and correct conditional logic), then asynchronously analyzes questions configured for generative AI evaluation against a set of best practices. Use GetEvaluationFormValidation to retrieve the status and results once the validation completes.

See also: AWS API Documentation

Request Syntax

response = client.start_evaluation_form_validation(
    InstanceId='string',
    EvaluationFormId='string',
    EvaluationFormVersion=123
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • EvaluationFormId (string) –

    [REQUIRED]

    The unique identifier for the evaluation form.

  • EvaluationFormVersion (integer) –

    [REQUIRED]

    The version of the evaluation form to validate.

Return type:

dict

Returns:

Response Syntax

{
    'EvaluationFormId': 'string',
    'EvaluationFormArn': 'string',
    'EvaluationFormVersion': 123
}

Response Structure

  • (dict) –

    • EvaluationFormId (string) –

      The unique identifier for the evaluation form.

    • EvaluationFormArn (string) –

      The Amazon Resource Name (ARN) for the evaluation form resource.

    • EvaluationFormVersion (integer) –

      A version of the evaluation form.

Exceptions