SDK の設定
API キーとクライアント
Section titled “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');
トレーシング
Section titled “トレーシング”トレーシングは既定で有効で、上のセクションの OpenAI キーを使用します。別のキーは setTracingExportApiKey()
で設定できます。
import { setTracingExportApiKey } from '@openai/agents';
setTracingExportApiKey('sk-...');
トレーシングを完全に無効化することもできます。
import { setTracingDisabled } from '@openai/agents';
setTracingDisabled(true);
デバッグログ
Section titled “デバッグログ”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');
ログ中の機微なデータ
Section titled “ログ中の機微なデータ”いくつかのログにはユーザーデータが含まれる場合があります。次の環境変数を設定して無効化できます。
LLM の入力と出力のロギングを無効化するには:
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
ツールの入力と出力のロギングを無効化するには:
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1