@@ -4,17 +4,25 @@ search:
44---
55# SDK の設定
66
7+ このページでは、通常アプリケーション起動時に一度だけ設定する SDK 全体のデフォルト値(デフォルトの OpenAI key や client、デフォルトの OpenAI API 形式、トレーシングのエクスポートデフォルト、ロギング動作など)を扱います。
8+
9+ 代わりに特定のエージェントや実行を設定する必要がある場合は、まず次をご覧ください。
10+
11+ - ` RunConfig ` 、セッション、会話状態オプションについては [ エージェントの実行] ( running_agents.md ) 。
12+ - モデル選択とプロバイダー設定については [ Models] ( models/index.md ) 。
13+ - 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーについては [ Tracing] ( tracing.md ) 。
14+
715## API キーとクライアント
816
9- デフォルトでは、SDK は LLM リクエストと トレーシング に ` OPENAI_API_KEY ` 環境変数を使用します。このキーは、 SDK が最初に OpenAI クライアントを作成するとき (遅延初期化)に解決されるため、最初の モデル 呼び出しの前に環境変数を設定してください。アプリの起動前にその環境変数を設定できない場合は、 [ set_default_openai_key()] [ agents.set_default_openai_key ] 関数を使ってキーを設定できます 。
17+ デフォルトでは、SDK は LLM リクエストとトレーシングに ` OPENAI_API_KEY ` 環境変数を使用します。キーは SDK が最初に OpenAI client を作成する際 (遅延初期化)に解決されるため、最初のモデル呼び出し前に環境変数を設定してください。アプリ起動前にその環境変数を設定できない場合は、キーを設定するために [ set_default_openai_key()] [ agents.set_default_openai_key ] 関数を使用できます 。
1018
1119``` python
1220from agents import set_default_openai_key
1321
1422set_default_openai_key(" sk-..." )
1523```
1624
17- 代わりに 、使用する OpenAI クライアントを設定することもできます 。デフォルトでは、SDK は ` AsyncOpenAI ` インスタンスを作成し、環境変数の API キー、または上で設定したデフォルトキーを使用します 。これは [ set_default_openai_client()] [ agents.set_default_openai_client ] 関数で変更できます。
25+ また 、使用する OpenAI client を設定することもできます 。デフォルトでは、SDK は ` AsyncOpenAI ` インスタンスを作成し、環境変数または上で設定したデフォルトキーの API キーを使用します 。これは [ set_default_openai_client()] [ agents.set_default_openai_client ] 関数で変更できます。
1826
1927``` python
2028from openai import AsyncOpenAI
@@ -24,7 +32,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
2432set_default_openai_client(custom_client)
2533```
2634
27- 最後に、使用する OpenAI API もカスタマイズできます 。デフォルトでは OpenAI Responses API を使用します。[ set_default_openai_api()] [ agents.set_default_openai_api ] 関数を使うことで、 Chat Completions API を使用するように上書きできます 。
35+ 最後に、使用する OpenAI API をカスタマイズすることもできます 。デフォルトでは OpenAI Responses API を使用します。[ set_default_openai_api()] [ agents.set_default_openai_api ] 関数を使用して、これを Chat Completions API に上書きできます 。
2836
2937``` python
3038from agents import set_default_openai_api
@@ -34,22 +42,22 @@ set_default_openai_api("chat_completions")
3442
3543## トレーシング
3644
37- トレーシング はデフォルトで有効です 。デフォルトでは、上のセクションの OpenAI API キー(つまり、環境変数または設定したデフォルトキー )を使用します。トレーシング に使用する API キーを明示的に設定するには 、[ ` set_tracing_export_api_key ` ] [ agents.set_tracing_export_api_key ] 関数を使用します 。
45+ トレーシングはデフォルトで有効です 。デフォルトでは、上記セクションのモデルリクエストと同じ OpenAI API キー(つまり環境変数または設定したデフォルトキー )を使用します。トレーシングで使用する API キーは 、[ ` set_tracing_export_api_key ` ] [ agents.set_tracing_export_api_key ] 関数で明示的に設定できます 。
3846
3947``` python
4048from agents import set_tracing_export_api_key
4149
4250set_tracing_export_api_key(" sk-..." )
4351```
4452
45- デフォルトのエクスポーターを使用する際に、トレースを特定の organization または project に紐付ける必要がある場合は、アプリの起動前に次の環境変数を設定してください:
53+ デフォルトエクスポーターを使用する際にトレースを特定の organization や project に紐付ける必要がある場合は、アプリ起動前に次の環境変数を設定してください。
4654
4755``` bash
4856export OPENAI_ORG_ID=" org_..."
4957export OPENAI_PROJECT_ID=" proj_..."
5058```
5159
52- グローバルなエクスポーターを変更せずに、実行ごとに トレーシング の API キーを設定することもできます。
60+ グローバルエクスポーターを変更せずに、実行ごとにトレーシング API キーを設定することもできます。
5361
5462``` python
5563from agents import Runner, RunConfig
@@ -61,15 +69,15 @@ await Runner.run(
6169)
6270```
6371
64- [ ` set_tracing_disabled() ` ] [ agents.set_tracing_disabled ] 関数を使用すると、トレーシング を完全に無効化することもできます 。
72+ [ ` set_tracing_disabled() ` ] [ agents.set_tracing_disabled ] 関数を使用して、トレーシングを完全に無効化することもできます 。
6573
6674``` python
6775from agents import set_tracing_disabled
6876
6977set_tracing_disabled(True )
7078```
7179
72- トレーシング は有効のままにしつつ、トレースのペイロードから機密性の高い可能性がある入力 / 出力を除外したい場合は、[ ` RunConfig.trace_include_sensitive_data ` ] [ agents.run.RunConfig.trace_include_sensitive_data ] を ` False ` に設定します:
80+ トレーシングは有効のままにしつつ、トレースペイロードから機密性の高い可能性がある入力/ 出力を除外したい場合は、[ ` RunConfig.trace_include_sensitive_data ` ] [ agents.run.RunConfig.trace_include_sensitive_data ] を ` False ` に設定してください。
7381
7482``` python
7583from agents import Runner, RunConfig
@@ -81,17 +89,17 @@ await Runner.run(
8189)
8290```
8391
84- コードなしでデフォルトを変更するには、アプリの起動前にこの環境変数を設定することもできます:
92+ コードを変更せずにデフォルトを変更するには、アプリ起動前に次の環境変数を設定することもできます。
8593
8694``` bash
8795export OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA=0
8896```
8997
90- トレーシング の制御の全体像については、 [ トレーシング ガイド ] ( tracing.md ) を参照してください。
98+ トレーシング制御の全体については、 [ トレーシングガイド ] ( tracing.md ) を参照してください。
9199
92- ## デバッグ ロギング
100+ ## デバッグロギング
93101
94- SDK は 2 つの Python ロガー (` openai.agents ` と ` openai.agents.tracing ` )を定義しており、デフォルトではハンドラーをアタッチしません。ログは、アプリケーションの Python ロギング設定に従います 。
102+ SDK は 2 つの Python logger (` openai.agents ` と ` openai.agents.tracing ` )を定義し、デフォルトでは handler をアタッチしません。ログはアプリケーションの Python logging 設定に従います 。
95103
96104詳細ログを有効にするには、[ ` enable_verbose_stdout_logging() ` ] [ agents.enable_verbose_stdout_logging ] 関数を使用します。
97105
@@ -101,7 +109,7 @@ from agents import enable_verbose_stdout_logging
101109enable_verbose_stdout_logging()
102110```
103111
104- または、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズできます。詳しくは [ Python logging guide] ( https://docs.python.org/3/howto/logging.html ) を参照してください。
112+ または、handler、filter、formatter などを追加してログをカスタマイズできます。詳細は [ Python logging guide] ( https://docs.python.org/3/howto/logging.html ) を参照してください。
105113
106114``` python
107115import logging
@@ -122,16 +130,16 @@ logger.addHandler(logging.StreamHandler())
122130
123131### ログ内の機密データ
124132
125- 一部のログには機密データ(例: ユーザー データ)が含まれる場合があります 。
133+ 一部のログには機密データ(例: ユーザーデータ)が含まれる可能性があります 。
126134
127- デフォルトでは、SDK は LLM の入力 / 出力やツールの入力 / 出力をログに ** 記録しません** 。これらの保護は次で制御されます:
135+ デフォルトでは、SDK は LLM の入力/ 出力やツールの入力/出力を ** 記録しません** 。これらの保護は次で制御されます。
128136
129137``` bash
130138OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
131139OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1
132140```
133141
134- デバッグのために一時的にこのデータを含める必要がある場合は、アプリの起動前にいずれかの変数を ` 0 ` (または ` false ` )に設定してください:
142+ デバッグのために一時的にこのデータを含める必要がある場合は、アプリ起動前にいずれかの変数を ` 0 ` (または ` false ` )に設定してください。
135143
136144``` bash
137145export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=0
0 commit comments