コンテキスト管理

コンテキストは多義的な用語です。関心を持つ可能性のあるコンテキストには、大きく 2 つの種類があります。

ローカルコンテキスト: 実行中にコードからアクセスできるものです。ツールに必要な依存関係やデータ、onHandoff のようなコールバック、ライフサイクルフックが含まれます。
エージェント / LLM コンテキスト: レスポンス生成時に言語モデルが参照できるものです。

ローカルコンテキスト

ローカルコンテキストは RunContext<T> 型で表されます。状態や依存関係を保持する任意のオブジェクトを作成し、それを Runner.run() に渡します。すべてのツール呼び出しとフックは RunContext ラッパーを受け取り、そのオブジェクトを読み取ったり変更したりできます。

import { Agent, run, RunContext, tool } from '@openai/agents';
import { z } from 'zod';

interface UserInfo {
  name: string;
  uid: number;
}

const fetchUserAge = tool({
  name: 'fetch_user_age',
  description: 'Return the age of the current user',
  parameters: z.object({}),
  execute: async (
    _args,
    runContext?: RunContext<UserInfo>,
  ): Promise<string> => {
    return `User ${runContext?.context.name} is 47 years old`;
  },
});

async function main() {
  const userInfo: UserInfo = { name: 'John', uid: 123 };

  const agent = new Agent<UserInfo>({
    name: 'Assistant',
    tools: [fetchUserAge],
  });

  const result = await run(agent, 'What is the age of the user?', {
    context: userInfo,
  });

  console.log(result.finalOutput);
  // The user John is 47 years old.
}

main().catch((error) => {
  console.error(error);
  process.exit(1);
});

1 回の実行に参加するすべてのエージェント、ツール、フックは、同じコンテキストの型を使用する必要があります。

ローカルコンテキストは、次のような用途に使用します。

実行に関するデータ（ユーザー名、ID など）
ロガーやデータフェッチャーなどの依存関係
ヘルパー関数

1 回の実行内では、派生コンテキストは同じ基盤となるアプリコンテキスト、承認、使用状況トラッキングを共有します。ネストされた agent.asTool() の実行では別の toolInput が添付される場合がありますが、デフォルトではアプリ状態の分離されたコピーは取得しません。

`RunContext` の公開内容

RunContext<T> は、アプリで定義したコンテキストオブジェクトのラッパーです。実際には、ほとんどの場合、次のものを使用します。

runContext.context は、独自の可変アプリ状態と依存関係に使用します。
runContext.usage は、現在の実行における集約されたトークン / リクエスト使用量に使用します。
runContext.toolInput は、現在の実行が agent.asTool() の内部で実行されている場合の構造化入力に使用します。
runContext.approveTool(...) / runContext.rejectTool(...) は、承認状態をプログラムで更新する必要がある場合に使用します。

runContext.context だけがアプリで定義したオブジェクトです。他のフィールドは SDK が管理するランタイムメタデータです。

あとで人間の介入（HITL）のために RunState をシリアライズする場合、そのランタイムメタデータも状態とともに保存されます。シリアライズした状態を永続化または送信する予定がある場合は、runContext.context にシークレットを入れないでください。

RunContext をサブクラス化する場合は、ネストされた実行や派生実行でも、依存しているサブクラス固有のインスタンス状態が引き続き保持されることを確認してください。SDK はネストされた実行中に内部でフォークされたコンテキストを作成します。

エージェント / LLM コンテキスト

LLM が呼び出されるとき、LLM が参照できるデータは会話履歴から来るものだけです。追加情報を利用可能にするには、いくつかの選択肢があります。

エージェントの instructions に追加します。これはシステムメッセージまたは開発者メッセージとも呼ばれます。静的な文字列でも、コンテキストを受け取って文字列を返す関数でもかまいません。
Runner.run() を呼び出すときに input に含めます。これは instructions の手法に似ていますが、メッセージを指揮系統（chain of command）のより低い位置に配置できます。
LLM が必要に応じてデータを取得できるように、関数ツール経由で公開します。
ファイル、データベース、または Web からの関連データに基づいて応答できるように、取得や Web 検索ツールを使用します。