Skip to main content

aip_sdk.NamedCheckResult

aip_sdk.NamedCheckResult

A CheckResult with an identifying name and human-readable message.

Returned by concrete BaseQualityCheck subclasses via their run() method. Used to assemble a DataQualityReport.

aip_sdk.NamedCheckResult.description​

aip_sdk.NamedCheckResult.description: str = Field(default='', description='What this check measures — shown as a tooltip in the UI')

No docstring is defined in the source.

aip_sdk.NamedCheckResult.flagged_row_ids​

aip_sdk.NamedCheckResult.flagged_row_ids: list[str] = Field(default_factory=list)

No docstring is defined in the source.

aip_sdk.NamedCheckResult.message​

aip_sdk.NamedCheckResult.message: str = Field(description='One-line human-readable summary of the check outcome')

No docstring is defined in the source.

aip_sdk.NamedCheckResult.metadata​

aip_sdk.NamedCheckResult.metadata: dict[str, Any] = Field(default_factory=dict)

No docstring is defined in the source.

aip_sdk.NamedCheckResult.name​

aip_sdk.NamedCheckResult.name: str

No docstring is defined in the source.

aip_sdk.NamedCheckResult.score​

aip_sdk.NamedCheckResult.score: float = Field(ge=0.0, le=1.0, description='Normalised quality score 0.0-1.0')

No docstring is defined in the source.

aip_sdk.NamedCheckResult.severity​

aip_sdk.NamedCheckResult.severity: Severity

No docstring is defined in the source.

aip_sdk.NamedCheckResult.source​

aip_sdk.NamedCheckResult.source: str = Field(default='custom', description="'builtin' for AIP standard checks, 'custom' for user-defined")

No docstring is defined in the source.