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