openai-agents-python/docs/ja/config.md
Kazuhiro Sera 68c725f942
Improve translation pipeline details (#475)
This pull request improves the translation pipeline, which was
introduced by #460. Now the document generation works pretty well with
gpt-4o model.
2025-04-10 16:54:05 -04:00

3.8 KiB

SDK の設定

API キーとクライアント

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

from agents import set_default_openai_key

set_default_openai_key("sk-...")

また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数からの API キーまたは上記で設定したデフォルトキーを使用して AsyncOpenAI インスタンスを作成します。これを変更するには、[set_default_openai_client()][agents.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()][agents.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][agents.set_tracing_export_api_key] 関数を使用します。

from agents import set_tracing_export_api_key

set_tracing_export_api_key("sk-...")

トレーシングを完全に無効にするには、[set_tracing_disabled()][agents.set_tracing_disabled] 関数を使用します。

from agents import set_tracing_disabled

set_tracing_disabled(True)

デバッグログ

SDK にはハンドラーが設定されていない 2 つの Python ロガーがあります。デフォルトでは、警告とエラーが stdout に送信されますが、他のログは抑制されます。

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

from agents import enable_verbose_stdout_logging

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

export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1

ツールの入力と出力のログ記録を無効にするには:

export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1