monitor_schema.models.TrailingWindowBaseline

class monitor_schema.models.TrailingWindowBaseline

A dynamic trailing window.

This is useful if you don’t have a static baseline to monitor against. This is the default mode for most monitors.

Show JSON schema

{
   "title": "TrailingWindowBaseline",
   "description": "A dynamic trailing window.\n\nThis is useful if you don't have a static baseline to monitor against. This is the default mode for most\nmonitors.",
   "type": "object",
   "properties": {
      "datasetId": {
         "title": "DatasetId",
         "description": "The unique ID of an dataset. This is specific to WhyLabs. If the dataset ID does not exist, user will get a validation exception when saving the config with WhyLabs API",
         "maxLength": 100,
         "pattern": "[a-zA-Z0-9\\-_\\.]+",
         "type": "string"
      },
      "inheritSegment": {
         "title": "InheritSegment",
         "description": "Default to false. Whether to use the segment from the target to filter down the baseline",
         "type": "boolean"
      },
      "type": {
         "title": "Type",
         "enum": [
            "TrailingWindow"
         ],
         "type": "string"
      },
      "size": {
         "title": "Size",
         "description": "Window size",
         "exclusiveMinimum": 3,
         "maximum": 90,
         "type": "integer"
      },
      "offset": {
         "title": "Offset",
         "description": "Offset from the current batch for the range of the trailing window. Default to 1 (the previous batch). This means that if set this to 0, the baseline will include the current batch's value, orif we set it o 7, then the window is off by 7.",
         "type": "integer"
      },
      "exclusionRanges": {
         "title": "ExclusionRanges",
         "description": "The list of exclusion ranges",
         "maxItems": 100,
         "type": "array",
         "items": {
            "$ref": "#/definitions/TimeRange"
         }
      }
   },
   "required": [
      "type",
      "size"
   ],
   "additionalProperties": false,
   "definitions": {
      "TimeRange": {
         "title": "TimeRange",
         "description": "Support for a specific time range.",
         "type": "object",
         "properties": {
            "start": {
               "title": "Start",
               "description": "Inclusive. Start time of a time range.",
               "type": "string",
               "format": "date-time"
            },
            "end": {
               "title": "End",
               "description": "Exclusive. End time of a time range.",
               "type": "string",
               "format": "date-time"
            }
         },
         "required": [
            "start",
            "end"
         ],
         "additionalProperties": false
      }
   }
}

Fields:

• exclusionRanges (List[monitor_schema.models.commons.TimeRange] | None)

• offset (int | None)

• size (int)

• type (Literal[

field exclusionRanges: List[TimeRange] | None = None

The list of exclusion ranges

Constraints:

• maxItems = 100

field offset: int | None = None

Offset from the current batch for the range of the trailing window. Default to 1 (the previous batch). This means that if set this to 0, the baseline will include the current batch’s value, orif we set it o 7, then the window is off by 7.

field size: int [Required]

Window size

Constraints:

• exclusiveMinimum = 3

• maximum = 90

field type: TrailingWindow: 'TrailingWindow'>] [Required]