跳转到内容

运行智能体

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

Simple 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 实例:

Simple run
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 的 run 方法时,你需要传入一个起始智能体和输入。输入可以是字符串(被视为一条用户消息),也可以是输入项列表,即 OpenAI Responses API 中的项目。

然后 runner 会运行一个循环:

  1. 使用当前输入调用当前智能体的模型。
  2. 检查 LLM 的响应。
    • 最终输出 → 返回。
    • 交接 → 切换到新的智能体,保留累积的会话历史,回到步骤 1。
    • 工具调用 → 执行工具,将其结果追加到会话中,回到步骤 1。
  3. 当达到 maxTurns 时抛出 MaxTurnsExceededError

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

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

输入可以是字符串(被视为一条用户消息)、输入项列表,或在构建人机协作智能体时使用的 RunState 对象。

其他可选项包括:

OptionDefaultDescription
streamfalse如果为 true,调用将返回一个 StreamedRunResult,并在事件从模型到达时逐步发出。
context转发到每个工具 / 护栏 / 交接的上下文对象。详见上下文管理
maxTurns10安全限制——达到该值时抛出 MaxTurnsExceededError
signal用于取消的 AbortSignal

流式传输允许你在 LLM 运行时接收额外的流式事件。流启动后,StreamedRunResult 将包含关于此次运行的完整信息,包括所有新生成的输出。你可以使用 for await 循环迭代这些流式事件。阅读流式传输指南了解更多。

如果你要创建自己的 Runner 实例,可以传入一个 RunConfig 对象来配置 runner。

FieldTypePurpose
modelstring | Model为运行中的所有智能体强制指定特定模型。
modelProviderModelProvider解析模型名称——默认为 OpenAI 提供方。
modelSettingsModelSettings覆盖每个智能体设置的全局调优参数。
handoffInputFilterHandoffInputFilter执行交接时用于变更输入项(如果交接本身未定义)的过滤器。
inputGuardrailsInputGuardrail[]应用于初始用户输入的护栏。
outputGuardrailsOutputGuardrail[]应用于最终输出的护栏。
tracingDisabledboolean完全禁用 OpenAI 追踪。
traceIncludeSensitiveDataboolean在仍然发出 span 的同时,将 LLM/工具的输入与输出从追踪中排除。
workflowNamestring显示在 Traces 仪表板中——有助于将相关运行分组。
traceId / groupIdstring手动指定 trace 或 group ID,而不是交由 SDK 自动生成。
traceMetadataRecord<string, any>附加到每个 span 的任意元数据。

每次调用 runner.run()(或 run() 实用函数)都代表你的应用层会话中的一个轮次。你可以自行决定向终端用户展示多少 RunResult 内容——有时仅展示 finalOutput,有时展示每一个生成的项目。

Example of carrying over the conversation history
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 为你持久化会话历史,而无需在每个轮次都发送完整的本地记录。当你在协调长会话或多个服务时,这很有用。详见会话状态指南

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

你可以使用Conversations API 创建一次会话,然后在每个轮次复用其 ID。SDK 会自动仅包含新生成的项目。

Reusing a server conversation
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 从上一个轮次继续

Section titled “2. 使用 previousResponseId 从上一个轮次继续”

如果你只想从 Responses API 开始,可以使用上一个响应返回的 ID 串联每个请求。这样无需创建完整的会话资源也能在轮次之间保持上下文。

Chaining with previousResponseId
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);

SDK 会抛出一小组可供捕获的错误:

这些错误都继承自基础类 AgentsError,它可能提供 state 属性以访问当前运行状态。

下面是一个处理 GuardrailExecutionError 的代码示例:

Guardrail execution error
import {
Agent,
run,
GuardrailExecutionError,
InputGuardrail,
InputGuardrailTripwireTriggered,
} from '@openai/agents';
import { z } from 'zod';
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(),
}),
});
const unstableGuardrail: InputGuardrail = {
name: 'Math Homework Guardrail (unstable)',
execute: async () => {
throw new Error('Something is wrong!');
},
};
const fallbackGuardrail: InputGuardrail = {
name: 'Math Homework Guardrail (fallback)',
execute: async ({ input, context }) => {
const result = await run(guardrailAgent, input, { context });
return {
outputInfo: result.finalOutput,
tripwireTriggered: result.finalOutput?.isMathHomework ?? false,
};
},
};
const agent = new Agent({
name: 'Customer support agent',
instructions:
'You are a customer support agent. You help customers with their questions.',
inputGuardrails: [unstableGuardrail],
});
async function main() {
try {
const input = 'Hello, can you help me solve for x: 2x + 3 = 11?';
const result = await run(agent, input);
console.log(result.finalOutput);
} catch (e) {
if (e instanceof GuardrailExecutionError) {
console.error(`Guardrail execution failed: ${e}`);
// If you want to retry the execution with different settings,
// you can reuse the runner's latest state this way:
if (e.state) {
try {
agent.inputGuardrails = [fallbackGuardrail]; // fallback
const result = await run(agent, e.state);
console.log(result.finalOutput);
} catch (ee) {
if (ee instanceof InputGuardrailTripwireTriggered) {
console.log('Math homework guardrail tripped');
}
}
}
} else {
throw e;
}
}
}
main().catch(console.error);

运行上述示例时,你将看到如下输出:

Guardrail execution failed: Error: Input guardrail failed to complete: Error: Something is wrong!
Math homework guardrail tripped