Skip to content

docs: Fix Guardrail intro to include output validation #697

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.

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

Conversation

Wania-Kazmi
Copy link

@Wania-Kazmi Wania-Kazmi commented May 15, 2025

Problem:
The original introductory sentence stated that guardrails enable validation for just "user input".

Solution:
This change updates the sentence to clarify that guardrails enable validation of "data flowing through your agent system (such as user input or agent output)".

Why this change?
This provides a more accurate and comprehensive initial understanding of what guardrails are used for, as the documentation later details both Input Guardrails (for user input) and Output Guardrails (for agent output). Aligning the introduction makes the documentation clearer from the start.

Specific Change:

  • Old: Guardrails run in parallel to your agents, enabling you to do checks and validations of user input.
  • New: Guardrails run in parallel to your agents, enabling you to perform checks and validations on data flowing through your agent system (such as user input or agent output).

Updated the description of guardrails to specify that they perform checks and validations on data flowing through the agent system, enhancing clarity and understanding of their purpose.
@Wania-Kazmi Wania-Kazmi changed the title docs: Improve Guardrail intro to include output validation docs: Fix Guardrail intro to include output validation May 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant