Skip to content

Commit dde45fc

Browse files
docs: update translated document pages (#2579)
1 parent 4902b07 commit dde45fc

File tree

18 files changed

+847
-696
lines changed

18 files changed

+847
-696
lines changed

docs/ja/config.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@
22
search:
33
exclude: true
44
---
5-
# SDK の設定
5+
# 設定
66

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

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

1111
- `RunConfig`、セッション、会話状態オプションについては [エージェントの実行](running_agents.md)
12-
- モデル選択とプロバイダー設定については [Models](models/index.md)
13-
- 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーについては [Tracing](tracing.md)
12+
- モデル選択とプロバイダー設定については [モデル](models/index.md)
13+
- 実行ごとのトレーシングメタデータとカスタムトレースプロセッサーについては [トレーシング](tracing.md)
1414

1515
## API キーとクライアント
1616

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

1919
```python
2020
from agents import set_default_openai_key
2121

2222
set_default_openai_key("sk-...")
2323
```
2424

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

2727
```python
2828
from openai import AsyncOpenAI
@@ -32,7 +32,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
3232
set_default_openai_client(custom_client)
3333
```
3434

35-
最後に、使用する 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 を使用できます
3636

3737
```python
3838
from agents import set_default_openai_api
@@ -42,15 +42,15 @@ set_default_openai_api("chat_completions")
4242

4343
## トレーシング
4444

45-
トレーシングはデフォルトで有効です。デフォルトでは、上記セクションのモデルリクエストと同じ 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] 関数で個別に設定できます
4646

4747
```python
4848
from agents import set_tracing_export_api_key
4949

5050
set_tracing_export_api_key("sk-...")
5151
```
5252

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

5555
```bash
5656
export OPENAI_ORG_ID="org_..."
@@ -77,7 +77,7 @@ from agents import set_tracing_disabled
7777
set_tracing_disabled(True)
7878
```
7979

80-
トレーシングは有効のままにしつつ、トレースペイロードから機密性の高い可能性がある入力/出力を除外したい場合は[`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` に設定してください。
8181

8282
```python
8383
from agents import Runner, RunConfig
@@ -89,27 +89,27 @@ await Runner.run(
8989
)
9090
```
9191

92-
コードを変更せずにデフォルトを変更するには、アプリ起動前に次の環境変数を設定することもできます
92+
アプリ起動前にこの環境変数を設定すれば、コードを書かずにデフォルトを変更することもできます
9393

9494
```bash
9595
export OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA=0
9696
```
9797

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

100100
## デバッグロギング
101101

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

104-
詳細ログを有効にするには[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。
104+
詳細なロギングを有効にするには[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。
105105

106106
```python
107107
from agents import enable_verbose_stdout_logging
108108

109109
enable_verbose_stdout_logging()
110110
```
111111

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

114114
```python
115115
import logging
@@ -130,9 +130,9 @@ logger.addHandler(logging.StreamHandler())
130130

131131
### ログ内の機密データ
132132

133-
一部のログには機密データ(例: ユーザーデータ)が含まれる可能性があります。
133+
一部のログには機密データ(たとえばユーザーデータ)が含まれる可能性があります。
134134

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

137137
```bash
138138
OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1

docs/ja/index.md

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,41 @@ search:
44
---
55
# OpenAI Agents SDK
66

7-
[OpenAI Agents SDK](https://github.com/openai/openai-agents-python) は、非常に少ない抽象化で、軽量かつ使いやすいパッケージとして エージェント型 AI アプリを構築できるようにします。これは、以前の エージェント 向け実験である [Swarm](https://github.com/openai/swarm/tree/main) を本番対応にアップグレードしたものです。Agents SDK には、非常に小さな基本コンポーネントのセットがあります。
7+
[OpenAI Agents SDK](https://github.com/openai/openai-agents-python) は、非常に少ない抽象化で、軽量かつ使いやすいパッケージとしてエージェント型 AI アプリを構築できるようにします。これは、以前のエージェント向け実験である [Swarm](https://github.com/openai/swarm/tree/main) を本番対応にアップグレードしたものです。Agents SDK には、非常に小さな基本コンポーネントのセットがあります。
88

9-
- **エージェント**: instructions と tools を備えた LLM
10-
- **Agents as tools / ハンドオフ**: 特定のタスクのために エージェント がほかの エージェント に委任できるようにする仕組み
11-
- **ガードレール**: エージェント の入力と出力の検証を可能にする仕組み
9+
- **エージェント**instructions と tools を備えた LLM です
10+
- **Agents as tools / ハンドオフ**特定のタスクのために、エージェントが他のエージェントへ委任できるようにします
11+
- **ガードレール**。エージェントの入力と出力の検証を可能にします
1212

13-
Python と組み合わせることで、これらの基本コンポーネントは、ツールと エージェント 間の複雑な関係を表現するのに十分強力であり、急な学習コストなしで実運用アプリケーションを構築できます。さらにSDK には組み込みの **トレーシング** があり、エージェントフローを可視化・デバッグできるほか、それらを評価し、さらにはアプリケーション向けにモデルをファインチューニングすることもできます
13+
これらの基本コンポーネントは Python と組み合わせることで、ツールとエージェント間の複雑な関係を表現できるほど強力であり、急な学習曲線なしで実運用アプリケーションを構築できます。さらに SDK には組み込みの **トレーシング** があり、エージェント型フローを可視化してデバッグできるほか、評価や、アプリケーション向けのモデルのファインチューニングまで行えます
1414

15-
## Agents SDK を使用する理由
15+
## Agents SDK を使う理由
1616

1717
SDK には 2 つの主要な設計原則があります。
1818

19-
1. 使う価値があるだけの機能を備えつつ、素早く学べるよう基本コンポーネントは少数にすること
20-
2. そのままで優れた動作をしつつ、何が起こるかを正確にカスタマイズできること。
19+
1. 使う価値があるだけの機能は備えつつ、すばやく学べるよう基本コンポーネントは少なくすること
20+
2. そのままですぐに優れた動作をしつつ、何が起こるかを正確にカスタマイズできること。
2121

2222
以下は SDK の主な機能です。
2323

24-
- **エージェントループ**: ツール呼び出しを処理し、結果を LLM に返し、タスクが完了するまで継続する組み込みの エージェント ループ
25-
- **Python ファースト**: 新しい抽象化を学ぶ必要なく、組み込みの言語機能を使って エージェントオーケストレーション と連結を行えます
26-
- **Agents as tools / ハンドオフ**: 複数の エージェント 間で作業を調整・委任するための強力な仕組み
27-
- **ガードレール**: エージェント 実行と並行して入力検証と安全性チェックを実行し、チェックを通過しない場合は迅速に失敗させます
28-
- **関数ツール**: 自動スキーマ生成と Pydantic ベースの検証により、任意の Python 関数をツールに変換します
29-
- **MCP サーバーツール呼び出し**: 関数ツールと同じ方法で動作する、組み込みの MCP サーバーツール統合
30-
- **セッション**: エージェントループ内で作業コンテキストを維持するための永続メモリレイヤー
31-
- **Human in the loop**: エージェント 実行全体で人間を関与させるための組み込みメカニズム
32-
- **トレーシング**: ワークフローの可視化、デバッグ、監視のための組み込みトレーシング。OpenAI の評価、ファインチューニング、蒸留ツール群をサポートします。
33-
- **Realtime Agents**: 自動割り込み検出、コンテキスト管理、ガードレールなどの機能を備えた強力な音声 エージェント を構築できます
24+
- **エージェントループ**: ツール呼び出しを処理し、結果を LLM に返し、タスクが完了するまで継続する組み込みのエージェントループです
25+
- **Python ファースト**: 新しい抽象化を学ぶ代わりに、組み込みの言語機能を使ってエージェントをエージェントオーケストレーションおよび連結できます
26+
- **Agents as tools / ハンドオフ**: 複数のエージェント間で作業を調整・委任するための強力な仕組みです
27+
- **ガードレール**: 入力検証と安全性チェックをエージェント実行と並行して実行し、チェックを通過しない場合は即座に失敗させます
28+
- **関数ツール**: 自動スキーマ生成と Pydantic による検証により、任意の Python 関数をツール化できます
29+
- **MCP サーバーツール呼び出し**: 関数ツールと同じ方法で動作する、組み込みの MCP サーバーツール統合です
30+
- **セッション**: エージェントループ内で作業コンテキストを維持するための永続的メモリ層です
31+
- **Human in the loop**: エージェント実行全体で人間を関与させるための組み込みメカニズムです
32+
- **トレーシング**: ワークフローの可視化、デバッグ、監視のための組み込みトレーシングであり、OpenAI の評価、ファインチューニング、蒸留ツール群をサポートします。
33+
- **Realtime エージェント**: 自動割り込み検知、コンテキスト管理、ガードレールなどの機能を備えた強力な音声エージェントを構築できます
3434

3535
## インストール
3636

3737
```bash
3838
pip install openai-agents
3939
```
4040

41-
## Hello World の例
41+
## Hello world の例
4242

4343
```python
4444
from agents import Agent, Runner
@@ -53,14 +53,29 @@ print(result.final_output)
5353
# Infinite loop's dance.
5454
```
5555

56-
_これを実行する場合は`OPENAI_API_KEY` 環境変数を設定していることを確認してください_
56+
これを実行する場合は`OPENAI_API_KEY` 環境変数を設定していることを確認してください
5757

5858
```bash
5959
export OPENAI_API_KEY=sk-...
6060
```
6161

62-
## 開始ポイント
62+
## 開始地点
6363

64-
- [Quickstart](quickstart.md) で最初のテキストベースの エージェント を構築します。
65-
- [Realtime agents quickstart](realtime/quickstart.md) で低遅延の音声 エージェント を構築します。
66-
- 代わりに speech-to-text / agent / text-to-speech のパイプラインを使いたい場合は、[Voice pipeline quickstart](voice/quickstart.md) を参照してください。
64+
- [Quickstart](quickstart.md) で最初のテキストベースのエージェントを構築します。
65+
- 次に、[Running agents](running_agents.md#choose-a-memory-strategy) でターン間の状態をどのように保持するかを決めます。
66+
- ハンドオフとマネージャー型オーケストレーションのどちらにするかを判断する場合は、[Agent orchestration](multi_agent.md) をご覧ください。
67+
68+
## パスの選択
69+
70+
やりたい作業は分かっているが、どのページに説明があるか分からない場合は、この表を使ってください。
71+
72+
| 目標 | 開始地点 |
73+
| --- | --- |
74+
| 最初のテキストエージェントを構築し、1 回の完全な実行を確認する | [Quickstart](quickstart.md) |
75+
| 関数ツール、ホストされたツール、または Agents as tools を追加する | [Tools](tools.md) |
76+
| ハンドオフとマネージャー型オーケストレーションのどちらにするか決める | [Agent orchestration](multi_agent.md) |
77+
| ターン間でメモリを保持する | [Running agents](running_agents.md#choose-a-memory-strategy)[Sessions](sessions/index.md) |
78+
| OpenAI モデル、websocket トランスポート、または非 OpenAI プロバイダーを使用する | [Models](models/index.md) |
79+
| 出力、実行項目、割り込み、再開状態を確認する | [Results](results.md) |
80+
| 低レイテンシの音声エージェントを構築する | [Realtime agents quickstart](realtime/quickstart.md) |
81+
| speech-to-text / agent / text-to-speech のパイプラインを構築する | [Voice pipeline quickstart](voice/quickstart.md) |

0 commit comments

Comments
 (0)