SDK の設定
API キーとクライアント
デフォルトでは、SDK はインポート直後から LLM リクエストとトレーシングのために、環境変数 OPENAI_API_KEY
を探します。アプリ起動前にその環境変数を設定できない場合は、set_default_openai_key() 関数でキーを設定できます。
また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数または上記で設定したデフォルトキーを用いて AsyncOpenAI
インスタンスを作成します。これを変更するには、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 を使用します。これを上書きして Chat Completions API を使うには、set_default_openai_api() 関数を使用します。
トレーシング
トレーシングはデフォルトで有効です。デフォルトでは上記の OpenAI API キー(つまり、環境変数または設定したデフォルトキー)を使用します。トレーシングに使用する API キーを個別に設定するには、set_tracing_export_api_key
関数を使用します。
トレーシングを完全に無効化するには、set_tracing_disabled()
関数を使用します。
デバッグ ログ
SDK にはハンドラー未設定の Python ロガーが 2 つあります。デフォルトでは、警告とエラーは stdout
に送られますが、その他のログは抑制されます。
詳細なログを有効にするには、enable_verbose_stdout_logging()
関数を使用します。
また、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズできます。詳細は Python ロギングガイド を参照してください。
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())
ログ内の機微なデータ
一部のログには機微なデータ(例: ユーザー データ)が含まれる場合があります。これらのデータがログに記録されないようにするには、以下の環境変数を設定してください。
LLM の入力と出力のロギングを無効化するには:
ツールの入力と出力のロギングを無効化するには: