設定
このページでは、デフォルトの OpenAI キーやクライアント、デフォルトの OpenAI API 形式、トレーシングのエクスポート既定値、ロギングの動作など、通常はアプリケーション起動時に一度だけ設定する SDK 全体のデフォルトについて説明します。
代わりに特定のエージェントや実行を設定する必要がある場合は、次から始めてください。
RunConfig、セッション、会話状態オプションについては エージェントの実行。- モデル選択とプロバイダー設定については モデル。
- 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーについては トレーシング。
API キーとクライアント
デフォルトでは、 SDK は LLM リクエストとトレーシングに OPENAI_API_KEY 環境変数を使用します。このキーは SDK が最初に OpenAI クライアントを作成したときに解決されるため（遅延初期化）、最初のモデル呼び出しの前に環境変数を設定してください。アプリ起動前にその環境変数を設定できない場合は、キーを設定するために set_default_openai_key() 関数を使用できます。
別の方法として、使用する OpenAI クライアントを設定することもできます。デフォルトでは、 SDK は AsyncOpenAI インスタンスを作成し、環境変数の API キーまたは上で設定したデフォルトキーを使用します。これは set_default_openai_client() 関数で変更できます。
from openai import AsyncOpenAI
from agents import set_default_openai_client
custom_client = AsyncOpenAI(base_url="...", api_key="...")
set_default_openai_client(custom_client)
最後に、使用する OpenAI API をカスタマイズすることもできます。デフォルトでは OpenAI Responses API を使用します。set_default_openai_api() 関数を使用すると、これを上書きして Chat Completions API を使用できます。
トレーシング
トレーシングはデフォルトで有効です。デフォルトでは、上記セクションのモデルリクエストと同じ OpenAI API キー（つまり環境変数または設定したデフォルトキー）を使用します。トレーシングで使用する API キーは、set_tracing_export_api_key 関数で個別に設定できます。
デフォルトのエクスポーター使用時にトレースを特定の organization や project に紐付ける必要がある場合は、アプリ起動前に次の環境変数を設定してください。
グローバルエクスポーターを変更せずに、実行ごとにトレーシング API キーを設定することもできます。
from agents import Runner, RunConfig
await Runner.run(
agent,
input="Hello",
run_config=RunConfig(tracing={"api_key": "sk-tracing-123"}),
)
set_tracing_disabled() 関数を使用して、トレーシングを完全に無効化することもできます。
トレーシングは有効のままにしつつ、機密性の高い可能性がある入出力をトレースペイロードから除外したい場合は、RunConfig.trace_include_sensitive_data を False に設定してください。
from agents import Runner, RunConfig
await Runner.run(
agent,
input="Hello",
run_config=RunConfig(trace_include_sensitive_data=False),
)
アプリ起動前にこの環境変数を設定すれば、コードを書かずにデフォルトを変更することもできます。
トレーシング制御の詳細は、トレーシングガイド を参照してください。
デバッグロギング
SDK は 2 つの Python ロガー（openai.agents と openai.agents.tracing）を定義しており、デフォルトではハンドラーをアタッチしません。ログはアプリケーションの Python ロギング設定に従います。
詳細なロギングを有効にするには、enable_verbose_stdout_logging() 関数を使用します。
または、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることもできます。詳しくは Python logging guide を参照してください。
import logging
logger = logging.getLogger("openai.agents") # or openai.agents.tracing for the Tracing logger
# To make all logs show up
logger.setLevel(logging.DEBUG)
# To make info and above show up
logger.setLevel(logging.INFO)
# To make warning and above show up
logger.setLevel(logging.WARNING)
# etc
# You can customize this as needed, but this will output to `stderr` by default
logger.addHandler(logging.StreamHandler())
ログ内の機密データ
一部のログには機密データ（たとえばユーザーデータ）が含まれる可能性があります。
デフォルトでは、 SDK は LLM の入出力やツールの入出力を ログに記録しません 。これらの保護は次によって制御されます。
デバッグのために一時的にこのデータを含める必要がある場合は、アプリ起動前にいずれかの変数を 0（または false）に設定してください。