Request Validation

To ensure the integrity and reliability of the Supervised AI platform's testing suite, all incoming requests to the testing-api must adhere to strict schema requirements. This section outlines the validation rules for payloads submitted to the testing endpoints.

Global Validation Rules

All API endpoints expect data in JSON format. The following rules apply globally:

Content-Type: Must be application/json.
Field Types: Types are strictly enforced (e.g., a field defined as an Integer will fail if a String is provided).
Mandatory Fields: Any field marked as Required must be present in the root of the JSON object.
Null Values: Fields do not accept null unless explicitly stated in the schema.

Test Submission Schema

When submitting a test case for evaluation, the request body must conform to the following structure:

Example Payload

{
  "test_id": "550e8400-e29b-41d4-a716-446655440000",
  "model_version": "v2.1.0-alpha",
  "input_data": {
    "prompt": "Summarize the document.",
    "context": "Text content here..."
  },
  "expected_output": "This is a summary.",
  "metadata": {
    "environment": "staging",
    "priority": "high"
  }
}

Batch Processing Validation

For high-throughput testing, use the batch endpoint. Validation is performed on the entire array before processing begins.

Limit: Maximum of 100 test objects per batch request.
Structure: An array of objects conforming to the Test Submission Schema.

[
  { "test_id": "...", "input_data": { ... } },
  { "test_id": "...", "input_data": { ... } }
]

Error Responses

If a request fails validation, the API returns a 422 Unprocessable Entity or 400 Bad Request status code. The response body provides details on the specific validation failure:

Example Validation Error

{
  "error_code": "VALIDATION_FAILED",
  "message": "The request payload contains 1 validation error.",
  "details": [
    {
      "field": "model_version",
      "issue": "Field is required and cannot be empty."
    }
  ]
}

Constraints and Sanitization

String Length: model_version and keys within input_data are capped at 255 characters.
Nesting: input_data supports nested JSON objects up to 3 levels deep.
Character Encoding: Only UTF-8 encoded strings are accepted.