Skip to content

Commit b9b0141

Browse files
docs: update translated document pages (#2903)
1 parent 6b14ebc commit b9b0141

File tree

9 files changed

+869
-722
lines changed

9 files changed

+869
-722
lines changed

docs/ja/config.md

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

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

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

11-
代わりに特定のエージェントまたは実行を設定する必要がある場合は、次から始めてください
11+
代わりに特定のエージェントや実行を設定する必要がある場合は、次から始めてください:
1212

13-
- 通常の `Agent` における instructions、tools、出力型、ハンドオフ、ガードレールは [Agents](agents.md) を参照してください
14-
- `RunConfig`、セッション、会話状態オプションは [Running agents](running_agents.md) を参照してください
15-
- `SandboxRunConfig`、マニフェスト、機能、sandbox クライアント固有のワークスペース設定は [Sandbox agents](sandbox/guide.md) を参照してください
16-
- モデル選択とプロバイダー設定は [Models](models/index.md) を参照してください
17-
- 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーは [Tracing](tracing.md) を参照してください
13+
- 通常の `Agent` における instructions、ツール、出力タイプ、ハンドオフ、ガードレールについては [Agents](agents.md)
14+
- `RunConfig`、セッション、会話状態オプションについては [エージェントの実行](running_agents.md)
15+
- `SandboxRunConfig`、マニフェスト、機能、sandbox クライアント固有のワークスペース設定については [Sandbox エージェント](sandbox/guide.md)
16+
- モデル選択とプロバイダー設定については [Models](models/index.md)
17+
- 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーについては [トレーシング](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,7 +36,14 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
3636
set_default_openai_client(custom_client)
3737
```
3838

39-
最後に、使用する OpenAI API をカスタマイズすることもできます。デフォルトでは OpenAI Responses API を使用します。これは [set_default_openai_api()][agents.set_default_openai_api] 関数を使って Chat Completions API を使用するように上書きできます。
39+
環境変数ベースのエンドポイント設定を使いたい場合、デフォルトの OpenAI プロバイダーは `OPENAI_BASE_URL` も読み取ります。Responses websocket トランスポートを有効にすると、websocket `/responses` エンドポイント用に `OPENAI_WEBSOCKET_BASE_URL` も読み取ります。
40+
41+
```bash
42+
export OPENAI_BASE_URL="https://your-openai-compatible-endpoint.example/v1"
43+
export OPENAI_WEBSOCKET_BASE_URL="wss://your-openai-compatible-endpoint.example/v1"
44+
```
45+
46+
最後に、使用する OpenAI API をカスタマイズすることもできます。デフォルトでは OpenAI Responses API を使用します。これは [set_default_openai_api()][agents.set_default_openai_api] 関数を使って Chat Completions API を使うように上書きできます。
4047

4148
```python
4249
from agents import set_default_openai_api
@@ -46,15 +53,30 @@ set_default_openai_api("chat_completions")
4653

4754
## トレーシング
4855

49-
トレーシングはデフォルトで有効です。デフォルトでは、上記セクションのモデルリクエストと同じ OpenAI API キー(つまり、環境変数または設定したデフォルトキー)を使用します。トレーシングに使用する API キーを明示的に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します
56+
トレーシングはデフォルトで有効です。デフォルトでは、上のセクションのモデルリクエストと同じ OpenAI API キー(つまり環境変数または設定したデフォルトキー)を使用します。トレーシングに使用する API キーは [`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数で明示的に設定できます
5057

5158
```python
5259
from agents import set_tracing_export_api_key
5360

5461
set_tracing_export_api_key("sk-...")
5562
```
5663

57-
デフォルトエクスポーター使用時に、特定の組織またはプロジェクトにトレースを紐付ける必要がある場合は、アプリ起動前に次の環境変数を設定してください。
64+
モデル通信があるキーまたはクライアントを使い、トレーシングは別の OpenAI キーを使う必要がある場合、デフォルトキーまたはクライアント設定時に `use_for_tracing=False` を渡してから、トレーシングを個別に設定してください。カスタムクライアントを使わない場合は [`set_default_openai_key()`][agents.set_default_openai_key] でも同じパターンが使えます。
65+
66+
```python
67+
from openai import AsyncOpenAI
68+
from agents import (
69+
set_default_openai_client,
70+
set_tracing_export_api_key,
71+
)
72+
73+
custom_client = AsyncOpenAI(base_url="https://your-openai-compatible-endpoint.example/v1", api_key="provider-key")
74+
set_default_openai_client(custom_client, use_for_tracing=False)
75+
76+
set_tracing_export_api_key("sk-tracing")
77+
```
78+
79+
デフォルトのエクスポーター使用時に、トレースを特定の組織またはプロジェクトに紐付ける必要がある場合は、アプリ起動前に以下の環境変数を設定してください:
5880

5981
```bash
6082
export OPENAI_ORG_ID="org_..."
@@ -81,7 +103,7 @@ from agents import set_tracing_disabled
81103
set_tracing_disabled(True)
82104
```
83105

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

86108
```python
87109
from agents import Runner, RunConfig
@@ -93,17 +115,17 @@ await Runner.run(
93115
)
94116
```
95117

96-
コードを書かずにデフォルトを変更するには、アプリ起動前にこの環境変数を設定することもできます。
118+
アプリ起動前にこの環境変数を設定すれば、コードなしでデフォルトを変更することもできます:
97119

98120
```bash
99121
export OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA=0
100122
```
101123

102-
トレーシング制御の全体については、[tracing guide](tracing.md) を参照してください。
124+
トレーシング制御の全体については、[トレーシングガイド](tracing.md) を参照してください。
103125

104-
## デバッグロギング
126+
## デバッグログ
105127

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

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

@@ -113,7 +135,7 @@ from agents import enable_verbose_stdout_logging
113135
enable_verbose_stdout_logging()
114136
```
115137

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

118140
```python
119141
import logging
@@ -134,16 +156,16 @@ logger.addHandler(logging.StreamHandler())
134156

135157
### ログ内の機密データ
136158

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

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

141163
```bash
142164
OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
143165
OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1
144166
```
145167

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

148170
```bash
149171
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=0

0 commit comments

Comments
 (0)