防护栏

防护栏与您的代理并行运行，使您能够对用户输入进行检查和验证。例如，假设您有一个代理，它使用一个非常智能（因此速度慢/成本高）的模型来帮助处理客户请求。您不希望恶意用户让模型帮助他们完成数学作业。因此，您可以运行一个快速/廉价的模型作为防护栏。如果防护栏检测到恶意使用，它可以立即引发错误，从而阻止昂贵的模型运行，为您节省时间和金钱。

有两种类型的防护栏：

输入防护措施在初始用户输入时运行
输出护栏运行在最终代理输出上

输入防护机制

输入防护措施分3个步骤运行：

首先，护栏接收传递给代理的相同输入。
接下来，防护栏函数运行生成一个GuardrailFunctionOutput，然后被封装在InputGuardrailResult中
最后，我们检查.tripwire_triggered是否为true。如果为true，则会引发InputGuardrailTripwireTriggered异常，以便您可以适当地响应用户或处理该异常。

注意

输入防护栏旨在对用户输入运行，因此只有当代理是第一个代理时，其防护栏才会运行。您可能会疑惑，为什么guardrails属性放在代理上而不是传递给Runner.run？这是因为防护栏通常与实际代理相关——不同代理会运行不同的防护栏，因此将代码放在一起有助于提高可读性。

输出防护栏

输出防护措施分3个步骤运行：

首先，防护栏接收传递给代理的相同输入。
接下来，护栏函数运行生成一个GuardrailFunctionOutput，然后将其包装在OutputGuardrailResult中
最后，我们检查.tripwire_triggered是否为true。如果为true，则会引发OutputGuardrailTripwireTriggered异常，以便您可以适当地响应用户或处理该异常。

注意

输出护栏旨在运行在智能体的最终输出上，因此只有当智能体是最后一个智能体时，其护栏才会运行。与输入护栏类似，我们这样做是因为护栏往往与实际智能体相关——您会为不同智能体运行不同的护栏，因此将代码放在一起有助于提高可读性。

触发机制

如果输入或输出未能通过防护栏检查，防护栏会通过触发线发出信号。一旦我们发现某个防护栏触发了触发线，我们会立即抛出{Input,Output}GuardrailTripwireTriggered异常并停止Agent的执行。

实现防护栏

您需要提供一个接收输入并返回GuardrailFunctionOutput的函数。在本示例中，我们将通过底层运行一个Agent来实现这一点。

from pydantic import BaseModel
from agents import (
    Agent,
    GuardrailFunctionOutput,
    InputGuardrailTripwireTriggered,
    RunContextWrapper,
    Runner,
    TResponseInputItem,
    input_guardrail,
)

class MathHomeworkOutput(BaseModel):
    is_math_homework: bool
    reasoning: str

guardrail_agent = Agent( # (1)!
    name="Guardrail check",
    instructions="Check if the user is asking you to do their math homework.",
    output_type=MathHomeworkOutput,
)


@input_guardrail
async def math_guardrail( # (2)!
    ctx: RunContextWrapper[None], agent: Agent, input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
    result = await Runner.run(guardrail_agent, input, context=ctx.context)

    return GuardrailFunctionOutput(
        output_info=result.final_output, # (3)!
        tripwire_triggered=result.final_output.is_math_homework,
    )


agent = Agent(  # (4)!
    name="Customer support agent",
    instructions="You are a customer support agent. You help customers with their questions.",
    input_guardrails=[math_guardrail],
)

async def main():
    # This should trip the guardrail
    try:
        await Runner.run(agent, "Hello, can you help me solve for x: 2x + 3 = 11?")
        print("Guardrail didn't trip - this is unexpected")

    except InputGuardrailTripwireTriggered:
        print("Math homework guardrail tripped")

我们将在护栏函数中使用此代理。
这是接收代理输入/上下文并返回结果的护栏函数。
我们可以在护栏结果中包含额外信息。
这是定义工作流程的实际代理程序。

输出防护机制也是类似的。

from pydantic import BaseModel
from agents import (
    Agent,
    GuardrailFunctionOutput,
    OutputGuardrailTripwireTriggered,
    RunContextWrapper,
    Runner,
    output_guardrail,
)
class MessageOutput(BaseModel): # (1)!
    response: str

class MathOutput(BaseModel): # (2)!
    reasoning: str
    is_math: bool

guardrail_agent = Agent(
    name="Guardrail check",
    instructions="Check if the output includes any math.",
    output_type=MathOutput,
)

@output_guardrail
async def math_guardrail(  # (3)!
    ctx: RunContextWrapper, agent: Agent, output: MessageOutput
) -> GuardrailFunctionOutput:
    result = await Runner.run(guardrail_agent, output.response, context=ctx.context)

    return GuardrailFunctionOutput(
        output_info=result.final_output,
        tripwire_triggered=result.final_output.is_math,
    )

agent = Agent( # (4)!
    name="Customer support agent",
    instructions="You are a customer support agent. You help customers with their questions.",
    output_guardrails=[math_guardrail],
    output_type=MessageOutput,
)

async def main():
    # This should trip the guardrail
    try:
        await Runner.run(agent, "Hello, can you help me solve for x: 2x + 3 = 11?")
        print("Guardrail didn't trip - this is unexpected")

    except OutputGuardrailTripwireTriggered:
        print("Math output guardrail tripped")

这是代理程序的实际输出类型。
这是护栏的输出类型。
这是接收代理输出并返回结果的护栏函数。
这是定义工作流程的实际代理程序。