ガードレール

ガードレールはエージェントと 並列で 実行され、ユーザー入力やエージェント出力に対してチェックやバリデーションを行えます。たとえば、コストの高いモデルを呼び出す前に軽量モデルをガードレールとして実行することができます。ガードレールが悪意のある利用を検出した場合、エラーを発生させて高価なモデルの実行を停止できます。

ガードレールには 2 種類あります:

入力ガードレール は最初のユーザー入力に対して実行されます
出力ガードレール は最終的なエージェント出力に対して実行されます

入力ガードレール

入力ガードレールは次の 3 ステップで動作します:

ガードレールはエージェントに渡されたものと同じ入力を受け取ります
ガードレール関数が実行され、その戻り値として GuardrailFunctionOutput を InputGuardrailResult にラップして返します
tripwireTriggered が true の場合、InputGuardrailTripwireTriggered エラーがスローされます

Note
入力ガードレールはユーザー入力を対象としているため、ワークフロー内で最初のエージェントに対してのみ実行されます。ガードレールはエージェントごとに設定します。エージェントごとに必要なガードレールが異なることが多いためです。

出力ガードレール

出力ガードレールも同じパターンに従います:

ガードレールはエージェントに渡されたものと同じ入力を受け取ります
ガードレール関数が実行され、その戻り値として GuardrailFunctionOutput を OutputGuardrailResult にラップして返します
tripwireTriggered が true の場合、OutputGuardrailTripwireTriggered エラーがスローされます

Note
出力ガードレールはワークフロー内で最後のエージェントに対してのみ実行されます。リアルタイム音声インタラクションについては音声エージェントの構築を参照してください。

トリップワイヤ

ガードレールが失敗すると、トリップワイヤを通じてそれを通知します。トリップワイヤが発火すると直ちに 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',
  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 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);
    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);

guardrailAgent はガードレール関数内で使用されます
ガードレール関数はエージェントの入力または出力を受け取り、結果を返します
追加情報をガードレール結果に含めることもできます
agent がガードレールを適用する実際のワークフローを定義します