Skip to content

docs: update GuardrailFunctionOutput docstrings for clarity #1152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −4
Open

docs: update GuardrailFunctionOutput docstrings for clarity #1152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/agents/guardrail.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,18 @@

@dataclass
class GuardrailFunctionOutput:
"""The output of a guardrail function."""
"""Encapsulates the result of a guardrail’s validation step."""

output_info: Any
"""
Optional information about the guardrail's output. For example, the guardrail could include
information about the checks it performed and granular results.
Detailed metadata or diagnostics from the check,
for example which rules passed, which failed, and any metrics.
"""

tripwire_triggered: bool
"""
Whether the tripwire was triggered. If triggered, the agent's execution will be halted.
Whether this check caused a hard stop.
If True, downstream execution must abort immediately.
"""


Expand Down