AI SDK 集成
Agents SDK 开箱即用地通过 Responses API 或 Chat Completions API 支持 OpenAI 模型。不过,如果您想使用其他模型,Vercel AI SDK 提供了一系列受支持的模型,可通过此适配器接入 Agents SDK。
-
通过安装 extensions 包来安装 AI SDK 适配器:
Terminal window npm install @openai/agents-extensions -
从 Vercel 的 AI SDK 中选择所需的模型包并安装:
Terminal window npm install @ai-sdk/openai -
导入适配器和模型,以连接到您的智能体:
导入适配器 import { openai } from '@ai-sdk/openai';import { aisdk } from '@openai/agents-extensions/ai-sdk'; -
初始化一个供智能体使用的模型实例:
创建模型 import { openai } from '@ai-sdk/openai';import { aisdk } from '@openai/agents-extensions/ai-sdk';const model = aisdk(openai('gpt-5.4'));
import { Agent, run } from '@openai/agents';
// Import the model package you installedimport { openai } from '@ai-sdk/openai';
// Import the adapterimport { aisdk } from '@openai/agents-extensions/ai-sdk';
// Create a model instance to be used by the agentconst model = aisdk(openai('gpt-5.4'));
// Create an agent with the modelconst agent = new Agent({ name: 'My Agent', instructions: 'You are a helpful assistant.', model,});
// Run the agent with the new modelrun(agent, 'What is the capital of Germany?');提供商元数据传递
Section titled “提供商元数据传递”如果您需要随消息发送提供商特定的选项,请通过 providerMetadata 传递。其值会直接转发到底层 AI SDK 模型。例如,Agents SDK 中的以下 providerData
const providerData = { anthropic: { cacheControl: { type: 'ephemeral', }, },};会在使用 AI SDK 集成时变为
const providerMetadata = { anthropic: { cacheControl: { type: 'ephemeral', }, },};最终输出文本规范化
Section titled “最终输出文本规范化”某些提供商会以带有额外包装的纯文本形式返回 structured outputs,例如 JSON 代码围栏。如果您需要在 Agents 运行时验证最终输出之前进行提供商特定的清理,请在创建适配器时传入 transformOutputText:
import { openai } from '@ai-sdk/openai';import { aisdk } from '@openai/agents-extensions/ai-sdk';
const model = aisdk(openai('gpt-5.4'), { transformOutputText(text) { return text.match(/```(?:json)?\s*([\s\S]*?)\s*```/)?.[1]?.trim() ?? text; },});transformOutputText 会在非流式响应的最终助手文本上运行,也会在流式响应的最终 response_done 事件上运行。它不会修改增量 output_text_delta 事件。
modelSettings.retry 也适用于 AI SDK 支持的模型,因为重试由 Agents 运行时实现,而不仅仅由默认 OpenAI 提供商实现。
这意味着您可以附加在其他地方使用的相同重试配置:
- 在
Agent、Runner或两者上设置modelSettings.retry。 - 组合
retryPolicies,例如networkError()、httpStatus([...])或providerSuggested()。 - 请注意,只有当被包装的 AI SDK 模型能够通过适配器暴露重试建议时,
providerSuggested()才有帮助。
如需使用 aisdk(openai(...)) 的完整示例,请参阅 examples/ai-sdk/retry.ts。如需了解重试 API 本身,包括流式传输和有状态后续请求的安全边界,请参阅模型。
合适集成的选择
Section titled “合适集成的选择”@openai/agents-extensions 中有两个相关集成:
@openai/agents-extensions/ai-sdk会适配 AI SDK 模型,使Agent可以在其上运行。@openai/agents-extensions/ai-sdk-ui会适配流式传输的 Agents SDK 运行,使 AI SDK UI 路由可以返回标准的流式传输Response。
AI SDK 模型注意事项
Section titled “AI SDK 模型注意事项”@openai/agents-extensions/ai-sdk适配器仍处于 beta 阶段,因此值得针对您选择的提供商进行仔细测试,尤其是较小的提供商。- 如果您使用的是 OpenAI 模型,请优先使用默认 OpenAI 模型提供商,而不是此适配器。
- 受支持的 AI SDK 提供商必须暴露
specificationVersionv2或v3。如果您需要较旧的 v1 提供商风格,请将 examples/ai-sdk-v1 中的模块复制到您的项目中。 - 通过此适配器使用计算机工具时,需要提供显示元数据。请确保工具同时包含
environment和dimensions元数据。 - 此处不支持延迟的 Responses 工具加载流程。这包括
toolNamespace()、带有deferLoading: true的函数工具,以及toolSearchTool()。如果您需要工具搜索,请直接使用 OpenAI Responses 模型。请参阅工具和模型。
AI SDK UI 流式传输辅助工具
Section titled “AI SDK UI 流式传输辅助工具”@openai/agents-extensions/ai-sdk-ui 提供响应辅助工具,用于将 Agents SDK 流接入 AI SDK UI 路由:
createAiSdkTextStreamResponse(source, options?)用于纯文本流式传输响应。createAiSdkUiMessageStream(source)用于更底层的ReadableStream<UIMessageChunk>。createAiSdkUiMessageStreamResponse(source, options?)用于UIMessageChunk流式传输响应。
这些辅助工具接受 StreamedRunResult、类流来源或兼容的包装对象。响应辅助工具会返回带有适合流式传输的 header 的 Response。
当您的路由应直接返回 AI SDK 响应时,请使用 createAiSdkUiMessageStreamResponse(...)。当您想自行控制响应或渲染层,同时仍使用维护中的 Agents SDK 到 AI SDK UIMessageChunk 转换时,请使用 createAiSdkUiMessageStream(...)。当您只需要纯文本时,请使用 createAiSdkTextStreamResponse(...)。
响应辅助工具还通过 options 接受可选的响应设置:
headers:要合并到流式传输响应中的额外响应 header。status:返回的Response的 HTTP 状态码。statusText:返回的Response的 HTTP 状态文本。
更底层的 UI 消息流示例:
import { Agent, run } from '@openai/agents';import { createAiSdkUiMessageStream } from '@openai/agents-extensions/ai-sdk-ui';
const agent = new Agent({ name: 'Assistant', instructions: 'Reply with a short answer.',});
export async function createStream() { const stream = await run(agent, 'Hello there.', { stream: true }); return createAiSdkUiMessageStream(stream);}用于 UI 消息流式传输的 Next.js 路由示例:
import { Agent, run } from '@openai/agents';import { createAiSdkUiMessageStreamResponse } from '@openai/agents-extensions/ai-sdk-ui';
const agent = new Agent({ name: 'Assistant', instructions: 'Reply with a short answer.',});
export async function POST() { const stream = await run(agent, 'Hello there.', { stream: true }); return createAiSdkUiMessageStreamResponse(stream);}用于仅文本流式传输的 Next.js 路由示例:
import { Agent, run } from '@openai/agents';import { createAiSdkTextStreamResponse } from '@openai/agents-extensions/ai-sdk-ui';
const agent = new Agent({ name: 'Assistant', instructions: 'Reply with a short answer.',});
export async function POST() { const stream = await run(agent, 'Hello there.', { stream: true }); return createAiSdkTextStreamResponse(stream);}如需端到端用法,请参阅此代码仓库中的 examples/ai-sdk-ui 应用。