コンテンツにスキップ

SDK の設定

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

既定の OpenAI キーを設定
import { setDefaultOpenAIKey } from '@openai/agents';
setDefaultOpenAIKey(process.env.OPENAI_API_KEY!); // sk-...

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

既定の OpenAI クライアントを設定
import { OpenAI } from 'openai';
import { setDefaultOpenAIClient } from '@openai/agents';
const customClient = new OpenAI({ baseURL: '...', apiKey: '...' });
setDefaultOpenAIClient(customClient);

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

OpenAI API を設定
import { setOpenAIAPI } from '@openai/agents';
setOpenAIAPI('chat_completions');

トレーシングは既定で有効で、上記の OpenAI キーを使用します。

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

トレーシングのエクスポート用 API キーを設定
import { setTracingExportApiKey } from '@openai/agents';
setTracingExportApiKey('sk-...');

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

トレーシングを無効化
import { setTracingDisabled } from '@openai/agents';
setTracingDisabled(true);

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

SDK はデバッグログに debug パッケージを使用します。詳細なログを表示するには、環境変数 DEBUGopenai-agents* に設定します。

Terminal window
export DEBUG=openai-agents*

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

ロガーを取得
import { getLogger } from '@openai/agents';
const logger = getLogger('my-app');
logger.debug('something happened');

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

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

Terminal window
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1

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

Terminal window
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1