上下文管理
上下文(context)是一个含义宽泛的术语。你可能会关心两类主要的上下文:
- 你的代码在一次运行期间可访问的本地上下文:工具所需的依赖或数据、
onHandoff之类的回调,以及生命周期钩子。 - 语言模型在生成响应时可见的智能体/LLM 上下文。
本地上下文由 RunContext<T> 类型表示。你可以创建任意对象来保存状态或依赖,并将其传给 Runner.run()。所有工具调用和钩子都会收到一个 RunContext 包装器,以便读取或修改该对象。
import { Agent, run, RunContext, tool } from '@openai/agents';import { z } from 'zod';
interface UserInfo { name: string; uid: number;}
const fetchUserAge = tool({ name: 'fetch_user_age', description: 'Return the age of the current user', parameters: z.object({}), execute: async ( _args, runContext?: RunContext<UserInfo>, ): Promise<string> => { return `User ${runContext?.context.name} is 47 years old`; },});
async function main() { const userInfo: UserInfo = { name: 'John', uid: 123 };
const agent = new Agent<UserInfo>({ name: 'Assistant', tools: [fetchUserAge], });
const result = await run(agent, 'What is the age of the user?', { context: userInfo, });
console.log(result.finalOutput); // The user John is 47 years old.}
main().catch((error) => { console.error(error); process.exit(1);});参与同一次运行的每个智能体、工具和钩子都必须使用相同的上下文类型。
本地上下文可用于以下内容:
- 运行相关数据(用户名、ID 等)
- 依赖项,例如日志记录器或数据获取器
- 辅助函数
在同一次运行中,派生上下文共享同一个底层应用上下文、审批状态和用量追踪。嵌套的 agent.asTool() 运行可能会附加不同的 toolInput,但默认不会获得你的应用状态的隔离副本。
RunContext 的公开内容
Section titled “RunContext 的公开内容”RunContext<T> 是你在应用中定义的上下文对象的包装器。实际中你最常用的是:
runContext.context:你自己的可变应用状态和依赖。runContext.usage:当前运行聚合后的 token/请求用量。runContext.toolInput:当当前运行在agent.asTool()内执行时的结构化输入。runContext.approveTool(...)/runContext.rejectTool(...):当你需要以编程方式更新审批状态时使用。
只有 runContext.context 是你在应用中定义的对象。其余字段都是由 SDK 管理的运行时元数据。
如果你之后为人机协作序列化 RunState,这些运行时元数据也会随状态一起保存。若你打算持久化或传输序列化状态,请避免在 runContext.context 中放入敏感信息。
如果你对 RunContext 进行子类化,请确认嵌套运行或派生运行仍能保留你所依赖的子类实例状态。SDK 在嵌套运行期间会在内部创建分叉上下文。
智能体/LLM 上下文
Section titled “智能体/LLM 上下文”调用 LLM 时,它唯一能看到的数据来自会话历史。若要提供额外信息,你有几种选择:
- 添加到智能体的
instructions中——也称为 system 或 developer message。这可以是静态字符串,也可以是接收上下文并返回字符串的函数。 - 在调用
Runner.run()时将其包含在input中。这与 instructions 的方式类似,但你可以把消息放在命令链中更低的位置。 - 通过函数工具暴露它,让 LLM 按需获取数据。
- 使用检索或 Web 搜索工具,让响应基于来自文件、数据库或网络的相关数据。