Metric Threshold¶

pydantic model ibm_watsonx_gov.entities.metric_threshold.MetricThreshold¶

Bases: BaseModel

The class that defines the threshold for a metric.

Show JSON schema

{
   "title": "MetricThreshold",
   "description": "The class that defines the threshold for a metric.",
   "type": "object",
   "properties": {
      "type": {
         "description": "Threshold type. One of 'lower_limit', 'upper_limit'",
         "enum": [
            "lower_limit",
            "upper_limit"
         ],
         "title": "Type",
         "type": "string"
      },
      "value": {
         "default": 0,
         "description": "The value of metric threshold",
         "title": "Threshold value",
         "type": "number"
      }
   },
   "required": [
      "type"
   ]
}

Fields:

type (Literal['lower_limit', 'upper_limit'])
value (float)

field type: Annotated[Literal['lower_limit', 'upper_limit'], FieldInfo(annotation=NoneType, required=True, description="Threshold type. One of 'lower_limit', 'upper_limit'")] [Required]¶: Threshold type. One of ‘lower_limit’, ‘upper_limit’

field value: Annotated[float, FieldInfo(annotation=NoneType, required=False, default=0, title='Threshold value', description='The value of metric threshold')] = 0¶: The value of metric threshold