From b78a7eb140a7784f9aef7d037f493d9c3c416e01 Mon Sep 17 00:00:00 2001 From: Wania Kazmi <112770629+Wania-Kazmi@users.noreply.github.com> Date: Thu, 15 May 2025 16:56:13 +0500 Subject: [PATCH] docs: clarify guardrails functionality in documentation 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. --- docs/guardrails.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guardrails.md b/docs/guardrails.md index 2f0be0f2..69536d6e 100644 --- a/docs/guardrails.md +++ b/docs/guardrails.md @@ -1,6 +1,6 @@ # Guardrails -Guardrails run _in parallel_ to your agents, enabling you to do checks and validations of user input. For example, imagine you have an agent that uses a very smart (and hence slow/expensive) model to help with customer requests. You wouldn't want malicious users to ask the model to help them with their math homework. So, you can run a guardrail with a fast/cheap model. If the guardrail detects malicious usage, it can immediately raise an error, which stops the expensive model from running and saves you time/money. +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). For example, imagine you have an agent that uses a very smart (and hence slow/expensive) model to help with customer requests. You wouldn't want malicious users to ask the model to help them with their math homework. So, you can run a guardrail with a fast/cheap model. If the guardrail detects malicious usage, it can immediately raise an error, which stops the expensive model from running and saves you time/money. There are two kinds of guardrails: