Response Structures

This module contains the validators for the Guardrails framework.

The name with which a validator is registered is the name that is used in the RAIL spec to specify formatters.

ValidationResult

metadata class-attribute instance-attribute

metadata: Optional[Dict[str, Any]] = None

outcome instance-attribute

outcome: str

PassResult

metadata class-attribute instance-attribute

metadata: Optional[Dict[str, Any]] = None

outcome class-attribute instance-attribute

outcome: Literal['pass'] = 'pass'

value_override class-attribute instance-attribute

value_override: Optional[Any] = Field(default=ValueOverrideSentinel)

ValueOverrideSentinel

FailResult

error_message instance-attribute

error_message: str

fix_value class-attribute instance-attribute

fix_value: Optional[Any] = None

metadata class-attribute instance-attribute

metadata: Optional[Dict[str, Any]] = None

outcome class-attribute instance-attribute

outcome: Literal['fail'] = 'fail'