ガードレール

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

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

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

Input guardrails

Input guardrails は 3 つのステップで動作します:

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

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

Output guardrails

Output guardrails も同じパターンに従います:

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

Note Output guardrails は、エージェントがワークフロー内の最後のエージェントである場合にのみ実行されます。リアルタイムの音声対話については音声エージェントの構築を参照してください。

Tripwires

ガードレールが失敗すると、トリップワイヤーでそれを通知します。トリップワイヤーが発火した時点で、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);

Output guardrails も同様に機能します。

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 はガードレールが適用される実際のワークフローを定義します