v5

latestOpenAPI 3.1.0MITraw.githubusercontent.com2025-07-24172759.4 KB

TestCases

Create a test case

Create a new test case

post/v4/test-cases

Request body

datasetIdstring uuid required

Dataset UUID

namestring required

Test case name

inputsobject required

Test case inputs as a JSON object

expectedOutputsobject

Optional expected outputs as a JSON object

Example request

{
  "datasetId": "b2c3d4e5-f6a7-8901-2345-67890abcdef1",
  "name": "Prompting with a SQL query that does not return any results",
  "inputs": {
    "query": "What is the capital of France?"
  },
  "expectedOutputs": {
    "result": "No results found"
  }
}

Response

Successful response

idstring uuid required

Test Case UUID

createdAtstring required

Creation timestamp (ISO 8601)

updatedAtstring required

Last update timestamp (ISO 8601)

inputsobject required

Input data for the test case

expectedOutputsobject nullable required

Expected output data for the test case

datasetIdstring required

Associated Dataset UUID

namestring required

Test Case name

pipelineIdstring uuid required

Associated Pipeline UUID

archivedAtstring nullable required

Archive timestamp (ISO 8601)

deletedAtstring nullable required

Deletion timestamp (ISO 8601)

Example response

{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "createdAt": "2025-04-01T00:00:00.000Z",
  "updatedAt": "2025-04-01T00:00:00.000Z",
  "inputs": {
    "query": "What is the capital of France?"
  },
  "expectedOutputs": {
    "answer": "Paris"
  },
  "datasetId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Capital of France query",
  "pipelineId": "abcdef12-3456-7890-abcd-ef1234567890",
  "archivedAt": "2025-04-01T00:00:00.000Z",
  "deletedAt": "2025-04-01T00:00:00.000Z"
}