エージェントの実行
エージェントはそれ自体では何もしません。Runner クラスまたは run() ユーティリティを使ってエージェントを 実行 します。
ターンの実行、イベントのストリーミング、会話状態の管理を行う場合は、エージェントを読んだ後にこのページをお読みください。エージェントをどのように定義するかまだ検討中の場合は、まずエージェントから始めてください。
import { Agent, run } from '@openai/agents';
const agent = new Agent({ name: 'Assistant', instructions: 'You are a helpful assistant',});
const result = await run( agent, 'Write a haiku about recursion in programming.',);console.log(result.finalOutput);
// Code within the code,// Functions calling themselves,// Infinite loop's dance.カスタム Runner が不要な場合は、シングルトンのデフォルト Runner インスタンスを実行する run() ユーティリティも使用できます。
または、独自の Runner インスタンスを作成できます。
import { Agent, Runner } from '@openai/agents';
const agent = new Agent({ name: 'Assistant', instructions: 'You are a helpful assistant',});
// You can pass custom configuration to the runnerconst runner = new Runner();
const result = await runner.run( agent, 'Write a haiku about recursion in programming.',);console.log(result.finalOutput);
// Code within the code,// Functions calling themselves,// Infinite loop's dance.エージェントを実行すると、最終出力と実行履歴全体を含む実行結果オブジェクトを受け取ります。
Runner のライフサイクルと設定
Section titled “Runner のライフサイクルと設定”エージェントループ
Section titled “エージェントループ”Runner の run メソッドを使用する場合、開始エージェントと入力を渡します。入力には、ユーザーメッセージとして扱われる文字列、または OpenAI Responses API のアイテムである入力アイテムのリストを指定できます。
Runner は次のループを実行します。
- 現在の入力を使用して、現在のエージェントのモデルを呼び出します。
- LLM の応答を確認します。
- 最終出力 → 返します。
- ハンドオフ → 新しいエージェントに切り替え、蓄積された会話履歴を保持したまま、手順 1 に戻ります。
- ツール呼び出し → ツールを実行し、その結果を会話に追加して、手順 1 に戻ります。
maxTurnsがnullでない限り、maxTurnsに達するとMaxTurnsExceededErrorをスローします。
Runner のライフサイクル
Section titled “Runner のライフサイクル”アプリの起動時に Runner を作成し、複数のリクエストで再利用します。このインスタンスには、モデルプロバイダーやトレーシングオプションなどのグローバル設定が保存されます。まったく異なる設定が必要な場合にのみ、別の Runner を作成してください。単純なスクリプトでは、内部でデフォルトの Runner を使用する run() を呼び出すこともできます。
run() メソッドには、実行を開始する初期エージェント、実行への入力、および一連のオプションを渡します。
入力には、ユーザーメッセージとして扱われる文字列、入力アイテムのリスト、または人間の介入(HITL)エージェントを構築する場合は RunState オブジェクトを指定できます。
追加のオプションは次のとおりです。
| オプション | デフォルト | 説明 |
|---|---|---|
stream | false | true の場合、呼び出しは StreamedRunResult を返し、モデルからイベントが到着するたびに発行します。 |
context | – | すべてのツール、ガードレール、ハンドオフに転送されるコンテキストオブジェクトです。詳しくはコンテキスト管理を参照してください。 |
maxTurns | 10 | 安全上の制限です。上限に達すると MaxTurnsExceededError をスローします。制限を無効にするには null を渡します。 |
signal | – | キャンセル用の AbortSignal です。 |
session | – | セッション永続化の実装です。セッションを参照してください。 |
sessionInputCallback | – | セッション履歴と新しい入力をマージするためのカスタムロジックです。モデル呼び出しの前に実行されます。セッションを参照してください。 |
callModelInputFilter | – | モデルを呼び出す直前に、モデル入力(アイテムと任意の instructions)を編集するためのフックです。モデル呼び出し入力フィルターを参照してください。 |
toolErrorFormatter | – | モデルに返されるツールエラーメッセージをカスタマイズするためのフックです。ツールエラーフォーマッターを参照してください。 |
reasoningItemIdPolicy | – | 以前の実行アイテムを再びモデル入力に変換するときに、推論アイテムの id を保持するか省略するかを制御します。推論アイテム ID ポリシーを参照してください。 |
tracing | – | 実行単位のトレーシング設定のオーバーライドです(例:エクスポート用 API キー)。 |
sandbox | – | SandboxAgent の実行で使用するサンドボックスクライアント、ライブセッション、セッション状態、スナップショット、マニフェストのオーバーライド、または同時実行数の制限です。コンセプトを参照してください。 |
toolExecution | – | ローカルツール呼び出しに対する SDK 側の実行設定です。同時に実行する関数ツールの数を制限するには toolExecution.maxFunctionToolConcurrency を使用し、承認待ちリクエストの前に関数ツールの入力ガードレールを実行するには toolExecution.preApprovalInputGuardrails を使用します。 |
toolNotFoundBehavior | 'raise_error' | モデルが出力した未解決の関数ツール呼び出しの処理方法を制御します。モデルから参照可能なツールエラーを返して実行を続行するには、'return_error_to_model' を使用します。 |
errorHandlers | – | サポートされているランタイムエラーのハンドラーです。エラーハンドラーを参照してください。 |
conversationId | – | サーバー側の会話を再利用します(OpenAI Responses API と Conversations API のみ)。 |
previousResponseId | – | 会話を作成せずに、前回の Responses API 呼び出しから続行します(OpenAI Responses API のみ)。 |
ストリーミング
Section titled “ストリーミング”ストリーミングを使用すると、LLM の実行中にストリーミングイベントも受信できます。ストリームが開始されると、StreamedRunResult には、生成されたすべての新しい出力を含む実行の完全な情報が格納されます。for await ループを使用して、ストリーミングイベントを反復処理できます。詳しくはストリーミングを参照してください。
独自の Runner インスタンスを作成する場合は、Runner を設定するための RunConfig オブジェクトを渡せます。
| フィールド | 型 | 目的 |
|---|---|---|
model | string | Model | 実行内の すべての エージェントに特定のモデルを強制的に使用します。 |
modelProvider | ModelProvider | モデル名を解決します。デフォルトは OpenAI プロバイダーです。 |
modelSettings | ModelSettings | エージェント単位の設定を上書きするグローバル調整パラメーターです。オプトインの再試行設定を含む詳細は、モデルを参照してください。 |
handoffInputFilter | HandoffInputFilter | ハンドオフの実行時に入力アイテムを変更します(ハンドオフ自体にフィルターが定義されていない場合)。 |
inputGuardrails | InputGuardrail[] | 最初の ユーザー入力に適用されるガードレールです。 |
outputGuardrails | OutputGuardrail[] | 最終 出力に適用されるガードレールです。 |
tracingDisabled | boolean | OpenAI トレーシングを完全に無効にします。 |
traceIncludeSensitiveData | boolean | スパンを発行しながら、LLM やツールの入出力をトレースから除外します。 |
workflowName | string | Traces ダッシュボードに表示され、関連する実行のグループ化に役立ちます。 |
traceId / groupId | string | SDK に生成させる代わりに、トレース ID またはグループ ID を手動で指定します。 |
traceMetadata | Record<string, string> | すべてのスパンに付加する任意のメタデータです。 |
tracing | TracingConfig | 実行単位のトレーシング設定のオーバーライドです(例:エクスポート用 API キー)。 |
sessionInputCallback | SessionInputCallback | この Runner によるすべての実行で使用する、デフォルトの履歴マージ方式です。 |
callModelInputFilter | CallModelInputFilter | 各モデル呼び出しの前にモデル入力を編集するグローバルフックです。 |
toolErrorFormatter | ToolErrorFormatter | モデルに返されるツールエラーメッセージをカスタマイズするグローバルフックです。 |
reasoningItemIdPolicy | ReasoningItemIdPolicy | 生成済みアイテムを後続のモデル呼び出しへの入力として再利用するときに、推論アイテムの id を保持または省略するデフォルトポリシーです。 |
sandbox | SandboxRunConfig | SandboxAgent の実行で使用する、デフォルトのサンドボックスランタイム設定です。 |
toolExecution | ToolExecutionConfig | ローカルツール呼び出しに対するデフォルトの SDK 側実行設定です。maxFunctionToolConcurrency は、各ターンにおけるローカル関数ツールの同時実行数を制限します。未設定または null の場合、1 ターンで出力されたすべての関数ツール呼び出しが開始されます。preApprovalInputGuardrails を使用すると、承認待ちリクエストの前に関数ツールの入力ガードレールを実行できます。 |
toolNotFoundBehavior | ToolNotFoundBehavior | 未解決の関数ツール呼び出しに対するデフォルトの動作です。'raise_error' は ModelBehaviorError を発生させ、'return_error_to_model' はモデルから参照可能なツールエラーを返して実行を続行します。 |
toolExecution.maxFunctionToolConcurrency は、1 以上の整数である必要があります。この設定は、SDK 側でのローカル関数ツールの実行のみを制限します。プロバイダー側の modelSettings.parallelToolCalls は変更しません。
toolExecution.preApprovalInputGuardrails はデフォルトで無効です。true に設定すると、承認が必要なローカル関数ツールでは、SDK が承認待ちの中断を記録する前に入力ガードレールが実行されます。ガードレールが rejectContent を返した場合、SDK は承認を求める代わりに、その拒否メッセージをツール出力として返します。ガードレールが呼び出しを許可した場合も承認リクエストは発生し、承認が解決された後、ツールの実行直前に同じ入力ガードレールが再度実行されます。
状態と会話の管理
Section titled “状態と会話の管理”メモリ方式の選択
Section titled “メモリ方式の選択”次のターンに状態を引き継ぐ一般的な方法は 4 つあります。
| 方式 | 状態の保存場所 | 適した用途 | 次のターンに渡すもの |
|---|---|---|---|
result.history | アプリのメモリ | 小規模なチャットループ、完全な手動制御、任意のプロバイダー | result.history |
session | ストレージと SDK | 永続的なチャット状態、再開可能な実行、カスタムストア | 同じ session インスタンス(またはストアを使用するインスタンス) |
conversationId | OpenAI Conversations API | ワーカーやサービス間で共有するサーバー側の状態 | 同じ conversationId と新しいユーザーターンのみ |
previousResponseId | OpenAI Responses API のみ | 会話を作成せずに行う、最も単純なサーバー管理の継続 | result.lastResponseId と新しいユーザーターンのみ |
result.history と session はクライアント側で管理されます。conversationId と previousResponseId は OpenAI 側で管理され、OpenAI Responses API を使用している場合にのみ適用されます。ほとんどのアプリケーションでは、会話ごとに 1 つの永続化方式を選択してください。両方のレイヤーを意図的に整合させない限り、クライアント管理の履歴とサーバー管理の状態を併用すると、コンテキストが重複する可能性があります。
サンドボックスエージェントには、ライブサンドボックスワークスペースという別の状態レイヤーがあります。会話履歴には通常の SDK の session、conversationId、または previousResponseId を使用し、サンドボックスのファイルシステム状態には sandbox.session、sandbox.sessionState、RunState、またはスナップショットを使用します。ワークスペースのライフサイクルについては、コンセプトを参照してください。
会話とチャットスレッド
Section titled “会話とチャットスレッド”runner.run() または run() ユーティリティの各呼び出しは、アプリケーションレベルの会話における 1 つの ターン を表します。RunResult のうち、エンドユーザーにどの程度表示するかを選択できます。finalOutput のみを表示する場合もあれば、生成されたすべてのアイテムを表示する場合もあります。
import { Agent, run } from '@openai/agents';import type { AgentInputItem } from '@openai/agents';
let thread: AgentInputItem[] = [];
const agent = new Agent({ name: 'Assistant',});
async function userSays(text: string) { const result = await run( agent, thread.concat({ role: 'user', content: text }), );
thread = result.history; // Carry over history + newly generated items return result.finalOutput;}
await userSays('What city is the Golden Gate Bridge in?');// -> "San Francisco"
await userSays('What state is it in?');// -> "California"対話型のバージョンについては、チャットのコード例を参照してください。
サーバー管理の会話
Section titled “サーバー管理の会話”各ターンでローカルの会話履歴全体を送信する代わりに、OpenAI Responses API に会話履歴を永続化させることができます。これは、長い会話や複数のサービスを連携させる場合に便利です。以下のどちらのサーバー管理方式でも、各リクエストでは新しいターンの入力だけを渡します。API が以前の状態を再利用します。詳しくは、会話状態ガイドを参照してください。
OpenAI では、サーバー側の状態を再利用する方法を 2 つ提供しています。
1. 会話全体で使用する conversationId
Section titled “1. 会話全体で使用する conversationId”Conversations API を使用して会話を一度作成し、その ID を各ターンで再利用できます。SDK は、新しく生成されたアイテムのみを自動的に含めます。
import { Agent, run } from '@openai/agents';import { OpenAI } from 'openai';
const agent = new Agent({ name: 'Assistant', instructions: 'Reply very concisely.',});
async function main() { // Create a server-managed conversation: const client = new OpenAI(); const { id: conversationId } = await client.conversations.create({});
const first = await run(agent, 'What city is the Golden Gate Bridge in?', { conversationId, }); console.log(first.finalOutput); // -> "San Francisco"
const second = await run(agent, 'What state is it in?', { conversationId }); console.log(second.finalOutput); // -> "California"}
main().catch(console.error);2. 最後のターンから続行する previousResponseId
Section titled “2. 最後のターンから続行する previousResponseId”Responses API のみを使用して開始する場合は、前回の応答から返された ID を使用して各リクエストを連結できます。これにより、完全な会話リソースを作成せずに、ターン間でコンテキストを維持できます。
import { Agent, run } from '@openai/agents';
const agent = new Agent({ name: 'Assistant', instructions: 'Reply very concisely.',});
async function main() { const first = await run(agent, 'What city is the Golden Gate Bridge in?'); console.log(first.finalOutput); // -> "San Francisco"
const previousResponseId = first.lastResponseId; const second = await run(agent, 'What state is it in?', { previousResponseId, }); console.log(second.finalOutput); // -> "California"}
main().catch(console.error);conversationId と previousResponseId は同時に使用できません。システム間で共有できる名前付き会話リソースが必要な場合は conversationId を使用し、ある応答から次の応答へ、SDK レベルで最小コストの継続手段のみが必要な場合は previousResponseId を使用します。
フックとカスタマイズ
Section titled “フックとカスタマイズ”モデル呼び出し入力フィルター
Section titled “モデル呼び出し入力フィルター”モデルが呼び出される 直前 にモデル入力を編集するには、callModelInputFilter を使用します。このフックは、現在のエージェント、コンテキスト、および結合された入力アイテム(存在する場合はセッション履歴を含む)を受け取ります。更新した input 配列と任意の instructions を返すことで、機密データのマスキング、古いメッセージの削除、または追加のシステムガイダンスの挿入を行えます。
実行単位では runner.run(..., { callModelInputFilter }) に設定し、デフォルトとして使用する場合は Runner の設定(RunConfig の callModelInputFilter)に設定します。
戻り値は、{ input: AgentInputItem[], instructions? } 形式の ModelInputData オブジェクトである必要があります。input フィールドは必須であり、配列でなければなりません。それ以外の形式を返すと UserError がスローされます。
SDK は、フィルターを呼び出す前に、準備済みのターン入力を複製します。session も使用している場合は、フィルター処理された複製が永続化されるため、ここで適用したマスキングや切り詰めは、保存されるセッション履歴にも反映されます。
conversationId または previousResponseId を使用する場合、このフックは次の Responses API 呼び出し用に準備されたペイロードに対して実行されます。以前のサーバー管理コンテキストは API によって復元されるため、その呼び出しに渡されるフィルター処理済み配列は、以前の履歴全体ではなく、新しいターンの差分のみをすでに表している場合があります。この最終的なフィルター処理の前に、保存済みの履歴と現在のターンをマージする方法を変更する必要がある場合は、sessionInputCallback を使用します。
ツールエラーフォーマッター
Section titled “ツールエラーフォーマッター”モデルに返されるツールエラーメッセージをカスタマイズするには、toolErrorFormatter を使用します。これにより、SDK のデフォルトメッセージの代わりに、ドメイン固有の文言(コンプライアンスに関するガイダンスなど)を返せます。
フォーマッターは、実行単位(runner.run(..., { toolErrorFormatter }))または RunConfig でグローバル(new Runner(...) の toolErrorFormatter)に設定できます。
このフォーマッターは、承認拒否に対するグローバルなフォールバックです。result.state.reject(interruption, { message: '...' }) を使用して特定の中断を拒否した場合、その呼び出し単位の message が toolErrorFormatter より優先されます。どちらも指定されていない場合、SDK はデフォルトの拒否テキストである Tool execution was not approved. にフォールバックします。
toolNotFoundBehavior: 'return_error_to_model' が未解決の関数ツール呼び出しを、モデルから参照可能なツール出力へ変換するときにも、このフォーマッターが実行されます。この場合のデフォルトメッセージは Tool '<name>' not found. です。
フォーマッターは次の値を受け取ります。
kind('approval_rejected'または'tool_not_found')toolType('function'、'computer'、'shell'、または'apply_patch')toolNamecallIddefaultMessage(現在のエラー種別に対する SDK のフォールバックメッセージ)runContext
メッセージを上書きするには文字列を返し、SDK のデフォルトを維持するには undefined を返します。フォーマッターが例外をスローした場合、または文字列以外の値を返した場合、SDK は警告をログに記録し、現在のエラー種別に対するデフォルトメッセージにフォールバックします。
推論アイテム ID ポリシー
Section titled “推論アイテム ID ポリシー”SDK が以前に生成された実行アイテムを、後続のモデル入力用の AgentInputItem[] に変換するときに、推論アイテムの id フィールドを保持するかどうかを制御するには、reasoningItemIdPolicy を使用します。
これは、SDK が生成済みのモデルアイテムを入力として再利用する次のような箇所に影響します。
- 同じ実行内での後続のモデル呼び出し(例:ツール実行後)
- 生成済みアイテムを入力や履歴として再利用する後続のターン
- 保存済みの
RunStateから再開された実行 result.history/result.outputなどの派生した実行結果ビュー(モデル入力形式の配列)'preserve'(デフォルト)は推論アイテムの ID を保持します。'omit'は、入力として送り返す前に推論アイテムからidフィールドを削除します。- 推論アイテム以外には影響しません。
このポリシーによって 変更されない ものは次のとおりです。
- 元のモデル応答(
result.rawResponses) - 実行アイテム(
result.newItems) - プロバイダーから返される、モデルの現在のターンの出力
つまり、このポリシーは、SDK が以前に生成されたアイテムから 次の入力 を構築するときに適用されます。
ポリシーは、実行単位(runner.run(..., { reasoningItemIdPolicy: 'omit' }))または Runner のデフォルト(new Runner({ reasoningItemIdPolicy: 'omit', ... }))として設定できます。保存済みの RunState から再開する場合、上書きしない限り、以前に決定されたポリシーが再利用されます。
callModelInputFilter との相互作用
Section titled “callModelInputFilter との相互作用”reasoningItemIdPolicy は callModelInputFilter より前に適用されます。カスタム動作が必要な場合、callModelInputFilter で準備済みの入力を確認し、モデル呼び出しの前に推論 ID を手動で再追加または削除できます。
'omit' の使用場面
Section titled “'omit' の使用場面”再利用される推論アイテムを ID なしで正規化したい場合(例:転送または再利用されるモデル入力を簡潔に保つ場合や、アプリのパイプラインにおける連携要件に合わせる場合)は、'omit' を使用します。
バックエンドやプロバイダーが、再利用された推論アイテムをリクエスト検証エラーで拒否する場合にも、トラブルシューティングに役立つオプションです(例:後続の入力に含まれる推論アイテム ID に関連する HTTP 400 エラー)。このような場合、'omit' を使用して再利用される推論 ID を削除すると、バックエンドが新しいリクエストでは無効と見なす ID の送信を回避できます。
SDK で再利用される入力に推論アイテムの ID を引き継ぎ、連携先でもそれを受け入れられる場合は、'preserve' を使用してください。
エラーと復旧
Section titled “エラーと復旧”エラーハンドラー
Section titled “エラーハンドラー”サポートされているランタイムエラーを、例外としてスローする代わりに最終出力へ変換するには、errorHandlers を使用します。サポートされているキーは、maxTurns、modelRefusal、invalidFinalOutput です。
errorHandlers.maxTurnsは、最大ターン数のエラーのみを処理します。errorHandlers.modelRefusalは、ModelRefusalErrorとして公開されるモデルの拒否を処理します。errorHandlers.invalidFinalOutputは、構造化された最終出力がない場合、または出力スキーマの検証に失敗した場合に発生するModelBehaviorErrorインスタンスを処理します。このハンドラーは、モデルの再試行やツールの副作用の再実行を行わず、検証済みのフォールバックを返します。errorHandlers.defaultは、サポートされているエラー種別に対するフォールバックとして使用されます。- ハンドラーは
{ error, context, runData }を受け取り、{ finalOutput, includeInHistory? }を返せます。返されるfinalOutputは、現在のエージェントのoutputTypeと一致する必要があります。structured outputs の場合、SDK は実行を完了する前にフォールバックを検証します。undefinedを返すと、そのエラーに対するデフォルトの動作が維持されます。
SDK は、捕捉可能な少数のエラーをスローします。
MaxTurnsExceededError–maxTurnsに到達しました。ModelBehaviorError– モデルが無効な出力を生成しました(例:不正な形式の JSON、不明なツール)。ModelRefusalError– モデルが要求された出力の生成を拒否しました。InputGuardrailTripwireTriggered/OutputGuardrailTripwireTriggered– ガードレール違反です。ToolInputGuardrailTripwireTriggered/ToolOutputGuardrailTripwireTriggered– ツールのガードレール違反です。GuardrailExecutionError– ガードレールを完了できませんでした。ToolTimeoutError– 関数ツールがtimeoutMsを超過し、timeoutBehavior: 'raise_exception'が使用されました。ToolCallError– タイムアウト以外のエラーにより、関数ツールの実行に失敗しました。UserError– 設定またはユーザー入力に基づいてスローされたエラーです。
これらはすべて基底クラス AgentsError を継承しており、現在の実行状態にアクセスするための state プロパティを提供する場合があります。
次のコード例では、GuardrailExecutionError を処理します。入力ガードレールは最初のユーザー入力に対してのみ実行されるため、この例では元の入力とコンテキストを使用して実行を再開します。また、保存された状態を再利用し、モデルを再度呼び出さずに出力ガードレールを再試行する方法も示しています。
import { Agent, GuardrailExecutionError, InputGuardrail, InputGuardrailTripwireTriggered, OutputGuardrail, OutputGuardrailTripwireTriggered, run,} from '@openai/agents';import { z } from 'zod';
// Shared guardrail agent to avoid re-creating it on every fallback run.const guardrailAgent = new Agent({ name: 'Guardrail check', instructions: 'Check if the user is asking you to do their math homework.', outputType: z.object({ isMathHomework: z.boolean(), reasoning: z.string(), }),});
async function main() { const input = 'Hello, can you help me solve for x: 2x + 3 = 11?'; const context = { customerId: '12345' };
// Input guardrail example
const unstableInputGuardrail: InputGuardrail = { name: 'Math Homework Guardrail (unstable)', execute: async () => { throw new Error('Something is wrong!'); }, };
const fallbackInputGuardrail: InputGuardrail = { name: 'Math Homework Guardrail (fallback)', execute: async ({ input, context }) => { const result = await run(guardrailAgent, input, { context }); const isMathHomework = result.finalOutput?.isMathHomework ?? /solve for x|math homework/i.test(JSON.stringify(input)); return { outputInfo: result.finalOutput, tripwireTriggered: isMathHomework, }; }, };
const agent = new Agent({ name: 'Customer support agent', instructions: 'You are a customer support agent. You help customers with their questions.', inputGuardrails: [unstableInputGuardrail], });
try { // Input guardrails only run on the first turn of a run, so retries must start a fresh run. await run(agent, input, { context }); } catch (e) { if (e instanceof GuardrailExecutionError) { console.error(`Guardrail execution failed (input): ${e}`); try { agent.inputGuardrails = [fallbackInputGuardrail]; // Retry from scratch with the original input and context. await run(agent, input, { context }); } catch (ee) { if (ee instanceof InputGuardrailTripwireTriggered) { console.log('Math homework input guardrail tripped on retry'); } else { throw ee; } } } else { throw e; } }
// Output guardrail example
const replyOutputSchema = z.object({ reply: z.string() });
const unstableOutputGuardrail: OutputGuardrail<typeof replyOutputSchema> = { name: 'Answer review (unstable)', execute: async () => { throw new Error('Output guardrail crashed.'); }, };
const fallbackOutputGuardrail: OutputGuardrail<typeof replyOutputSchema> = { name: 'Answer review (fallback)', execute: async ({ agentOutput }) => { const outputText = typeof agentOutput === 'string' ? agentOutput : (agentOutput?.reply ?? JSON.stringify(agentOutput)); const flagged = /math homework|solve for x|x =/i.test(outputText); return { outputInfo: { flaggedOutput: outputText }, tripwireTriggered: flagged, }; }, };
const agent2 = new Agent<unknown, typeof replyOutputSchema>({ name: 'Customer support agent (output check)', instructions: 'You are a customer support agent. Answer briefly.', outputType: replyOutputSchema, outputGuardrails: [unstableOutputGuardrail], });
try { await run(agent2, input, { context }); } catch (e) { if (e instanceof GuardrailExecutionError && e.state) { console.error(`Guardrail execution failed (output): ${e}`); try { agent2.outputGuardrails = [fallbackOutputGuardrail]; // Output guardrails can be retried using the saved state without another model call. await run(agent2, e.state); } catch (ee) { if (ee instanceof OutputGuardrailTripwireTriggered) { console.log('Output guardrail tripped after retry with saved state'); } else { throw ee; } } } else { throw e; } }}
main().catch(console.error);入力と出力の再試行の違いは次のとおりです。
- 入力ガードレールは、実行における最初のユーザー入力に対してのみ実行されます。そのため、再試行するには、同じ入力とコンテキストを使用して新しい実行を開始する必要があります。保存済みの
stateを渡しても、入力ガードレールは再実行されません。 - 出力ガードレールはモデル応答の後に実行されるため、
GuardrailExecutionErrorの保存済みstateを再利用して、モデルを再度呼び出さずに出力ガードレールを再実行できます。
上記のコード例を実行すると、次の出力が表示されます。
Guardrail execution failed (input): Error: Input guardrail failed to complete: Error: Something is wrong!Math homework input guardrail tripped on retryGuardrail execution failed (output): Error: Output guardrail failed to complete: Error: Output guardrail crashed.Output guardrail tripped after retry with saved state