에이전트 실행

Runner 클래스를 통해 에이전트를 실행할 수 있습니다. 다음 3가지 옵션이 있습니다.

Runner.run(): 비동기 방식으로 실행되며 RunResult를 반환합니다.
Runner.run_sync(): 동기 메서드이며 내부적으로 .run()을 실행합니다.
Runner.run_streamed(): 비동기 방식으로 실행되며 RunResultStreaming을 반환합니다. 스트리밍 모드로 LLM을 호출하고, 이벤트가 수신되는 즉시 스트리밍합니다.

from agents import Agent, Runner

async def main():
    agent = Agent(name="Assistant", instructions="You are a helpful assistant")

    result = await Runner.run(agent, "Write a haiku about recursion in programming.")
    print(result.final_output)
    # Code within the code,
    # Functions calling themselves,
    # Infinite loop's dance

자세한 내용은 결과 가이드를 참고하세요.

Runner 수명 주기 및 구성

에이전트 루프

Runner의 실행 메서드를 사용할 때 시작 에이전트와 입력을 전달합니다. 입력은 다음 중 하나일 수 있습니다.

문자열(사용자 메시지로 처리)
OpenAI Responses API 형식의 입력 항목 목록
인터럽션(중단 처리)된 실행을 재개할 때의 RunState

그런 다음 Runner가 다음 루프를 실행합니다.

현재 입력을 사용하여 현재 에이전트의 LLM을 호출합니다.
LLM이 출력을 생성합니다.
1. LLM이 final_output을 반환하면 루프를 종료하고 결과를 반환합니다.
2. LLM이 핸드오프를 수행하면 현재 에이전트와 입력을 업데이트하고 루프를 다시 실행합니다.
3. LLM이 도구 호출을 생성하면 해당 도구 호출을 실행하고 결과를 추가한 후 루프를 다시 실행합니다.
전달된 max_turns를 초과하면 MaxTurnsExceeded 예외가 발생합니다. 이 턴 제한을 비활성화하려면 max_turns=None을 전달하세요.

Note

LLM 출력이 "최종 출력"으로 간주되는 기준은 원하는 유형의 텍스트 출력을 생성하고 도구 호출이 없는 것입니다.

스트리밍

스트리밍을 사용하면 LLM이 실행되는 동안 스트리밍 이벤트도 수신할 수 있습니다. 스트림이 완료되면 RunResultStreaming에 새로 생성된 모든 출력을 비롯한 전체 실행 정보가 포함됩니다. 스트리밍 이벤트를 받으려면 .stream_events()를 호출할 수 있습니다. 자세한 내용은 스트리밍 가이드를 참고하세요.

Responses WebSocket 전송(선택적 도우미)

OpenAI Responses WebSocket 전송을 활성화해도 기존 Runner API를 계속 사용할 수 있습니다. 연결 재사용을 위해 WebSocket 세션 도우미를 사용하는 것이 권장되지만 필수는 아닙니다.

이는 WebSocket 전송을 통한 Responses API이며, Realtime API가 아닙니다.

전송 선택 규칙과 구체적인 모델 객체 또는 사용자 지정 제공자에 관한 주의 사항은 모델을 참고하세요.

패턴 1: 세션 도우미 미사용

WebSocket 전송만 필요하고 SDK가 공유 제공자나 세션을 관리할 필요가 없을 때 사용합니다.

import asyncio

from agents import Agent, Runner, set_default_openai_responses_transport


async def main():
    set_default_openai_responses_transport("websocket")

    agent = Agent(name="Assistant", instructions="Be concise.")
    result = Runner.run_streamed(agent, "Summarize recursion in one sentence.")

    async for event in result.stream_events():
        if event.type == "raw_response_event":
            continue
        print(event.type)


asyncio.run(main())

이 패턴은 단일 실행에 적합합니다. Runner.run() / Runner.run_streamed()를 반복적으로 호출하면 동일한 RunConfig / 제공자 인스턴스를 직접 재사용하지 않는 한 실행할 때마다 다시 연결될 수 있습니다.

패턴 2: `responses_websocket_session()` 사용(다중 턴 재사용에 권장)

동일한 run_config를 상속하는 중첩된 에이전트 도구 호출을 포함하여 여러 실행에서 WebSocket을 지원하는 공유 제공자와 RunConfig를 사용하려면 responses_websocket_session()을 사용하세요.

import asyncio

from agents import Agent, responses_websocket_session


async def main():
    agent = Agent(name="Assistant", instructions="Be concise.")

    async with responses_websocket_session(
        responses_websocket_options={"ping_interval": 20.0, "ping_timeout": 60.0},
    ) as ws:
        first = ws.run_streamed(agent, "Say hello in one short sentence.")
        async for _event in first.stream_events():
            pass

        second = ws.run_streamed(
            agent,
            "Now say goodbye.",
            previous_response_id=first.last_response_id,
        )
        async for _event in second.stream_events():
            pass


asyncio.run(main())

컨텍스트가 종료되기 전에 스트리밍된 결과를 모두 소비하세요. WebSocket 요청이 아직 진행 중일 때 컨텍스트를 종료하면 공유 연결이 강제로 닫힐 수 있습니다.

긴 추론 턴에서 WebSocket 연결 유지 시간 초과가 발생하면 ping_timeout을 늘리거나 ping_timeout=None으로 설정하여 하트비트 시간 초과를 비활성화하세요. WebSocket 지연 시간보다 안정성이 더 중요한 실행에는 HTTP/SSE 전송을 사용하세요.

실행 구성

run_config 매개변수를 사용하면 에이전트 실행의 일부 전역 설정을 구성할 수 있습니다.

일반적인 실행 구성 카테고리

각 에이전트 정의를 변경하지 않고 단일 실행의 동작을 재정의하려면 RunConfig를 사용하세요.

모델, 제공자 및 세션 기본값

model: 각 Agent에 설정된 model과 관계없이 사용할 전역 LLM 모델을 설정할 수 있습니다.
model_provider: 모델 이름을 조회하는 모델 제공자이며 기본값은 OpenAI입니다.
model_settings: 에이전트별 설정을 재정의합니다. 예를 들어 전역 temperature 또는 top_p를 설정할 수 있습니다.
session_settings: 실행 중 기록을 가져올 때 세션 수준 기본값(예: SessionSettings(limit=...))을 재정의합니다.
session_input_callback: Sessions를 사용할 때 각 턴 전에 새로운 사용자 입력을 세션 기록과 병합하는 방식을 사용자 지정합니다. 콜백은 동기 또는 비동기일 수 있습니다.

가드레일, 핸드오프 및 모델 입력 구성

input_guardrails, output_guardrails: 모든 실행에 포함할 입력 또는 출력 가드레일 목록입니다.
handoff_input_filter: 핸드오프에 자체 입력 필터가 아직 없는 경우 모든 핸드오프에 적용할 전역 입력 필터입니다. 입력 필터를 사용하면 새 에이전트로 전송되는 입력을 수정할 수 있습니다. 자세한 내용은 Handoff.input_filter 문서를 참고하세요.
nest_handoff_history: 다음 에이전트를 호출하기 전에 이전 트랜스크립트를 단일 어시스턴트 메시지로 축약하는 선택적 베타 기능입니다. 중첩된 핸드오프를 안정화하는 동안에는 기본적으로 비활성화되어 있습니다. 활성화하려면 True로 설정하고, 원문 트랜스크립트를 그대로 전달하려면 False로 두세요. Runner 메서드는 RunConfig를 전달하지 않으면 자동으로 생성하므로 빠른 시작과 예제에서는 기본적으로 비활성화된 상태를 유지하며, 명시적인 Handoff.input_filter 콜백은 계속해서 이 설정보다 우선합니다. 개별 핸드오프는 Handoff.nest_handoff_history를 통해 이 설정을 재정의할 수 있습니다.
handoff_history_mapper: nest_handoff_history를 선택할 때마다 정규화된 트랜스크립트(기록 + 핸드오프 항목)를 받는 선택적 호출 가능 객체입니다. 다음 에이전트로 전달할 정확한 입력 항목 목록을 반환해야 하므로, 전체 핸드오프 필터를 작성하지 않고도 기본 제공 요약을 대체할 수 있습니다.
call_model_input_filter: 모델 호출 직전에 완전히 준비된 모델 입력(instructions 및 입력 항목)을 수정하는 훅입니다. 예를 들어 기록을 줄이거나 시스템 프롬프트를 삽입할 수 있습니다.
reasoning_item_id_policy: Runner가 이전 출력을 다음 턴의 모델 입력으로 변환할 때 추론 항목 ID를 유지할지 생략할지 제어합니다.

트레이싱 및 관측 가능성

tracing_disabled: 전체 실행에서 트레이싱을 비활성화할 수 있습니다.
tracing: 실행별 트레이싱 API 키와 같은 트레이스 내보내기 설정을 재정의하려면 TracingConfig를 전달합니다.
trace_include_sensitive_data: 트레이스에 LLM 및 도구 호출 입력/출력과 같이 잠재적으로 민감한 데이터를 포함할지 구성합니다.
workflow_name, trace_id, group_id: 실행의 트레이싱 워크플로 이름, 트레이스 ID 및 트레이스 그룹 ID를 설정합니다. 최소한 workflow_name은 설정하는 것이 좋습니다. 그룹 ID는 여러 실행의 트레이스를 연결할 수 있는 선택적 필드입니다.
trace_metadata: 모든 트레이스에 포함할 메타데이터입니다.

도구 실행, 승인 및 도구 오류 동작

tool_execution: 한 번에 실행되는 함수 도구 수를 제한하는 등 로컬 도구 호출의 SDK 측 실행 동작을 구성합니다.
tool_not_found_behavior: 모델이 생성한 함수 도구 호출을 확인할 수 없을 때 Runner가 이를 처리하는 방식을 구성합니다. 기본적으로 ModelBehaviorError가 발생하며, 대신 모델에 표시되는 오류 출력을 반환하도록 선택할 수 있습니다.
tool_error_formatter: 승인 거부 및 선택적 도구 미발견 출력과 같이 모델에 표시되는 도구 오류 메시지를 사용자 지정합니다.

중첩된 핸드오프는 선택적 베타 기능으로 제공됩니다. RunConfig(nest_handoff_history=True)를 전달하거나 특정 핸드오프에서 handoff(..., nest_handoff_history=True)를 설정하여 축약된 트랜스크립트 동작을 활성화하세요. 원문 트랜스크립트를 유지하려면(기본값) 플래그를 설정하지 않거나 대화를 필요한 방식 그대로 전달하는 handoff_input_filter 또는 handoff_history_mapper를 제공하세요. 사용자 지정 매퍼를 작성하지 않고 생성된 요약에 사용되는 래퍼 텍스트를 변경하려면 set_conversation_history_wrappers를 호출하세요. 기본값으로 복원하려면 reset_conversation_history_wrappers를 호출합니다.

실행 구성 세부 정보

`tool_execution`

로컬 함수 도구의 동시 실행 수 제한과 같이 단일 실행에서 로컬 함수 도구에 대한 SDK 측 동작을 구성하려면 tool_execution을 사용하세요.

from agents import Agent, RunConfig, Runner, ToolExecutionConfig

agent = Agent(name="Assistant", tools=[...])

result = await Runner.run(
    agent,
    "Run the required tool calls.",
    run_config=RunConfig(
        tool_execution=ToolExecutionConfig(
            max_function_tool_concurrency=2,
            pre_approval_tool_input_guardrails=True,
        ),
    ),
)

max_function_tool_concurrency=None은 기본 동작을 유지합니다. 모델이 한 턴에 여러 함수 도구 호출을 생성하면 SDK가 생성된 모든 로컬 함수 도구 호출을 시작합니다. 동시에 실행되는 로컬 함수 도구 수를 제한하려면 정수 값을 설정하세요.

이는 제공자 측 ModelSettings.parallel_tool_calls와 별개입니다. parallel_tool_calls는 모델이 단일 응답에서 여러 도구 호출을 생성할 수 있는지를 제어합니다. tool_execution.max_function_tool_concurrency는 모델이 도구 호출을 생성한 후 SDK가 로컬 함수 도구 호출을 실행하는 방식을 제어합니다.

pre_approval_tool_input_guardrails=False는 기본 승인 흐름을 유지합니다. 함수 도구에 승인이 필요한 경우 실행이 먼저 일시 중지되고, 도구 입력 가드레일은 승인 후 실행 직전에만 실행됩니다. 대기 중인 승인 인터럽션(중단 처리)이 생성되기 전에 함수 도구 입력 가드레일을 실행하려면 True로 설정하세요. 이 사전 승인 검사를 통과한 호출도 승인 후 동일한 입력 가드레일을 다시 실행하므로, 시간에 민감한 검사가 실행 전에 다시 검증됩니다.

`tool_not_found_behavior`

기본적으로 모델이 현재 에이전트에서 사용할 수 있는 함수 도구와 일치하지 않는 함수 도구 호출을 생성하면 Runner가 ModelBehaviorError를 발생시킵니다.

실행을 복구 가능한 상태로 유지하려면 tool_not_found_behavior="return_error_to_model"로 설정하세요. 이 모드에서는 SDK가 확인할 수 없는 도구 호출에 대한 function_call_output을 추가하고 모델을 다시 실행하므로, 모델이 사용 가능한 도구를 선택하거나 해당 도구 없이 응답할 수 있습니다.

from agents import Agent, RunConfig, Runner

agent = Agent(name="Assistant", tools=[...])

result = await Runner.run(
    agent,
    "Handle this request with the available tools.",
    run_config=RunConfig(tool_not_found_behavior="return_error_to_model"),
)

현재 이 옵션은 확인할 수 없는 함수 도구 호출에만 적용됩니다. 그 밖의 잘못된 도구 페이로드에는 기존 오류 동작이 계속 적용됩니다.

`tool_error_formatter`

SDK가 모델에 표시되는 도구 오류 출력을 생성할 때 모델에 반환되는 메시지를 사용자 지정하려면 tool_error_formatter를 사용하세요.

포매터는 다음 필드가 포함된 ToolErrorFormatterArgs를 받습니다.

kind: "approval_rejected" 또는 "tool_not_found"과 같은 오류 카테고리
tool_type: 도구 런타임("function", "computer", "shell", "apply_patch" 또는 "custom")
tool_name: 도구 이름
call_id: 도구 호출 ID
default_message: 모델에 표시되는 SDK의 기본 메시지
run_context: 활성 실행 컨텍스트 래퍼

메시지를 대체하려면 문자열을 반환하고, SDK 기본값을 사용하려면 None을 반환하세요.

from agents import Agent, RunConfig, Runner, ToolErrorFormatterArgs


def format_rejection(args: ToolErrorFormatterArgs[None]) -> str | None:
    if args.kind == "approval_rejected":
        return (
            f"Tool call '{args.tool_name}' was rejected by a human reviewer. "
            "Ask for confirmation or propose a safer alternative."
        )
    if args.kind == "tool_not_found":
        return f"Tool '{args.tool_name}' is not available. Choose one of the listed tools."
    return None


agent = Agent(name="Assistant")
result = Runner.run_sync(
    agent,
    "Please delete the production database.",
    run_config=RunConfig(tool_error_formatter=format_rejection),
)

`reasoning_item_id_policy`

reasoning_item_id_policy는 Runner가 기록을 다음 턴으로 전달할 때 추론 항목이 다음 턴의 모델 입력으로 변환되는 방식을 제어합니다(예: RunResult.to_input_list() 또는 세션 기반 실행을 사용하는 경우).

None 또는 "preserve"(기본값): 추론 항목 ID 유지
"omit": 생성된 다음 턴 입력에서 추론 항목 ID 제거

주로 추론 항목이 id와 함께 전송되지만 필수 후속 항목 없이 전송되어 발생하는 Responses API 400 오류 유형에 대한 선택적 완화책으로 "omit"을 사용하세요(예: Item 'rs_...' of type 'reasoning' was provided without its required following item.).

SDK가 이전 출력에서 후속 입력을 구성하는 다중 턴 에이전트 실행에서 이런 문제가 발생할 수 있습니다. 여기에는 세션 지속성, 서버 관리형 대화 델타, 스트리밍/비스트리밍 후속 턴 및 재개 경로가 포함됩니다. 이때 추론 항목 ID는 유지되지만 제공자는 해당 ID가 대응하는 후속 항목과 계속 쌍을 이루도록 요구할 수 있습니다.

reasoning_item_id_policy="omit"으로 설정하면 추론 콘텐츠는 유지하되 추론 항목의 id를 제거하여 SDK가 생성한 후속 입력에서 해당 API 불변 조건이 위반되는 것을 방지합니다.

적용 범위 참고 사항:

SDK가 후속 입력을 구성할 때 생성하거나 전달하는 추론 항목만 변경합니다.
사용자가 제공한 초기 입력 항목은 다시 작성하지 않습니다.
이 정책이 적용된 후에도 call_model_input_filter가 의도적으로 추론 ID를 다시 추가할 수 있습니다.

상태 및 대화 관리

메모리 전략 선택

다음 턴에 상태를 전달하는 일반적인 방법은 네 가지입니다.

전략	상태 저장 위치	적합한 용도	다음 턴에 전달하는 항목
`result.to_input_list()`	애플리케이션 메모리	작은 채팅 루프, 완전한 수동 제어, 모든 제공자	`result.to_input_list()`의 목록과 다음 사용자 메시지
`session`	스토리지 및 SDK	지속적인 채팅 상태, 재개 가능한 실행, 사용자 지정 저장소	동일한 `session` 인스턴스 또는 동일한 저장소를 가리키는 다른 인스턴스
`conversation_id`	OpenAI Conversations API	작업자 또는 서비스 간에 공유하려는 이름이 지정된 서버 측 대화	동일한 `conversation_id`와 새 사용자 턴만 전달
`previous_response_id`	OpenAI Responses API	대화 리소스를 생성하지 않는 경량 서버 관리형 연속 실행	`result.last_response_id`와 새 사용자 턴만 전달

result.to_input_list()와 session은 클라이언트 관리형입니다. conversation_id와 previous_response_id는 OpenAI 관리형이며 OpenAI Responses API를 사용할 때만 적용됩니다. 대부분의 애플리케이션에서는 대화별로 하나의 지속성 전략을 선택하세요. 클라이언트 관리형 기록과 OpenAI 관리형 상태를 혼합하면 두 계층을 의도적으로 조정하지 않는 한 컨텍스트가 중복될 수 있습니다.

Note

세션 지속성은 동일한 실행에서 서버 관리형 대화 설정 (conversation_id, previous_response_id 또는 auto_previous_response_id)과 함께 사용할 수 없습니다. 호출마다 하나의 방식을 선택하세요.

대화 및 채팅 스레드

실행 메서드 중 하나를 호출하면 하나 이상의 에이전트가 실행되어 하나 이상의 LLM 호출이 발생할 수 있지만, 채팅 대화에서는 단일 논리적 턴을 나타냅니다. 예를 들면 다음과 같습니다.

사용자 턴: 사용자가 텍스트 입력
Runner 실행: 첫 번째 에이전트가 LLM을 호출하고 도구를 실행한 뒤 두 번째 에이전트로 핸드오프하고, 두 번째 에이전트가 추가 도구를 실행한 다음 출력을 생성

에이전트 실행이 끝나면 사용자에게 표시할 내용을 선택할 수 있습니다. 예를 들어 에이전트가 생성한 모든 새 항목을 사용자에게 표시하거나 최종 출력만 표시할 수 있습니다. 어느 쪽이든 사용자가 후속 질문을 하면 실행 메서드를 다시 호출할 수 있습니다.

수동 대화 관리

RunResultBase.to_input_list() 메서드를 사용해 다음 턴의 입력을 가져오는 방식으로 대화 기록을 수동으로 관리할 수 있습니다.

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    thread_id = "thread_123"  # Example thread ID
    with trace(workflow_name="Conversation", group_id=thread_id):
        # First turn
        result = await Runner.run(agent, "What city is the Golden Gate Bridge in?")
        print(result.final_output)
        # San Francisco

        # Second turn
        new_input = result.to_input_list() + [{"role": "user", "content": "What state is it in?"}]
        result = await Runner.run(agent, new_input)
        print(result.final_output)
        # California

세션을 통한 자동 대화 관리

더 간단한 방법으로 Sessions를 사용하면 .to_input_list()를 직접 호출하지 않고도 대화 기록을 자동으로 처리할 수 있습니다.

from agents import Agent, Runner, SQLiteSession

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    # Create session instance
    session = SQLiteSession("conversation_123")

    thread_id = "thread_123"  # Example thread ID
    with trace(workflow_name="Conversation", group_id=thread_id):
        # First turn
        result = await Runner.run(agent, "What city is the Golden Gate Bridge in?", session=session)
        print(result.final_output)
        # San Francisco

        # Second turn - agent automatically remembers previous context
        result = await Runner.run(agent, "What state is it in?", session=session)
        print(result.final_output)
        # California

Sessions는 다음 작업을 자동으로 수행합니다.

각 실행 전에 대화 기록 검색
각 실행 후 새 메시지 저장
서로 다른 세션 ID에 대해 별도의 대화 유지

자세한 내용은 Sessions 문서를 참고하세요.

서버 관리형 대화

to_input_list() 또는 Sessions를 사용해 로컬에서 처리하는 대신 OpenAI 대화 상태 기능이 서버 측에서 대화 상태를 관리하도록 할 수도 있습니다. 이를 통해 이전의 모든 메시지를 직접 다시 보내지 않고도 대화 기록을 유지할 수 있습니다. 아래의 서버 관리형 방식 중 하나를 사용할 때는 각 요청에 새 턴의 입력만 전달하고 저장된 ID를 재사용하세요. 자세한 내용은 OpenAI 대화 상태 가이드를 참고하세요.

OpenAI는 여러 턴에 걸쳐 상태를 추적하는 두 가지 방법을 제공합니다.

1. `conversation_id` 사용

먼저 OpenAI Conversations API를 사용하여 대화를 생성한 다음 이후의 모든 호출에서 해당 ID를 재사용합니다.

from agents import Agent, Runner
from openai import AsyncOpenAI

client = AsyncOpenAI()

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    # Create a server-managed conversation
    conversation = await client.conversations.create()
    conv_id = conversation.id

    while True:
        user_input = input("You: ")
        result = await Runner.run(agent, user_input, conversation_id=conv_id)
        print(f"Assistant: {result.final_output}")

2. `previous_response_id` 사용

또 다른 옵션은 각 턴을 이전 턴의 응답 ID에 명시적으로 연결하는 응답 체이닝입니다.

from agents import Agent, Runner

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    previous_response_id = None

    while True:
        user_input = input("You: ")

        # Setting auto_previous_response_id=True enables response chaining automatically
        # for the first turn, even when there's no actual previous response ID yet.
        result = await Runner.run(
            agent,
            user_input,
            previous_response_id=previous_response_id,
            auto_previous_response_id=True,
        )
        previous_response_id = result.last_response_id
        print(f"Assistant: {result.final_output}")

실행이 승인을 위해 일시 중지되고 RunState에서 재개하면 SDK는 저장된 conversation_id / previous_response_id / auto_previous_response_id 설정을 유지하므로 재개된 턴이 동일한 서버 관리형 대화에서 계속됩니다.

conversation_id와 previous_response_id는 상호 배타적입니다. 여러 시스템에서 공유할 수 있는 이름이 지정된 대화 리소스가 필요하면 conversation_id를 사용하세요. 한 턴에서 다음 턴으로 이어지는 가장 가벼운 Responses API 연속 실행 기본 구성 요소가 필요하면 previous_response_id를 사용하세요.

Note

SDK는 conversation_locked 오류를 백오프 방식으로 자동 재시도합니다. 서버 관리형 대화 실행에서는 재시도 전에 내부 대화 추적기의 입력을 되돌려 동일하게 준비된 항목을 문제없이 다시 전송할 수 있도록 합니다.

conversation_id, previous_response_id 또는 auto_previous_response_id와 함께 사용할 수 없는 로컬 세션 기반 실행에서도 SDK는 최근에 저장된 입력 항목을 최선의 방식으로 롤백하여 재시도 후 기록 항목의 중복을 줄입니다.

이 호환성 재시도는 ModelSettings.retry를 구성하지 않아도 수행됩니다. 모델 요청에 대해 더 광범위한 선택적 재시도 동작을 사용하려면 Runner 관리형 재시도를 참고하세요.

훅 및 사용자 지정

모델 호출 입력 필터

모델 호출 직전에 모델 입력을 수정하려면 call_model_input_filter를 사용하세요. 이 훅은 현재 에이전트, 컨텍스트 및 결합된 입력 항목(존재하는 경우 세션 기록 포함)을 받고 새로운 ModelInputData를 반환합니다.

반환 값은 ModelInputData 객체여야 합니다. 해당 객체의 input 필드는 필수이며 입력 항목 목록이어야 합니다. 다른 형태를 반환하면 UserError가 발생합니다.

from agents import Agent, Runner, RunConfig
from agents.run import CallModelData, ModelInputData

def drop_old_messages(data: CallModelData[None]) -> ModelInputData:
    # Keep only the last 5 items and preserve existing instructions.
    trimmed = data.model_data.input[-5:]
    return ModelInputData(input=trimmed, instructions=data.model_data.instructions)

agent = Agent(name="Assistant", instructions="Answer concisely.")
result = Runner.run_sync(
    agent,
    "Explain quines",
    run_config=RunConfig(call_model_input_filter=drop_old_messages),
)

Runner는 준비된 입력 목록의 복사본을 훅에 전달하므로 호출자의 원래 목록을 제자리에서 변경하지 않고도 항목을 줄이거나 대체하거나 순서를 변경할 수 있습니다.

세션을 사용하는 경우 세션 기록을 이미 불러와 현재 턴과 병합한 후 call_model_input_filter가 실행됩니다. 이보다 앞선 병합 단계 자체를 사용자 지정하려면 session_input_callback을 사용하세요.

conversation_id, previous_response_id 또는 auto_previous_response_id를 사용하여 OpenAI 서버 관리형 대화 상태를 사용하는 경우 훅은 다음 Responses API 호출을 위해 준비된 페이로드에서 실행됩니다. 이 페이로드는 이전 기록의 전체 재생이 아니라 이미 새 턴의 델타만 나타낼 수 있습니다. 반환한 항목만 해당 서버 관리형 연속 실행에서 전송된 것으로 표시됩니다.

민감한 데이터를 제거하거나, 긴 기록을 줄이거나, 추가 시스템 지침을 삽입하려면 run_config를 통해 실행별로 훅을 설정하세요.

오류 및 복구

오류 처리기

모든 Runner 진입점은 오류 종류를 키로 사용하는 딕셔너리인 error_handlers를 허용합니다. 지원되는 키는 "max_turns", "model_refusal" 및 "invalid_final_output"입니다. 해당 오류로 실행을 종료하는 대신 제어된 최종 출력을 반환하려면 이를 사용하세요.

from agents import (
    Agent,
    RunErrorHandlerInput,
    RunErrorHandlerResult,
    Runner,
)

agent = Agent(name="Assistant", instructions="Be concise.")


def on_max_turns(_data: RunErrorHandlerInput[None]) -> RunErrorHandlerResult:
    return RunErrorHandlerResult(
        final_output="I couldn't finish within the turn limit. Please narrow the request.",
        include_in_history=False,
    )


result = Runner.run_sync(
    agent,
    "Analyze this long transcript",
    max_turns=3,
    error_handlers={"max_turns": on_max_turns},
)
print(result.final_output)

모델 메시지가 에이전트의 구조화된 output_type에 대해 검증되지 않거나 모델이 구조화된 최종 메시지를 반환하지 않을 때 "invalid_final_output"을 사용하세요. 처리기는 애플리케이션별 대체 값을 반환할 수 있으며, SDK는 동일한 output_type에 대해 이를 검증합니다. 모델 호출을 재시도하거나 도구의 부작용을 다시 실행하지는 않습니다. None을 반환하면 복구를 수행하지 않습니다. 대체 값이 없으면 비어 있지 않은 응답의 검증 실패에서는 계속 ModelBehaviorError가 발생하고, 비어 있는 구조화된 응답에는 기존 다음 턴 동작이 유지됩니다.

from pydantic import BaseModel

from agents import Agent, ModelBehaviorError, RunErrorHandlerInput, Runner


class Recipe(BaseModel):
    ingredients: list[str]
    recovered_from_invalid_output: bool = False


def on_invalid_final_output(data: RunErrorHandlerInput[None]) -> Recipe:
    assert isinstance(data.error, ModelBehaviorError)
    return Recipe(ingredients=[], recovered_from_invalid_output=True)


agent = Agent(
    name="Recipe assistant",
    instructions="Return a structured recipe.",
    output_type=Recipe,
)

result = Runner.run_sync(
    agent,
    "Plan tonight's dinner.",
    error_handlers={"invalid_final_output": on_invalid_final_output},
)
print(result.final_output)

대체 출력을 대화 기록에 추가하지 않으려면 include_in_history=False로 설정하세요.

모델 거부 시 ModelRefusalError로 실행을 종료하는 대신 애플리케이션별 대체 값을 생성하려면 "model_refusal"을 사용하세요.

from pydantic import BaseModel

from agents import Agent, ModelRefusalError, RunErrorHandlerInput, Runner


class Recipe(BaseModel):
    ingredients: list[str]
    refusal_reason: str | None = None


def on_model_refusal(data: RunErrorHandlerInput[None]) -> Recipe:
    assert isinstance(data.error, ModelRefusalError)
    return Recipe(ingredients=[], refusal_reason=data.error.refusal)


agent = Agent(
    name="Recipe assistant",
    instructions="Return a structured recipe.",
    output_type=Recipe,
)

result = Runner.run_sync(
    agent,
    "Make me something unsafe.",
    error_handlers={"model_refusal": on_model_refusal},
)
print(result.final_output)

내구성 실행 통합 및 휴먼인더루프 (HITL)

도구 승인 일시 중지/재개 패턴은 전용 휴먼인더루프 (HITL) 가이드부터 참고하세요. 아래 통합은 실행이 긴 대기, 재시도 또는 프로세스 재시작에 걸쳐 지속될 수 있는 내구성 오케스트레이션을 위한 것입니다.

Dapr

Agents SDK Dapr Diagrid 통합을 사용하면 휴먼인더루프 (HITL) 지원과 함께 장애에서 자동으로 복구되는 내구성 있는 장기 실행 에이전트를 실행할 수 있습니다. Dapr는 공급업체 중립적인 CNCF 워크플로 오케스트레이터입니다. Dapr 및 OpenAI 에이전트 사용은 여기에서 시작할 수 있습니다.

Temporal

Agents SDK Temporal 통합을 사용하면 휴먼인더루프 (HITL) 작업을 포함하여 내구성 있는 장기 실행 워크플로를 실행할 수 있습니다. 장기 실행 작업을 완료하기 위해 Temporal과 Agents SDK가 함께 작동하는 데모는 이 동영상에서 확인할 수 있으며, 문서는 여기에서 볼 수 있습니다.

Restate

Agents SDK Restate 통합을 사용하면 사람의 승인, 핸드오프 및 세션 관리를 포함하는 경량의 내구성 있는 에이전트를 실행할 수 있습니다. 이 통합은 Restate의 단일 바이너리 런타임을 종속성으로 필요로 하며, 에이전트를 프로세스/컨테이너 또는 서버리스 함수로 실행할 수 있습니다. 자세한 내용은 개요 또는 문서를 참고하세요.

DBOS

Agents SDK DBOS 통합을 사용하면 장애와 재시작 후에도 진행 상태를 보존하는 신뢰할 수 있는 에이전트를 실행할 수 있습니다. 장기 실행 에이전트, 휴먼인더루프 (HITL) 워크플로 및 핸드오프를 지원합니다. 동기 및 비동기 메서드를 모두 지원합니다. 이 통합에는 SQLite 또는 Postgres 데이터베이스만 필요합니다. 자세한 내용은 통합 리포지토리 및 문서를 참고하세요.

예외

SDK는 특정 상황에서 예외를 발생시킵니다. 전체 목록은 agents.exceptions에 있습니다. 개요는 다음과 같습니다.

AgentsException: SDK 내에서 발생하는 모든 예외의 기본 클래스입니다. 다른 모든 특정 예외가 파생되는 일반 유형입니다.
MaxTurnsExceeded: 에이전트 실행이 Runner.run, Runner.run_sync 또는 Runner.run_streamed 메서드에 전달된 max_turns 제한을 초과하면 이 예외가 발생합니다. 지정된 상호작용 턴 수 안에 에이전트가 작업을 완료하지 못했음을 나타냅니다. 제한을 비활성화하려면 max_turns=None으로 설정하세요.
ModelBehaviorError: 기반 모델(LLM)이 예상하지 못한 출력이나 유효하지 않은 출력을 생성하면 이 예외가 발생합니다. 다음과 같은 경우가 포함될 수 있습니다.
- 잘못된 형식의 JSON: 특히 특정 output_type이 정의된 경우 모델이 도구 호출 또는 직접 출력에서 잘못된 형식의 JSON 구조를 제공하는 경우
- 예상하지 못한 도구 관련 실패: 모델이 예상된 방식으로 도구를 사용하지 못하는 경우
ToolTimeoutError: 함수 도구 호출이 구성된 제한 시간을 초과하고 도구에서 timeout_behavior="raise_exception"을 사용하는 경우 이 예외가 발생합니다.
UserError: SDK를 사용하는 코드를 작성한 사람이 SDK를 사용하는 중 오류를 범하면 이 예외가 발생합니다. 일반적으로 잘못된 코드 구현, 유효하지 않은 구성 또는 SDK API의 잘못된 사용으로 인해 발생합니다.
InputGuardrailTripwireTriggered, OutputGuardrailTripwireTriggered: 각각 입력 가드레일 또는 출력 가드레일의 조건이 충족되면 이 예외가 발생합니다. 입력 가드레일은 처리 전에 수신 메시지를 검사하고, 출력 가드레일은 전달 전에 에이전트의 최종 응답을 검사합니다.

에이전트 실행

Runner 수명 주기 및 구성

에이전트 루프

스트리밍

Responses WebSocket 전송(선택적 도우미)

패턴 1: 세션 도우미 미사용

패턴 2: responses_websocket_session() 사용(다중 턴 재사용에 권장)

실행 구성

일반적인 실행 구성 카테고리

모델, 제공자 및 세션 기본값

가드레일, 핸드오프 및 모델 입력 구성

트레이싱 및 관측 가능성

도구 실행, 승인 및 도구 오류 동작

실행 구성 세부 정보

tool_execution

tool_not_found_behavior

tool_error_formatter

reasoning_item_id_policy

상태 및 대화 관리

메모리 전략 선택

대화 및 채팅 스레드

수동 대화 관리

세션을 통한 자동 대화 관리

서버 관리형 대화

1. conversation_id 사용

2. previous_response_id 사용

훅 및 사용자 지정

모델 호출 입력 필터

오류 및 복구

오류 처리기

내구성 실행 통합 및 휴먼인더루프 (HITL)

Dapr

Temporal

Restate

DBOS

예외

패턴 2: `responses_websocket_session()` 사용(다중 턴 재사용에 권장)

`tool_execution`

`tool_not_found_behavior`

`tool_error_formatter`

`reasoning_item_id_policy`

1. `conversation_id` 사용

2. `previous_response_id` 사용