实时智能体指南
本指南介绍 OpenAI Agents SDK的实时层如何映射到 OpenAI Realtime API,以及 Python SDK 在此基础上增加的行为。
从这里开始
如果你希望使用默认的 Python 路径,请先阅读快速入门。如果你正在确定应用应使用服务端 WebSocket 还是 SIP,请阅读实时传输。浏览器 WebRTC 传输不属于 Python SDK。
概述
实时智能体会与 Realtime API 保持长期连接,使模型能够增量处理文本和音频、以流式传输方式输出音频、调用工具并处理中断,而无需在每轮对话时重新发起请求。
SDK 的主要组件包括:
- RealtimeAgent:单个实时专家智能体的指令、工具、输出安全防护措施和任务转移
- RealtimeRunner:将起始智能体连接到实时传输层的会话工厂
- RealtimeSession:用于发送输入、接收事件、追踪历史记录和执行工具的实时会话
- RealtimeModel:传输抽象。默认实现是 OpenAI的服务端 WebSocket。
会话生命周期
典型的实时会话流程如下:
- 创建一个或多个
RealtimeAgent。 - 使用起始智能体创建
RealtimeRunner。 - 调用
await runner.run()获取RealtimeSession。 - 使用
async with session:或await session.enter()进入会话。 - 使用
send_message()或send_audio()发送用户输入。 - 迭代处理会话事件,直到对话结束。
与纯文本运行不同,runner.run() 不会立即生成最终结果。它会返回一个实时会话对象,使本地历史记录、后台工具执行、安全防护措施状态和当前智能体配置与传输层保持同步。
默认情况下,RealtimeRunner 使用 OpenAIRealtimeWebSocketModel,因此默认的 Python 路径是通过服务端 WebSocket 连接到 Realtime API。如果传入其他 RealtimeModel,仍会使用相同的会话生命周期和智能体功能,但连接机制可以有所不同。
智能体与会话配置
RealtimeAgent 的设计范围有意比常规 Agent 类型更窄:
- 模型选择在会话级别配置,而不是为每个智能体单独配置。
- 不支持 structured outputs。
- 可以配置语音,但会话生成口语音频后便无法更改。
- 指令、工具调用、任务转移、钩子和输出安全防护措施仍然可用。
RealtimeSessionModelSettings 同时支持较新的嵌套 audio 配置和旧版扁平别名。新代码应优先使用嵌套结构,并为新的实时智能体从 gpt-realtime-2.1 开始:
runner = RealtimeRunner(
starting_agent=agent,
config={
"model_settings": {
"model_name": "gpt-realtime-2.1",
"audio": {
"input": {
"format": "pcm16",
"transcription": {"model": "gpt-4o-mini-transcribe"},
"turn_detection": {"type": "semantic_vad", "interrupt_response": True},
},
"output": {"format": "pcm16", "voice": "ash"},
},
"tool_choice": "auto",
}
},
)
常用的会话级设置包括:
audio.input.format,audio.output.formataudio.input.transcriptionaudio.input.noise_reductionaudio.input.turn_detectionaudio.output.voice,audio.output.speedoutput_modalitiestool_choiceprompttracing
RealtimeRunner(config=...) 中常用的运行级设置包括:
async_tool_callsoutput_guardrailsguardrails_settings.debounce_text_lengthtool_error_formattertracing_disabled
有关完整的类型化接口,请参阅 RealtimeRunConfig 和 RealtimeSessionModelSettings。
输入与输出
文本与结构化用户消息
使用 session.send_message() 发送纯文本或结构化实时消息。
from agents.realtime import RealtimeUserInputMessage
await session.send_message("Summarize what we discussed so far.")
message: RealtimeUserInputMessage = {
"type": "message",
"role": "user",
"content": [
{"type": "input_text", "text": "Describe this image."},
{"type": "input_image", "image_url": image_data_url, "detail": "high"},
],
}
await session.send_message(message)
结构化消息是在实时对话中包含图像输入的主要方式。examples/realtime/app/server.py 中的 Web 演示示例以这种方式转发 input_image 消息。
音频输入
使用 session.send_audio() 以流式传输方式发送原始音频字节:
如果禁用了服务端轮次检测,你需要负责标记轮次边界。高级便捷用法如下:
如果需要更底层的控制,也可以通过底层模型传输层发送原始客户端事件,例如 input_audio_buffer.commit。
手动响应控制
session.send_message() 使用高级路径发送用户输入,并为你启动响应。原始音频缓冲在所有配置下并不会自动执行相同操作。
在 Realtime API 层面,手动轮次控制意味着使用原始 session.update 清除 turn_detection,然后自行发送 input_audio_buffer.commit 和 response.create。
如果你要手动管理轮次,可以通过模型传输层发送原始客户端事件:
from agents.realtime.model_inputs import RealtimeModelSendRawMessage
await session.model.send_event(
RealtimeModelSendRawMessage(
message={
"type": "response.create",
}
)
)
此模式适用于以下情况:
- 已禁用
turn_detection,且你希望自行决定模型何时响应 - 希望在触发响应前检查或限制用户输入
- 需要为带外响应使用自定义提示词
examples/realtime/twilio_sip/server.py 中的 SIP 示例使用原始 response.create 强制发送开场问候语。
事件、历史记录与中断
RealtimeSession 会发出更高级的 SDK 事件,同时在需要时仍会转发原始模型事件。
重要的会话事件包括:
audio,audio_end,audio_interruptedagent_start,agent_endtool_start,tool_end,tool_approval_requiredhandoffhistory_added,history_updatedguardrail_trippedinput_audio_timeout_triggerederrorraw_model_event
对 UI 状态最有用的事件通常是 history_added 和 history_updated。它们会以 RealtimeItem 对象形式公开会话的本地历史记录,其中包括用户消息、助手消息和工具调用。
用量统计
当已完成的模型响应包含用量信息时,OpenAI实时模型会在 raw_model_event 中发出 RealtimeModelUsageEvent。其 usage 字段包含该响应的 token 数量,而 input_tokens_details 和 output_tokens_details 提供可选的模态细分数据。
会话还会将每个响应的用量添加到共享的 RunContextWrapper.usage 中。可在后续的高级事件(例如 agent_end)中通过 event.info.context.usage 读取它,以查看实时会话的累计用量。
from agents.realtime import RealtimeModelUsageEvent
async for event in session:
if event.type == "raw_model_event" and isinstance(
event.data, RealtimeModelUsageEvent
):
response_usage = event.data.usage
print("Response tokens:", response_usage.total_tokens)
print("Input modalities:", event.data.input_tokens_details)
print("Output modalities:", event.data.output_tokens_details)
elif event.type == "agent_end":
session_usage = event.info.context.usage
print("Session tokens:", session_usage.total_tokens)
仅当模型提供方在已完成的响应中包含用量信息时,才会报告用量。累计值涵盖该 RealtimeSession 收到的响应,并非跨会话总计。
中断与播放追踪
当用户打断助手时,会话会发出 audio_interrupted 并更新历史记录,使服务端对话与用户实际听到的内容保持一致。
对于低延迟本地播放,默认播放追踪器通常已足够。在远程或延迟播放场景中,尤其是电话场景,应使用 RealtimePlaybackTracker,使中断截断基于实际播放进度,而不是假设所有已生成的音频都已播放给用户。
examples/realtime/twilio/twilio_handler.py 中的 Twilio 示例展示了此模式。
工具、审批、任务转移与安全防护措施
工具调用
实时智能体支持在实时对话期间使用工具调用:
from agents import function_tool
@function_tool
def get_weather(city: str) -> str:
"""Get current weather for a city."""
return f"The weather in {city} is sunny, 72F."
agent = RealtimeAgent(
name="Assistant",
instructions="You can answer weather questions.",
tools=[get_weather],
)
工具审批
工具调用可以要求在执行前进行人工审批。发生这种情况时,会话会发出 tool_approval_required,并暂停工具运行,直到你调用 approve_tool_call() 或 reject_tool_call()。
如果工具还具有输入安全防护措施,则这些安全防护措施会在审批后、执行前立即运行。若要在发出审批事件之前运行它们,请使用 RealtimeRunner(..., config={"tool_execution": {"pre_approval_tool_input_guardrails": True}}) 创建运行器。通过该预审批检查的调用仍会在审批后、执行前再次接受检查。
async for event in session:
if event.type == "tool_approval_required":
await session.approve_tool_call(event.call_id)
有关具体的服务端审批循环,请参阅 examples/realtime/app/server.py。人工介入文档也介绍了此流程。
任务转移
实时任务转移允许一个智能体将实时对话转交给另一个专家智能体:
from agents.realtime import RealtimeAgent, realtime_handoff
billing_agent = RealtimeAgent(
name="Billing Support",
instructions="You specialize in billing issues.",
)
main_agent = RealtimeAgent(
name="Customer Service",
instructions="Triage the request and hand off when needed.",
handoffs=[
realtime_handoff(
billing_agent,
tool_description_override="Transfer to billing support",
)
],
)
直接使用的 RealtimeAgent 任务转移会被自动封装,而 realtime_handoff(...) 允许你自定义名称、描述、验证、回调和可用性。实时任务转移不支持常规任务转移的 input_filter。
安全防护措施
实时智能体支持对智能体响应使用输出安全防护措施,并支持对工具调用使用输入安全防护措施。输出安全防护措施基于经过防抖处理的转录文本累积结果运行,而不是针对每个部分 token 运行;触发时会发出 guardrail_tripped,而不是引发异常。
from agents.guardrail import GuardrailFunctionOutput, OutputGuardrail
def sensitive_data_check(context, agent, output):
return GuardrailFunctionOutput(
tripwire_triggered="password" in output,
output_info=None,
)
agent = RealtimeAgent(
name="Assistant",
instructions="...",
output_guardrails=[OutputGuardrail(guardrail_function=sensitive_data_check)],
)
当实时输出安全防护措施被触发时,会话会中断当前响应,强制执行 response.cancel,发出 guardrail_tripped,并发送一条后续用户消息,其中包含被触发的安全防护措施名称,以便模型生成替代响应。你的音频播放器仍应监听 audio_interrupted 并立即停止本地播放,因为安全防护措施基于经过防抖处理的转录文本运行,触发机制生效时可能已有部分音频进入缓冲区。
SIP 与电话
Python SDK 通过 OpenAIRealtimeSIPModel 提供一流的 SIP 挂接流程。
当呼叫通过 Realtime Calls API 到达,且你希望将智能体会话挂接到生成的 call_id 时,请使用此流程:
from agents.realtime import RealtimeRunner
from agents.realtime.openai_realtime import OpenAIRealtimeSIPModel
runner = RealtimeRunner(starting_agent=agent, model=OpenAIRealtimeSIPModel())
async with await runner.run(
model_config={
"call_id": call_id_from_webhook,
}
) as session:
async for event in session:
...
如果需要先接听呼叫,并希望接听载荷与基于智能体生成的会话配置保持一致,请使用 OpenAIRealtimeSIPModel.build_initial_session_payload(...)。完整流程可参阅 examples/realtime/twilio_sip/server.py。
底层访问与自定义端点
可以通过 session.model 访问底层传输对象。
以下情况需要使用此对象:
- 通过
session.model.add_listener(...)添加自定义监听器 - 发送原始客户端事件,例如
response.create或session.update - 通过
model_config自定义url、headers或api_key处理 - 使用
call_id挂接到现有实时呼叫
RealtimeModelConfig 支持:
api_keyurlheadersinitial_model_settingsplayback_trackercall_id
此代码仓库提供的 call_id 示例使用 SIP。更广泛的 Realtime API 也会在某些服务端控制流程中使用 call_id,但此处未将这些流程打包为 Python 示例。
连接 Azure OpenAI 时,请传入正式发布版(GA)的 Realtime 端点 URL 和显式请求头。例如:
session = await runner.run(
model_config={
"url": "wss://<your-resource>.openai.azure.com/openai/v1/realtime?model=<deployment-name>",
"headers": {"api-key": "<your-azure-api-key>"},
}
)
对于基于 token 的身份验证,请在 headers 中使用 bearer token:
session = await runner.run(
model_config={
"url": "wss://<your-resource>.openai.azure.com/openai/v1/realtime?model=<deployment-name>",
"headers": {"authorization": f"Bearer {token}"},
}
)
如果传入 headers,SDK 不会自动添加 Authorization。使用实时智能体时,应避免使用旧版 beta 路径(/openai/realtime?api-version=...)。