安全防护措施

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

安全防护措施有两种类型：

输入安全防护措施运行在初始用户输入上
输出安全防护措施运行在最终智能体输出上

输入安全防护措施

输入安全防护措施分三步运行：

首先，安全防护措施接收与智能体相同的输入。
接着，安全防护措施函数运行以生成一个GuardrailFunctionOutput，随后被包装成InputGuardrailResult
最后，我们检查.tripwire_triggered是否为 true。若为 true，则会抛出InputGuardrailTripwireTriggered异常，以便您对用户做出恰当响应或处理该异常。

Note

输入安全防护措施旨在运行于用户输入上，因此只有当某个智能体是第一个智能体时，它的安全防护措施才会运行。您可能会疑惑，为什么 guardrails 属性在智能体上，而不是传给 Runner.run？这是因为安全防护措施通常与具体的智能体相关——不同的智能体会运行不同的安全防护措施，因此将代码就近放置更有利于可读性。

输出安全防护措施

输出安全防护措施分三步运行：

首先，安全防护措施接收由智能体产生的输出。
接着，安全防护措施函数运行以生成一个GuardrailFunctionOutput，随后被包装成OutputGuardrailResult
最后，我们检查.tripwire_triggered是否为 true。若为 true，则会抛出OutputGuardrailTripwireTriggered异常，以便您对用户做出恰当响应或处理该异常。

Note

输出安全防护措施旨在运行于最终的智能体输出上，因此只有当某个智能体是最后一个智能体时，它的安全防护措施才会运行。与输入安全防护措施类似，我们这样设计是因为安全防护措施通常与具体的智能体相关——不同的智能体会运行不同的安全防护措施，因此将代码就近放置更有利于可读性。

触发线

如果输入或输出未通过安全防护措施，安全防护措施可以通过触发线来发出信号。一旦我们发现某个安全防护措施触发了触发线，就会立即抛出 {Input,Output}GuardrailTripwireTriggered 异常并停止智能体执行。

实现安全防护措施

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

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")

这是实际智能体的输出类型。
这是安全防护措施的输出类型。
这是接收智能体输出并返回结果的安全防护措施函数。
这是定义工作流的实际智能体。