휴먼 인 더 루프 (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 },});- 도구 호출이 실행되기 직전에 SDK가 승인 규칙(
needsApproval또는 이에 해당하는 호스티드 MCP 규칙)을 평가합니다. - 승인이 필요하지만 아직 저장된 결정이 없으면 도구 호출은 실행되지 않습니다. 대신 실행에서
RunToolApprovalItem을 기록합니다. - 해당 턴이 끝나면 실행이 일시 중지되고 실행 결과의
interruptions배열에 대기 중인 모든 승인이 반환됩니다. 여기에는 중첩된agent.asTool()실행 내부에서 발생한 승인도 포함됩니다. - 대기 중인 각 항목을
result.state.approve(interruption)또는result.state.reject(interruption)로 처리합니다. 실행이 끝날 때까지 동일한 도구를 계속 승인하거나 거부하려면{ alwaysApprove: true }또는{ alwaysReject: true }를 전달합니다. 거부할 때는{ message: '...' }를 전달하여 해당 도구 호출에 대해 모델로 반환되는 거부 메시지를 제어할 수도 있습니다. - 업데이트된
result.state를runner.run(agent, state)에 다시 전달하여 재개합니다. 여기서agent는 실행의 원래 최상위 에이전트입니다. SDK는 중첩된 에이전트 도구 실행을 포함해 인터럽션(중단 처리)이 발생한 지점부터 계속합니다.
기본적으로 함수 도구 입력 가드레일은 승인 후 도구가 실행되기 직전에만 실행됩니다. 대기 중인 승인이 표시되기 전에 동일한 입력 가드레일로 로컬 함수 도구 호출을 검증하려면 run() 또는 Runner에 toolExecution: { preApprovalInputGuardrails: true }를 전달합니다. 승인 전 가드레일이 호출을 거부하면 SDK는 승인 인터럽션(중단 처리)을 생성하는 대신 가드레일 메시지를 도구 출력으로 모델에 반환합니다. 호출을 허용하면 실행은 승인을 위해 계속 일시 중지되며, 대기 중 도구 호출이 안전하지 않게 변경되었을 가능성에 대비해 승인 후 입력 가드레일이 다시 실행됩니다.
needsApproval이 함수인 경우 SDK는 도구 인수가 검사 가능한 객체로 파싱된 후에만 이 함수를 호출합니다. 잘못된 JSON과 객체가 아닌 값은 안전을 위해 차단됩니다. SDK는 콜백을 호출하거나 도구를 실행하지 않고 승인을 요청합니다. 해당 호출을 승인해도 도구는 실행되지 않으며, 일반적인 인수 파싱 오류 경로로 계속 진행됩니다. Realtime 함수 도구에도 동일한 규칙이 적용되며, 유효하지 않은 호출에 대해 tool_approval_requested를 내보냅니다.
{ alwaysApprove: true } 또는 { alwaysReject: true }로 생성된 지속 결정은 실행 상태에 저장되므로, 나중에 동일한 일시 중지된 실행을 재개할 때 toString() / fromString()을 거쳐도 유지됩니다.
정식 출시(GA) 모델에서 컴퓨터 도구 인터럽션(중단 처리)은 하나의 computer_call에 포함된 작업 배치를 나타낼 수 있습니다. SDK는 실행 전에 각 작업별로 needsApproval을 평가하므로, 하나의 대기 중인 승인으로 이동과 클릭 같은 작업 시퀀스를 처리할 수 있습니다. UI를 렌더링하기 위해 interruption.rawItem을 검사한다면 정식 출시(GA)의 actions 배열과 레거시 단일 action 필드를 모두 처리해야 합니다.
직렬화된 RunState는 현재 computer 도구 이름과 레거시 computer_use_preview 이름 모두에서 컴퓨터 승인을 유지하므로, 프리뷰에서 정식 출시(GA)로 마이그레이션하는 동안에도 일시 중지된 실행을 문제없이 재개할 수 있습니다.
message를 제공하지 않으면 SDK는 설정된 toolErrorFormatter가 있을 경우 이를 사용하고, 그렇지 않으면 기본 거부 메시지를 사용합니다.
대기 중인 모든 승인을 한 번에 처리할 필요는 없습니다. 일부 항목만 승인하거나 거부한 후 다시 실행하면 처리된 호출은 계속 진행되고, 처리되지 않은 호출은 interruptions에 남아 실행을 다시 일시 중지합니다.
alwaysApprove: true 또는 alwaysReject: true로 생성된 지속 결정은 이후 동일한 도구 호출의 기본값이 됩니다. 특정 호출 ID에 대한 명시적 결정은 이 지속 기본값보다 우선합니다. 지속 승인 상태에서도 하나의 호출을 거부하거나, 지속 거부 상태에서도 하나의 호출을 승인할 수 있으며 다른 호출의 기본값은 변경되지 않습니다. 나중에 해당 명시적 결정을 교체하면 새 명시적 결정이 그 호출에 적용되고, 나머지 호출에는 지속 기본값이 계속 적용됩니다.
재개 전 입력 추가
섹션 제목: “재개 전 입력 추가”실행이 일시 중지된 동안 새 사용자 입력이 도착했고 다음 모델 호출을 재개하기 전에 이를 반영해야 한다면 RunState.addInput()을 사용합니다. 승인을 처리하고 동일한 상태를 Runner.run()에 다시 전달하기 전에 입력을 추가합니다. 준비된 입력은 직렬화된 상태에 포함되므로, 처리되지 않은 승인이나 로컬 도구 작업으로 모델 호출이 지연되더라도 toString() / fromString()을 거쳐 유지됩니다.
state.pendingInput을 읽어 준비된 항목의 복제된 스냅샷을 검사하거나, 재개 전에 state.clearPendingInput()을 호출하여 모두 제거할 수 있습니다. addInput()은 문자열 또는 입력 항목 배열을 받습니다. 종료 상태, 남은 턴이 없는 상태, 도구 결과가 실행을 종료할 수 있는 인터럽션(중단 처리) 등 상태가 다른 모델 호출에 안전하게 도달할 수 없는 경우 UserError가 발생합니다.
반영된 각 준비 입력은 실행의 newItems에서 RunInputItem이 되고, 원문 입력 항목은 history에 포함됩니다. 로컬 session을 사용하면 SDK는 모델 요청을 시작하기 전에 반영된 입력을 한 번 저장합니다. conversationId 또는 previousResponseId를 사용하면 서버가 응답을 수락할 때까지 입력이 대기 상태로 유지되므로, 수락 전에 발생한 것으로 확인된 실패는 입력을 잃지 않고 재개할 수 있습니다. 요청이 이미 수락되었을 가능성이 있다고 공급자가 보고하면 SDK는 해당 입력을 체크포인트로 기록하고, 이를 조용히 재실행하는 대신 안전을 위해 차단합니다. 별도로 명시적으로 설정하는 안전하지 않은 재실행 재정의는 모델 재시도를 참조하세요.
자동 승인 결정
섹션 제목: “자동 승인 결정”수동 interruptions가 가장 일반적인 패턴이지만 유일한 방식은 아닙니다.
- 로컬
shellTool()및applyPatchTool()은onApproval을 사용하여 코드에서 즉시 승인하거나 거부할 수 있음 - 호스티드 MCP 도구는
requireApproval과onApproval을 함께 사용하여 동일한 방식으로 프로그래밍 방식의 결정을 내릴 수 있음 - 일반 함수 도구는 이 페이지의 수동 인터럽션(중단 처리) 흐름을 사용함
이러한 콜백이 결정을 반환하면 실행은 사람의 응답을 기다리기 위해 일시 중지되지 않고 계속됩니다. Realtime 세션 API의 경우 음성 에이전트 구축 가이드의 승인 흐름을 참조하세요.
스트리밍 및 세션
섹션 제목: “스트리밍 및 세션”동일한 인터럽션(중단 처리) 흐름이 스트리밍 실행에서도 작동합니다. 스트리밍 실행이 일시 중지되면 stream.completed를 기다리고 stream.interruptions를 읽어 처리한 다음, 재개된 출력도 계속 스트리밍하려면 { stream: true }를 사용하여 run()을 다시 호출합니다. 이 패턴의 스트리밍 버전은 스트리밍 중 휴먼인더루프 (HITL)를 참조하세요.
session도 사용 중이라면 RunState에서 재개할 때 동일한 session을 계속 전달합니다. 그러면 입력을 다시 준비하지 않고 재개된 턴이 세션 메모리에 추가됩니다. 세션 수명 주기에 관한 자세한 내용은 세션 가이드를 참조하세요.
다음은 터미널에서 승인을 요청하고 상태를 파일에 임시로 저장하는 휴먼인더루프 (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) { // Store the current run state await fs.writeFile( 'result.json', JSON.stringify(result.state, null, 2), 'utf-8', );
// At this point, another process could review the saved state
// Read the saved state later 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 from the restored 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)을 사용하여 상태를 직렬화할 수 있습니다. 이후 직렬화된 상태를 RunState.fromString(agent, serializedState)에 전달하여 재개할 수 있으며, 여기서 agent는 전체 실행을 시작한 에이전트의 인스턴스입니다.
승인된 함수 도구 결과가 실행의 최종 출력이 될 수 있는 경우 출력 가드레일은 더 엄격한 재개 경계를 적용합니다. 현재 RunState 스키마는 SDK가 확실히 판별할 수 있는 경우 현재 응답에서 생성된 항목의 정확한 소유권을 기록하므로, 지원되는 출력 포함 부분 승인 체크포인트를 직렬화된 상태로 왕복 변환할 수 있습니다. SDK는 추가 모델, 도구 또는 세션 부수 효과가 발생하기 전에 해당 소유권을 검증합니다. 소유권이 누락되거나 유효하지 않거나 모호한 이전 스냅샷과 체크포인트는 여전히 안전을 위해 차단되며 UserError가 발생합니다. 이 경우 안전한 입력에서 새 실행을 시작합니다. 동일한 에이전트 그래프를 다시 구축하고 원래 toolUseBehavior를 유지하세요. 원문 항목을 재실행하여 소유권 오류를 우회하지 마세요.
RunState가 직렬화되면 SDK는 핸드오프 및 Agent.asTool() 그래프에 대한 안정적인 에이전트 식별 정보를 기록합니다. 덕분에 서로 다른 에이전트가 동일한 name을 사용하더라도 실행을 재개하는 프로세스에서 동일한 에이전트 그래프를 다시 구축하면 일시 중지된 실행을 재개할 수 있습니다.
RunState.fromString(agent, serializedState)에 전달된 agent는 다시 구축된 그래프의 루트입니다. 역직렬화 중 SDK는 해당 에이전트의 핸드오프와 Agent.asTool() 참조를 순회한 다음, 상태에 직렬화된 모든 에이전트 참조를 다시 구축된 그래프와 대조하여 해석합니다. 여기에는 현재 에이전트뿐 아니라 생성된 항목, 처리된 모델 응답 및 대기 중인 다음 단계가 보유한 중첩 참조도 포함됩니다.
다른 런타임에서 모델이나 도구를 래핑한 에이전트처럼 대체된 그래프로 재개해야 한다면 원래 그래프로 상태를 역직렬화하고 다시 직렬화한 다음, 그 문자열을 대체된 루트 에이전트로 역직렬화합니다. state.setCurrentAgent(agent)를 호출하면 활성 에이전트만 변경되며, 역직렬화 중 이미 해석된 중첩 참조는 다시 작성되지 않습니다.
재개된 프로세스에 새로운 컨텍스트 객체를 주입해야 한다면 대신 RunState.fromStringWithContext(agent, serializedState, context, { contextStrategy })를 사용합니다.
contextStrategy: 'merge'(기본값)는 제공된RunContext를 유지하고 직렬화된 승인 상태를 병합하며, 새 컨텍스트에 이미 정의되어 있지 않다면 직렬화된toolInput을 복원함contextStrategy: 'replace'는 제공된RunContext를 그대로 사용하여 실행을 다시 구축함
직렬화된 실행 상태에는 애플리케이션 컨텍스트와 함께 승인, 사용량, 중첩된 toolInput, 대기 중인 중첩 에이전트 도구 재개 등 SDK가 관리하는 런타임 메타데이터가 포함됩니다. 직렬화된 상태를 저장하거나 전송할 계획이라면 runContext.context를 영구 저장 데이터로 취급하고, 상태와 함께 비밀 정보를 의도적으로 이동하려는 경우가 아니라면 그 안에 비밀 정보를 넣지 마세요.
기본적으로 비밀 정보를 실수로 영구 저장하지 않도록 트레이싱 API 키는 직렬화된 상태에서 제외됩니다. 트레이싱 자격 증명을 상태와 함께 의도적으로 이동해야 하는 경우에만 result.state.toString({ includeTracingApiKey: true })를 전달하세요.
이 방식으로 직렬화된 상태를 데이터베이스에 저장하거나 요청과 함께 저장할 수 있습니다.
대기 중 작업의 버전 관리
섹션 제목: “대기 중 작업의 버전 관리”승인 요청에 오랜 시간이 걸리고 에이전트 정의를 의미 있게 버전 관리하거나 Agents SDK 버전을 올릴 예정이라면, 현재는 패키지 별칭을 사용하여 두 버전의 Agents SDK를 병렬로 설치하고 자체 분기 로직을 구현하는 방식을 권장합니다.
실제로는 자체 코드에 버전 번호를 할당하고 이를 직렬화된 상태와 함께 저장한 다음, 올바른 코드 버전으로 역직렬화되도록 안내해야 합니다.