abacusai.api_class.monitor_alert — AbacusAI documentation

# `abacusai.api_class.monitor_alert`

## Module Contents

### Classes

`AlertConditionConfig` | Helper class that provides a standard way to create an ABC using
`AccuracyBelowThresholdConditionConfig` | Accuracy Below Threshold Condition Config for Monitor Alerts
`FeatureDriftConditionConfig` | Feature Drift Condition Config for Monitor Alerts
`TargetDriftConditionConfig` | Target Drift Condition Config for Monitor Alerts
`HistoryLengthDriftConditionConfig` | History Length Drift Condition Config for Monitor Alerts
`DataIntegrityViolationConditionConfig` | Data Integrity Violation Condition Config for Monitor Alerts
`BiasViolationConditionConfig` | Bias Violation Condition Config for Monitor Alerts
`_AlertConditionConfigFactory` | Helper class that provides a standard way to create an ABC using
`AlertActionConfig` | Helper class that provides a standard way to create an ABC using
`EmailActionConfig` | Email Action Config for Monitor Alerts
`_AlertActionConfigFactory` | Helper class that provides a standard way to create an ABC using

class abacusai.api_class.monitor_alert.AlertConditionConfig

  Bases: `abacusai.api_class.abstract.ApiClass`

  Helper class that provides a standard way to create an ABC using inheritance.

  alert_type: abacusai.api_class.enums.MonitorAlertType
  classmethod _get_builder()

class abacusai.api_class.monitor_alert.AccuracyBelowThresholdConditionConfig

  Bases: `AlertConditionConfig`

  Accuracy Below Threshold Condition Config for Monitor Alerts :param threshold: Threshold for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float

  threshold: float
  __post_init__()

class abacusai.api_class.monitor_alert.FeatureDriftConditionConfig

  Bases: `AlertConditionConfig`

  Feature Drift Condition Config for Monitor Alerts :param feature_drift_type: Feature drift type to apply the threshold on to determine whether a column has drifted significantly enough to be a violation. :type feature_drift_type: FeatureDriftType :param threshold: Threshold for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int :param feature_names: List of feature names to monitor for this alert. :type feature_names: List[str]

  feature_drift_type: abacusai.api_class.enums.FeatureDriftType
  threshold: float
  minimum_violations: int
  feature_names: List[str]
  __post_init__()

class abacusai.api_class.monitor_alert.TargetDriftConditionConfig

  Bases: `AlertConditionConfig`

  Target Drift Condition Config for Monitor Alerts :param feature_drift_type: Target drift type to apply the threshold on to determine whether a column has drifted significantly enough to be a violation. :type feature_drift_type: FeatureDriftType :param threshold: Threshold for when to consider the target column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float

  feature_drift_type: abacusai.api_class.enums.FeatureDriftType
  threshold: float
  __post_init__()

class abacusai.api_class.monitor_alert.HistoryLengthDriftConditionConfig

  Bases: `AlertConditionConfig`

  History Length Drift Condition Config for Monitor Alerts :param feature_drift_type: History length drift type to apply the threshold on to determine whether the history length has drifted significantly enough to be a violation. :type feature_drift_type: FeatureDriftType :param threshold: Threshold for when to consider the history length to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float

  feature_drift_type: abacusai.api_class.enums.FeatureDriftType
  threshold: float
  __post_init__()

class abacusai.api_class.monitor_alert.DataIntegrityViolationConditionConfig

  Bases: `AlertConditionConfig`

  Data Integrity Violation Condition Config for Monitor Alerts :param data_integrity_type: This option selects the data integrity violations to monitor for this alert. :type data_integrity_type: DataIntegrityViolationType :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int

  data_integrity_type: abacusai.api_class.enums.DataIntegrityViolationType
  minimum_violations: int
  __post_init__()

class abacusai.api_class.monitor_alert.BiasViolationConditionConfig

  Bases: `AlertConditionConfig`

  Bias Violation Condition Config for Monitor Alerts :param bias_type: This option selects the bias metric to monitor for this alert. :type bias_type: BiasType :param threshold: Threshold for when to consider a column to be in violation. The alert will only fire when the drift value is strictly greater than the threshold. :type threshold: float :param minimum_violations: Number of columns that must exceed the specified threshold to trigger an alert. :type minimum_violations: int

  bias_type: abacusai.api_class.enums.BiasType
  threshold: float
  minimum_violations: int
  __post_init__()

class abacusai.api_class.monitor_alert._AlertConditionConfigFactory

  Bases: `abacusai.api_class.abstract._ApiClassFactory`

  Helper class that provides a standard way to create an ABC using inheritance.

  config_abstract_class
  config_class_key = 'alert_type'
  config_class_key_value_camel_case = True
  config_class_map

class abacusai.api_class.monitor_alert.AlertActionConfig

  Bases: `abacusai.api_class.abstract.ApiClass`

  Helper class that provides a standard way to create an ABC using inheritance.

  action_type: abacusai.api_class.enums.AlertActionType
  classmethod _get_builder()

class abacusai.api_class.monitor_alert.EmailActionConfig

  Bases: `AlertActionConfig`

  Email Action Config for Monitor Alerts :param email_recipients: List of email addresses to send the alert to. :type email_recipients: List[str] :param email_body: Body of the email to send. :type email_body: str

  email_recipients: List[str]
  email_body: str
  __post_init__()

class abacusai.api_class.monitor_alert._AlertActionConfigFactory

  Bases: `abacusai.api_class.abstract._ApiClassFactory`

  Helper class that provides a standard way to create an ABC using inheritance.

  config_abstract_class
  config_class_key = 'action_type'
  config_class_map