aip_sdk.ThresholdBand
aip_sdk.ThresholdBand
The object form of MetricSpec.threshold: the four keys score-card resolution reads.
pass, warn, direction and inverted are all optional — each merges onto the
metric's registered card, leaving an unset key's value untouched. A bare float in
threshold is shorthand for setting pass alone.
extra="forbid" because a typo'd key ({"passs": 0.9}) would otherwise resolve to the
default card and let the run score cleanly against a bar the author never set.
An unset key dumps as null rather than being pruned — dump with exclude_none=True to
drop it. A model_serializer is deliberately not used, as it would collapse this class to
an untyped object in FastAPI's JSON Schema.
aip_sdk.ThresholdBand.direction
aip_sdk.ThresholdBand.direction: MetricDirection | None = None
No docstring is defined in the source.
aip_sdk.ThresholdBand.inverted
aip_sdk.ThresholdBand.inverted: bool | None = None
No docstring is defined in the source.
aip_sdk.ThresholdBand.model_config
aip_sdk.ThresholdBand.model_config = ConfigDict(extra='forbid', populate_by_name=True, serialize_by_alias=True)
No docstring is defined in the source.
aip_sdk.ThresholdBand.pass_
aip_sdk.ThresholdBand.pass_: Threshold | None = Field(default=None, validation_alias='pass', serialization_alias='pass')
No docstring is defined in the source.
aip_sdk.ThresholdBand.warn
aip_sdk.ThresholdBand.warn: Threshold | None = None
No docstring is defined in the source.