モデル
最終的にすべてのエージェントは 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',});
OpenAI プロバイダー
Section titled “OpenAI プロバイダー”デフォルトの ModelProvider
は OpenAI APIs を使って名前を解決します。2 つの異なるエンドポイントをサポートします:
API | 用途 | setOpenAIAPI() を呼ぶ |
---|---|---|
Chat Completions | 標準的なチャットと関数呼び出し | setOpenAIAPI('chat_completions') |
Responses | 新しい streaming‑first な生成 API(ツール呼び出し、柔軟な出力) | setOpenAIAPI('responses') (default) |
import { setDefaultOpenAIKey } from '@openai/agents';
setDefaultOpenAIKey(process.env.OPENAI_API_KEY!); // sk-...
カスタムのネットワーク設定が必要な場合は、setDefaultOpenAIClient(client)
で独自の OpenAI
クライアントを差し込むこともできます。
デフォルトモデル
Section titled “デフォルトモデル”OpenAI プロバイダーのデフォルトは gpt‑4o
です。エージェント単位またはグローバルに上書きできます:
import { Runner } from '@openai/agents';
const runner = new Runner({ model: 'gpt‑4.1-mini' });
ModelSettings
Section titled “ModelSettings”ModelSettings
は OpenAI のパラメーターを反映しますが、プロバイダーに依存しません。
Field | Type | Notes |
---|---|---|
temperature | number | 創造性と決定性のトレードオフ |
topP | number | Nucleus サンプリング |
frequencyPenalty | number | 繰り返しトークンへのペナルティ |
presencePenalty | number | 新しいトークンの促進 |
toolChoice | 'auto' | 'required' | 'none' | string | forcing tool use を参照 |
parallelToolCalls | boolean | サポートされる場合に並列の関数呼び出しを許可 |
truncation | 'auto' | 'disabled' | トークン切り捨て戦略 |
maxTokens | number | レスポンスの最大トークン数 |
store | boolean | レスポンスを永続化して取得や RAG ワークフローで利用 |
設定はどちらのレベルにも付与できます:
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_684b3b772e648193b92404d7d0101d8a07f7a7903e519946', version: '1', variables: { poem_style: 'limerick', }, }, });
const result = await run(agent, 'Write about unrequited love.'); console.log(result.finalOutput);}
if (require.main === module) { main().catch(console.error);}
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 にトレースが送信され、ワークフローの完全な実行グラフを確認できます。