SDK の設定

API キーとクライアント

デフォルトでは、SDK は最初にインポートされた際に OPENAI_API_KEY 環境変数を読み込みます。環境変数を設定できない場合は、setDefaultOpenAIKey() を手動で呼び出してください。

Set default OpenAI key

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

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

独自の OpenAI クライアント インスタンスを渡すこともできます。渡さない場合、SDK は前述のキーを用いて自動的にクライアントを生成します。

Set default OpenAI client

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

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

最後に、Responses API と Chat Completions API を切り替えることも可能です。

Set OpenAI API

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

setOpenAIAPI('chat_completions');

トレーシング

トレーシングはデフォルトで有効になっており、前述の OpenAI キーを使用します。別のキーを使用したい場合は setTracingExportApiKey() で設定できます。

Set tracing export API key

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

setTracingExportApiKey('sk-...');

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

Disable tracing

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

setTracingDisabled(true);

デバッグログ

SDK は debug パッケージを使用してデバッグログを出力します。詳細ログを表示するには、DEBUG 環境変数に openai-agents* を設定してください。

export DEBUG=openai-agents*

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

Get logger

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