コンテンツにスキップ

SDK の設定

API キーとクライアント

デフォルトでは、SDK はインポートされるとすぐに、LLM リクエストと トレーシング 用の環境変数 OPENAI_API_KEY を探します。アプリの起動前にその環境変数を設定できない場合は、set_default_openai_key() 関数でキーを設定できます。

from agents import set_default_openai_key

set_default_openai_key("sk-...")

また、使用する 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() 関数を使用します。

from agents import set_default_openai_api

set_default_openai_api("chat_completions")

トレーシング

トレーシング はデフォルトで有効です。デフォルトでは、上記のセクションの OpenAI API キー(つまり、環境変数または設定したデフォルトキー)を使用します。トレーシング に使用する API キーを個別に設定するには、set_tracing_export_api_key 関数を使用します。

from agents import set_tracing_export_api_key

set_tracing_export_api_key("sk-...")

set_tracing_disabled() 関数を使用して、トレーシング を完全に無効化することもできます。

from agents import set_tracing_disabled

set_tracing_disabled(True)

デバッグログ

SDK には、ハンドラーが設定されていない 2 つの Python ロガーがあります。デフォルトでは、これは警告とエラーが stdout に送られ、それ以外のログは抑制されることを意味します。

詳細なログを有効にするには、enable_verbose_stdout_logging() 関数を使用します。

from agents import enable_verbose_stdout_logging

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 の入力と出力のログ記録を無効化するには:

export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1

tool の入力と出力のログ記録を無効化するには:

export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1