monitor_schema.models.SingleBatchBaseline#

class monitor_schema.models.SingleBatchBaseline[source]#

Using current batch.

This is used when you want to use one batch to monitor another batch in a different metric entity.

Show JSON schema

{
   "title": "SingleBatchBaseline",
   "description": "Using current batch.\n\nThis is used when you want to use one batch to monitor another batch in a different metric entity.",
   "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": [
            "CurrentBatch"
         ],
         "type": "string"
      },
      "offset": {
         "title": "Offset",
         "description": "Offset from the current batch for the baseline. Default to 0 - (the current batch). This means that if this field set this to 0, the baseline be the current batch's value. The dataset fieldis required to be set for this baseline config.Typical use case is to use another entity to monitor against the current entity",
         "type": "integer"
      }
   },
   "required": [
      "datasetId",
      "type"
   ],
   "additionalProperties": false
}

Fields:

field datasetId: str [Required]#

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

Constraints:

maxLength = 100
pattern = [a-zA-Z0-9-_.]+

field offset: int | None = None#: Offset from the current batch for the baseline. Default to 0 - (the current batch). This means that if this field set this to 0, the baseline be the current batch’s value. The dataset fieldis required to be set for this baseline config.Typical use case is to use another entity to monitor against the current entity

field type: CurrentBatch: 'CurrentBatch'>] [Required]#