使用状況
Agents SDK は各実行ごとにトークン使用状況を自動追跡します。実行コンテキストから参照でき、コストの監視、制限の適用、分析の記録に利用できます。
追跡対象
- requests : 実行された LLM API 呼び出し数
- input_tokens : 送信された入力トークン総数
- output_tokens : 受信した出力トークン総数
- total_tokens : 入力 + 出力
- details :
input_tokens_details.cached_tokens
output_tokens_details.reasoning_tokens
実行からの使用状況へのアクセス
Runner.run(...)
の後、result.context_wrapper.usage
から使用状況を参照します。
result = await Runner.run(agent, "What's the weather in Tokyo?")
usage = result.context_wrapper.usage
print("Requests:", usage.requests)
print("Input tokens:", usage.input_tokens)
print("Output tokens:", usage.output_tokens)
print("Total tokens:", usage.total_tokens)
使用状況は実行中のすべてのモデル呼び出し(ツール呼び出しやハンドオフを含む)にわたって集計されます。
セッションでの使用状況へのアクセス
Session
(例: SQLiteSession
)を使用する場合、Runner.run(...)
の各呼び出しは、その特定の実行に対する使用状況を返します。セッションはコンテキスト用に会話履歴を保持しますが、各実行の使用状況は独立しています。
session = SQLiteSession("my_conversation")
first = await Runner.run(agent, "Hi!", session=session)
print(first.context_wrapper.usage.total_tokens) # Usage for first run
second = await Runner.run(agent, "Can you elaborate?", session=session)
print(second.context_wrapper.usage.total_tokens) # Usage for second run
セッションは実行間で会話コンテキストを保持しますが、各 Runner.run()
呼び出しで返される使用状況の指標は、その実行に限られます。セッションでは、前のメッセージが各実行の入力として再投入される場合があり、その結果、後続ターンの入力トークン数に影響します。
フックでの使用状況の利用
RunHooks
を使用している場合、各フックに渡される context
オブジェクトに usage
が含まれます。これにより、重要なライフサイクル時点で使用状況を記録できます。
class MyHooks(RunHooks):
async def on_agent_end(self, context: RunContextWrapper, agent: Agent, output: Any) -> None:
u = context.usage
print(f"{agent.name} → {u.requests} requests, {u.total_tokens} total tokens")
API リファレンス
詳細な API ドキュメントは以下を参照してください。
Usage
- 使用状況の追跡データ構造RunContextWrapper
- 実行コンテキストから使用状況にアクセスRunHooks
- 使用状況トラッキングのライフサイクルにフック