护栏
护栏可以与您的智能体并行运行,或阻止执行直到其完成,从而允许您对用户输入或智能体输出执行检查与验证。例如,您可以在调用昂贵模型之前,先运行一个轻量级模型作为护栏。如果护栏检测到恶意使用,它可以触发错误并阻止高成本模型运行。
护栏有两种类型:
- 输入护栏运行在初始用户输入上。
- 输出护栏运行在最终智能体输出上。
护栏附加在智能体上,但它们不一定会在工作流中的每个智能体上运行:
- 输入护栏仅对链路中的第一个智能体运行。
- 输出护栏仅对产生最终输出的智能体运行。
- 工具护栏会在每次函数工具调用时运行,其中输入护栏在执行前运行,输出护栏在执行后运行。
如果您需要在包含管理器或交接的工作流中,对每次自定义函数工具调用进行检查,请使用工具护栏,而不是智能体级别的输入/输出护栏。
输入护栏分三步运行:
- 护栏接收传递给智能体的相同输入。
- 护栏函数执行,并返回一个包装在
InputGuardrailResult中的GuardrailFunctionOutput。 - 如果
tripwireTriggered为true,则会抛出InputGuardrailTripwireTriggered错误。
注意 输入护栏面向用户输入,因此只有当该智能体是工作流中的第一个智能体时才会运行。护栏配置在智能体本身上,因为不同智能体通常需要不同的护栏。
runInParallel: true(默认)会与 LLM/工具调用同时启动护栏。这会将延迟降到最低,但如果护栏稍后触发,模型可能已经消耗了 token 或运行了工具。runInParallel: false会在调用模型之前运行护栏,从而在护栏阻止请求时避免 token 消耗和工具执行。当您更看重安全性和成本而非延迟时,请使用此模式。
输出护栏分 3 步运行:
- 护栏接收由智能体生成的输出。
- 护栏函数执行,并返回一个包装在
OutputGuardrailResult中的GuardrailFunctionOutput。 - 如果
tripwireTriggered为true,则会抛出OutputGuardrailTripwireTriggered错误。
注意 输出护栏仅在该智能体是工作流中的最后一个智能体时运行。对于实时语音交互,请参见语音智能体指南。
输出护栏函数还会接收一个可选的 details 对象,其中包含底层的 modelResponse 以及该轮生成的输出项。当仅凭最终输出不足以判断响应是否应通过时,可使用该对象,例如在触发护栏之前检查完整的生成项列表或提供方响应元数据。
工具护栏包装函数工具,让您可以在执行前后验证或阻止工具调用。它们配置在工具本身上(通过 tool() 选项),并会在该工具的每次调用时运行。
在实践中,这意味着您可以在自定义函数工具中,于 tool({...}) 上设置 inputGuardrails 和/或 outputGuardrails。
- 输入工具护栏在工具执行前运行,可以用消息拒绝调用,或抛出 tripwire。
- 输出工具护栏在工具执行后运行,可以用拒绝消息替换输出,或抛出 tripwire。
工具护栏会返回一个 behavior:
allow—— 继续执行下一个护栏或工具。rejectContent—— 使用一条消息短路返回(跳过工具调用或替换输出)。throwException—— 立即抛出一个 tripwire 错误。
工具护栏适用于您使用 tool() 定义的函数工具。交接会以类似函数工具的形式呈现给模型,但它们通过 SDK 的交接路径运行,而不是普通的函数工具流水线,因此工具护栏不适用于交接调用本身。托管工具和内置执行工具(computerTool、shellTool、applyPatchTool)也不会使用此护栏流水线,且 agent.asTool() 当前也不直接暴露工具护栏选项。
Tripwire
Section titled “Tripwire”当护栏失败时,它会通过 tripwire 发出信号。一旦 tripwire 被触发,runner 就会抛出相应错误并停止执行。
护栏本质上只是一个返回 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?'); console.log("Guardrail didn't trip - this is unexpected"); } catch (e) { if (e instanceof InputGuardrailTripwireTriggered) { console.log('Math homework guardrail tripped'); } }}
main().catch(console.error);输出护栏的工作方式相同。
import { Agent, run, OutputGuardrailTripwireTriggered, OutputGuardrail,} from '@openai/agents';import { z } from 'zod';
// The output by the main agentconst MessageOutput = z.object({ response: z.string() });type MessageOutput = z.infer<typeof MessageOutput>;
// The output by the math guardrail agentconst MathOutput = z.object({ reasoning: z.string(), isMath: z.boolean() });
// The guardrail agentconst guardrailAgent = new Agent({ name: 'Guardrail check', instructions: 'Check if the output includes any math.', outputType: MathOutput,});
// An output guardrail using an agent internallyconst 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); console.log("Guardrail didn't trip - this is unexpected"); } catch (e) { if (e instanceof OutputGuardrailTripwireTriggered) { console.log('Math output guardrail tripped'); } }}
main().catch(console.error);工具输入/输出护栏如下所示:
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定义了实际应用护栏的工作流。