跳转到内容

人机协作

本指南介绍 SDK 的基于审批的人工干预流程。当工具调用需要审批时，SDK 会暂停运行，返回 interruptions，并允许您稍后从同一个 RunState 恢复。

该审批入口的作用范围是整个运行，而不限于当前顶层智能体。当工具属于当前智能体、属于通过交接到达的智能体，或属于嵌套的 agent.asTool() 执行时，都适用同一模式。在嵌套的 agent.asTool() 场景中，中断仍会出现在外层运行中，因此您需要在外层 result.state 上批准或拒绝它，并恢复原始根运行。

使用 agent.asTool() 时，审批可能发生在两个不同层级：智能体工具本身可以通过 asTool({ needsApproval }) 要求审批，而嵌套智能体中的工具也可能在嵌套运行启动后再提出自己的审批请求。两者都通过同一个外层运行中断流程处理。

本页重点介绍通过 interruptions 进行的手动审批流程。如果您的应用可以在代码中做出决定，某些工具类型也支持程序化审批回调，让运行无需暂停即可继续。如果您是在设置 agent.asTool() 本身，请参阅工具；本页介绍的是该运行层级中的任何工具需要审批后会发生什么。

审批流程

Section titled “审批流程”

您可以通过将 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
  },
});

流程

Section titled “流程”
  1. 当工具调用即将执行时，SDK 会评估它的审批规则（needsApproval 或对应的托管 MCP 规则）。
  2. 如果需要审批且尚未存储决策，则该工具调用不会执行。相反，运行会记录一个 RunToolApprovalItem。
  3. 在该轮结束时，运行会暂停，并在执行结果的 interruptions 数组中返回所有待审批项。这包括嵌套 agent.asTool() 运行中提出的审批请求。
  4. 使用 result.state.approve(interruption) 或 result.state.reject(interruption) 处理每个待处理项。如果同一个工具在本次运行剩余期间都应保持批准或拒绝，请传入 { alwaysApprove: true } 或 { alwaysReject: true }。拒绝时，您还可以传入 { message: '...' }，用于控制发送回模型的、针对该特定工具调用的拒绝文本。
  5. 将更新后的 result.state 传回 runner.run(agent, state) 来恢复运行，其中 agent 是本次运行的原始顶层智能体。SDK 会从中断点继续，包括嵌套的智能体工具执行。

使用 { alwaysApprove: true } 或 { alwaysReject: true } 创建的粘性决策会存储在运行状态中，因此当您稍后恢复同一个已暂停运行时，它们会在 toString() / fromString() 后继续保留。

在 GA 模型上，计算机工具中断可以表示一个 computer_call 中的一批操作。SDK 会在执行前按操作评估 needsApproval，因此一个待审批项可以覆盖诸如移动 + 点击这样的操作序列。如果您检查 interruption.rawItem 来渲染 UI，请同时处理 GA 的 actions 数组和旧版的单个 action 字段。

序列化的 RunState 还会同时保留当前 computer 工具名称和旧版 computer_use_preview 名称下的计算机工具审批，因此在从 preview 迁移到 GA 的过程中，已暂停的运行也可以干净地恢复。

如果您没有提供 message，SDK 会回退到已配置的 toolErrorFormatter（如有），然后回退到默认拒绝文本。

您不需要在同一次处理中解决所有待审批项。如果您只批准或拒绝其中一部分后重新运行，已处理的调用可以继续，而未处理的调用会保留在 interruptions 中，并再次暂停运行。

自动审批决策

Section titled “自动审批决策”

手动 interruptions 是最通用的模式，但并不是唯一模式：

  • 本地 shellTool() 和 applyPatchTool() 可以使用 onApproval 在代码中立即批准或拒绝。
  • 托管 MCP 工具可以将 requireApproval 与 onApproval 结合使用，实现同类程序化决策。
  • 普通函数工具使用本页介绍的手动中断流程。

当这些回调返回决策时，运行会继续，而不会暂停等待人工响应。对于 Realtime / 语音会话 API，请参阅构建语音智能体中的审批流程。

流式传输与会话

Section titled “流式传输与会话”

同一中断流程也适用于流式传输运行。流式运行暂停后，等待 stream.completed，读取 stream.interruptions，处理这些中断项；如果您希望恢复后的输出继续流式传输，请再次调用带有 { stream: true } 的 run()。有关该模式的流式传输版本，请参阅流式传输期间的人工干预。

如果您还在使用 session，从 RunState 恢复时请继续传入同一个 session。这样，恢复后的轮次会追加到会话记忆中，而无需重新准备输入。有关会话生命周期的详细信息，请参阅会话。

示例

Section titled “示例”

下面是一个更完整的人工干预流程示例，它会在终端中提示进行审批，并将状态临时存储在文件中。

人工干预
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) {
    // storing
    await fs.writeFile(
      'result.json',
      JSON.stringify(result.state, null, 2),
      'utf-8',
    );


    // from here on you could run things on a different thread/process


    // reading later on
    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 of the current state
    result = await run(agent, state);
    hasInterruptions = result.interruptions?.length > 0;
  }


  console.log(result.finalOutput);
}


main().catch((error) => {
  console.dir(error, { depth: null });
});

有关可运行的端到端版本，请参阅完整示例脚本。

较长审批时间的处理

Section titled “较长审批时间的处理”

人工干预流程设计为可以长时间中断，而不需要让您的服务器一直运行。如果您需要结束请求并稍后继续，可以序列化状态，并在之后恢复。

您可以使用 result.state.toString()（或 JSON.stringify(result.state)）序列化状态，并在稍后通过将序列化状态传入 RunState.fromString(agent, serializedState) 来恢复，其中 agent 是触发整体运行的智能体实例。

序列化 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 时恢复序列化的 toolInput。
  • contextStrategy: 'replace' 会按原样使用提供的 RunContext 重建运行。

序列化的运行状态包含您的应用上下文，以及由 SDK 管理的运行时元数据，例如审批、用量、嵌套的 toolInput 和待恢复的嵌套智能体工具。如果您计划存储或传输序列化状态，请将 runContext.context 视为持久化数据，并避免在其中放置密钥，除非您确实希望它们随状态一同传递。

默认情况下，追踪 API 密钥会从序列化状态中省略，以免您意外持久化密钥。只有在您确实需要让追踪凭证随状态一起移动时，才传入 result.state.toString({ includeTracingApiKey: true })。

这样，您就可以将序列化状态存储在数据库中，或与请求一起保存。

待处理任务的版本管理

Section titled “待处理任务的版本管理”

如果您的审批请求耗时较长，并且您打算以有意义的方式对智能体定义进行版本管理，或升级 Agents SDK 版本，我们目前建议您使用包别名并行安装两个版本的 Agents SDK，以实现自己的分支逻辑。

实践中，这意味着为您的代码分配版本号，将其与序列化状态一起存储，并引导反序列化使用正确版本的代码。