运行智能体

你可以通过 Runner 类来运行智能体。你有 3 种选择：

1. Runner.run()：异步运行并返回一个 RunResult。
2. Runner.run_sync()：同步方法，内部实际调用 .run()。
3. 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 中使用 run 方法时，你会传入一个起始智能体和输入。输入可以是字符串（被视为用户消息），也可以是输入项列表，这些输入项符合 OpenAI Responses API 的格式。

接着，runner 会运行一个循环：

1. 我们使用当前输入调用当前智能体的 LLM。
2. LLM 产生输出。
   1. 如果 LLM 返回 final_output，循环结束并返回结果。
   2. 如果 LLM 执行任务转移，我们会更新当前智能体和输入，并重新运行循环。
   3. 如果 LLM 产生工具调用，我们会运行这些工具调用，追加结果，并重新运行循环。
3. 如果超过传入的 max_turns，将抛出 MaxTurnsExceeded 异常。

Note

判断 LLM 输出是否被视为“最终输出”的规则是：其产生了所需类型的文本输出，且没有任何工具调用。

流式传输

流式传输允许你在 LLM 运行时额外接收流式事件。流结束后，RunResultStreaming 将包含关于本次运行的完整信息，包括所有新产生的输出。你可以调用 .stream_events() 获取流式事件。更多内容参见流式传输指南。

运行配置

run_config 参数允许你为智能体运行配置一些全局设置：

• model：允许设置一个全局的 LLM 模型使用，而不考虑每个 Agent 上的 model。
• model_provider：用于查找模型名称的模型提供方，默认是 OpenAI。
• model_settings：覆盖智能体特定设置。例如，你可以设置一个全局的 temperature 或 top_p。
• input_guardrails, output_guardrails：在所有运行中包含的输入或输出安全防护措施列表。
• handoff_input_filter：应用于所有任务转移的全局输入过滤器（如果该任务转移尚未设置）。该输入过滤器允许你编辑发送给新智能体的输入。更多详情参见 Handoff.input_filter 的文档。
• nest_handoff_history：当为 True（默认）时，runner 会在调用下一个智能体之前，将此前的对话记录折叠为一条助手消息。辅助机制会将内容放入一个 <CONVERSATION HISTORY> 块中，并在后续任务转移发生时持续追加新轮次。如果你更希望传递原始对话记录，请将其设为 False 或提供自定义的 handoff 过滤器。所有 Runner 方法 在你未显式传入时会自动创建一个 RunConfig，因此快速入门与 code examples 会自动采用此默认值，而任何显式的 Handoff.input_filter 回调仍将覆盖它。单个任务转移可通过 Handoff.nest_handoff_history 覆盖该设置。
• handoff_history_mapper：可选的可调用对象，当 nest_handoff_history 为 True 时接收标准化的转录（历史 + handoff 项）。它必须返回要转发给下一个智能体的输入项的精确列表，使你无需编写完整的 handoff 过滤器即可替换内置摘要。
• tracing_disabled：允许为整个运行禁用追踪。
• trace_include_sensitive_data：配置追踪中是否包含潜在敏感数据，例如 LLM 和工具调用的输入/输出。
• workflow_name, trace_id, group_id：为本次运行设置追踪的工作流名称、追踪 ID 和追踪分组 ID。我们建议至少设置 workflow_name。分组 ID 是可选字段，允许跨多次运行关联追踪。
• trace_metadata：要包含在所有追踪中的元数据。

默认情况下，SDK 在智能体进行任务转移时，会将之前的轮次嵌套到单条助手摘要消息中。这减少了重复的助手消息，并将完整的对话转录置于单个块中，便于新智能体快速扫描。如果你想回到旧行为，传入 RunConfig(nest_handoff_history=False)，或提供一个 handoff_input_filter（或 handoff_history_mapper）以按需转发对话。你也可以在某个特定 handoff 上选择退出（或启用），通过设置 handoff(..., nest_handoff_history=False) 或 True。若想在不编写自定义映射器的情况下更改生成摘要所用的包装文本，调用 set_conversation_history_wrappers（以及 reset_conversation_history_wrappers 恢复默认值）。

对话/聊天线程

调用任一运行方法可能导致一个或多个智能体运行（因此会有一次或多次 LLM 调用），但它代表一次聊天对话中的单个逻辑轮次。例如：

1. 用户轮次：用户输入文本
2. 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 的自动对话管理

为简化流程，你可以使用 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 文档。

服务端托管的对话

你也可以让 OpenAI 的会话状态特性在服务端管理对话状态，而不是通过 to_input_list() 或 Sessions 在本地处理。这样可以在无需手动重发所有历史消息的情况下保留对话历史。详情参见 OpenAI Conversation state 指南。

OpenAI 提供两种跨轮次跟踪状态的方式：

1. 使用 conversation_id

你先使用 OpenAI Conversations API 创建一个对话，然后在每次后续调用中复用其 ID：

from agents import Agent, Runner
from openai import AsyncOpenAI

client = AsyncOpenAI()

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

    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    # First turn
    result1 = await Runner.run(agent, "What city is the Golden Gate Bridge in?", conversation_id=conv_id)
    print(result1.final_output)
    # San Francisco

    # Second turn reuses the same conversation_id
    result2 = await Runner.run(
        agent,
        "What state is it in?",
        conversation_id=conv_id,
    )
    print(result2.final_output)
    # California

2. 使用 previous_response_id

另一种选择是响应链式调用，其中每一轮都显式链接到上一轮的响应 ID。

from agents import Agent, Runner

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

    # First turn
    result1 = await Runner.run(agent, "What city is the Golden Gate Bridge in?")
    print(result1.final_output)
    # San Francisco

    # Second turn, chained to the previous response
    result2 = await Runner.run(
        agent,
        "What state is it in?",
        previous_response_id=result1.last_response_id,
    )
    print(result2.final_output)
    # California

长运行智能体与人工在环

你可以使用 Agents SDK 的 Temporal 集成来运行持久、长时间运行的工作流，包括人工在环任务。观看 Temporal 与 Agents SDK 协同完成长时任务的演示视频，并查看此处的文档。

异常

SDK 在某些情况下会抛出异常。完整列表在 agents.exceptions 中。概览如下：

• AgentsException：SDK 内抛出的所有异常的基类。它作为通用类型，其他特定异常均由其派生。
• MaxTurnsExceeded：当智能体运行超过传递给 Runner.run、Runner.run_sync 或 Runner.run_streamed 的 max_turns 限制时抛出。表示智能体无法在指定的交互轮次内完成任务。
• ModelBehaviorError：当底层模型（LLM）产生意外或无效输出时发生。这可能包括：
  • JSON 结构不合法：当模型为工具调用或其直接输出提供了不合法的 JSON 结构时，尤其是在定义了特定 output_type 的情况下。
  • 与工具相关的意外失败：当模型未能以预期方式使用工具时
• UserError：当你（使用 SDK 编写代码的人）在使用 SDK 时犯错时抛出。通常由不正确的代码实现、无效的配置或对 SDK 的 API 的误用导致。
• InputGuardrailTripwireTriggered, OutputGuardrailTripwireTriggered：当输入安全防护措施或输出安全防护措施的条件被满足时分别抛出。输入安全防护措施在处理前检查传入消息，而输出安全防护措施在交付前检查智能体的最终响应。