Skip to main content

GuardrailsVersion

A versioned snapshot of the guardrails configuration.

guardrails_id is auto-generated at construction time. version is auto-assigned by GuardrailsStore ("v1", "v2", …). created_at defaults to the current UTC time. is_active is True for the most recently created version. source tracks whether this was loaded from the API or from file.

guardrails_idGuardrails Id (string)
versionVersion (string)
Default value: v1
guardrails objectrequired

A simplified, API-manageable view of the guardrails configuration.

strategy_registry lists the names of allowed strategies. type_strategy_map maps primitive type names to their valid strategies. parameter_priors maps signal IDs to severity-level prior dicts. bias_rules maps bias words to severity level strings. threshold_directions maps signal IDs to threshold direction strings. global_preferred_strategy is the strategy biased toward when no hint exists. global_default_strategy is the fallback strategy of last resort.

strategy_registrystring[]required
type_strategy_map objectrequired
property name* string[]
  • Array [
    • string
  • ]
    • parameter_priors objectrequired
    property name*object
    bias_rules objectrequired
    property name*string
    threshold_directions object
    property name*string
    global_preferred_strategyGlobal Preferred Strategy (string)
    Default value: percentile
    global_default_strategyGlobal Default Strategy (string)
    Default value: threshold
    change_note object
    anyOf
    string
    created_atstring<date-time>
    is_activeIs Active (boolean)
    Default value: true
    sourceSource (string)

    Possible values: [api, file]

    Default value: api
    GuardrailsVersion
    {
      "guardrails_id": "string",
      "version": "v1",
      "guardrails": {
        "strategy_registry": [
          "string"
        ],
        "type_strategy_map": {},
        "parameter_priors": {},
        "bias_rules": {},
        "threshold_directions": {},
        "global_preferred_strategy": "percentile",
        "global_default_strategy": "threshold"
      },
      "change_note": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "is_active": true,
      "source": "api"
    }