GuardResult

The result of evaluating a guardrail against a message.

Usage

Source

GuardResult()

Use the class methods passed(), blocked(), and rewrite() to construct results rather than calling the constructor directly.

Parameter Attributes

action: GuardAction

message: Optional[str] = None

reason: Optional[str] = None

guard_name: Optional[str] = None

Attributes

action: GuardAction

Whether the message passed, was blocked, or was rewritten.

message: Optional[str]

The (possibly rewritten) message text. None when blocked.

reason: Optional[str]

Human-readable explanation of why the guard acted.

guard_name: Optional[str]

Name of the guard that produced this result.

Methods

Name	Description
blocked()	Create a blocked result (message is rejected).
passed()	Create a passing result (message is unchanged).
rewrite()	Create a rewrite result (message is modified and continues).

---

blocked()

Create a blocked result (message is rejected).

Usage

Source

blocked(reason)

Parameters

reason: str

Explanation of why the message was blocked.

---

passed()

Create a passing result (message is unchanged).

Usage

Source

passed(*, reason=None)

Parameters

reason: str | None = None

Optional explanation (e.g., for logging/telemetry).

---

rewrite()

Create a rewrite result (message is modified and continues).

Usage

Source

rewrite(new_text, *, reason=None)

Parameters

new_text: str

The rewritten message text that replaces the original.

reason: str | None = None

Optional explanation of what was changed.