Skip to content

Commit 94c1f60

Browse files
authored
docs: updates for v0.17.8 release (openai#3737)
1 parent 7a828f6 commit 94c1f60

7 files changed

Lines changed: 647 additions & 414 deletions

File tree

docs/ja/config.md

Lines changed: 53 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ search:
44
---
55
# 設定
66

7-
このページでは、デフォルトの OpenAI キーまたはクライアント、デフォルトの OpenAI API の形式、トレーシングエクスポートのデフォルト、ログ記録の動作など、アプリケーション起動時に通常一度だけ設定する SDK 全体のデフォルトについて説明します。
7+
このページでは、デフォルトの OpenAI キーまたはクライアント、デフォルトの OpenAI API の形式、トレーシングエクスポートのデフォルト、ログ動作など、通常はアプリケーションの起動時に一度だけ設定する SDK 全体のデフォルトについて説明します。
88

9-
これらのデフォルトはサンドボックスベースのワークフローにも適用されますが、サンドボックスワークスペース、サンドボックスクライアント、セッション再利用は別途設定します
9+
これらのデフォルトはサンドボックスベースのワークフローにも引き続き適用されますが、サンドボックスワークスペース、サンドボックスクライアント、セッションの再利用は別途設定します
1010

1111
代わりに特定のエージェントまたは実行を設定する必要がある場合は、まず次を参照してください:
1212

13-
- [エージェント](agents.md): 通常の `Agent` における instructions、tools、出力型、ハンドオフ、ガードレールについて。
14-
- [エージェントの実行](running_agents.md): `RunConfig`、セッション、会話状態のオプションについて
15-
- [サンドボックスエージェント](sandbox/guide.md): `SandboxRunConfig`、マニフェスト、機能、サンドボックスクライアント固有のワークスペース設定について。
13+
- [エージェント](agents.md): 通常の `Agent` instructions、tools、出力タイプ、ハンドオフ、ガードレールについて。
14+
- [エージェントの実行](running_agents.md): `RunConfig`、セッション、会話状態オプションについて
15+
- [サンドボックスエージェント](sandbox/guide.md): `SandboxRunConfig`、マニフェスト、ケイパビリティ、サンドボックスクライアント固有のワークスペース設定について。
1616
- [モデル](models/index.md): モデル選択とプロバイダー設定について。
1717
- [トレーシング](tracing.md): 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーについて。
1818

1919
## API キーとクライアント
2020

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

2323
```python
2424
from agents import set_default_openai_key
2525

2626
set_default_openai_key("sk-...")
2727
```
2828

29-
また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数の API キー、または上記で設定したデフォルトキーを使用して`AsyncOpenAI` インスタンスを作成します。これは [set_default_openai_client()][agents.set_default_openai_client] 関数を使用して変更できます。
29+
また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数の API キー、または上で設定したデフォルトキーを使用して`AsyncOpenAI` インスタンスを作成します。これは [set_default_openai_client()][agents.set_default_openai_client] 関数を使用して変更できます。
3030

3131
```python
3232
from openai import AsyncOpenAI
@@ -36,21 +36,53 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
3636
set_default_openai_client(custom_client)
3737
```
3838

39-
環境変数ベースのエンドポイント設定を使用したい場合、デフォルトの OpenAI プロバイダーは `OPENAI_BASE_URL` も読み取ります。Responses websocket トランスポートを有効にすると、websocket`/responses` エンドポイント用に `OPENAI_WEBSOCKET_BASE_URL` も読み取ります。
39+
環境変数ベースのエンドポイント設定を使用したい場合、デフォルトの OpenAI プロバイダーは `OPENAI_BASE_URL` も読み取ります。Responses WebSocket トランスポートを有効にすると、WebSocket`/responses` エンドポイント用に `OPENAI_WEBSOCKET_BASE_URL` も読み取ります。
4040

4141
```bash
4242
export OPENAI_BASE_URL="https://your-openai-compatible-endpoint.example/v1"
4343
export OPENAI_WEBSOCKET_BASE_URL="wss://your-openai-compatible-endpoint.example/v1"
4444
```
4545

46-
最後に、使用する OpenAI API もカスタマイズできます。デフォルトでは OpenAI Responses API を使用します。[set_default_openai_api()][agents.set_default_openai_api] 関数を使用すると、これを Chat Completions API に上書きできます
46+
最後に、使用される OpenAI API もカスタマイズできます。デフォルトでは OpenAI Responses API を使用します。[set_default_openai_api()][agents.set_default_openai_api] 関数を使用すると、これを上書きして Chat Completions API を使用できます
4747

4848
```python
4949
from agents import set_default_openai_api
5050

5151
set_default_openai_api("chat_completions")
5252
```
5353

54+
## OpenAI プロバイダーのデフォルト
55+
56+
OpenAI を基盤とするプロバイダーは、モデル名を解決するときにも SDK 全体のデフォルトを読み取ります。OpenAI Responses モデルがデフォルトで WebSocket トランスポートを使用するようにするには、[`set_default_openai_responses_transport()`][agents.set_default_openai_responses_transport] を使用します:
57+
58+
```python
59+
from agents import set_default_openai_responses_transport
60+
61+
set_default_openai_responses_transport("websocket")
62+
```
63+
64+
これは、デフォルトの OpenAI プロバイダーによって解決される OpenAI Responses モデルに影響します。プロバイダーレベルのセットアップ、接続の再利用、キープアライブオプション、カスタム WebSocket エンドポイントについては、[Responses WebSocket トランスポート](models/index.md#responses-websocket-transport) を参照してください。
65+
66+
OpenAI セットアップでプロバイダーレベルのエージェント登録メタデータが必要な場合は、起動時にデフォルトのハーネス ID を一度設定してください:
67+
68+
```python
69+
from agents import set_default_openai_harness
70+
71+
set_default_openai_harness("your-harness-id")
72+
```
73+
74+
完全な登録オブジェクトを渡すこともできます:
75+
76+
```python
77+
from agents import OpenAIAgentRegistrationConfig, set_default_openai_agent_registration
78+
79+
set_default_openai_agent_registration(
80+
OpenAIAgentRegistrationConfig(harness_id="your-harness-id")
81+
)
82+
```
83+
84+
SDK のデフォルトが設定されていない場合、OpenAI を基盤とするプロバイダーは `OPENAI_AGENT_HARNESS_ID` 環境変数にフォールバックします。ハーネス ID が設定されている場合、`agent_harness_id``RunConfig.trace_metadata` にすでに存在する場合を除き、SDK はそれを `agent_harness_id` としてトレースメタデータに追加します。
85+
5486
## トレーシング
5587

5688
トレーシングはデフォルトで有効です。デフォルトでは、上のセクションで説明したモデルリクエストと同じ OpenAI API キー(つまり、環境変数または設定したデフォルトキー)を使用します。トレーシングに使用する API キーは、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用して個別に設定できます。
@@ -61,7 +93,7 @@ from agents import set_tracing_export_api_key
6193
set_tracing_export_api_key("sk-...")
6294
```
6395

64-
モデルのトラフィックにはあるキーまたはクライアントを使用し、トレーシングには別の OpenAI キーを使用したい場合は、デフォルトキーまたはクライアントを設定するときに `use_for_tracing=False` を渡してから、トレーシングを別途設定します。カスタムクライアントを使用していない場合は、[`set_default_openai_key()`][agents.set_default_openai_key] でも同じパターンを使用できます
96+
モデルのトラフィックではあるキーまたはクライアントを使用し、トレーシングでは別の OpenAI キーを使用したい場合は、デフォルトのキーまたはクライアントを設定するときに `use_for_tracing=False` を渡し、そのうえでトレーシングを個別に設定してください。カスタムクライアントを使用していない場合は、同じパターンを [`set_default_openai_key()`][agents.set_default_openai_key] にも適用できます
6597

6698
```python
6799
from openai import AsyncOpenAI
@@ -76,7 +108,7 @@ set_default_openai_client(custom_client, use_for_tracing=False)
76108
set_tracing_export_api_key("sk-tracing")
77109
```
78110

79-
デフォルトのエクスポーターを使用する際に、トレースを特定の組織またはプロジェクトに関連付ける必要がある場合は、アプリの起動前にこれらの環境変数を設定してください:
111+
デフォルトエクスポーターを使用するときに、トレースを特定の組織またはプロジェクトに関連付ける必要がある場合は、アプリの起動前に次の環境変数を設定してください:
80112

81113
```bash
82114
export OPENAI_ORG_ID="org_..."
@@ -103,7 +135,7 @@ from agents import set_tracing_disabled
103135
set_tracing_disabled(True)
104136
```
105137

106-
トレーシングは有効のまま、機密性がある可能性のある入力/出力をトレースペイロードから除外したい場合は、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data]`False` に設定します:
138+
トレーシングを有効のままにしつつ、機微情報を含む可能性のある入力/出力をトレースペイロードから除外したい場合は、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data]`False` に設定してください:
107139

108140
```python
109141
from agents import Runner, RunConfig
@@ -115,27 +147,27 @@ await Runner.run(
115147
)
116148
```
117149

118-
アプリの起動前にこの環境変数を設定することで、コードを変更せずにデフォルトを変更することもできます:
150+
コードを使わずにデフォルトを変更することもできます。アプリの起動前にこの環境変数を設定してください:
119151

120152
```bash
121153
export OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA=0
122154
```
123155

124-
トレーシング制御の詳細は[トレーシングガイド](tracing.md) を参照してください。
156+
トレーシング制御の詳細については[トレーシングガイド](tracing.md) を参照してください。
125157

126158
## デバッグログ
127159

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

130-
詳細なログ出力を有効にするには[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。
162+
詳細ログを有効にするには[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。
131163

132164
```python
133165
from agents import enable_verbose_stdout_logging
134166

135167
enable_verbose_stdout_logging()
136168
```
137169

138-
または、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズできます。詳細は [Python ロギングガイド](https://docs.python.org/3/howto/logging.html) で確認できます
170+
また、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることもできます。詳しくは [Python ロギングガイド](https://docs.python.org/3/howto/logging.html) を参照してください
139171

140172
```python
141173
import logging
@@ -154,18 +186,18 @@ logger.setLevel(logging.WARNING)
154186
logger.addHandler(logging.StreamHandler())
155187
```
156188

157-
### ログ内の機密データ
189+
### ログ内の機微データ
158190

159-
一部のログには機密データ(たとえば、ユーザーデータ)が含まれる場合があります。
191+
一部のログには、機微データ(たとえば、ユーザーデータ)が含まれる場合があります。
160192

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

163195
```bash
164196
OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
165197
OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1
166198
```
167199

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

170202
```bash
171203
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=0

0 commit comments

Comments
 (0)