エージェントの実行結果
エージェントの実行を行うと、次のいずれかを受け取ります。
stream: trueを指定せずにrunを呼び出した場合は、RunResultstream: trueを指定してrunを呼び出した場合は、StreamedRunResult。ストリーミングの詳細については、ストリーミングも参照してください。
どちらの結果型も、finalOutput、newItems、interruptions、state など、同じ主要な結果サーフェスを公開します。StreamedRunResult には、completed、toStream()、toTextStream()、currentAgent などのストリーミング制御が追加されています。
適切な結果サーフェスの選択
Section titled “適切な結果サーフェスの選択”ほとんどのアプリケーションでは、必要なプロパティは数個だけです。
| 必要なもの | 使用するプロパティ |
|---|---|
| ユーザーに表示する最終回答 | finalOutput |
| ローカルの会話履歴全体を含む、再実行可能な次ターンの入力 | history |
| この実行で新たに生成されたモデル形式の項目のみ | output |
| エージェント、ツール、ハンドオフのメタデータを含む詳細な実行項目 | newItems |
| 通常、次のユーザーターンを処理すべきエージェント | lastAgent または activeAgent |
previousResponseId を使用した OpenAI Responses API のチェーン | lastResponseId |
| 保留中の承認と再開可能なスナップショット | interruptions と state |
| アプリのコンテキスト、承認、使用量、ネストされたエージェントツールの入力 | runContext |
現在のネストされた Agent.asTool() 呼び出しに関するメタデータ(たとえば customOutputExtractor 内) | agentToolInvocation |
| 元のモデル呼び出しまたはガードレールの診断情報 | rawResponses とガードレール結果の配列 |
finalOutput プロパティには、最後に実行されたエージェントの最終出力が格納されます。この結果は次のいずれかです。
string—outputTypeが定義されていないエージェントのデフォルトunknown— エージェントの出力型として JSON スキーマが定義されている場合。この場合、JSON は解析されていますが、型は手動で検証する必要がありますz.infer<outputType>— エージェントの出力型として Zod スキーマが定義されている場合。出力は、このスキーマに対して自動的に解析されますundefined— エージェントが出力を生成しなかった場合(たとえば、出力を生成する前に停止した場合)
ストリーミング実行がまだ進行中の場合や、最終出力に到達する前に承認による中断で実行が一時停止した場合も、finalOutput は undefined です。
異なる出力型を持つハンドオフを使用する場合は、new Agent() コンストラクターではなく Agent.create() メソッドを使用してエージェントを作成してください。
これにより、SDK は可能なすべてのハンドオフにわたって出力型を推論し、finalOutput プロパティにユニオン型を提供できます。
例:
import { Agent, run } from '@openai/agents';import { z } from 'zod';
const refundAgent = new Agent({ name: 'Refund Agent', instructions: 'You are a refund agent. You are responsible for refunding customers.', outputType: z.object({ refundApproved: z.boolean(), }),});
const orderAgent = new Agent({ name: 'Order Agent', instructions: 'You are an order agent. You are responsible for processing orders.', outputType: z.object({ orderId: z.string(), }),});
const triageAgent = Agent.create({ name: 'Triage Agent', instructions: 'You are a triage agent. You are responsible for triaging customer issues.', handoffs: [refundAgent, orderAgent],});
const result = await run(triageAgent, 'I need to a refund for my order');
const output = result.finalOutput;// ^? { refundApproved: boolean } | { orderId: string } | string | undefined入出力サーフェス
Section titled “入出力サーフェス”これらのプロパティは、それぞれ異なる目的に対応します。
| プロパティ | 格納される内容 | 最適な用途 |
|---|---|---|
input | この実行の基本入力。ハンドオフ入力フィルターによって履歴が書き換えられた場合、実行が継続されたフィルタリング後の入力が反映されます。 | この実行で実際に使用された入力の監査 |
output | エージェントのメタデータを含まない、この実行で生成されたモデル形式の項目のみ。 | 新しいモデル差分のみの保存または再実行 |
newItems | エージェント、ツール、ハンドオフのメタデータを含む詳細な RunItem ラッパー。 | ログ、UI、監査、デバッグ |
history | input + newItems から構築された、再実行可能な次ターンの入力。 | 手動のチャットループとクライアント管理の会話状態 |
実際には、次のように使い分けます。
- アプリケーション内で会話全体を手動で引き継ぐ場合は、
historyを使用します。 - 以前の履歴をすでに別の場所に保存しており、この実行で新たに生成された項目のみが必要な場合は、
outputを使用します。 - エージェントとの関連付け、ツールの出力、ハンドオフの境界、承認項目が必要な場合は、
newItemsを使用します。 conversationIdまたはpreviousResponseIdを使用している場合、通常はhistoryをrun()に戻して渡しません。代わりに、新しいユーザー入力だけを渡し、サーバー管理の ID を再利用します。詳細な比較については、エージェントの実行を参照してください。
history は、チャット形式のユースケースで完全な履歴を維持するための便利な方法です。
import { Agent, user, run } from '@openai/agents';import type { AgentInputItem } from '@openai/agents';
const agent = new Agent({ name: 'Assistant', instructions: 'You are a helpful assistant knowledgeable about recent AGI research.',});
let history: AgentInputItem[] = [ // initial message user('Are we there yet?'),];
for (let i = 0; i < 10; i++) { // run 10 times const result = await run(agent, history);
// update the history to the new output history = result.history;
history.push(user('How about now?'));}newItems を使用すると、実行中に起きたことを最も詳細に確認できます。一般的な項目型は次のとおりです。
- アシスタントメッセージを表す
RunMessageOutputItem。 - 推論項目を表す
RunReasoningItem。 - Responses のツール検索リクエストと、それらが返す読み込み済みのツール定義を表す
RunToolSearchCallItemおよびRunToolSearchOutputItem。 - ツール呼び出しとその結果を表す
RunToolCallItemおよびRunToolCallOutputItem。 - 承認待ちで一時停止したツール呼び出しを表す
RunToolApprovalItem。 - ハンドオフリクエストと完了した移行を表す
RunHandoffCallItemおよびRunHandoffOutputItem。
どのエージェントが項目を生成したか、またはその項目がツール、ツール検索、ハンドオフ、承認の境界を示すかを把握する必要がある場合は、output ではなく newItems を選択してください。toolSearchTool() を使用する場合、通常のツール呼び出しが行われる前にどの遅延ツールまたは名前空間が読み込まれたかを確認するには、これらのツール検索項目が最も簡単な方法です。
ローカルツールまたは MCP サーバーで customDataExtractor が定義されている場合、対応する RunToolCallOutputItem.customData には、返された SDK 専用のメタデータが格納されます。このデータは、レンダラー向けのヒントや内部 ID など、アプリケーションの UI 状態に役立ちます。このデータは RunState のシリアライズ後も保持されますが、history からは除外され、モデルには送り返されません。
会話の継続または再開
Section titled “会話の継続または再開”アクティブなエージェント
Section titled “アクティブなエージェント”lastAgent プロパティには、最後に実行されたエージェントが格納されます。多くの場合、ハンドオフ後の次のユーザーターンで再利用するエージェントとして最適です。activeAgent は同じ値のエイリアスです。
ストリーミングモードでは、currentAgent により、実行の進行中に現在アクティブなエージェントを確認できます。
中断と再開可能な状態
Section titled “中断と再開可能な状態”ツールに承認が必要な場合、実行は一時停止し、interruptions には保留中の RunToolApprovalItem が格納されます。これには、直接のツール、ハンドオフ後に到達したツール、またはネストされた agent.asTool() の実行によって発生した承認が含まれる場合があります。
result.state.approve(...) / result.state.reject(...) を使用して承認を処理し、同じ state を run() に戻して渡すことで再開します。すべての中断を一度に処理する必要はありません。一部の項目だけを処理した後に再実行すると、処理済みの呼び出しは継続できますが、未処理の呼び出しは保留状態のまま残り、実行が再び一時停止します。
state プロパティは、結果の基盤となるシリアライズ可能なスナップショットです。人間の介入(HITL)、再試行フロー、または一時停止した実行を後で再開する必要がある場合に使用します。
サーバー管理の継続
Section titled “サーバー管理の継続”lastResponseId は、OpenAI Responses API のチェーンを使用する場合に、次のターンで previousResponseId として渡す値です。
すでに history、session、または conversationId を使用して会話を継続している場合、通常は lastResponseId は必要ありません。複数ステップの実行から元のモデルレスポンスをすべて取得する必要がある場合は、代わりに rawResponses を確認してください。
ネストされたエージェントツールのメタデータ
Section titled “ネストされたエージェントツールのメタデータ”agentToolInvocation は、ネストされた Agent.asTool() の結果で使用します。特に、customOutputExtractor 内で現在のツール呼び出しに関するメタデータが必要な場合に使用します。これは、一般的な「実行全体が完了した」ことを示す概要フィールドではありません。
このネストされたコンテキストでは、agentToolInvocation は次の情報を公開します。
toolNametoolCallIdtoolArguments
ネストされたエージェントツールの実行に渡された構造化入力も必要な場合は、result.runContext.toolInput と組み合わせて使用します。
通常のトップレベルの run() の結果では、通常これは undefined です。このメタデータは実行時にのみ存在し、RunState にはシリアライズされません。関連するパターンについては、Agents as toolsを参照してください。
ストリーミング結果
Section titled “ストリーミング結果”StreamedRunResult は上記と同じ結果サーフェスを継承し、さらにストリーミング固有の制御を追加します。
- アシスタントのテキストのみを取得する
toTextStream()。 - 完全なイベントストリームを取得する
toStream()またはfor await ... of stream。 - 実行とすべての後処理コールバックが完了するまで待機する
completed。 - ストリーミングの終了状態を確認する
errorとcancelled。 - 実行中にアクティブなエージェントを追跡する
currentAgent。
ストリーミング実行の確定した最終状態が必要な場合は、finalOutput、history、interruptions、またはその他の概要プロパティを読み取る前に、completed を待機してください。イベントごとの処理については、ストリーミングを参照してください。
ストリーミング実行がキャンセルされた場合でも、クリーンアップ後に completed は解決され、cancelled は true になります。ただし、現在のターンが完了していないため、finalOutput などのターン終了時のフィールドは未設定のままになる場合があります。新しいユーザーメッセージを追加するのではなく、result.state(session を使用している場合は同じ session も)を使用して、未完了のターンを再開してください。
診断および高度なフィールド
Section titled “診断および高度なフィールド”実行コンテキスト
Section titled “実行コンテキスト”runContext プロパティは、結果に含まれる実行コンテキストについて、サポートされている公開ビューです。result.runContext.context はアプリのコンテキストであり、同じオブジェクトには、承認、使用量、ネストされた toolInput など、SDK が管理する実行時メタデータも含まれます。完全な構造については、コンテキスト管理を参照してください。
元のレスポンス
Section titled “元のレスポンス”rawResponses には、実行中に収集された元のモデルレスポンスが格納されます。複数ステップの実行では、たとえばハンドオフやツールとモデルのサイクルの繰り返しによって、複数のレスポンスが生成される場合があります。
ガードレールの結果
Section titled “ガードレールの結果”inputGuardrailResults および outputGuardrailResults プロパティには、エージェントレベルのガードレール結果が格納されます。ツールのガードレール結果は、toolInputGuardrailResults および toolOutputGuardrailResults を通じて個別に公開されます。
ガードレールの判定を記録する場合、ガードレール関数から返された追加のメタデータを確認する場合、または実行がブロックされた理由をデバッグする場合は、これらの配列を使用します。
1 つのガードレールの実行に失敗した場合でも、正常に完了した他のガードレールの結果は実行状態に残ります。ストリーミング実行では、completed が reject された後に結果配列を確認してください。非ストリーミング実行では、GuardrailExecutionError に同じ確定済みの state が格納されます。
トークン使用量は result.state.usage に集計され、実行のリクエスト数とトークン合計が追跡されます。同じ使用量オブジェクトは、result.runContext.usage からも利用できます。ストリーミング実行では、レスポンスの到着に応じてこのデータが更新されます。
import { Agent, run } from '@openai/agents';
const agent = new Agent({ name: 'Usage Tracker', instructions: 'Summarize the latest project update in one sentence.',});
const result = await run( agent, 'Summarize this: key customer feedback themes and the next product iteration.',);
const usage = result.state.usage;console.log({ requests: usage.requests, inputTokens: usage.inputTokens, outputTokens: usage.outputTokens, totalTokens: usage.totalTokens,});
if (usage.requestUsageEntries) { for (const entry of usage.requestUsageEntries) { console.log('request', { endpoint: entry.endpoint, inputTokens: entry.inputTokens, outputTokens: entry.outputTokens, totalTokens: entry.totalTokens, }); }}