Files

T

wehub-resource-sync 4ed4e9ff99 chore: import upstream snapshot with attribution

2026-07-13 12:39:17 +08:00

17 KiB

Raw Blame History

exclude
true

휴먼인더루프 (HITL)

휴먼인더루프 (HITL) 흐름을 사용해 사람이 민감한 도구 호출을 승인하거나 거부할 때까지 에이전트 실행을 일시 중지합니다. 도구는 승인이 필요한 시점을 선언하고, 실행 결과는 보류 중인 승인을 인터럽션(중단 처리)으로 노출하며, RunState를 사용하면 결정이 내려진 뒤 실행을 직렬화하고 재개할 수 있습니다.

이 승인 처리는 실행 전체 범위에 적용되며, 현재 최상위 에이전트로 제한되지 않습니다. 도구가 현재 에이전트에 속한 경우, 핸드오프로 도달한 에이전트에 속한 경우, 또는 중첩된 [Agent.as_tool()][agents.agent.Agent.as_tool] 실행에 속한 경우에도 같은 패턴이 적용됩니다. 중첩된 Agent.as_tool()의 경우에도 인터럽션(중단 처리)은 외부 실행에 노출되므로, 외부 RunState에서 승인하거나 거부한 뒤 원래 최상위 실행을 재개합니다.

Agent.as_tool()에서는 두 가지 계층에서 승인이 발생할 수 있습니다. 에이전트 도구 자체가 Agent.as_tool(..., needs_approval=...)를 통해 승인을 요구할 수 있고, 중첩된 에이전트 내부의 도구가 중첩 실행이 시작된 뒤 자체 승인 요청을 나중에 발생시킬 수 있습니다. 둘 다 동일한 외부 실행 인터럽션(중단 처리) 흐름을 통해 처리됩니다.

이 페이지는 interruptions를 통한 수동 승인 흐름에 중점을 둡니다. 앱이 코드로 결정을 내릴 수 있다면, 일부 도구 유형은 실행을 일시 중지하지 않고 계속 진행할 수 있도록 프로그래밍 방식 승인 콜백도 지원합니다.

승인이 필요한 도구 표시

항상 승인을 요구하려면 needs_approval을 True로 설정하거나, 호출마다 결정하는 비동기 함수를 제공합니다. 호출 가능한 함수는 실행 컨텍스트, 파싱된 도구 매개변수, 도구 호출 ID를 받습니다.

from agents import Agent, Runner, function_tool


@function_tool(needs_approval=True)
async def cancel_order(order_id: int) -> str:
    return f"Cancelled order {order_id}"


async def requires_review(_ctx, params, _call_id) -> bool:
    return "refund" in params.get("subject", "").lower()


@function_tool(needs_approval=requires_review)
async def send_email(subject: str, body: str) -> str:
    return f"Sent '{subject}'"


agent = Agent(
    name="Support agent",
    instructions="Handle tickets and ask for approval when needed.",
    tools=[cancel_order, send_email],
)

needs_approval은 [function_tool][agents.tool.function_tool], [Agent.as_tool][agents.agent.Agent.as_tool], [ShellTool][agents.tool.ShellTool], [ApplyPatchTool][agents.tool.ApplyPatchTool]에서 사용할 수 있습니다. 로컬 MCP 서버도 [MCPServerStdio][agents.mcp.server.MCPServerStdio], [MCPServerSse][agents.mcp.server.MCPServerSse], [MCPServerStreamableHttp][agents.mcp.server.MCPServerStreamableHttp]의 require_approval을 통해 승인을 지원합니다. 호스티드 MCP 서버는 tool_config={"require_approval": "always"}와 선택적 on_approval_request 콜백을 사용해 [HostedMCPTool][agents.tool.HostedMCPTool]을 통한 승인을 지원합니다. 셸 및 apply_patch 도구는 인터럽션(중단 처리)을 노출하지 않고 자동 승인 또는 자동 거부하려는 경우 on_approval 콜백을 허용합니다.

승인 흐름의 작동 방식

모델이 도구 호출을 내보내면, 러너는 해당 승인 규칙(needs_approval, require_approval 또는 호스티드 MCP 대응 기능)을 평가합니다.
해당 도구 호출에 대한 승인 결정이 이미 [RunContextWrapper][agents.run_context.RunContextWrapper]에 저장되어 있으면, 러너는 프롬프트를 표시하지 않고 진행합니다. 호출별 승인은 특정 호출 ID 범위로 한정됩니다. 실행의 나머지 동안 해당 도구에 대한 이후 호출에도 같은 결정을 유지하려면 always_approve=True 또는 always_reject=True를 전달합니다.
그렇지 않으면 실행이 일시 중지되고 RunResult.interruptions(또는 RunResultStreaming.interruptions)에 agent.name, tool_name, arguments 같은 세부 정보가 포함된 [ToolApprovalItem][agents.items.ToolApprovalItem] 항목이 들어갑니다. 여기에는 핸드오프 이후 또는 중첩된 Agent.as_tool() 실행 내부에서 발생한 승인도 포함됩니다.
result.to_state()로 결과를 RunState로 변환하고, state.approve(...) 또는 state.reject(...)를 호출한 다음, Runner.run(agent, state) 또는 Runner.run_streamed(agent, state)로 재개합니다. 여기서 agent는 해당 실행의 원래 최상위 에이전트입니다.
재개된 실행은 중단된 지점부터 계속 진행되며, 새 승인이 필요하면 이 흐름으로 다시 들어갑니다.

always_approve=True 또는 always_reject=True로 생성된 고정 결정은 실행 상태에 저장되므로, 나중에 같은 일시 중지된 실행을 재개할 때 state.to_string() / RunState.from_string(...) 및 state.to_json() / RunState.from_json(...) 이후에도 유지됩니다.

보류 중인 모든 승인을 같은 단계에서 해결할 필요는 없습니다. interruptions에는 일반 함수 도구, 호스티드 MCP 승인, 중첩된 Agent.as_tool() 승인이 섞여 있을 수 있습니다. 일부 항목만 승인하거나 거부한 뒤 다시 실행하면, 해결된 호출은 계속 진행될 수 있고 해결되지 않은 호출은 interruptions에 남아 실행을 다시 일시 중지합니다.

사용자 지정 거부 메시지

기본적으로 거부된 도구 호출은 SDK의 표준 거부 텍스트를 실행으로 다시 반환합니다. 이 메시지는 두 계층에서 사용자 지정할 수 있습니다.

실행 전체 폴백: 전체 실행에서 승인 거부에 대해 모델에 표시되는 기본 메시지를 제어하려면 [RunConfig.tool_error_formatter][agents.run.RunConfig.tool_error_formatter]를 설정합니다.
호출별 재정의: 특정 거부된 도구 호출 하나에 다른 메시지를 노출하려면 state.reject(...)에 rejection_message=...를 전달합니다.

둘 다 제공되면 호출별 rejection_message가 실행 전체 포매터보다 우선합니다.

from agents import RunConfig, ToolErrorFormatterArgs


def format_rejection(args: ToolErrorFormatterArgs[None]) -> str | None:
    if args.kind != "approval_rejected":
        return None
    return "Publish action was canceled because approval was rejected."


run_config = RunConfig(tool_error_formatter=format_rejection)

# Later, while resolving a specific interruption:
state.reject(
    interruption,
    rejection_message="Publish action was canceled because the reviewer denied approval.",
)

두 계층을 함께 보여 주는 전체 코드 예제는 examples/agent_patterns/human_in_the_loop_custom_rejection.py를 참고하세요.

자동 승인 결정

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

로컬 [ShellTool][agents.tool.ShellTool] 및 [ApplyPatchTool][agents.tool.ApplyPatchTool]은 코드에서 즉시 승인하거나 거부하기 위해 on_approval을 사용할 수 있습니다.
[HostedMCPTool][agents.tool.HostedMCPTool]은 같은 유형의 프로그래밍 방식 결정을 위해 tool_config={"require_approval": "always"}를 on_approval_request와 함께 사용할 수 있습니다.
일반 [function_tool][agents.tool.function_tool] 도구와 [Agent.as_tool()][agents.agent.Agent.as_tool]는 이 페이지의 수동 인터럽션(중단 처리) 흐름을 사용합니다.

이러한 콜백이 결정을 반환하면, 실행은 사람의 응답을 기다리기 위해 일시 중지하지 않고 계속됩니다. Realtime 및 음성 세션 API의 경우 Realtime 가이드의 승인 흐름을 참고하세요.

스트리밍과 세션

동일한 인터럽션(중단 처리) 흐름은 스트리밍 실행에서도 작동합니다. 스트리밍 실행이 일시 중지된 뒤에는 반복자가 끝날 때까지 [RunResultStreaming.stream_events()][agents.result.RunResultStreaming.stream_events]를 계속 소비하고, [RunResultStreaming.interruptions][agents.result.RunResultStreaming.interruptions]를 검사해 해결한 다음, 재개된 출력도 계속 스트리밍되게 하려면 [Runner.run_streamed(...)][agents.run.Runner.run_streamed]로 재개합니다. 이 패턴의 스트리밍 버전은 스트리밍을 참고하세요.

세션도 함께 사용하는 경우 RunState에서 재개할 때 같은 세션 인스턴스를 계속 전달하거나, 동일한 백킹 스토어를 가리키는 다른 세션 객체를 전달합니다. 그러면 재개된 턴이 동일하게 저장된 대화 기록에 추가됩니다. 세션 수명 주기 세부 정보는 세션을 참고하세요.

예제: 일시 중지, 승인, 재개

아래 스니펫은 JavaScript HITL 가이드와 동일한 흐름을 따릅니다. 도구에 승인이 필요할 때 일시 중지하고, 상태를 디스크에 저장한 뒤, 다시 로드하고, 결정을 수집한 후 재개합니다.

import asyncio
import json
from pathlib import Path

from agents import Agent, Runner, RunState, function_tool


async def needs_oakland_approval(_ctx, params, _call_id) -> bool:
    return "Oakland" in params.get("city", "")


@function_tool(needs_approval=needs_oakland_approval)
async def get_temperature(city: str) -> str:
    return f"The temperature in {city} is 20° Celsius"


agent = Agent(
    name="Weather assistant",
    instructions="Answer weather questions with the provided tools.",
    tools=[get_temperature],
)

STATE_PATH = Path(".cache/hitl_state.json")


def prompt_approval(tool_name: str, arguments: str | None) -> bool:
    answer = input(f"Approve {tool_name} with {arguments}? [y/N]: ").strip().lower()
    return answer in {"y", "yes"}


async def main() -> None:
    result = await Runner.run(agent, "What is the temperature in Oakland?")

    while result.interruptions:
        # Persist the paused state.
        state = result.to_state()
        STATE_PATH.parent.mkdir(parents=True, exist_ok=True)
        STATE_PATH.write_text(state.to_string())

        # Load the state later (could be a different process).
        stored = json.loads(STATE_PATH.read_text())
        state = await RunState.from_json(agent, stored)

        for interruption in result.interruptions:
            approved = await asyncio.get_running_loop().run_in_executor(
                None, prompt_approval, interruption.name or "unknown_tool", interruption.arguments
            )
            if approved:
                state.approve(interruption, always_approve=False)
            else:
                state.reject(interruption)

        result = await Runner.run(agent, state)

    print(result.final_output)


if __name__ == "__main__":
    asyncio.run(main())

이 예제에서 prompt_approval은 input()을 사용하고 run_in_executor(...)로 실행되기 때문에 동기 함수입니다. 승인 소스가 이미 비동기인 경우(예: HTTP 요청 또는 비동기 데이터베이스 쿼리), 대신 async def 함수를 사용하고 직접 await할 수 있습니다.

승인을 기다리는 동안 출력을 스트리밍하려면 Runner.run_streamed를 호출하고, 완료될 때까지 result.stream_events()를 소비한 다음, 위에 표시된 것과 동일한 result.to_state() 및 재개 단계를 따릅니다.

리포지토리 패턴과 코드 예제

스트리밍 승인: examples/agent_patterns/human_in_the_loop_stream.py는 stream_events()를 모두 소비한 다음, Runner.run_streamed(agent, state)로 재개하기 전에 보류 중인 도구 호출을 승인하는 방법을 보여 줍니다.
사용자 지정 거부 텍스트: examples/agent_patterns/human_in_the_loop_custom_rejection.py는 승인이 거부될 때 실행 수준 tool_error_formatter와 호출별 rejection_message 재정의를 결합하는 방법을 보여 줍니다.
도구로 사용하는 에이전트 승인: Agent.as_tool(..., needs_approval=...)는 위임된 에이전트 작업에 검토가 필요할 때 동일한 인터럽션(중단 처리) 흐름을 적용합니다. 중첩된 인터럽션(중단 처리)은 여전히 외부 실행에 노출되므로, 중첩된 에이전트가 아니라 원래 최상위 에이전트를 재개합니다.
로컬 셸 및 apply_patch 도구: ShellTool 및 ApplyPatchTool도 needs_approval을 지원합니다. 향후 호출에 대한 결정을 캐시하려면 state.approve(interruption, always_approve=True) 또는 state.reject(..., always_reject=True)를 사용합니다. 자동 결정을 위해서는 on_approval을 제공하세요(examples/tools/shell.py 참고). 수동 결정을 위해서는 인터럽션(중단 처리)을 처리하세요(examples/tools/shell_human_in_the_loop.py 참고). 호스티드 셸 환경은 needs_approval 또는 on_approval을 지원하지 않습니다. 도구 가이드를 참고하세요.
로컬 MCP 서버: MCP 도구 호출을 제한하려면 MCPServerStdio / MCPServerSse / MCPServerStreamableHttp에서 require_approval을 사용합니다(examples/mcp/get_all_mcp_tools_example/main.py 및 examples/mcp/tool_filter_example/main.py 참고).
호스티드 MCP 서버: HITL을 강제하려면 HostedMCPTool에서 require_approval을 "always"로 설정하고, 선택적으로 자동 승인 또는 거부를 위해 on_approval_request를 제공합니다(examples/hosted_mcp/human_in_the_loop.py 및 examples/hosted_mcp/on_approval.py 참고). 신뢰할 수 있는 서버에는 "never"를 사용합니다(examples/hosted_mcp/simple.py).
세션과 메모리: 승인과 대화 기록이 여러 턴 동안 유지되도록 Runner.run에 세션을 전달합니다. SQLite 및 OpenAI Conversations 세션 변형은 examples/memory/memory_session_hitl_example.py 및 examples/memory/openai_session_hitl_example.py에 있습니다.
실시간 에이전트: 실시간 데모는 RealtimeSession의 approve_tool_call / reject_tool_call을 통해 도구 호출을 승인하거나 거부하는 WebSocket 메시지를 노출합니다. 서버 측 핸들러는 examples/realtime/app/server.py를, API 인터페이스는 Realtime 가이드를 참고하세요.

장기 실행 승인

RunState는 내구성을 갖도록 설계되었습니다. state.to_json() 또는 state.to_string()을 사용해 보류 중인 작업을 데이터베이스나 큐에 저장하고, 나중에 RunState.from_json(...) 또는 RunState.from_string(...)으로 다시 생성합니다.

유용한 직렬화 옵션:

context_serializer: 비매핑 컨텍스트 객체가 직렬화되는 방식을 사용자 지정합니다.
context_deserializer: RunState.from_json(...) 또는 RunState.from_string(...)으로 상태를 로드할 때 비매핑 컨텍스트 객체를 다시 빌드합니다.
strict_context=True: 컨텍스트가 이미 매핑이거나 적절한 serializer/deserializer를 제공한 경우가 아니면 직렬화 또는 역직렬화에 실패합니다.
context_override: 상태를 로드할 때 직렬화된 컨텍스트를 대체합니다. 원래 컨텍스트 객체를 복원하고 싶지 않을 때 유용하지만, 이미 직렬화된 페이로드에서 해당 컨텍스트를 제거하지는 않습니다.
include_tracing_api_key=True: 재개된 작업이 동일한 자격 증명으로 트레이스를 계속 내보내야 하는 경우, 직렬화된 트레이스 페이로드에 트레이싱 API 키를 포함합니다.

직렬화된 실행 상태에는 앱 컨텍스트와 함께 승인, 사용량, 직렬화된 tool_input, 중첩된 agent-as-tool 재개, 트레이스 메타데이터, 서버 관리 대화 설정 같은 SDK 관리 런타임 메타데이터가 포함됩니다. 직렬화된 상태를 저장하거나 전송하려는 경우 RunContextWrapper.context를 영속화된 데이터로 취급하고, 상태와 함께 이동하기를 의도한 경우가 아니라면 그 안에 비밀 정보를 두지 마세요.

보류 중인 작업 버전 관리

승인이 한동안 대기할 수 있다면, 에이전트 정의 또는 SDK의 버전 표시자를 직렬화된 상태와 함께 저장하세요. 그러면 모델, 프롬프트 또는 도구 정의가 변경될 때 비호환성을 피하기 위해 역직렬화를 일치하는 코드 경로로 라우팅할 수 있습니다.

17 KiB Raw Blame History