SDK の設定

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);

最後に Responses API と Chat Completions API を切り替えることもできます。

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

setOpenAIAPI('chat_completions');

トレーシング

トレーシングはデフォルトで有効になっており、上記の 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 の 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