SDK の設定

OpenAI クライアントとトランスポート

API キーとクライアント

デフォルトでは SDK は最初のインポート時に環境変数 OPENAI_API_KEY を読み込みます。変数を設定できない場合は、手動で setDefaultOpenAIKey() を呼び出せます。

import { setDefaultOpenAIKey } from '@openai/agents';

setDefaultOpenAIKey(process.env.OPENAI_API_KEY!); // sk-...

独自の OpenAI クライアントインスタンスを渡すこともできます。指定がない場合、SDK はデフォルトのキーを使って自動的に作成します。

import { OpenAI } from 'openai';
import { setDefaultOpenAIClient } from '@openai/agents';

const customClient = new OpenAI({ baseURL: '...', apiKey: '...' });
setDefaultOpenAIClient(customClient);

API の選択

最後に、Responses API と Chat Completions API を切り替えられます。

import { setOpenAIAPI } from '@openai/agents';

setOpenAIAPI('chat_completions');

Responses トランスポート

Responses API を使用している場合、OpenAI プロバイダのトランスポートも選べます。デフォルトは HTTP です。

import { setOpenAIAPI, setOpenAIResponsesTransport } from '@openai/agents';

setOpenAIAPI('responses');
setOpenAIResponsesTransport('websocket');

WebSocket トランスポートを有効にするには setOpenAIResponsesTransport('websocket')、元に戻すには setOpenAIResponsesTransport('http') を使用します。WebSocket トラフィックをプロキシやゲートウェイ経由でルーティングする場合は、OPENAI_WEBSOCKET_BASE_URL を設定するか、OpenAIProvider の websocketBaseURL を構成してください。

可観測性とデバッグ

トレーシング

トレーシングはデフォルトで有効で、上記の OpenAI キーを使用します。

別のキーは setTracingExportApiKey() で設定できます:

import { setTracingExportApiKey } from '@openai/agents';

setTracingExportApiKey('sk-...');

トレーシングは完全に無効化することもできます:

import { setTracingDisabled } from '@openai/agents';

setTracingDisabled(true);

トレーシング機能の詳細はトレーシングをご覧ください。

デバッグロギング

SDK はデバッグロギングに debug パッケージを使用します。冗長なログを表示するには、環境変数 DEBUG を openai-agents* に設定します。

export DEBUG=openai-agents*

セッション永続化のアクティビティを記録するには、OPENAI_AGENTS__DEBUG_SAVE_SESSION=1 を設定します。

@openai/agents の getLogger(namespace) を使うと、独自モジュール用の名前空間付きロガーを取得できます。

import { getLogger } from '@openai/agents';

const logger = getLogger('my-app');
logger.debug('something happened');

ログ内の機微情報

一部のログにはユーザーデータが含まれる場合があります。以下の環境変数を設定して無効化できます。

LLM の入力と出力のロギングを無効化するには:

export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1

ツールの入力と出力のロギングを無効化するには:

export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1