nemoguardrails.actions.rail_outcome
nemoguardrails.actions.rail_outcome
The engine-neutral outcome of a single rail check.
RailOutcome is the canonical, backend-agnostic verdict a rail produces.
Each engine or Colang flow renders the consequence from the decision, its
configuration, and any explicitly supported presentation metadata. For example,
a consumer may use metadata["refusal_message"] as a localized refusal
override; unsupported metadata must not be assumed to affect rendering.
Fields:
decision: ALLOW / BLOCK / TRANSFORM.reason: optional neutral, human-readable explanation.metadata: evidence the decision is based on (policy violations, categories, scores, or backend-specific details) and supported presentation hints. The top-level mapping is copied at construction and is never load-bearing for the decision itself. Consumers own serialization, disclosure, and the interpretation of presentation hints.transforms: for TRANSFORM, which conversation variables are rewritten and to what. Transform outcomes are non-streaming; streaming output paths treat the check as non-blocking and do not apply the rewrite.failed: the rail raised instead of returning a verdict, so this BLOCK is the engine’s fail-closed envelope rather than the rail’s own decision.
Exception types and Colang event/context-update channels remain the consumer’s responsibility. Presentation metadata does not change the verdict: a BLOCK always means “stop”; there is no soft-block flag.
Module Contents
Classes
Functions
API
Bases: enum.Enum
The three mutually exclusive things a rail can decide.
The engine-neutral verdict of one rail check.
transforms is non-empty if and only if decision is TRANSFORM. Each
engine renders the consequence of a BLOCK its own way; this object does not
determine how presentation metadata is rendered.
The single field both engines read to gate; rendering is theirs.
A block the engine synthesized because the rail raised instead of deciding.
A rewrite of a single conversation variable.
Bases: enum.Enum
The conversation variable a transform rewrites.