monitor_schema.models.ReferenceProfileId#

class monitor_schema.models.ReferenceProfileId[source]#

A baseline based on a static reference profile.

A typical use case is to use a “gold” dataset and upload its profile to WhyLabs. This can be a training dataset as well for an ML model.

Show JSON schema
{
   "title": "ReferenceProfileId",
   "description": "A baseline based on a static reference profile.\n\nA typical use case is to use a \"gold\" dataset and upload its profile to WhyLabs. This can be a training dataset\nas well for an ML model.",
   "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"
      },
      "type": {
         "title": "Type",
         "enum": [
            "Reference"
         ],
         "type": "string"
      },
      "profileId": {
         "title": "ProfileId",
         "description": "The unique profile ID for the reference profile",
         "maxLength": 100,
         "type": "string"
      }
   },
   "required": [
      "type",
      "profileId"
   ],
   "additionalProperties": false
}

Fields:
field profileId: str [Required]#

The unique profile ID for the reference profile

Constraints:

  • maxLength = 100

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