护栏

护栏可以与智能体并行运行，也可以阻止执行直至检查完成，从而对用户输入或智能体输出进行检查和验证。例如，您可以在调用高成本模型之前，先运行一个轻量级模型作为护栏。如果护栏检测到恶意使用，它可以触发错误并阻止高成本模型运行。

护栏分为三类：

输入护栏针对初始用户输入运行。
输出护栏针对最终智能体输出运行。
工具护栏在每次调用自定义函数工具前后运行。

工作流边界

护栏附加到智能体，但不一定会针对工作流中的每个智能体运行：

输入护栏仅针对链中的第一个智能体运行。
输出护栏仅针对生成最终输出的智能体运行。
工具护栏针对每次函数工具调用运行，其中输入护栏在执行前运行，输出护栏在执行后运行。

如果需要检查包含管理器或交接的工作流中的每次自定义函数工具调用，请使用工具护栏，而不是智能体级输入护栏和输出护栏。

输入护栏

输入护栏分三个步骤运行：

护栏接收传递给智能体的相同输入。
护栏函数执行并返回一个封装在 InputGuardrailResult 中的 GuardrailFunctionOutput。
如果 tripwireTriggered 为 true，则抛出 InputGuardrailTripwireTriggered 错误。

注意输入护栏用于处理用户输入，因此仅当智能体是工作流中的第一个智能体时才会运行。护栏配置在智能体本身，因为不同的智能体通常需要不同的护栏。

执行模式

runInParallel: true（默认值）会让输入护栏与智能体并发执行。并发执行可以最大限度地降低延迟，但如果护栏之后触发，模型可能已经消耗了 token 或运行了工具。
runInParallel: false 会在调用模型之前运行护栏。当护栏阻止请求时，这可以避免消耗 token 和执行工具。如果您更重视安全性和成本而非延迟，请使用此模式。

输出护栏

输出护栏分 3 个步骤运行：

护栏接收智能体生成的输出。
护栏函数执行并返回一个封装在 OutputGuardrailResult 中的 GuardrailFunctionOutput。
如果 tripwireTriggered 为 true，则抛出 OutputGuardrailTripwireTriggered 错误。

注意输出护栏仅当智能体是工作流中的最后一个智能体时才会运行。有关实时语音交互，请参阅构建语音智能体。

输出护栏函数还会接收一个可选的 details 对象，其中包含底层 modelResponse 以及本轮生成的输出项。当仅凭最终输出不足以决定响应是否应通过时，可以使用此对象。例如，在触发护栏之前，您可能希望检查完整的生成项列表或提供商响应元数据。

被拒绝的终止工具输出

当 toolUseBehavior 将已完成的函数工具结果设为本次运行的最终输出时，输出护栏会先评估该结果，之后 SDK 才会将结果视为可重放的最终数据。护栏接收原始候选输出。如果护栏触发，SDK 会在 SDK 管理的运行状态、重放数据、会话历史记录和公开触发器错误中，将被拒绝的终止结果替换为 Output withheld by an output guardrail.。

SDK 还会清理可能保留被拒绝输出别名的元数据。对于当前响应，OutputGuardrailResult.agentOutput 会变为相同的占位文本，同时删除 OutputGuardrailResult.outputInfo。当前的工具输出护栏结果会保留其判定，但省略 outputInfo；rejectContent 结果会使用该占位文本作为消息。之前已接受轮次中的结果和历史记录保持不变。

对于可识别的函数调用和结果对，SDK 会保留可安全重放的标识和状态字段，同时替换结果内容。如果 SDK 无法确认当前响应中的哪些项属于被拒绝的终止输出，它会丢弃当前响应中存在歧义的后缀，或以安全失败方式处理，而不是对其进行重放。

这种保护不会撤销外部工具的副作用、收回已经发送给应用程序代码的输出、删除已经存储在 SDK 控制范围之外的数据，也不会修改应用程序持有的原始提供商数据引用。

工具护栏

工具护栏封装函数工具，让您可以在执行前后验证或阻止工具调用。它们配置在工具本身（通过 tool() 选项），并在每次调用该工具时运行。

实际上，这指的是您在 tool({...}) 上设置了 inputGuardrails、outputGuardrails 或两者的自定义函数工具。

工具输入护栏在工具执行前运行，可以通过消息拒绝调用或抛出触发器错误。
工具输出护栏在工具执行后运行，可以用拒绝消息替换输出或抛出触发器错误。

如果本地函数工具还需要人工审批，工具输入护栏通常会在审批完成后、执行前立即运行。若还要在发出待审批请求之前运行这些输入护栏，请在 run() 或 Runner 上设置 toolExecution: { preApprovalInputGuardrails: true }。审批完成后、工具执行之前，护栏仍会再次运行。

工具护栏返回一个 behavior：

allow — 继续执行下一个护栏或工具。
rejectContent — 使用一条消息进行短路处理（跳过工具调用或替换输出）。
throwException — 立即抛出触发器错误。

工具护栏适用于使用 tool() 定义的函数工具。交接会作为类似函数的工具呈现给模型，但它们通过 SDK 的交接路径运行，而不是常规的函数工具管线，因此工具护栏不适用于交接调用本身。托管工具和内置执行工具（computerTool、shellTool、applyPatchTool）也不使用此护栏管线，并且 agent.asTool() 目前不直接公开工具护栏选项。

触发器

护栏失败时，会通过触发器发出信号。运行器首先等待同一批次中启动的其他护栏完成，并记录它们已完成的结果。然后，运行器会抛出相应错误并停止后续运行处理。使用并行输入护栏时，模型或工具可能已经开始工作，如执行模式中所述。

护栏实现

护栏只是一个返回 GuardrailFunctionOutput 的函数。下面是一个最小代码示例，它通过在底层运行另一个智能体，检查用户是否在寻求数学作业帮助。

import {
  Agent,
  run,
  InputGuardrailTripwireTriggered,
  InputGuardrail,
} from '@openai/agents';
import { z } from 'zod';

const guardrailAgent = new Agent({
  name: 'Guardrail check',
  instructions: 'Check if the user is asking you to do their math homework.',
  outputType: z.object({
    isMathHomework: z.boolean(),
    reasoning: z.string(),
  }),
});

const mathGuardrail: InputGuardrail = {
  name: 'Math Homework Guardrail',
  // Set runInParallel to false to block the model until the guardrail completes.
  runInParallel: false,
  execute: async ({ input, context }) => {
    const result = await run(guardrailAgent, input, { context });
    return {
      outputInfo: result.finalOutput,
      tripwireTriggered: result.finalOutput?.isMathHomework ?? false,
    };
  },
};

const agent = new Agent({
  name: 'Customer support agent',
  instructions:
    'You are a customer support agent. You help customers with their questions.',
  inputGuardrails: [mathGuardrail],
});

async function main() {
  try {
    await run(agent, 'Hello, can you help me solve for x: 2x + 3 = 11?');
    throw new Error('Expected the math homework guardrail to trip.');
  } catch (e) {
    if (e instanceof InputGuardrailTripwireTriggered) {
      console.log('Math homework guardrail tripped');
      return;
    }
    throw e;
  }
}

main().catch((error) => {
  console.error(error);
  process.exit(1);
});

输出护栏的工作方式相同。

import {
  Agent,
  run,
  OutputGuardrailTripwireTriggered,
  OutputGuardrail,
} from '@openai/agents';
import { z } from 'zod';

// The output by the main agent
const MessageOutput = z.object({ response: z.string() });
type MessageOutput = z.infer<typeof MessageOutput>;

// The output by the math guardrail agent
const MathOutput = z.object({ reasoning: z.string(), isMath: z.boolean() });

// The guardrail agent
const guardrailAgent = new Agent({
  name: 'Guardrail check',
  instructions: 'Check if the output includes any math.',
  outputType: MathOutput,
});

// An output guardrail using an agent internally
const mathGuardrail: OutputGuardrail<typeof MessageOutput> = {
  name: 'Math Guardrail',
  async execute({ agentOutput, context }) {
    const result = await run(guardrailAgent, agentOutput.response, {
      context,
    });
    return {
      outputInfo: result.finalOutput,
      tripwireTriggered: result.finalOutput?.isMath ?? false,
    };
  },
};

const agent = new Agent({
  name: 'Support agent',
  instructions:
    'You are a user support agent. You help users with their questions.',
  outputGuardrails: [mathGuardrail],
  outputType: MessageOutput,
});

async function main() {
  try {
    const input = 'Hello, can you help me solve for x: 2x + 3 = 11?';
    await run(agent, input);
    throw new Error('Expected the math output guardrail to trip.');
  } catch (e) {
    if (e instanceof OutputGuardrailTripwireTriggered) {
      console.log('Math output guardrail tripped');
      return;
    }
    throw e;
  }
}

main().catch((error) => {
  console.error(error);
  process.exit(1);
});

工具输入护栏和工具输出护栏如下所示：

import {
  Agent,
  ToolGuardrailFunctionOutputFactory,
  defineToolInputGuardrail,
  defineToolOutputGuardrail,
  tool,
} from '@openai/agents';
import { z } from 'zod';

const blockSecrets = defineToolInputGuardrail({
  name: 'block_secrets',
  run: async ({ toolCall }) => {
    const args = JSON.parse(toolCall.arguments) as { text?: string };
    if (args.text?.includes('sk-')) {
      return ToolGuardrailFunctionOutputFactory.rejectContent(
        'Remove secrets before calling this tool.',
      );
    }
    return ToolGuardrailFunctionOutputFactory.allow();
  },
});

const redactOutput = defineToolOutputGuardrail({
  name: 'redact_output',
  run: async ({ output }) => {
    const text = String(output ?? '');
    if (text.includes('sk-')) {
      return ToolGuardrailFunctionOutputFactory.rejectContent(
        'Output contained sensitive data.',
      );
    }
    return ToolGuardrailFunctionOutputFactory.allow();
  },
});

const classifyTool = tool({
  name: 'classify_text',
  description: 'Classify text for internal routing.',
  parameters: z.object({
    text: z.string(),
  }),
  inputGuardrails: [blockSecrets],
  outputGuardrails: [redactOutput],
  execute: ({ text }) => `length:${text.length}`,
});

const agent = new Agent({
  name: 'Classifier',
  instructions: 'Classify incoming text.',
  tools: [classifyTool],
});

guardrailAgent 在护栏函数内部使用。
护栏函数接收智能体输入或输出并返回结果。
护栏结果中可以包含额外信息。
agent 定义应用护栏的实际工作流。