跳转至

上下文管理

上下文是一个含义多重的术语。你可能会关注两大类上下文:

  1. 代码在本地可用的上下文:即工具函数运行时、on_handoff 等回调中、生命周期钩子中可能需要的数据和依赖项。
  2. LLM 可用的上下文:即 LLM 在生成响应时可以看到的数据。

本地上下文

本地上下文通过 RunContextWrapper 类及其中的 context 属性表示。其工作方式如下:

  1. 创建任意所需的 Python 对象。常见做法是使用 dataclass 或 Pydantic 对象。
  2. 将该对象传递给各种运行方法(例如 Runner.run(..., context=whatever))。
  3. 所有工具调用、生命周期钩子等都会收到一个包装器对象 RunContextWrapper[T],其中 T 表示上下文对象的类型;可以通过 wrapper.context 访问该对象本身。

对于某些特定于运行时的回调,SDK 可能会传递 RunContextWrapper[T] 的更专用子类。例如,FunctionTool 实例的生命周期钩子通常会收到 ToolContext,后者还会公开 tool_call_idtool_nametool_arguments 等工具调用元数据。

需要注意的最重要事项是:对于给定的一次智能体运行,每个智能体、工具函数、生命周期等都必须使用相同的上下文_类型_。

上下文可用于:

  • 运行所需的上下文数据(例如用户名/uid 或关于用户的其他信息)
  • 依赖项(例如日志记录器对象、数据获取器等)
  • 辅助函数

注意

上下文对象不会发送给 LLM。它完全是一个本地对象,你可以读取、写入它以及调用其方法。

在单次运行中,派生包装器共享相同的底层应用上下文、审批状态和用量追踪。嵌套的 Agent.as_tool() 运行可以附加不同的 tool_input,但默认情况下,它们不会获得应用状态的独立副本。

本地上下文在能力可见性方面的使用

当函数工具、MCP 工具和任务转移依赖同一请求策略时,请将策略输入或辅助函数保存在应用上下文中。每个 SDK 接口都通过各自的回调公开当前运行上下文:

请针对这些回调调整共享的应用策略,而不是维护单独的能力列表。这些回调用于控制 SDK 在当前运行中公开哪些能力;它们无法对模型生成的参数或资源选择进行授权。对于函数工具,请在工具实现内部实施这些决策,或在适当时使用工具输入安全防护措施审批。MCP 服务器必须自行对受保护的操作进行授权。对于具有 input_type 的任务转移,请在 on_handoff 开始时、应用产生副作用之前检查解析后的输入;如果授权失败,应抛出异常,而不是返回结果。工具输入安全防护措施不会对任务转移运行。有关回调生命周期,请参阅任务转移输入

RunContextWrapper 公开的内容

RunContextWrapper 是应用自定义上下文对象的包装器。在实际使用中,最常用的包括:

只有 wrapper.context 是应用自定义对象。其他字段均为 SDK 管理的运行时元数据。

如果之后为人在回路或持久化作业工作流序列化 RunState,该运行时元数据将随状态一起保存。如果打算持久化或传输序列化状态,请避免在 RunContextWrapper.context 中存放机密信息。

对话状态是另一个独立问题。根据希望如何延续多个对话轮次,可以使用 result.to_input_list()sessionconversation_idprevious_response_id。有关如何选择,请参阅结果运行智能体会话

import asyncio
from dataclasses import dataclass

from agents import Agent, RunContextWrapper, Runner
from agents.decorators import tool

@dataclass
class UserInfo:  # (1)!
    name: str
    uid: int

@tool
async def fetch_user_age(wrapper: RunContextWrapper[UserInfo]) -> str:  # (2)!
    """Fetch the age of the user. Call this function to get user's age information."""
    return f"The user {wrapper.context.name} is 47 years old"

async def main():
    user_info = UserInfo(name="John", uid=123)

    agent = Agent[UserInfo](  # (3)!
        name="Assistant",
        tools=[fetch_user_age],
    )

    result = await Runner.run(  # (4)!
        starting_agent=agent,
        input="What is the age of the user?",
        context=user_info,
    )

    print(result.final_output)  # (5)!
    # The user John is 47 years old.

if __name__ == "__main__":
    asyncio.run(main())
  1. 这是上下文对象。此处使用了 dataclass,但也可以使用任何类型。
  2. 这是一个工具。可以看到,它接受一个 RunContextWrapper[UserInfo]。工具实现会从上下文中读取数据。
  3. 我们使用泛型 UserInfo 标记智能体,以便类型检查器捕获错误(例如,当我们尝试传入一个使用不同上下文类型的工具时)。
  4. 上下文会传递给 run 函数。
  5. 智能体正确调用工具并获取年龄。

高级功能:ToolContext

在某些情况下,你可能希望访问有关正在执行的工具的额外元数据,例如工具名称、调用 ID 或原始参数字符串。
为此,可以使用 ToolContext 类,该类扩展了 RunContextWrapper

from typing import Annotated
from pydantic import BaseModel, Field
from agents import Agent
from agents.decorators import tool
from agents.tool_context import ToolContext

class WeatherContext(BaseModel):
    user_id: str

class Weather(BaseModel):
    city: str = Field(description="The city name")
    temperature_range: str = Field(description="The temperature range in Celsius")
    conditions: str = Field(description="The weather conditions")

@tool
def get_weather(ctx: ToolContext[WeatherContext], city: Annotated[str, "The city to get the weather for"]) -> Weather:
    print(f"[debug] Tool context: (name: {ctx.tool_name}, call_id: {ctx.tool_call_id}, args: {ctx.tool_arguments})")
    return Weather(city=city, temperature_range="14-20C", conditions="Sunny with wind.")

agent = Agent(
    name="Weather Agent",
    instructions="You are a helpful agent that can tell the weather of a given city.",
    tools=[get_weather],
)

ToolContext 提供与 RunContextWrapper 相同的 .context 属性,
以及以下特定于当前工具调用的额外字段:

  • tool_name – 正在调用的工具名称
  • tool_call_id – 此工具调用的唯一标识符
  • tool_arguments – 传递给工具的原始参数字符串
  • tool_namespace – 工具调用的 Responses 命名空间,适用于通过 tool_namespace() 或其他命名空间化接口加载工具的情况
  • qualified_tool_name – 存在命名空间时,以该命名空间限定的工具名称

如果执行期间需要工具级元数据,请使用 ToolContext
对于智能体与工具之间的常规上下文共享,RunContextWrapper 仍然足够。由于 ToolContext 扩展了 RunContextWrapper,因此当嵌套的 Agent.as_tool() 运行提供结构化输入时,它也可以公开 .tool_input


智能体/LLM 上下文

调用 LLM 时,它唯一能看到的数据来自对话历史记录。这意味着,如果希望让 LLM 获得某些新数据,就必须以某种方式将其加入该历史记录。可以通过以下几种方式实现:

  1. 可以将其添加到智能体的 instructions 中。这也称为“system prompt”或“开发者消息”。system prompt 可以是静态字符串,也可以是接收上下文并输出字符串的动态函数。这是一种适合提供始终有用的信息的常用方法(例如用户姓名或当前日期)。
  2. 调用 Runner.run 函数时,将其添加到 input 中。这与 instructions 方法类似,但可以使消息在指令层级中处于较低层级。
  3. 通过 FunctionTool 实例公开这些数据。这适用于_按需_上下文:LLM 自行决定何时需要某些数据,并可以调用工具获取这些数据。
  4. 使用检索或网络检索。这些特殊工具能够从文件或数据库中获取相关数据(检索),或者从网络获取相关数据(网络检索)。这有助于让响应以相关上下文数据为依据。