エージェントの実行結果
エージェントを実行すると、次のいずれかを受け取ります:
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 は中断を引き起こした ToolApprovalItem の配列になります。中断への対処方法の詳細は、人間の介入(HITL)を参照してください。
その他の情報
Section titled “その他の情報”元レスポンス
Section titled “元レスポンス”rawResponses プロパティには、エージェント実行中にモデルが生成した元の LLM レスポンスが含まれます。
最後のレスポンス ID
Section titled “最後のレスポンス ID”lastResponseId プロパティには、エージェント実行中にモデルが生成した最後のレスポンスの ID が含まれます。
ガードレールの結果
Section titled “ガードレールの結果”inputGuardrailResults と outputGuardrailResults プロパティには、存在する場合にガードレールの結果が含まれます。ガードレールの結果には、記録や保存に役立つ情報が含まれることがあるため、利用できるようにしています。
ツールのガードレール結果は toolInputGuardrailResults と toolOutputGuardrailResults 経由で個別に公開されます。
input プロパティには、実行メソッドに提供した元の入力が含まれます。多くの場合は不要ですが、必要な場合に備えて利用できます。