Skip to content

usage.md

Latest commit

 

History

History
99 lines (70 loc) · 4.62 KB

usage.md

File metadata and controls

99 lines (70 loc) · 4.62 KB
search
exclude
true

使用方法

Agents SDK は、実行ごとのトークン使用量を自動的に追跡します。実行コンテキストからアクセスでき、コスト監視、制限の適用、分析記録に利用できます。

追跡対象

  • requests: 実行された LLM API 呼び出し回数
  • input_tokens: 送信された入力トークン総数
  • output_tokens: 受信した出力トークン総数
  • total_tokens: 入力 + 出力
  • request_usage_entries: リクエストごとの使用量内訳の一覧
  • 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)

使用量は、実行中のすべてのモデル呼び出し（ツール呼び出しとハンドオフを含む）で集計されます。

LiteLLM モデルでの使用量の有効化

LiteLLM プロバイダーは、デフォルトでは使用量メトリクスを報告しません。[LitellmModel][agents.extensions.models.litellm_model.LitellmModel] を使用している場合は、LiteLLM のレスポンスが result.context_wrapper.usage を埋めるよう、エージェントに ModelSettings(include_usage=True) を渡してください。設定手順とコード例については、Models ガイドの LiteLLM note を参照してください。

from agents import Agent, ModelSettings, Runner
from agents.extensions.models.litellm_model import LitellmModel

agent = Agent(
    name="Assistant",
    model=LitellmModel(model="your/model", api_key="..."),
    model_settings=ModelSettings(include_usage=True),
)

result = await Runner.run(agent, "What's the weather in Tokyo?")
print(result.context_wrapper.usage.total_tokens)

リクエストごとの使用量追跡

SDK は、request_usage_entries 内の API リクエストごとの使用量を自動追跡します。これは詳細なコスト計算やコンテキストウィンドウ消費量の監視に有用です。

result = await Runner.run(agent, "What's the weather in Tokyo?")

for i, request in enumerate(result.context_wrapper.usage.request_usage_entries):
    print(f"Request {i + 1}: {request.input_tokens} in, {request.output_tokens} out")

セッションでの使用量へのアクセス

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][agents.usage.Usage] - 使用量追跡データ構造
  • [RequestUsage][agents.usage.RequestUsage] - リクエストごとの使用量詳細
  • [RunContextWrapper][agents.run.RunContextWrapper] - 実行コンテキストから使用量にアクセス
  • [RunHooks][agents.run.RunHooks] - 使用量追跡ライフサイクルへのフック