Skip to content

MetricBasedObservation

Source code in docs_src/capo_glue/types/metric_based_observation.py
class MetricBasedObservation(TypedDict, closed=True):
    metric_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the data quality metric used for generating the observation.</p>"""
    statistic_id: NotRequired["capo_glue.types.hash_string.HashString"]
    """<p>The Statistic ID.</p>"""
    metric_values: NotRequired[
        "capo_glue.types.data_quality_metric_values.DataQualityMetricValues"
    ]
    """<p>An object of type <code>DataQualityMetricValues</code> representing the analysis of the data quality metric value.</p>"""
    new_rules: NotRequired["capo_glue.types.new_rules.NewRules"]
    """<p>A list of new data quality rules generated as part of the observation based on the data quality metric value.</p>"""

metric_name instance-attribute

metric_name: NotRequired[NameString]

The name of the data quality metric used for generating the observation.

metric_values instance-attribute

metric_values: NotRequired[DataQualityMetricValues]

An object of type DataQualityMetricValues representing the analysis of the data quality metric value.

new_rules instance-attribute

new_rules: NotRequired[NewRules]

A list of new data quality rules generated as part of the observation based on the data quality metric value.

statistic_id instance-attribute

statistic_id: NotRequired[HashString]

The Statistic ID.