跳转至

上下文管理

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

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

本地上下文

这通过 RunContextWrapper 类及其中的 context 属性来表示。其工作方式如下:

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

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

你可以将上下文用于以下场景:

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

Note

上下文对象不会被发送给 LLM。它是纯本地对象,你可以读取、写入并调用其方法。

import asyncio
from dataclasses import dataclass

from agents import Agent, RunContextWrapper, Runner, function_tool

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

@function_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 或原始参数字符串。
为此,你可以使用继承自 RunContextWrapperToolContext 类。

from typing import Annotated
from pydantic import BaseModel, Field
from agents import Agent, Runner, function_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")

@function_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 – 传递给工具的原始参数字符串

当你在执行期间需要工具级元数据时,请使用 ToolContext
对于智能体与工具之间的一般性上下文共享,RunContextWrapper 已经足够。


智能体/LLM 上下文

当调用 LLM 时,它能看到的唯一数据来自对话历史。这意味着如果你想让某些新数据对 LLM 可见,必须以让其出现在对话历史中的方式提供。可选方式包括:

  1. 将其添加到智能体的 instructions。这也被称为“系统提示词”(system prompt)或“开发者消息”。系统提示词可以是静态字符串,也可以是接收上下文并输出字符串的动态函数。这常用于始终有用的信息(例如用户名或当前日期)。
  2. 在调用 Runner.run 函数时,将其添加到 input。这与 instructions 的做法类似,但允许你提供在指令链中更靠后的消息。
  3. 通过工具调用(function tools)暴露。这适用于按需(on-demand)的上下文——LLM 决定何时需要某些数据,并可调用工具来获取该数据。
  4. 使用检索或网络检索(web search)。这些是能够从文件或数据库(检索)或网络(网络检索)中获取相关数据的特殊工具。这有助于用相关的上下文数据来“支撑”(ground)回复。