モデル
最終的にすべての エージェント は LLM を呼び出します。SDK は 2 つの軽量インターフェースの背後にモデルを抽象化します:
Model– 特定の API に対して 1 回 のリクエストを行う方法を知っていますModelProvider– 人が読めるモデルの names(例:'gpt‑4o')をModelインスタンスに解決します
日々の作業では、通常はモデルの names と、場合によっては ModelSettings にのみ触れます。
import { Agent } from '@openai/agents';
const agent = new Agent({ name: 'Creative writer', model: 'gpt-4.1',});既定のモデル
Section titled “既定のモデル”Agent の初期化時にモデルを指定しない場合、既定のモデルが使用されます。現在の既定は gpt-4.1 で、エージェントワークフローにおける予測可能性と低レイテンシの優れたバランスを提供します。
gpt-5 など他のモデルに切り替えたい場合、エージェントの設定方法は 2 つあります。
まず、カスタムモデルを設定していないすべてのエージェントで一貫して特定のモデルを使いたい場合は、エージェントを実行する前に環境変数 OPENAI_DEFAULT_MODEL を設定します。
export OPENAI_DEFAULT_MODEL=gpt-5node my-awesome-agent.js次に、Runner インスタンスに既定のモデルを設定できます。エージェント側でモデルを設定しない場合は、この Runner の既定モデルが使用されます。
import { Runner } from '@openai/agents';
const runner = new Runner({ model: 'gpt‑4.1-mini' });GPT-5 モデル
Section titled “GPT-5 モデル”この方法で GPT-5 の reasoning モデル(gpt-5、gpt-5-mini、または gpt-5-nano)を使用する場合、SDK は既定で妥当な modelSettings を適用します。具体的には、reasoning.effort と verbosity の両方を "low" に設定します。既定モデルの reasoning 努力度を調整するには、独自の modelSettings を渡してください:
import { Agent } from '@openai/agents';
const myAgent = new Agent({ name: 'My Agent', instructions: "You're a helpful agent.", modelSettings: { reasoning: { effort: 'minimal' }, text: { verbosity: 'low' }, }, // If OPENAI_DEFAULT_MODEL=gpt-5 is set, passing only modelSettings works. // It's also fine to pass a GPT-5 model name explicitly: // model: 'gpt-5',});低レイテンシを求める場合、gpt-5-mini または gpt-5-nano を reasoning.effort="minimal" とともに使用すると、既定設定より高速に応答を返すことが多いです。ただし、Responses API の一部の組み込みツール(ファイル検索や画像生成など)は "minimal" の reasoning 努力度をサポートしていないため、この Agents SDK の既定は "low" になっています。
非 GPT-5 モデル
Section titled “非 GPT-5 モデル”カスタムの modelSettings なしで非 GPT-5 のモデル名を渡した場合、SDK はあらゆるモデルと互換性のある汎用的な modelSettings にフォールバックします。
OpenAI プロバイダー
Section titled “OpenAI プロバイダー”既定の ModelProvider は OpenAI APIs を使用して名前を解決します。2 つの明確なエンドポイントをサポートします:
| API | 用途 | setOpenAIAPI() の呼び出し |
|---|---|---|
| Chat Completions | 標準的なチャット & 関数呼び出し | setOpenAIAPI('chat_completions') |
| Responses | ツールコールや柔軟な出力に対応した新しい ストリーミング ファーストの生成 API | setOpenAIAPI('responses') (default) |
import { setDefaultOpenAIKey } from '@openai/agents';
setDefaultOpenAIKey(process.env.OPENAI_API_KEY!); // sk-...カスタムのネットワーク設定が必要な場合は、setDefaultOpenAIClient(client) 経由で独自の OpenAI クライアントを差し込むこともできます。
ModelSettings
Section titled “ModelSettings”ModelSettings は OpenAI のパラメーターを反映しつつ、プロバイダー非依存です。
| Field | Type | Notes |
|---|---|---|
temperature | number | 創造性と決定性のバランス |
topP | number | Nucleus sampling |
frequencyPenalty | number | 繰り返し出現するトークンへのペナルティ |
presencePenalty | number | 新しいトークンの促進 |
toolChoice | 'auto' | 'required' | 'none' | string | ツール使用の強制 を参照 |
parallelToolCalls | boolean | サポートされている場合に並列の関数呼び出しを許可 |
truncation | 'auto' | 'disabled' | トークンの切り捨て戦略 |
maxTokens | number | 応答内の最大トークン数 |
store | boolean | 応答を永続化して取得や RAG ワークフローに利用 |
reasoning.effort | 'minimal' | 'low' | 'medium' | 'high' | gpt-5 などのための reasoning 努力度 |
text.verbosity | 'low' | 'medium' | 'high' | gpt-5 などのためのテキスト冗長性 |
設定は次のいずれかのレベルに付与できます:
import { Runner, Agent } from '@openai/agents';
const agent = new Agent({ name: 'Creative writer', // ... modelSettings: { temperature: 0.7, toolChoice: 'auto' },});
// or globallynew Runner({ modelSettings: { temperature: 0.3 } });Runner レベルの設定は、競合するエージェントごとの設定を上書きします。
エージェントは prompt パラメーターで構成でき、エージェントの動作を制御するために使用する サーバー保管 のプロンプト設定を指定します。現在、このオプションがサポートされるのは OpenAI の
Responses API を使用する場合のみです。
| Field | Type | Notes |
|---|---|---|
promptId | string | プロンプトの一意の識別子 |
version | string | 使用したいプロンプトのバージョン |
variables | object | プロンプトに代入する変数のキー/値ペア。値は文字列またはテキスト・画像・ファイルなどのコンテンツ入力タイプにできます |
import { Agent, run } from '@openai/agents';
async function main() { const agent = new Agent({ name: 'Assistant', prompt: { promptId: 'pmpt_68d50b26524c81958c1425070180b5e10ab840669e470fc7', variables: { name: 'Kaz' }, }, });
const result = await run(agent, 'What is your name?'); console.log(result.finalOutput);}
main().catch((error) => { console.error(error); process.exit(1);});tools や instructions などの追加のエージェント設定は、保管済みプロンプトで構成した値を上書きします。
カスタムモデルプロバイダー
Section titled “カスタムモデルプロバイダー”独自のプロバイダーの実装は簡単です。ModelProvider と Model を実装し、そのプロバイダーを Runner のコンストラクターに渡します:
import { ModelProvider, Model, ModelRequest, ModelResponse, ResponseStreamEvent,} from '@openai/agents-core';
import { Agent, Runner } from '@openai/agents';
class EchoModel implements Model { name: string; constructor() { this.name = 'Echo'; } async getResponse(request: ModelRequest): Promise<ModelResponse> { return { usage: {}, output: [{ role: 'assistant', content: request.input as string }], } as any; } async *getStreamedResponse( _request: ModelRequest, ): AsyncIterable<ResponseStreamEvent> { yield { type: 'response.completed', response: { output: [], usage: {} }, } as any; }}
class EchoProvider implements ModelProvider { getModel(_modelName?: string): Promise<Model> | Model { return new EchoModel(); }}
const runner = new Runner({ modelProvider: new EchoProvider() });console.log(runner.config.modelProvider.getModel());const agent = new Agent({ name: 'Test Agent', instructions: 'You are a helpful assistant.', model: new EchoModel(), modelSettings: { temperature: 0.7, toolChoice: 'auto' },});console.log(agent.model);トレーシングエクスポーター
Section titled “トレーシングエクスポーター”OpenAI プロバイダーを使用する場合、API キーを指定して自動トレースエクスポートを有効化できます:
import { setTracingExportApiKey } from '@openai/agents';
setTracingExportApiKey('sk-...');これにより OpenAI dashboard にトレースが送信され、ワークフローの完全な実行グラフを確認できます。