コンテンツにスキップ

人間の介入（HITL）

このガイドでは、Human in the loop (人間の介入) サポートを使用して、人間の介入に応じてエージェントの実行を一時停止および再開する方法を説明します。

現在の主なユースケースは、機密性の高いツール実行に対する承認の取得です。

承認リクエスト

Section titled “承認リクエスト”

needsApproval オプションを true、または boolean を返す非同期関数に設定すると、承認が必要なツールを定義できます。

ツール承認の定義
import { tool } from '@openai/agents';
import z from 'zod';


const sensitiveTool = tool({
  name: 'cancelOrder',
  description: 'Cancel order',
  parameters: z.object({
    orderId: z.number(),
  }),
  // always requires approval
  needsApproval: true,
  execute: async ({ orderId }, args) => {
    // prepare order return
  },
});


const sendEmail = tool({
  name: 'sendEmail',
  description: 'Send an email',
  parameters: z.object({
    to: z.string(),
    subject: z.string(),
    body: z.string(),
  }),
  needsApproval: async (_context, { subject }) => {
    // check if the email is spam
    return subject.includes('spam');
  },
  execute: async ({ to, subject, body }, args) => {
    // send email
  },
});

フロー

Section titled “フロー”
  1. エージェントがツール（複数可）の呼び出しを決定すると、needsApproval を評価してそのツールに承認が必要かどうかを確認します
  2. 承認が必要な場合、エージェントは既に承認が付与または拒否されているかを確認します
    • 承認がまだ付与も拒否もされていない場合、ツールは「ツール呼び出しを実行できない」といった静的メッセージをエージェントに返します
    • 承認 / 拒否が存在しない場合、ツール承認リクエストが発生します
  3. エージェントはすべてのツール承認リクエストを収集し、実行を中断します
  4. 中断がある場合、エージェントの実行結果 には保留中のステップを示す interruptions 配列が含まれます。ツール呼び出しに確認が必要なときは、type: "tool_approval_item" の ToolApprovalItem が現れます
  5. result.state.approve(interruption) または result.state.reject(interruption) を呼び出してツール呼び出しを承認または拒否できます
  6. すべての中断を処理したら、result.state を runner.run(agent, state) に渡して実行を再開します。ここで agent は最初に実行を開始したエージェントです
  7. フローはステップ 1 から再び始まります

例

Section titled “例”

以下は、ターミナルで承認を求め、状態を一時的にファイルに保存する Human in the loop (人間の介入) フローのより完全な例です。

Human in the loop
import { z } from 'zod';
import readline from 'node:readline/promises';
import fs from 'node:fs/promises';
import { Agent, run, tool, RunState, RunResult } from '@openai/agents';


const getWeatherTool = tool({
  name: 'get_weather',
  description: 'Get the weather for a given city',
  parameters: z.object({
    location: z.string(),
  }),
  needsApproval: async (_context, { location }) => {
    // forces approval to look up the weather in San Francisco
    return location === 'San Francisco';
  },
  execute: async ({ location }) => {
    return `The weather in ${location} is sunny`;
  },
});


const dataAgentTwo = new Agent({
  name: 'Data agent',
  instructions: 'You are a data agent',
  handoffDescription: 'You know everything about the weather',
  tools: [getWeatherTool],
});


const agent = new Agent({
  name: 'Basic test agent',
  instructions: 'You are a basic agent',
  handoffs: [dataAgentTwo],
});


async function confirm(question: string) {
  const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
  });


  const answer = await rl.question(`${question} (y/n): `);
  const normalizedAnswer = answer.toLowerCase();
  rl.close();
  return normalizedAnswer === 'y' || normalizedAnswer === 'yes';
}


async function main() {
  let result: RunResult<unknown, Agent<unknown, any>> = await run(
    agent,
    'What is the weather in Oakland and San Francisco?',
  );
  let hasInterruptions = result.interruptions?.length > 0;
  while (hasInterruptions) {
    // storing
    await fs.writeFile(
      'result.json',
      JSON.stringify(result.state, null, 2),
      'utf-8',
    );


    // from here on you could run things on a different thread/process


    // reading later on
    const storedState = await fs.readFile('result.json', 'utf-8');
    const state = await RunState.fromString(agent, storedState);


    for (const interruption of result.interruptions) {
      const confirmed = await confirm(
        `Agent ${interruption.agent.name} would like to use the tool ${interruption.rawItem.name} with "${interruption.rawItem.arguments}". Do you approve?`,
      );


      if (confirmed) {
        state.approve(interruption);
      } else {
        state.reject(interruption);
      }
    }


    // resume execution of the current state
    result = await run(agent, state);
    hasInterruptions = result.interruptions?.length > 0;
  }


  console.log(result.finalOutput);
}


main().catch((error) => {
  console.dir(error, { depth: null });
});

動作するエンドツーエンドの例は 完全なスクリプト を参照してください。

長時間の承認待ちに対処する

Section titled “長時間の承認待ちに対処する”

Human in the loop のフローは、サーバーを稼働し続けなくても長時間中断できるように設計されています。リクエストを終了して後で再開する必要がある場合は、状態をシリアライズして再開できます。

JSON.stringify(result.state) を使用して状態をシリアライズし、後で RunState.fromString(agent, serializedState) にシリアライズ済み状態を渡して再開します。ここで agent は実行を開始したエージェントのインスタンスです。

この方法でシリアライズ済み状態をデータベースやリクエストと一緒に保存できます。

保留タスクのバージョニング

Section titled “保留タスクのバージョニング”

承認リクエストに時間がかかり、エージェント定義を意味のある形でバージョン管理したり Agents SDK のバージョンを上げたりする予定がある場合は、パッケージエイリアスを使って複数バージョンの Agents SDK を並行してインストールし、独自のブランチロジックを実装することを推奨します。

実際には、自分のコードにバージョン番号を割り当て、それをシリアライズ済み状態と一緒に保存し、デシリアライズ時に正しいコードバージョンへ誘導するという運用になります。