Skip to main content

aip_sdk.DataQualityReport

aip_sdk.DataQualityReport

Aggregate output of running all quality checks on a dataset version.

The status field is the worst severity across the checks in this report — FAIL if any of them failed, WARN if any warned, PASS if all passed. A report covers only the checks its run executed, which is every check the dataset's schema admits unless the run named a subset, so a PASS is not a statement about the checks that were not run.

Usage from aip-sdk:

report = dataset.run_checks(version_id)
if report.status == Severity.FAIL:
    print(report.summary())

Usage from aip-api:

POST /datasets/{id}/versions/{vid}/quality-checks:run
→ persists the run and refreshes the version's latest quality verdict

aip_sdk.DataQualityReport.checked_at​

aip_sdk.DataQualityReport.checked_at: datetime

No docstring is defined in the source.

aip_sdk.DataQualityReport.checks​

aip_sdk.DataQualityReport.checks: list[NamedCheckResult]

No docstring is defined in the source.

aip_sdk.DataQualityReport.row_count​

aip_sdk.DataQualityReport.row_count: int

No docstring is defined in the source.

aip_sdk.DataQualityReport.status​

aip_sdk.DataQualityReport.status: Severity

No docstring is defined in the source.

aip_sdk.DataQualityReport.summary​

aip_sdk.DataQualityReport.summary() -> str

Return a human-readable summary of all check results.