跳转到内容

模型

每个智能体最终都会调用一个 LLM。SDK 通过两个轻量接口对模型进行抽象:

  • Model —— 知道如何针对特定 API 发起单次请求。
  • ModelProvider —— 将人类可读的模型名称(例如 'gpt‑4o')解析为 Model 实例。

在日常使用中,你通常只会与模型名称交互,偶尔会用到 ModelSettings

为每个智能体指定模型
import { Agent } from '@openai/agents';
const agent = new Agent({
name: 'Creative writer',
model: 'gpt-4.1',
});

当你在初始化 Agent 时未指定模型,将使用默认模型。目前的默认模型是 gpt-4.1,它在智能体工作流的可预测性与低延迟之间提供了良好平衡。

如果你想切换到其他模型,如 gpt-5,有两种方式可以为你的智能体进行配置。

首先,如果你希望对所有未设置自定义模型的智能体始终使用某个特定模型,请在运行智能体前设置环境变量 OPENAI_DEFAULT_MODEL

Terminal window
export OPENAI_DEFAULT_MODEL=gpt-5
node my-awesome-agent.js

其次,你可以为某个 Runner 实例设置默认模型。如果你未为某个智能体设置模型,则会使用该 Runner 的默认模型。

为 Runner 设置默认模型
import { Runner } from '@openai/agents';
const runner = new Runner({ model: 'gpt‑4.1-mini' });

当你以这种方式使用任一 GPT-5 的推理模型(gpt-5gpt-5-minigpt-5-nano)时,SDK 会默认应用合理的 modelSettings。具体来说,它会将 reasoning.effortverbosity 都设为 "low"。若要为默认模型调整推理强度,请传入你自己的 modelSettings

自定义 GPT-5 默认设置
import { Agent } from '@openai/agents';
const myAgent = new Agent({
name: 'My Agent',
instructions: "You're a helpful agent.",
modelSettings: {
reasoning: { effort: 'minimal' },
text: { verbosity: 'low' },
},
// If OPENAI_DEFAULT_MODEL=gpt-5 is set, passing only modelSettings works.
// It's also fine to pass a GPT-5 model name explicitly:
// model: 'gpt-5',
});

为了更低的延迟,使用 gpt-5-minigpt-5-nano 并设置 reasoning.effort="minimal",通常会比默认设置更快返回结果。不过,Responses API 中的一些内置工具(例如文件搜索与图像生成)不支持 "minimal" 推理强度,这也是本 Agents SDK 默认使用 "low" 的原因。

如果你传入的是非 GPT-5 的模型名称,且未提供自定义 modelSettings,SDK 将回退到与任意模型兼容的通用 modelSettings


默认的 ModelProvider 使用 OpenAI 的 API 来解析名称。它支持两个不同的端点:

API用途调用 setOpenAIAPI()
Chat Completions标准聊天与函数调用setOpenAIAPI('chat_completions')
Responses新的以流式优先的生成式 API(工具调用、灵活输出)setOpenAIAPI('responses')(默认)
设置默认 OpenAI 密钥
import { setDefaultOpenAIKey } from '@openai/agents';
setDefaultOpenAIKey(process.env.OPENAI_API_KEY!); // sk-...

如果你需要自定义网络设置,也可以通过 setDefaultOpenAIClient(client) 插入你自己的 OpenAI 客户端。


ModelSettings 与 OpenAI 的参数相对应,但与具体提供方无关。

字段类型说明
temperaturenumber创造性与确定性的权衡。
topPnumber核采样。
frequencyPenaltynumber惩罚重复 token。
presencePenaltynumber鼓励生成新的 token。
toolChoice'auto' | 'required' | 'none' | string参见强制使用工具
parallelToolCallsboolean在支持的情况下允许并行函数调用。
truncation'auto' | 'disabled'Token 截断策略。
maxTokensnumber响应中的最大 token 数。
storeboolean持久化响应以便检索 / RAG 工作流。
reasoning.effort'minimal' | 'low' | 'medium' | 'high'gpt-5 等模型的推理强度。
text.verbosity'low' | 'medium' | 'high'gpt-5 等模型的文本详尽度。

可在任一层级附加设置:

模型设置
import { Runner, Agent } from '@openai/agents';
const agent = new Agent({
name: 'Creative writer',
// ...
modelSettings: { temperature: 0.7, toolChoice: 'auto' },
});
// or globally
new Runner({ modelSettings: { temperature: 0.3 } });

Runner 级别的设置会覆盖任何与其冲突的按智能体设置。


可以通过 prompt 参数为智能体进行配置,指明应使用的服务器存储提示配置来控制智能体行为。目前,此选项仅在你使用 OpenAI 的 Responses API 时受支持。

字段类型说明
promptIdstring提示的唯一标识符。
versionstring你希望使用的提示版本。
variablesobject代入提示中的键/值变量对。取值可以是字符串或文本、图像、文件等内容输入类型。
带提示配置的智能体
import { Agent, run } from '@openai/agents';
async function main() {
const agent = new Agent({
name: 'Assistant',
prompt: {
promptId: 'pmpt_68d50b26524c81958c1425070180b5e10ab840669e470fc7',
variables: { name: 'Kaz' },
},
});
const result = await run(agent, 'What is your name?');
console.log(result.finalOutput);
}
main().catch((error) => {
console.error(error);
process.exit(1);
});

任何其他智能体配置(如 tools 或 instructions)都会覆盖你在存储提示中可能配置的值。


实现你自己的提供方很简单——实现 ModelProviderModel,并将该提供方传给 Runner 构造函数:

最简自定义提供方
import {
ModelProvider,
Model,
ModelRequest,
ModelResponse,
ResponseStreamEvent,
} from '@openai/agents-core';
import { Agent, Runner } from '@openai/agents';
class EchoModel implements Model {
name: string;
constructor() {
this.name = 'Echo';
}
async getResponse(request: ModelRequest): Promise<ModelResponse> {
return {
usage: {},
output: [{ role: 'assistant', content: request.input as string }],
} as any;
}
async *getStreamedResponse(
_request: ModelRequest,
): AsyncIterable<ResponseStreamEvent> {
yield {
type: 'response.completed',
response: { output: [], usage: {} },
} as any;
}
}
class EchoProvider implements ModelProvider {
getModel(_modelName?: string): Promise<Model> | Model {
return new EchoModel();
}
}
const runner = new Runner({ modelProvider: new EchoProvider() });
console.log(runner.config.modelProvider.getModel());
const agent = new Agent({
name: 'Test Agent',
instructions: 'You are a helpful assistant.',
model: new EchoModel(),
modelSettings: { temperature: 0.7, toolChoice: 'auto' },
});
console.log(agent.model);

当使用 OpenAI 提供方时,你可以通过提供 API 密钥来选择启用自动追踪导出:

追踪导出器
import { setTracingExportApiKey } from '@openai/agents';
setTracingExportApiKey('sk-...');

这会将追踪发送到 OpenAI 仪表盘,你可以在其中检查工作流的完整执行图。