运行智能体

智能体本身不会做任何事——您需要使用 Runner 类或 run() 工具来运行它们。

如果您已经阅读过智能体，并且想要执行轮次、流式事件或管理对话状态，请继续阅读本页。如果您仍在决定应如何定义智能体，请先从智能体开始。

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'You are a helpful assistant',
});

const result = await run(
  agent,
  'Write a haiku about recursion in programming.',
);
console.log(result.finalOutput);

// Code within the code,
// Functions calling themselves,
// Infinite loop's dance.

当您不需要自定义 runner 时，也可以使用 run() 工具，它会运行一个单例的默认 Runner 实例。

或者，您也可以创建自己的 runner 实例：

import { Agent, Runner } from '@openai/agents';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'You are a helpful assistant',
});

// You can pass custom configuration to the runner
const runner = new Runner();

const result = await runner.run(
  agent,
  'Write a haiku about recursion in programming.',
);
console.log(result.finalOutput);

// Code within the code,
// Functions calling themselves,
// Infinite loop's dance.

运行智能体后，您会收到一个执行结果对象，其中包含最终输出和该次运行的完整历史记录。

Runner 生命周期与配置

智能体循环

当您在 Runner 中使用 run 方法时，需要传入一个起始智能体和输入。输入可以是字符串（视为用户消息），也可以是输入项列表，即 OpenAI Responses API 中的项。

然后 runner 会运行一个循环：

使用当前输入调用当前智能体的模型。
检查 LLM 响应。
- 最终输出 → 返回。
- 交接 → 切换到新智能体，保留累积的对话历史，返回步骤 1。
- 工具调用 → 执行工具，将其结果追加到对话中，返回步骤 1。
一旦达到 maxTurns，就抛出 MaxTurnsExceededError，除非 maxTurns 为 null。

Runner 生命周期

在应用启动时创建一个 Runner，并在多个请求之间复用它。该实例会存储全局配置，例如模型提供方和追踪选项。只有在需要完全不同的设置时，才创建另一个 Runner。对于简单脚本，您也可以调用 run()，其内部会使用默认 runner。

运行参数

run() 方法的输入包括用于开始运行的初始智能体、该次运行的输入，以及一组选项。

输入可以是字符串（视为用户消息）、输入项列表，或者在构建人机协作智能体时传入 RunState 对象。

其他选项如下：

选项	默认值	说明
`stream`	`false`	如果为 `true`，调用将返回 `StreamedRunResult`，并在事件从模型到达时发出这些事件。
`context`	–	转发给每个工具 / 护栏 / 交接的上下文对象。请在上下文管理中了解更多。
`maxTurns`	`10`	安全限制——达到时抛出 `MaxTurnsExceededError`。传入 `null` 可禁用此限制。
`signal`	–	用于取消的 `AbortSignal`。
`session`	–	会话持久化实现。请参见会话。
`sessionInputCallback`	–	会话历史与新输入的自定义合并逻辑；在模型调用前运行。请参见会话。
`callModelInputFilter`	–	在调用模型前编辑模型输入（项 + 可选 instructions）的钩子。请参见模型调用输入过滤器。
`toolErrorFormatter`	–	用于自定义返回给模型的工具审批拒绝消息的钩子。请参见工具错误格式化器。
`reasoningItemIdPolicy`	–	控制当先前运行项被转换回模型输入时，是否保留或省略推理项的 `id`。请参见推理项 ID 策略。
`tracing`	–	每次运行的追踪配置覆盖项（例如导出 API 密钥）。
`sandbox`	–	用于 `SandboxAgent` 运行的沙盒客户端、实时会话、会话状态、快照、manifest 覆盖项或并发限制。请参见概念。
`toolExecution`	–	本地工具调用的 SDK 侧执行设置。使用 `toolExecution.maxFunctionToolConcurrency` 限制同时运行的函数工具数量，并使用 `toolExecution.preApprovalInputGuardrails` 在待审批请求之前运行函数工具输入护栏。
`errorHandlers`	–	受支持运行时错误（当前为 `maxTurns`）的处理器。请参见错误处理器。
`conversationId`	–	复用服务器端对话（仅限 OpenAI Responses API + Conversations API）。
`previousResponseId`	–	在不创建对话的情况下，从上一次 Responses API 调用继续（仅限 OpenAI Responses API）。

流式传输

流式传输允许您在 LLM 运行时额外接收流式事件。流开始后，StreamedRunResult 将包含该次运行的完整信息，包括所有新生成的输出。您可以使用 for await 循环遍历流式事件。请在流式传输中阅读更多。

运行配置

如果您创建自己的 Runner 实例，可以传入 RunConfig 对象来配置 runner。

字段	类型	用途
`model`	`string \| Model`	为本次运行中的所有智能体强制指定特定模型。
`modelProvider`	`ModelProvider`	解析模型名称——默认为 OpenAI 提供方。
`modelSettings`	`ModelSettings`	覆盖每个智能体设置的全局调优参数。详情请参见模型，包括可选启用的重试配置。
`handoffInputFilter`	`HandoffInputFilter`	执行交接时修改输入项（如果该交接本身尚未定义一个）。
`inputGuardrails`	`InputGuardrail[]`	应用于初始用户输入的护栏。
`outputGuardrails`	`OutputGuardrail[]`	应用于最终输出的护栏。
`tracingDisabled`	`boolean`	完全禁用 OpenAI 追踪。
`traceIncludeSensitiveData`	`boolean`	在仍发出 span 的同时，从追踪中排除 LLM/工具的输入和输出。
`workflowName`	`string`	显示在追踪仪表板中——有助于对相关运行分组。
`traceId` / `groupId`	`string`	手动指定 trace 或 group ID，而不是让 SDK 生成。
`traceMetadata`	`Record<string, string>`	附加到每个 span 的任意元数据。
`tracing`	`TracingConfig`	每次运行的追踪覆盖项（例如导出 API 密钥）。
`sessionInputCallback`	`SessionInputCallback`	此 runner 上所有运行的默认历史合并策略。
`callModelInputFilter`	`CallModelInputFilter`	在每次模型调用前编辑模型输入的全局钩子。
`toolErrorFormatter`	`ToolErrorFormatter`	用于自定义返回给模型的工具审批拒绝消息的全局钩子。
`reasoningItemIdPolicy`	`ReasoningItemIdPolicy`	将生成项重放到后续模型调用中时，用于保留或省略推理项 `id` 的默认策略。
`sandbox`	`SandboxRunConfig`	用于 `SandboxAgent` 运行的默认沙盒运行时配置。
`toolExecution`	`ToolExecutionConfig`	本地工具调用的默认 SDK 侧执行设置。`maxFunctionToolConcurrency` 会限制每个轮次的本地函数工具并发；未设置或为 `null` 时，会启动该轮中发出的所有函数工具调用。`preApprovalInputGuardrails` 选择启用在待审批请求前运行函数工具输入护栏。

toolExecution.maxFunctionToolConcurrency 必须是大于或等于 1 的整数。此设置只限制本地函数工具的 SDK 侧执行。它不会更改提供方侧的 modelSettings.parallelToolCalls。

toolExecution.preApprovalInputGuardrails 默认禁用。设置为 true 时，需要审批的本地函数工具会在 SDK 记录待审批中断之前运行其输入护栏。如果护栏返回 rejectContent，SDK 会将该拒绝消息作为工具输出发回，而不是请求审批。如果护栏允许该调用，仍会发起审批请求；审批解决后，在工具执行前会再次立即运行相同的输入护栏。

状态与对话管理

单一记忆策略的选择

有四种常见方式可将状态带入下一轮：

策略	状态所在位置	适用场景	下一轮传入内容
`result.history`	您的应用内存	小型聊天循环、完全手动控制、任何提供方	`result.history`
`session`	您的存储 + SDK	持久化聊天状态、可恢复运行、自定义存储	同一个 `session` 实例（或由存储支持的实例）
`conversationId`	OpenAI Conversations API	跨 worker/服务共享的服务器端状态	同一个 `conversationId`，以及仅新的用户轮次
`previousResponseId`	仅 OpenAI Responses API	不创建对话的最简单服务器管理延续方式	`result.lastResponseId`，以及仅新的用户轮次

result.history 和 session 由客户端管理。conversationId 和 previousResponseId 由 OpenAI 管理，并且仅在您使用 OpenAI Responses API 时适用。在大多数应用中，每个对话选择一种持久化策略。混合客户端管理历史和服务器管理状态可能会导致上下文重复，除非您有意协调这两层。

沙盒智能体还会增加另一层状态：正在运行的沙盒工作区。对话历史使用常规 SDK session、conversationId 或 previousResponseId；沙盒文件系统状态使用 sandbox.session、sandbox.sessionState、RunState 或快照。有关工作区生命周期，请参见概念。

对话 / 聊天线程

对 runner.run()（或 run() 工具）的每次调用，都表示应用级对话中的一个轮次。您可以选择向最终用户展示多少 RunResult 内容——有时只展示 finalOutput，有时展示每个生成项。

import { Agent, run } from '@openai/agents';
import type { AgentInputItem } from '@openai/agents';

let thread: AgentInputItem[] = [];

const agent = new Agent({
  name: 'Assistant',
});

async function userSays(text: string) {
  const result = await run(
    agent,
    thread.concat({ role: 'user', content: text }),
  );

  thread = result.history; // Carry over history + newly generated items
  return result.finalOutput;
}

await userSays('What city is the Golden Gate Bridge in?');
// -> "San Francisco"

await userSays('What state is it in?');
// -> "California"

交互式版本请参见聊天示例。

服务器管理的对话

您可以让 OpenAI Responses API 为您持久化对话历史，而不是在每一轮都发送完整的本地对话历史。当您在协调长对话或多个服务时，这很有用。使用下面任一种服务器管理方式时，每次请求只传入新一轮的输入。API 会为您复用先前状态。详情请参见对话状态指南。

OpenAI 提供两种复用服务器端状态的方式：

1. 用于整个对话的 `conversationId`

您可以使用 Conversations API 创建一次对话，然后在每一轮复用其 ID。SDK 会自动只包含新生成的项。

import { Agent, run } from '@openai/agents';
import { OpenAI } from 'openai';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'Reply very concisely.',
});

async function main() {
  // Create a server-managed conversation:
  const client = new OpenAI();
  const { id: conversationId } = await client.conversations.create({});

  const first = await run(agent, 'What city is the Golden Gate Bridge in?', {
    conversationId,
  });
  console.log(first.finalOutput);
  // -> "San Francisco"

  const second = await run(agent, 'What state is it in?', { conversationId });
  console.log(second.finalOutput);
  // -> "California"
}

main().catch(console.error);

2. 用于从上一轮继续的 `previousResponseId`

如果您本来就只想从 Responses API 开始，可以使用前一个响应返回的 ID 串联每个请求。这会在多个轮次之间保持上下文，而无需创建完整的对话资源。

import { Agent, run } from '@openai/agents';

const agent = new Agent({
  name: 'Assistant',
  instructions: 'Reply very concisely.',
});

async function main() {
  const first = await run(agent, 'What city is the Golden Gate Bridge in?');
  console.log(first.finalOutput);
  // -> "San Francisco"

  const previousResponseId = first.lastResponseId;
  const second = await run(agent, 'What state is it in?', {
    previousResponseId,
  });
  console.log(second.finalOutput);
  // -> "California"
}

main().catch(console.error);

conversationId 和 previousResponseId 互斥。当您需要一个可以跨系统共享的命名对话资源时，使用 conversationId；当您只需要从一个响应到下一个响应的最低成本 SDK 级延续基础组件时，使用 previousResponseId。

钩子与自定义

模型调用输入过滤器

使用 callModelInputFilter 在模型被调用的前一刻编辑模型输入。该钩子会接收当前智能体、上下文和组合后的输入项（如果存在会话历史，也包含在内）。返回更新后的 input 数组和可选的 instructions，以便遮盖敏感数据、丢弃旧消息或注入额外的系统指引。

可以在 runner.run(..., { callModelInputFilter }) 中按每次运行设置，也可以在 Runner 配置中作为默认值设置（RunConfig 中的 callModelInputFilter）。

返回值必须是 ModelInputData 对象：{ input: AgentInputItem[], instructions? }。input 字段是必需的，并且必须是数组。返回任何其他形状都会抛出 UserError。

SDK 会在调用过滤器前克隆准备好的轮次输入。如果您也在使用 session，被过滤后的克隆就是会被持久化的内容，因此在此处应用的遮盖或截断也会反映在存储的会话历史中。

使用 conversationId 或 previousResponseId 时，该钩子会在下一次 Responses API 调用的已准备请求载荷上运行。先前由服务器管理的上下文会由 API 恢复，因此该调用的过滤后数组可能已经只表示新一轮增量，而不是对早期历史的完整重放。如果您需要在最后这个过滤步骤之前改变存储历史与当前轮次的合并方式，请使用 sessionInputCallback。

工具错误格式化器

使用 toolErrorFormatter 自定义工具调用被拒绝时发送回模型的审批拒绝消息。这样您可以返回特定领域的措辞（例如合规指导），而不是 SDK 默认消息。

格式化器可以按每次运行设置（runner.run(..., { toolErrorFormatter })），也可以在 RunConfig 中全局设置（new Runner(...) 中的 toolErrorFormatter）。

该格式化器是审批拒绝的全局兜底。如果您使用 result.state.reject(interruption, { message: '...' }) 拒绝特定中断，则该次调用的 message 优先于 toolErrorFormatter。如果二者都未提供，SDK 会回退到默认拒绝文本：Tool execution was not approved.

当前，该格式化器会针对 approval_rejected 事件运行，并接收：

kind（当前始终为 'approval_rejected'）
toolType（'function'、'computer'、'shell' 或 'apply_patch'）
toolName
callId
defaultMessage（SDK 兜底消息，当前为 Tool execution was not approved.）
runContext

返回字符串以覆盖消息，或返回 undefined 以保留 SDK 默认值。如果格式化器抛出异常（或返回非字符串值），SDK 会记录一条警告，并回退到默认审批拒绝消息。

推理项 ID 策略

使用 reasoningItemIdPolicy 控制当 SDK 将先前生成的运行项转换回 AgentInputItem[] 以供后续模型输入时，推理项是否保留其 id 字段。

这会影响 SDK 将生成的模型项重放为输入的场景，例如：

同一次运行内的后续模型调用（例如工具执行之后），
后续轮次将生成项复用为输入 / 历史，
从已保存的 RunState 恢复的运行，
派生的结果视图，如 result.history / result.output（它们是模型输入形状的数组）。
'preserve'（默认）保留推理项 ID。
'omit' 会在推理项被作为输入发回前移除其 id 字段。
非推理项不受影响。

这不会改变：

原始模型响应（result.rawResponses），
运行项（result.newItems），
由提供方返回的模型当前轮次输出。

换句话说，该策略适用于 SDK 根据先前生成项构建下一次输入的时候。

可以按每次运行设置该策略（runner.run(..., { reasoningItemIdPolicy: 'omit' })），或作为 runner 默认值设置（new Runner({ reasoningItemIdPolicy: 'omit', ... })）。从已保存的 RunState 恢复时，除非您覆盖它，否则会复用先前解析出的策略。

与 `callModelInputFilter` 的交互

reasoningItemIdPolicy 会在 callModelInputFilter 之前应用。如果您需要自定义行为，callModelInputFilter 仍可检查已准备的输入，并在模型调用前手动重新引入或移除推理 ID。

`'omit'` 的使用场景

当您希望重放的推理项被规范化为不带 ID（例如，让转发 / 重放的模型输入更简单，或满足应用流水线中的集成要求）时，请使用 'omit'。

如果您的后端 / 提供方因请求校验错误而拒绝重放的推理项（例如与后续输入中的推理项 ID 相关的 HTTP 400 错误），它也是一个有用的故障排除选项。在这些情况下，使用 'omit' 移除重放的推理 ID，可以避免发送后端认为对新请求无效的 ID。

如果您希望 SDK 在重放输入中携带推理项 ID，并且您的集成接受这些 ID，请保留 'preserve'。

错误与恢复

错误处理器

使用 errorHandlers 将受支持的运行时错误转换为最终输出，而不是抛出异常。受支持的键是 maxTurns 和 modelRefusal。

errorHandlers.maxTurns 仅处理最大轮次错误。
errorHandlers.modelRefusal 处理以 ModelRefusalError 暴露的模型拒绝。
errorHandlers.default 用作受支持类型的兜底。
处理器接收 { error, context, runData }，并可返回 { finalOutput, includeInHistory? }。

异常

SDK 会抛出少量可捕获的错误：

MaxTurnsExceededError – 达到 maxTurns。
ModelBehaviorError – 模型产生了无效输出（例如格式错误的 JSON、未知工具）。
ModelRefusalError – 模型拒绝生成请求的输出。
InputGuardrailTripwireTriggered / OutputGuardrailTripwireTriggered – 护栏违规。
ToolInputGuardrailTripwireTriggered / ToolOutputGuardrailTripwireTriggered – 工具护栏违规。
GuardrailExecutionError – 护栏未能完成执行。
ToolTimeoutError – 函数工具超过 timeoutMs，并使用了 timeoutBehavior: 'raise_exception'。
ToolCallError – 函数工具执行因非超时错误而失败。
UserError – 基于配置或用户输入抛出的任何错误。

这些错误都继承自基础 AgentsError 类；该类可能提供 state 属性，用于访问当前运行状态。

下面的代码示例处理 GuardrailExecutionError。由于输入护栏只会在第一个用户输入上运行，该示例会使用原始输入和上下文重新启动运行。它还展示了如何复用已保存状态，在不再次调用模型的情况下重试输出护栏：

import {
  Agent,
  GuardrailExecutionError,
  InputGuardrail,
  InputGuardrailTripwireTriggered,
  OutputGuardrail,
  OutputGuardrailTripwireTriggered,
  run,
} from '@openai/agents';
import { z } from 'zod';

// Shared guardrail agent to avoid re-creating it on every fallback run.
const guardrailAgent = new Agent({
  name: 'Guardrail check',
  instructions: 'Check if the user is asking you to do their math homework.',
  outputType: z.object({
    isMathHomework: z.boolean(),
    reasoning: z.string(),
  }),
});

async function main() {
  const input = 'Hello, can you help me solve for x: 2x + 3 = 11?';
  const context = { customerId: '12345' };

  // Input guardrail example

  const unstableInputGuardrail: InputGuardrail = {
    name: 'Math Homework Guardrail (unstable)',
    execute: async () => {
      throw new Error('Something is wrong!');
    },
  };

  const fallbackInputGuardrail: InputGuardrail = {
    name: 'Math Homework Guardrail (fallback)',
    execute: async ({ input, context }) => {
      const result = await run(guardrailAgent, input, { context });
      const isMathHomework =
        result.finalOutput?.isMathHomework ??
        /solve for x|math homework/i.test(JSON.stringify(input));
      return {
        outputInfo: result.finalOutput,
        tripwireTriggered: isMathHomework,
      };
    },
  };

  const agent = new Agent({
    name: 'Customer support agent',
    instructions:
      'You are a customer support agent. You help customers with their questions.',
    inputGuardrails: [unstableInputGuardrail],
  });

  try {
    // Input guardrails only run on the first turn of a run, so retries must start a fresh run.
    await run(agent, input, { context });
  } catch (e) {
    if (e instanceof GuardrailExecutionError) {
      console.error(`Guardrail execution failed (input): ${e}`);
      try {
        agent.inputGuardrails = [fallbackInputGuardrail];
        // Retry from scratch with the original input and context.
        await run(agent, input, { context });
      } catch (ee) {
        if (ee instanceof InputGuardrailTripwireTriggered) {
          console.log('Math homework input guardrail tripped on retry');
        } else {
          throw ee;
        }
      }
    } else {
      throw e;
    }
  }

  // Output guardrail example

  const replyOutputSchema = z.object({ reply: z.string() });

  const unstableOutputGuardrail: OutputGuardrail<typeof replyOutputSchema> = {
    name: 'Answer review (unstable)',
    execute: async () => {
      throw new Error('Output guardrail crashed.');
    },
  };

  const fallbackOutputGuardrail: OutputGuardrail<typeof replyOutputSchema> = {
    name: 'Answer review (fallback)',
    execute: async ({ agentOutput }) => {
      const outputText =
        typeof agentOutput === 'string'
          ? agentOutput
          : (agentOutput?.reply ?? JSON.stringify(agentOutput));
      const flagged = /math homework|solve for x|x =/i.test(outputText);
      return {
        outputInfo: { flaggedOutput: outputText },
        tripwireTriggered: flagged,
      };
    },
  };

  const agent2 = new Agent<unknown, typeof replyOutputSchema>({
    name: 'Customer support agent (output check)',
    instructions: 'You are a customer support agent. Answer briefly.',
    outputType: replyOutputSchema,
    outputGuardrails: [unstableOutputGuardrail],
  });

  try {
    await run(agent2, input, { context });
  } catch (e) {
    if (e instanceof GuardrailExecutionError && e.state) {
      console.error(`Guardrail execution failed (output): ${e}`);
      try {
        agent2.outputGuardrails = [fallbackOutputGuardrail];
        // Output guardrails can be retried using the saved state without another model call.
        await run(agent2, e.state);
      } catch (ee) {
        if (ee instanceof OutputGuardrailTripwireTriggered) {
          console.log('Output guardrail tripped after retry with saved state');
        } else {
          throw ee;
        }
      }
    } else {
      throw e;
    }
  }
}

main().catch(console.error);

输入重试与输出重试：

输入护栏只在一次运行的第一个用户输入上运行，因此若要重试它们，必须使用相同的输入 / 上下文启动一次全新运行——传入已保存的 state 不会重新触发输入护栏。
输出护栏在模型响应之后运行，因此您可以复用 GuardrailExecutionError 中保存的 state，在不进行另一次模型调用的情况下重新运行输出护栏。

运行上述示例时，您会看到以下输出：

Guardrail execution failed (input): Error: Input guardrail failed to complete: Error: Something is wrong!
Math homework input guardrail tripped on retry
Guardrail execution failed (output): Error: Output guardrail failed to complete: Error: Output guardrail crashed.
Output guardrail tripped after retry with saved state