SDK の設定

API キーとクライアント

デフォルトでは、SDK は LLM リクエストとトレーシングに OPENAI_API_KEY 環境変数を使用します。このキーは、SDK が最初に OpenAI クライアントを作成するとき（遅延初期化）に解決されるため、最初のモデル呼び出しの前に環境変数を設定してください。アプリの起動前にその環境変数を設定できない場合は、set_default_openai_key() 関数を使ってキーを設定できます。

from agents import set_default_openai_key

set_default_openai_key("sk-...")

代わりに、使用する 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 を使用するように上書きできます。

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-...")

デフォルトのエクスポーターを使用する際に、トレースを特定の organization または project に紐付ける必要がある場合は、アプリの起動前に次の環境変数を設定してください:

export OPENAI_ORG_ID="org_..."
export OPENAI_PROJECT_ID="proj_..."

グローバルなエクスポーターを変更せずに、実行ごとにトレーシングの API キーを設定することもできます。

from agents import Runner, RunConfig

await Runner.run(
    agent,
    input="Hello",
    run_config=RunConfig(tracing={"api_key": "sk-tracing-123"}),
)

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

from agents import set_tracing_disabled

set_tracing_disabled(True)

トレーシングは有効のままにしつつ、トレースのペイロードから機密性の高い可能性がある入力 / 出力を除外したい場合は、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),
)

コードなしでデフォルトを変更するには、アプリの起動前にこの環境変数を設定することもできます:

export OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA=0

トレーシングの制御の全体像については、トレーシングガイドを参照してください。

デバッグロギング

SDK は 2 つの Python ロガー（openai.agents と openai.agents.tracing）を定義しており、デフォルトではハンドラーをアタッチしません。ログは、アプリケーションの Python ロギング設定に従います。

詳細ログを有効にするには、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())

ログ内の機密データ

一部のログには機密データ（例: ユーザーデータ）が含まれる場合があります。

デフォルトでは、SDK は LLM の入力 / 出力やツールの入力 / 出力をログに 記録しません。これらの保護は次で制御されます:

OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1

デバッグのために一時的にこのデータを含める必要がある場合は、アプリの起動前にいずれかの変数を 0（または false）に設定してください:

export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=0
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=0

SDK の設定

API キーとクライアント

トレーシング

デバッグ ロギング

ログ内の機密データ

デバッグロギング