abacusai.api_class.monitor

Module Contents

Classes

ForecastingMonitorConfig

Forecasting Monitor Configuration

StdDevThreshold

Std Dev Threshold types

ItemAttributesStdDevThreshold

Item Attributes Std Dev Threshold for Monitor Alerts

class abacusai.api_class.monitor.ForecastingMonitorConfig

Bases: abacusai.api_class.abstract.ApiClass

Forecasting Monitor Configuration

Parameters:
  • id_column (str) – The name of the column that contains the unique identifier for the time series.

  • timestamp_column (str) – The name of the column that contains the timestamp for the time series.

  • target_column (str) – The name of the column that contains the target value for the time series.

  • start_time (str) – The start time of the time series data.

  • end_time (str) – The end time of the time series data.

id_column: str
timestamp_column: str
target_column: str
start_time: str
end_time: str
to_dict()

Standardizes converting an ApiClass to dictionary. Keys of response dictionary are converted to camel case. This also validates the fields ( type, value, etc ) received in the dictionary.

class abacusai.api_class.monitor.StdDevThreshold

Bases: abacusai.api_class.abstract.ApiClass

Std Dev Threshold types

Parameters:
  • threshold_type (StdDevThresholdType) – Type of threshold to apply to the item attributes.

  • value (float) – Value to use for the threshold.

threshold_type: abacusai.api_class.enums.StdDevThresholdType
value: float
to_dict()

Standardizes converting an ApiClass to dictionary. Keys of response dictionary are converted to camel case. This also validates the fields ( type, value, etc ) received in the dictionary.

class abacusai.api_class.monitor.ItemAttributesStdDevThreshold

Bases: abacusai.api_class.abstract.ApiClass

Item Attributes Std Dev Threshold for Monitor Alerts

Parameters:
lower_bound: StdDevThreshold
upper_bound: StdDevThreshold
to_dict()

Standardizes converting an ApiClass to dictionary. Keys of response dictionary are converted to camel case. This also validates the fields ( type, value, etc ) received in the dictionary.