上下文管理
“上下文”是一个易混淆的术语。通常你会关心两类主要的上下文:
- 代码本地可用的上下文:指工具函数运行时、如
on_handoff回调、生命周期钩子等需要的数据与依赖。 - LLM 可用的上下文:指 LLM 在生成响应时所能看到的数据。
本地上下文
这由 RunContextWrapper 类及其内部的 context 属性表示。其工作方式是:
- 你创建任意 Python 对象。常见做法是使用 dataclass 或 Pydantic 对象。
- 将该对象传给各种运行方法(例如
Runner.run(..., **context=whatever**))。 - 所有工具调用、生命周期钩子等都会接收一个包装对象
RunContextWrapper[T],其中T表示你的上下文对象类型,你可以通过wrapper.context访问。
需要重点注意的是:对于同一次智能体运行,所有智能体、工具函数、生命周期等必须使用相同的上下文_类型_。
你可以将上下文用于以下场景:
- 运行的上下文数据(例如用户名/uid 或关于用户的其他信息)
- 依赖(例如日志记录对象、数据获取器等)
- 辅助函数
注意
上下文对象不会发送给 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())
- 这是上下文对象。此处使用了 dataclass,但你可以使用任何类型。
- 这是一个工具。你可以看到它接收一个
RunContextWrapper[UserInfo]。该工具的实现会从上下文中读取。 - 我们在智能体上标注泛型
UserInfo,以便类型检查器捕获错误(例如,如果我们试图传入一个使用不同上下文类型的工具)。 - 通过
run函数传入上下文。 - 智能体正确调用该工具并获取年龄。
高级:ToolContext
在某些情况下,你可能希望访问正在执行的工具的额外元数据——例如其名称、调用 ID,或原始参数字符串。
为此,你可以使用扩展自 RunContextWrapper 的 ToolContext 类。
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 可见,必须以能将其纳入历史的方式进行提供。常见方法包括:
- 将其添加到智能体的
instructions。这也被称为“system prompt”或“developer message”。System prompts 可以是静态字符串,或接收上下文并输出字符串的动态函数。这常用于总是有用的信息(例如用户名或当前日期)。 - 在调用
Runner.run函数时将其添加到input。这与instructions的做法类似,但允许你使用在指令链中层级更低的消息。 - 通过 工具调用 暴露。适用于_按需_上下文——LLM 决定何时需要某些数据,并可调用工具来获取该数据。
- 使用检索或 网络检索。它们是特殊的工具,能够从文件或数据库(文件检索),或从网页(网络检索)获取相关数据。这有助于将回答基于相关的上下文数据进行支撑(grounding)。