SDK の設定
API キーとクライアント
デフォルトでは、SDK はインポートされるとすぐに、LLM リクエストと トレーシング のために OPENAI_API_KEY 環境変数を探します。アプリの起動前にその環境変数を設定できない場合は、set_default_openai_key() 関数を使ってキーを設定できます。
代わりに、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数の API キー(または上で設定したデフォルトキー)を使って 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 を使用します。これは、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() 関数を使用して、トレーシング を完全に無効化することもできます。
デバッグログ
SDK には、ハンドラーが設定されていない Python ロガーが 2 つあります。デフォルトでは、警告とエラーが stdout に送られ、それ以外のログは抑制されます。
詳細なログを有効にするには、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())
ログに含まれる機密データ
一部のログには機密データ(例: ユーザーデータ)が含まれる場合があります。このデータがログに出力されないようにしたい場合は、次の環境変数を設定してください。
LLM の入力と出力のログを無効化するには:
ツールの入力と出力のログを無効化するには: