コンテキスト管理
コンテキストは多義的な用語です。重要になるコンテキストには主に 2 つの種類があります。
- コードからローカルに利用可能なコンテキスト: これは、ツール関数の実行時、
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、raw 引数文字列など)にアクセスしたいことがあります。
そのためには、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– ツールに渡された raw 引数文字列
実行中にツールレベルのメタデータが必要な場合は ToolContext を使用します。
エージェントとツール間で一般的にコンテキストを共有するだけなら、RunContextWrapper で十分です。
エージェント/LLM コンテキスト
LLM が呼び出されるとき、LLM が参照できるのは会話履歴のデータだけです。つまり、新しいデータを LLM に利用可能にしたい場合は、その履歴で参照できる形で提供する必要があります。方法はいくつかあります。
- エージェントの
instructionsに追加します。これは「システムプロンプト」または「開発者メッセージ」とも呼ばれます。システムプロンプトは静的な文字列にも、コンテキストを受け取って文字列を出力する動的関数にもできます。これは常に有用な情報(例: ユーザー名や現在の日付)に対して一般的な手法です。 Runner.runを呼び出すときのinputに追加します。これはinstructionsの手法に似ていますが、指揮系統 の下位にメッセージを配置できます。- 関数ツールとして公開します。これはオンデマンドのコンテキストに有用です。LLM が必要に応じてデータを要求し、ツールを呼び出してそのデータを取得できます。
- リトリーバルや Web 検索を使用します。これらは、ファイルやデータベース(リトリーバル)から、または Web(Web 検索)から関連データを取得できる特殊なツールです。これは、応答を関連するコンテキストデータに基づいて根拠付けるのに有用です。