エージェントの実行結果
エージェントの実行を行うと、次のいずれかを受け取ります:
stream: trueを指定せずにrunを呼び出した場合はRunResultstream: trueを指定してrunを呼び出した場合はStreamedRunResult。ストリーミングの詳細はストリーミングも参照してください。
finalOutput プロパティには、最後に実行されたエージェントの最終出力が含まれます。この結果は次のいずれかです:
string—outputTypeが定義されていないエージェントのデフォルトunknown— エージェントが出力タイプとして JSON スキーマを定義している場合。この場合、JSON はパースされていますが、型の検証は手動で行う必要がありますz.infer<outputType>— エージェントが出力タイプとして Zod スキーマを定義している場合。出力は自動的にこのスキーマに対してパースされます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 “次ターンへの入力”次ターン用の入力にアクセスする方法は 2 つあります:
result.history— あなたの入力とエージェントの出力の両方のコピーを含みますresult.output— エージェント実行全体の出力を含みます
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?'));}最後のエージェント
Section titled “最後のエージェント”lastAgent プロパティには、最後に実行されたエージェントが含まれます。アプリケーションによっては、次回ユーザーが入力する際に役立つことがよくあります。たとえば、フロントラインのトリアージ用エージェントが言語別のエージェントにハンドオフする場合、最後のエージェントを保存して、次回ユーザーがメッセージを送るときに再利用できます。
ストリーミングモードでは、現在実行中のエージェントに対応する currentAgent プロパティにアクセスするのも有用です。
新規アイテム
Section titled “新規アイテム”newItems プロパティには、実行中に生成された新しいアイテムが含まれます。アイテムは RunItem です。実行アイテムは、LLM が生成した元のアイテムをラップします。これにより、LLM の出力に加えて、どのエージェントに関連付けられたイベントかにもアクセスできます。
RunMessageOutputItemは LLM からのメッセージを示します。元アイテムは生成されたメッセージですRunHandoffCallItemは LLM がハンドオフツールを呼び出したことを示します。元アイテムは LLM からのツール呼び出しアイテムですRunHandoffOutputItemはハンドオフが発生したことを示します。元アイテムはハンドオフツール呼び出しへのツール応答です。アイテムからソース/ターゲットのエージェントにもアクセスできますRunToolCallItemは LLM がツールを起動したことを示しますRunToolCallOutputItemはツールが呼び出されたことを示します。元アイテムはツールの応答です。アイテムからツールの出力にもアクセスできますRunReasoningItemは LLM からの reasoning アイテムを示します。元アイテムは生成された reasoning ですRunToolApprovalItemは LLM がツール呼び出しの承認を要求したことを示します。元アイテムは LLM からのツール呼び出しアイテムです
state プロパティには、実行の状態が含まれます。result に付随する情報の多くは state から導出されていますが、state はシリアライズ/デシリアライズ可能で、エラーからのリカバリーが必要な場合や、interruption を処理する場合に、後続の run 呼び出しの入力としても使用できます。
エージェントで needsApproval を使用している場合、続行する前に処理が必要な interruptions がトリガーされることがあります。その場合、interruptions は中断を引き起こした ToolApprovalItems の配列になります。中断の扱い方については、人間の介入(HITL)を確認してください。
その他の情報
Section titled “その他の情報”元レスポンス
Section titled “元レスポンス”rawResponses プロパティには、エージェント実行中にモデルが生成した元の LLM レスポンスが含まれます。
最終レスポンス ID
Section titled “最終レスポンス ID”lastResponseId プロパティには、エージェント実行中にモデルが最後に生成したレスポンスの ID が含まれます。
ガードレール結果
Section titled “ガードレール結果”inputGuardrailResults と outputGuardrailResults プロパティには、存在する場合にガードレールの結果が含まれます。ガードレール結果には、記録や保存に有用な情報が含まれることがあるため、参照できるようにしています。
input プロパティには、run メソッドに提供した元の入力が含まれます。ほとんどの場合は不要ですが、必要に応じて使用できます。