Sign in

v1

latestOpenAPI 3.0.32026-07-223120123.1 KB
Projects

Create a test in a project.

Create a test.

post/projects/{projectId}/tests

Path parameters

projectIdstring uuid required

The project id.

Request body

idstring uuid required

The test id.

numberinteger required

The test number.

namestring required

The test name.

dateCreatedstring date-time required

The creation date.

dateUpdatedstring date-time required

The last updated date.

descriptionobject nullable required

The test description.

evaluationWindownumber nullable

The evaluation window in seconds. Only applies to tests that use production data.

delayWindownumber nullable

The delay window in seconds. Only applies to tests that use production data.

type'integrity' | 'consistency' | 'performance' required

The test type.

subtype'anomalousColumnCount' | 'characterLength' | 'classImbalanceRatio' | 'expectColumnAToBeInColumnB' | 'columnAverage' | 'columnDrift' | 'columnStatistic' | 'columnValuesMatch' | 'conflictingLabelRowCount' | 'containsPii' | 'containsValidUrl' | 'correlatedFeatureCount' | 'customMetricThreshold' | 'duplicateRowCount' | 'emptyFeature' | 'emptyFeatureCount' | 'driftedFeatureCount' | 'featureMissingValues' | 'featureValueValidation' | 'greatExpectations' | 'groupByColumnStatsCheck' | 'illFormedRowCount' | 'isCode' | 'isJson' | 'llmRubricThresholdV2' | 'labelDrift' | 'metricThreshold' | 'newCategoryCount' | 'newLabelCount' | 'nullRowCount' | 'rowCount' | 'ppScoreValueValidation' | 'quasiConstantFeature' | 'quasiConstantFeatureCount' | 'sqlQuery' | 'dtypeValidation' | 'sentenceLength' | 'sizeRatio' | 'specialCharactersRatio' | 'stringValidation' | 'trainValLeakageRowCount' required

The test subtype.

creatorIdstring uuid nullable required

The test creator id.

originProjectVersionIdstring uuid nullable required

The project version (commit) id where the test was created.

archivedboolean

Whether the test is archived.

dateArchivedstring date-time nullable required

The date the test was archived.

suggestedboolean required

Whether the test is suggested or user-created.

commentCountinteger required

The number of comments on the test.

usesMlModelboolean

Whether the test uses an ML model.

usesValidationDatasetboolean

Whether the test uses a validation dataset.

usesTrainingDatasetboolean

Whether the test uses a training dataset.

usesReferenceDatasetboolean

Whether the test uses a reference dataset (monitoring mode only).

usesProductionDataboolean

Whether the test uses production data (monitoring mode only).

includeHistoricalDataboolean nullable

Whether to include historical data in the test result. Only applies to tests that use production data.

defaultToAllPipelinesboolean nullable

Whether to apply the test to all pipelines (data sources) or to a specific set of pipelines. Only applies to tests that use production data.

includePipelinesstring[] nullable

Array of pipelines (data sources) to which the test should be applied. Only applies to tests that use production data.

excludePipelinesstring[] nullable

Array of pipelines (data sources) to which the test should not be applied. Only applies to tests that use production data.

Example request

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": 1,
  "name": "No duplicate rows",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "dateUpdated": "2024-03-22T11:31:01.185Z",
  "evaluationWindow": 3600,
  "type": "integrity",
  "subtype": "duplicateRowCount",
  "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
  "originProjectVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "thresholds": [
    {
      "measurement": "duplicateRowCount",
      "insightName": "duplicateRowCount",
      "insightParameters": [
        {
          "name": "column_name",
          "value": "Age"
        }
      ],
      "operator": "<="
    }
  ],
  "dateArchived": "2024-03-22T11:31:01.185Z",
  "usesValidationDataset": true
}

Response

Status OK.

idstring uuid required

The test id.

numberinteger required

The test number.

namestring required

The test name.

dateCreatedstring date-time required

The creation date.

dateUpdatedstring date-time required

The last updated date.

descriptionobject nullable required

The test description.

evaluationWindownumber nullable

The evaluation window in seconds. Only applies to tests that use production data.

delayWindownumber nullable

The delay window in seconds. Only applies to tests that use production data.

type'integrity' | 'consistency' | 'performance' required

The test type.

subtype'anomalousColumnCount' | 'characterLength' | 'classImbalanceRatio' | 'expectColumnAToBeInColumnB' | 'columnAverage' | 'columnDrift' | 'columnStatistic' | 'columnValuesMatch' | 'conflictingLabelRowCount' | 'containsPii' | 'containsValidUrl' | 'correlatedFeatureCount' | 'customMetricThreshold' | 'duplicateRowCount' | 'emptyFeature' | 'emptyFeatureCount' | 'driftedFeatureCount' | 'featureMissingValues' | 'featureValueValidation' | 'greatExpectations' | 'groupByColumnStatsCheck' | 'illFormedRowCount' | 'isCode' | 'isJson' | 'llmRubricThresholdV2' | 'labelDrift' | 'metricThreshold' | 'newCategoryCount' | 'newLabelCount' | 'nullRowCount' | 'rowCount' | 'ppScoreValueValidation' | 'quasiConstantFeature' | 'quasiConstantFeatureCount' | 'sqlQuery' | 'dtypeValidation' | 'sentenceLength' | 'sizeRatio' | 'specialCharactersRatio' | 'stringValidation' | 'trainValLeakageRowCount' required

The test subtype.

creatorIdstring uuid nullable required

The test creator id.

originProjectVersionIdstring uuid nullable required

The project version (commit) id where the test was created.

archivedboolean

Whether the test is archived.

dateArchivedstring date-time nullable required

The date the test was archived.

suggestedboolean required

Whether the test is suggested or user-created.

commentCountinteger required

The number of comments on the test.

usesMlModelboolean

Whether the test uses an ML model.

usesValidationDatasetboolean

Whether the test uses a validation dataset.

usesTrainingDatasetboolean

Whether the test uses a training dataset.

usesReferenceDatasetboolean

Whether the test uses a reference dataset (monitoring mode only).

usesProductionDataboolean

Whether the test uses production data (monitoring mode only).

includeHistoricalDataboolean nullable

Whether to include historical data in the test result. Only applies to tests that use production data.

defaultToAllPipelinesboolean nullable

Whether to apply the test to all pipelines (data sources) or to a specific set of pipelines. Only applies to tests that use production data.

includePipelinesstring[] nullable

Array of pipelines (data sources) to which the test should be applied. Only applies to tests that use production data.

excludePipelinesstring[] nullable

Array of pipelines (data sources) to which the test should not be applied. Only applies to tests that use production data.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number": 1,
  "name": "No duplicate rows",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "dateUpdated": "2024-03-22T11:31:01.185Z",
  "evaluationWindow": 3600,
  "type": "integrity",
  "subtype": "duplicateRowCount",
  "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
  "originProjectVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "thresholds": [
    {
      "measurement": "duplicateRowCount",
      "insightName": "duplicateRowCount",
      "insightParameters": [
        {
          "name": "column_name",
          "value": "Age"
        }
      ],
      "operator": "<="
    }
  ],
  "dateArchived": "2024-03-22T11:31:01.185Z",
  "usesValidationDataset": true
}