docs: fix output guardrail step description #724
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes a copy-paste error in docs/guardrails.md: the first step of “Output guardrails run in 3 steps” said the guardrail “receives the same input passed to the agent,” which contradicts the note and example code. The guardrail actually receives the agent’s output.
What’s changed
No code or API behavior is affected—this is documentation only.
Rationale
This clarification prevents confusion for developers writing custom guardrails, aligning the prose with the example signature (
def my_guardrail(output: MessageOutput, …)).Checklist
make docs) without warningsCloses #.