跳转到内容

上下文管理

上下文是一个含义较多的术语。你可能关心的上下文主要有两类:

  1. 你的代码在一次运行期间可以访问的本地上下文:工具所需的依赖或数据、类似 onHandoff 的回调以及生命周期钩子。
  2. 语言模型在生成响应时可以看到的智能体/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<T> 是对你在应用中定义的上下文对象的包装。在实践中,你最常使用的是:

  • runContext.context:用于你自己的可变应用状态和依赖。
  • runContext.usage:用于当前运行的聚合 token/请求用量。
  • runContext.toolInput:当当前运行在 agent.asTool() 内执行时,用于结构化输入。
  • runContext.approveTool(...) / runContext.rejectTool(...):当你需要以编程方式更新审批状态时使用。

只有 runContext.context 是你在应用中定义的对象。其他字段都是由 SDK 管理的运行时元数据。

如果你之后为了人机协作而序列化 RunState,这些运行时元数据会随状态一起保存。如果你打算持久化或传输序列化后的状态,请避免将密钥放入 runContext.context

如果你继承 RunContext,请确认嵌套或派生运行仍会保留你依赖的任何子类特有实例状态。SDK 会在嵌套运行期间在内部创建分叉上下文。

调用 LLM 时,它唯一能看到的数据来自对话历史。要让其他信息可用,你有几种选择:

  1. 将其添加到智能体的 instructions 中——也称为系统消息或开发者消息。它可以是静态字符串,也可以是接收上下文并返回字符串的函数。
  2. 在调用 Runner.run() 时将其包含在 input 中。这类似于 instructions 技术,但允许你把消息放在命令链中更低的位置。
  3. 通过函数工具公开它,让 LLM 可以按需获取数据。
  4. 使用检索或 Web 搜索工具,让响应基于来自文件、数据库或 Web 的相关数据。