휴먼 인 더 루프 (HITL)

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

이 승인 처리 범위는 현재 최상위 에이전트에만 국한되지 않고 실행 전체에 적용됩니다. 도구가 현재 에이전트에 속한 경우, 핸드오프를 통해 도달한 에이전트에 속한 경우, 또는 중첩된 agent.asTool() 실행에 속한 경우에도 동일한 패턴이 적용됩니다. 중첩된 agent.asTool()의 경우에도 인터럽션(중단 처리)은 여전히 외부 실행에 표시되므로, 외부 result.state에서 이를 승인하거나 거부한 뒤 원래 루트 실행을 재개합니다.

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

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

승인 흐름

needsApproval 옵션을 true 또는 불리언을 반환하는 비동기 함수로 설정하여 승인이 필요한 도구를 정의할 수 있습니다.

도구 승인 정의

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 또는 이에 해당하는 호스티드 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는 중첩된 에이전트 도구 실행을 포함하여 중단된 지점부터 계속 진행합니다.

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

컴퓨터 도구 인터럽션(중단 처리)은 GA 모델에서 하나의 computer_call 안에 있는 작업 배치를 나타낼 수 있습니다. SDK는 실행 전에 작업별로 needsApproval을 평가하므로, 하나의 대기 중인 승인이 이동 + 클릭 같은 시퀀스를 포함할 수 있습니다. UI를 렌더링하기 위해 interruption.rawItem을 검사하는 경우 GA actions 배열과 레거시 단일 action 필드를 모두 처리하세요.

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

message를 제공하지 않으면 SDK는 구성된 toolErrorFormatter가 있는 경우 이를 사용하고, 그다음 기본 거부 텍스트를 사용합니다.

대기 중인 모든 승인을 동일한 패스에서 해결할 필요는 없습니다. 일부 항목만 승인하거나 거부한 뒤 다시 실행하면, 해결된 호출은 계속 진행되고 해결되지 않은 항목은 interruptions에 남아 실행을 다시 일시 중지합니다.

자동 승인 결정

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

• 로컬 shellTool() 및 applyPatchTool()은 onApproval을 사용하여 코드에서 즉시 승인하거나 거부할 수 있습니다.
• 호스티드 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 });
});

작동하는 엔드투엔드 버전은 전체 예제 스크립트를 참조하세요.

더 긴 승인 시간 처리

휴먼인더루프 (HITL) 흐름은 서버를 계속 실행 상태로 유지하지 않고도 더 긴 시간 동안 인터럽트할 수 있도록 설계되었습니다. 요청을 종료하고 나중에 계속해야 하는 경우 상태를 직렬화하고 나중에 재개할 수 있습니다.

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

RunState가 직렬화되면 SDK는 핸드오프 및 Agent.asTool() 그래프에 대한 안정적인 에이전트 ID를 기록합니다. 이렇게 하면 서로 다른 에이전트가 동일한 name을 공유하더라도, 실행을 재개하는 프로세스가 동일한 에이전트 그래프를 다시 빌드하는 한 일시 중지된 실행을 재개할 수 있습니다.

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

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

직렬화된 실행 상태에는 앱 컨텍스트와 함께 승인, 사용량, 중첩된 toolInput, 대기 중인 중첩 에이전트 도구 재개와 같은 SDK 관리 런타임 메타데이터가 포함됩니다. 직렬화된 상태를 저장하거나 전송할 계획이라면 runContext.context를 영속 데이터로 취급하고, 상태와 함께 이동시키려는 의도가 아니라면 그 안에 시크릿을 넣지 마세요.

기본적으로 트레이싱 API 키는 직렬화된 상태에서 제외되므로 실수로 시크릿을 영속화하지 않습니다. 상태와 함께 트레이싱 자격 증명을 이동해야 하는 경우에만 result.state.toString({ includeTracingApiKey: true })를 전달하세요.

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

대기 중인 작업 버전 관리

참고

이는 주로 에이전트를 변경하는 동안 직렬화된 상태를 더 오래 저장하려는 경우에 적용됩니다.

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

실제로 이는 자체 코드에 버전 번호를 부여하고, 이를 직렬화된 상태와 함께 저장한 다음, 역직렬화가 코드의 올바른 버전으로 안내되도록 하는 것을 의미합니다.