List tests

import os
from openlayer import Openlayer

client = Openlayer()
tests = client.projects.tests.list(
  project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

{
  "items": [
    {
      "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",
      "description": "This test checks for duplicate rows in the dataset.",
      "evaluationWindow": 3600,
      "delayWindow": 0,
      "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": "<any>"
            }
          ],
          "thresholdMode": "manual",
          "operator": "<=",
          "value": 0
        }
      ],
      "archived": false,
      "dateArchived": "2024-03-22T11:31:01.185Z",
      "suggested": false,
      "commentCount": 0,
      "usesMlModel": false,
      "usesValidationDataset": true,
      "usesTrainingDataset": false,
      "usesReferenceDataset": false,
      "usesProductionData": false
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

projectId

string

required

The project id.

Query Parameters

page

integer

default:1

The page to return in a paginated query.

Required range: x >= 1

perPage

integer

default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100

type

enum<string>

Filter objects by test type. Available types are integrity, consistency, performance, fairness, and robustness.

Available options:

integrity,

consistency,

performance,

fairness,

robustness

suggested

boolean

default:false

Filter for suggested tests.

includeArchived

boolean

default:false

Filter for archived tests.

originVersionId

string | null

Retrive tests created by a specific project version.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

usesProductionData

boolean | null

Retrive tests with usesProductionData (monitoring).

Response

200

application/json

Status OK.

items

object[]

required

items.id

string

required

The test id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

items.number

integer

required

The test number.

Example:

1

items.name

string

required

The test name.

Maximum length: 100

Example:

"No duplicate rows"

items.dateCreated

string

required

The creation date.

Example:

"2024-03-22T11:31:01.185Z"

items.dateUpdated

string

required

The last updated date.

Example:

"2024-03-22T11:31:01.185Z"

items.description

object | null

required

The test description.

Example:

"This test checks for duplicate rows in the dataset."

items.type

enum<string>

required

The test type.

Available options:

integrity,

consistency,

performance

Example:

"integrity"

items.subtype

enum<string>

required

The test subtype.

Available options:

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

Example:

"duplicateRowCount"

items.creatorId

string | null

required

The test creator id.

Example:

"589ece63-49a2-41b4-98e1-10547761d4b0"

items.originProjectVersionId

string | null

required

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

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

items.thresholds

object[]

required

items.dateArchived

string | null

required

The date the test was archived.

Example:

"2024-03-22T11:31:01.185Z"

items.suggested

boolean

required

Whether the test is suggested or user-created.

Example:

false

items.commentCount

integer

required

The number of comments on the test.

Required range: x >= 0

Example:

0

items.evaluationWindow

number | null

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

Required range: x <= 2592000

Example:

3600

items.delayWindow

number | null

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

Required range: 0 <= x <= 2592000

Example:

0

items.archived

boolean

Whether the test is archived.

Example:

false

items.usesMlModel

boolean

Whether the test uses an ML model.

Example:

false

items.usesValidationDataset

boolean

Whether the test uses a validation dataset.

Example:

true

items.usesTrainingDataset

boolean

Whether the test uses a training dataset.

Example:

false

items.usesReferenceDataset

boolean

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

Example:

false

items.usesProductionData

boolean

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

Example:

false

Create test Update tests

import os
from openlayer import Openlayer

client = Openlayer()
tests = client.projects.tests.list(
  project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

{
  "items": [
    {
      "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",
      "description": "This test checks for duplicate rows in the dataset.",
      "evaluationWindow": 3600,
      "delayWindow": 0,
      "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": "<any>"
            }
          ],
          "thresholdMode": "manual",
          "operator": "<=",
          "value": 0
        }
      ],
      "archived": false,
      "dateArchived": "2024-03-22T11:31:01.185Z",
      "suggested": false,
      "commentCount": 0,
      "usesMlModel": false,
      "usesValidationDataset": true,
      "usesTrainingDataset": false,
      "usesReferenceDataset": false,
      "usesProductionData": false
    }
  ]
}

Reference

SDKs

CLI

REST API

Authorizations

Path Parameters

Query Parameters

Response