휴먼 인 더 루프 (HITL)

이 가이드는 SDK의 승인 기반 휴먼인더루프 (HITL) 흐름을 다룹니다. 도구 호출에 승인이 필요하면 SDK는 실행을 일시 중지하고 interruptions를 반환하며, 나중에 같은 RunState에서 재개할 수 있게 합니다.

이 승인 표면은 실행 전체에 적용되며, 현재 최상위 에이전트로 제한되지 않습니다. 같은 패턴이 현재 에이전트의 도구, 핸드오프를 통해 도달한 에이전트의 도구, 중첩된 agent.asTool() 실행의 도구에도 적용됩니다. 중첩 agent.asTool()의 경우에도 인터럽션은 바깥쪽 실행에 표시되므로, 바깥쪽 result.state에서 승인 또는 거절한 뒤 원래 루트 실행을 재개합니다.

agent.asTool()에서는 승인이 두 계층에서 발생할 수 있습니다. 에이전트 도구 자체가 asTool({ needsApproval })로 승인을 요구할 수 있고, 중첩 실행이 시작된 뒤 중첩 에이전트 내부의 도구가 별도로 승인을 요청할 수 있습니다. 둘 다 동일한 바깥쪽 실행 인터럽션 흐름으로 처리됩니다.

이 페이지는 interruptions를 통한 수동 승인 흐름에 초점을 맞춥니다. 앱이 코드로 결정을 내릴 수 있다면, 일부 도구 유형은 프로그래밍 방식 승인 콜백도 지원하므로 실행을 멈추지 않고 계속할 수 있습니다. agent.asTool() 자체를 설정하는 경우 도구 가이드를 참고하세요. 이 페이지는 해당 실행 계층에서 어떤 도구든 승인이 필요해진 이후의 동작을 다룹니다.

승인 흐름

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
  },
});

흐름

1. 도구 호출이 실행되기 직전에 SDK가 해당 승인 규칙(needsApproval 또는 Hosted MCP 동등 기능)을 평가합니다.
2. 승인이 필요하고 아직 결정이 저장되지 않았다면 도구 호출은 실행되지 않습니다. 대신 실행은 RunToolApprovalItem을 기록합니다.
3. 해당 턴의 끝에서 실행이 일시 중지되고, 실행 결과의 interruptions 배열에 보류 중인 승인 항목 전체를 반환합니다. 여기에는 중첩된 agent.asTool() 실행 내부에서 발생한 승인도 포함됩니다.
4. 각 보류 항목을 result.state.approve(interruption) 또는 result.state.reject(interruption)으로 처리합니다. 동일한 도구를 해당 실행의 나머지 동안 계속 승인 또는 거절 상태로 유지하려면 { alwaysApprove: true } 또는 { alwaysReject: true }를 전달하세요. 거절 시에는 { message: '...' }도 전달해 해당 도구 호출에 대해 모델로 되돌아가는 거절 텍스트를 제어할 수 있습니다.
5. 업데이트된 result.state를 runner.run(agent, state)에 다시 전달해 재개합니다. 여기서 agent는 해당 실행의 원래 최상위 에이전트입니다. SDK는 중단된 지점부터 계속 진행하며, 중첩된 agent-tool 실행도 포함됩니다.

{ alwaysApprove: true } 또는 { alwaysReject: true }로 생성한 고정 결정은 실행 상태에 저장되므로, 같은 일시 중지 실행을 나중에 재개할 때 toString() / fromString() 이후에도 유지됩니다.

컴퓨터 도구 인터럽션은 GA 모델의 하나의 computer_call에서 여러 액션 배치를 나타낼 수 있습니다. SDK는 실행 전에 액션별로 needsApproval을 평가하므로, 하나의 보류 승인으로 move + click 같은 연속 작업을 포괄할 수 있습니다. UI 렌더링을 위해 interruption.rawItem을 확인하는 경우, GA의 actions 배열과 레거시 단일 action 필드를 모두 처리하세요.

직렬화된 RunState는 현재 computer 도구 이름과 레거시 computer_use_preview 이름 모두에서 컴퓨터 승인 상태를 보존하므로, preview에서 GA로 마이그레이션하는 동안에도 일시 중지된 실행을 안정적으로 재개할 수 있습니다.

message를 제공하지 않으면 SDK는 먼저 설정된 toolErrorFormatter(있다면)를 사용하고, 그다음 기본 거절 텍스트를 사용합니다.

같은 패스에서 모든 보류 승인을 처리할 필요는 없습니다. 일부 항목만 승인 또는 거절한 뒤 다시 실행하면, 처리된 호출은 계속 진행되고 미처리 항목은 interruptions에 남아 실행을 다시 일시 중지합니다.

자동 승인 결정

수동 interruptions는 가장 일반적인 패턴이지만 유일한 방법은 아닙니다.

• 로컬 shellTool() 및 applyPatchTool()은 onApproval을 사용해 코드에서 즉시 승인 또는 거절할 수 있습니다
• Hosted MCP 도구는 requireApproval과 onApproval을 함께 사용해 같은 방식의 프로그래밍 결정이 가능합니다
• 일반 함수 도구는 이 페이지의 수동 인터럽션 흐름을 사용합니다

이 콜백들이 결정을 반환하면 사람 응답을 기다리기 위해 일시 중지하지 않고 실행이 계속됩니다. Realtime / 음성 세션 API의 경우 음성 에이전트 구축의 승인 흐름을 참고하세요.

스트리밍 및 세션

같은 인터럽션 흐름은 스트리밍 실행에서도 동작합니다. 스트리밍 실행이 일시 중지되면 stream.completed를 기다리고, stream.interruptions를 읽어 처리한 뒤, 재개 출력도 계속 스트리밍하려면 { stream: true }와 함께 run()을 다시 호출하세요. 이 패턴의 스트리밍 버전은 스트리밍 중 휴먼인더루프 (HITL)을 참고하세요.

session도 함께 사용 중이라면 RunState에서 재개할 때 같은 session을 계속 전달하세요. 그러면 재개된 턴이 입력을 다시 준비하지 않고 세션 메모리에 추가됩니다. 세션 수명 주기 상세 내용은 세션 가이드를 참고하세요.

예제

아래는 터미널에서 승인을 요청하고 상태를 파일에 임시 저장하는 휴먼인더루프 (HITL) 흐름의 좀 더 완전한 예제입니다.

휴먼인더루프 (HITL)

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.name} with "${interruption.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 });
});

동작하는 end-to-end 버전은 전체 예제 스크립트를 참고하세요.

장시간 승인 처리

휴먼인더루프 (HITL) 흐름은 서버를 계속 실행하지 않아도 더 긴 시간 동안 인터럽션 가능하도록 설계되었습니다. 요청을 종료하고 나중에 이어서 진행해야 한다면 상태를 직렬화해 나중에 재개할 수 있습니다.

result.state.toString()(또는 JSON.stringify(result.state))으로 상태를 직렬화하고, 나중에 직렬화된 상태를 RunState.fromString(agent, serializedState)에 전달해 재개할 수 있습니다. 여기서 agent는 전체 실행을 트리거한 에이전트 인스턴스입니다.

재개된 프로세스에서 새로운 컨텍스트 객체를 주입해야 하면 대신 RunState.fromStringWithContext(agent, serializedState, context, { contextStrategy })를 사용하세요.

• contextStrategy: 'merge'(기본값)는 제공된 RunContext를 유지하고, 직렬화된 승인 상태를 병합하며, 새 컨텍스트에 toolInput이 이미 정의되지 않은 경우 직렬화된 toolInput을 복원합니다
• contextStrategy: 'replace'는 제공된 RunContext를 그대로 사용해 실행을 다시 구성합니다

직렬화된 실행 상태에는 앱 컨텍스트와 함께 승인, 사용량, 중첩 toolInput, 보류 중인 중첩 agent-tool 재개 같은 SDK 관리 런타임 메타데이터가 포함됩니다. 직렬화된 상태를 저장하거나 전송할 계획이라면 runContext.context를 영속 데이터로 취급하고, 상태와 함께 이동시키려는 의도가 없다면 비밀 정보를 여기에 두지 마세요.

기본적으로 트레이싱 API 키는 직렬화된 상태에서 제외되어 실수로 비밀 정보를 저장하지 않도록 합니다. 상태와 함께 트레이싱 자격 증명을 의도적으로 이동해야 하는 경우에만 result.state.toString({ includeTracingApiKey: true })를 전달하세요.

이렇게 하면 직렬화된 상태를 데이터베이스에 저장하거나 요청과 함께 저장할 수 있습니다.

보류 작업 버저닝

참고

이는 주로 에이전트를 변경하면서 직렬화된 상태를 더 오랜 기간 저장하려는 경우에 해당합니다.

승인 요청에 더 긴 시간이 걸리고, 에이전트 정의를 의미 있게 버저닝하거나 Agents SDK 버전을 올릴 계획이라면, 현재로서는 패키지 별칭을 사용해 Agents SDK 두 버전을 병렬 설치하고 자체 분기 로직을 구현하는 것을 권장합니다.

실제로는 코드에 자체 버전 번호를 부여하고 이를 직렬화된 상태와 함께 저장한 뒤, 역직렬화 시 올바른 버전의 코드로 안내하는 방식입니다.