Skip to content

Commit c06e537

Browse files
committed
Merge branch 'main' into session-docs-improvements
2 parents 74fe9ae + f3cac17 commit c06e537

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+2324
-1229
lines changed

docs/ja/agents.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ search:
44
---
55
# エージェント
66

7-
エージェントはアプリの中核となる基本コンポーネントです。エージェントは、instructions と tools を設定した大規模言語モデル( LLM )です。
7+
エージェントはアプリの中核となる構成要素です。エージェントは、instructions と tools で構成された大規模言語モデル( LLM )です。
88

99
## 基本設定
1010

1111
エージェントで最も一般的に設定するプロパティは次のとおりです。
1212

1313
- `name`: エージェントを識別する必須の文字列です。
14-
- `instructions`: developer messageまたは system promptとも呼ばれます。
14+
- `instructions`: developer message または system prompt とも呼ばれます。
1515
- `model`: 使用する LLM と、temperature、top_p などのモデル調整パラメーターを設定する任意の `model_settings`
16-
- `tools`: エージェントがタスクを達成するために使用できるツール
16+
- `tools`: エージェントがタスクを達成するために使用できるツールです
1717

1818
```python
1919
from agents import Agent, ModelSettings, function_tool
@@ -33,7 +33,7 @@ agent = Agent(
3333

3434
## コンテキスト
3535

36-
エージェントはその `context` 型に対してジェネリックです。コンテキストは依存性注入の手段です。あなたが作成し `Runner.run()` に渡すオブジェクトで、すべてのエージェント、ツール、ハンドオフなどに渡され、エージェント実行のための依存関係と状態をまとめて保持します。コンテキストには任意の Python オブジェクトを提供できます
36+
エージェントは `context` 型に対してジェネリックです。コンテキストは依存性注入のためのツールで、あなたが作成して `Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、tool、handoff などに渡され、エージェント実行のための依存関係や状態を入れておく入れ物として機能します。任意の Python オブジェクトをコンテキストとして提供できます
3737

3838
```python
3939
@dataclass
@@ -50,9 +50,9 @@ agent = Agent[UserContext](
5050
)
5151
```
5252

53-
## 出力型
53+
## 出力タイプ
5454

55-
デフォルトでは、エージェントはプレーンテキスト(すなわち `str`を出力します。特定の型の出力を生成させたい場合は`output_type` パラメーターを使用できます。一般的な選択肢は [Pydantic](https://docs.pydantic.dev/) オブジェクトですが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップ可能な任意の型(dataclass、list、TypedDict など)をサポートします。
55+
既定では、エージェントはプレーンテキスト(すなわち `str`の出力を生成します。エージェントに特定のタイプの出力を生成させたい場合は`output_type` パラメーターを使用できます。一般的な選択肢は [Pydantic](https://docs.pydantic.dev/) オブジェクトを使うことですが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップできる任意の型(dataclasses、list、TypedDict など)をサポートします。
5656

5757
```python
5858
from pydantic import BaseModel
@@ -73,20 +73,20 @@ agent = Agent(
7373

7474
!!! note
7575

76-
`output_type` を渡すと、通常のプレーンテキスト応答ではなく、[structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使うようモデルに指示します
76+
`output_type` を渡すと、モデルは通常のプレーンテキスト応答ではなく [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するよう指示されます
7777

78-
## マルチエージェントシステムの設計パターン
78+
## マルチエージェントの設計パターン
7979

80-
マルチエージェントシステムの設計には多くの方法がありますが、一般的に広く適用できるパターンを 2 つ紹介します
80+
マルチエージェントシステムの設計には多くの方法がありますが、一般的に広く適用できるパターンとして次の 2 つがよく見られます
8181

82-
1. マネージャー(エージェントをツールとして): 中央のマネージャー/オーケストレーターが、特化したサブエージェントをツールとして呼び出し、会話の制御を保持します
83-
2. ハンドオフ: 対等なエージェント間で、会話を引き継ぐ特化エージェントへ制御を渡します。これは分散型です。
82+
1. マネージャー(ツールとしてのエージェント): 中央のマネージャー/オーケストレーターが、専門のサブエージェントをツールとして呼び出し、会話の制御を維持します
83+
2. ハンドオフ: 対等なエージェント同士が、会話を引き継ぐ専門エージェントに制御を手渡します。これは分散型です。
8484

85-
詳細は [実践的なエージェント構築ガイド](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf) を参照してください
85+
詳細は[エージェント構築の実践ガイド](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf)をご覧ください
8686

87-
### マネージャー(エージェントをツールとして
87+
### マネージャー(ツールとしてのエージェント
8888

89-
`customer_facing_agent` がすべてのユーザー対応を行い、ツールとして公開された特化サブエージェントを呼び出します。詳しくは [tools](tools.md#agents-as-tools) のドキュメントを参照してください
89+
`customer_facing_agent` はすべてのユーザー対応を処理し、ツールとして公開された専門のサブエージェントを呼び出します。詳細は [tools](tools.md#agents-as-tools) ドキュメントをご覧ください
9090

9191
```python
9292
from agents import Agent
@@ -115,7 +115,7 @@ customer_facing_agent = Agent(
115115

116116
### ハンドオフ
117117

118-
ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフが発生すると、委譲先のエージェントは会話履歴を受け取り、会話を引き継ぎます。このパターンにより、単一タスクに秀でたモジュール型・特化型エージェントが実現します。詳しくは [handoffs](handoffs.md) のドキュメントを参照してください
118+
ハンドオフは、エージェントが委任できるサブエージェントです。ハンドオフが起こると、委任先のエージェントは会話履歴を受け取り、会話を引き継ぎます。このパターンにより、単一のタスクに秀でたモジュール型の専門エージェントを実現できます。詳細は [handoffs](handoffs.md) ドキュメントをご覧ください
119119

120120
```python
121121
from agents import Agent
@@ -136,7 +136,7 @@ triage_agent = Agent(
136136

137137
## 動的 instructions
138138

139-
多くの場合、エージェント作成時に instructions を指定できますが、関数を通じて動的な instructions を提供することもできます。この関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数のどちらも使用できます
139+
多くの場合、エージェント作成時に instructions を指定できますが、関数経由で動的に instructions を提供することも可能です。関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数のどちらも利用できます
140140

141141
```python
142142
def dynamic_instructions(
@@ -153,11 +153,11 @@ agent = Agent[UserContext](
153153

154154
## ライフサイクルイベント(フック)
155155

156-
エージェントのライフサイクルを観察したい場合があります。たとえば、イベントのログを記録したり、特定のイベント発生時にデータを事前取得したりするケースです`hooks` プロパティでエージェントのライフサイクルにフックできます[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、関心のあるメソッドをオーバーライドしてください。
156+
エージェントのライフサイクルを観測したい場合があります。たとえば、イベントをログに記録したり、特定のイベント発生時にデータを事前取得したりすることが考えられます`hooks` プロパティを使ってエージェントのライフサイクルにフックできます[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、関心のあるメソッドをオーバーライドしてください。
157157

158158
## ガードレール
159159

160-
ガードレールは、エージェント実行と並行してユーザー入力に対するチェック/バリデーションを行い、エージェントの出力が生成された後にも同様のチェックを行えます。たとえば、ユーザー入力やエージェント出力の関連性をスクリーニングできます。詳しくは [guardrails](guardrails.md) のドキュメントを参照してください
160+
ガードレールにより、エージェントの実行と並行してユーザー入力に対するチェック/バリデーション、およびエージェントの出力が生成された後のチェック/バリデーションを実行できます。たとえば、ユーザー入力やエージェント出力の関連性をスクリーニングできます。詳細は [guardrails](guardrails.md) ドキュメントをご覧ください
161161

162162
## エージェントのクローン/コピー
163163

@@ -178,12 +178,12 @@ robot_agent = pirate_agent.clone(
178178

179179
## ツール使用の強制
180180

181-
ツールのリストを渡しても、LLM が必ずしもツールを使用するとは限りません[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定してツール使用を強制できます。有効な値は次のとおりです。
181+
ツールのリストを提供しても、LLM が必ずツールを使うとは限りません[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツール使用を強制できます。有効な値は次のとおりです。
182182

183-
1. `auto`: ツールを使用するかどうかを LLM に判断させます
184-
2. `required`: ツールの使用を必須にします(どのツールを使うかは賢く選択できます)。
185-
3. `none`: ツールを使用しないことを必須にします
186-
4. 特定の文字列(例: `my_tool`)を設定すると、その特定のツールを使用することを必須にします
183+
1. `auto`: LLM がツールを使うかどうかを判断します
184+
2. `required`: LLM にツールの使用を要求します(ただし、どのツールを使うかは賢く判断できます)。
185+
3. `none`: LLM にツールを使用しないことを要求します
186+
4. 特定の文字列(例: `my_tool`)を設定すると、LLM にその特定のツールを使用させます
187187

188188
```python
189189
from agents import Agent, Runner, function_tool, ModelSettings
@@ -201,12 +201,12 @@ agent = Agent(
201201
)
202202
```
203203

204-
## ツール使用の動作
204+
## ツール使用時の挙動
205205

206206
`Agent` 構成の `tool_use_behavior` パラメーターは、ツール出力の扱い方を制御します。
207207

208-
- `"run_llm_again"`: 既定。ツールを実行し、LLM が結果を処理して最終応答を生成します。
209-
- `"stop_on_first_tool"`: 最初のツール呼び出しの出力を最終応答として使用し、以降の LLM 処理は行いません
208+
- `"run_llm_again"`: 既定。ツールが実行され、LLM が結果を処理して最終応答を生成します。
209+
- `"stop_on_first_tool"`: 最初のツール呼び出しの出力を、その後の LLM 処理なしで最終応答として使用します
210210

211211
```python
212212
from agents import Agent, Runner, function_tool, ModelSettings
@@ -224,7 +224,7 @@ agent = Agent(
224224
)
225225
```
226226

227-
- `StopAtTools(stop_at_tool_names=[...])`: 指定したいずれかのツールが呼び出されたら停止し、その出力を最終応答として使用します。
227+
- `StopAtTools(stop_at_tool_names=[...])`: 指定したいずれかのツールが呼び出された場合に停止し、その出力を最終応答として使用します。
228228

229229
```python
230230
from agents import Agent, Runner, function_tool
@@ -248,7 +248,7 @@ agent = Agent(
248248
)
249249
```
250250

251-
- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM 継続かを決定するカスタム関数です
251+
- `ToolsToFinalOutputFunction`: ツール結果を処理して、停止するか LLM を続行するかを決定するカスタム関数です
252252

253253
```python
254254
from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper
@@ -286,4 +286,4 @@ agent = Agent(
286286

287287
!!! note
288288

289-
無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この動作は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定可能です。無限ループは、ツール結果が LLM に送られ、`tool_choice` により LLM がさらに別のツール呼び出しを生成し続けるために発生します
289+
無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動で "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定可能です。無限ループが起きるのは、ツール結果が LLM に送られ、`tool_choice` によって LLM が再びツール呼び出しを生成し続けるためです

docs/ja/config.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ search:
66

77
## API キーとクライアント
88

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

1111
```python
1212
from agents import set_default_openai_key
1313

1414
set_default_openai_key("sk-...")
1515
```
1616

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

1919
```python
2020
from openai import AsyncOpenAI
@@ -24,7 +24,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
2424
set_default_openai_client(custom_client)
2525
```
2626

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

2929
```python
3030
from agents import set_default_openai_api
@@ -34,25 +34,25 @@ set_default_openai_api("chat_completions")
3434

3535
## トレーシング
3636

37-
トレーシングはデフォルトで有効です。デフォルトでは、上記の OpenAI API キー(つまり、環境変数または設定したデフォルト キー)を使用します。トレーシングに使用する API キーを個別に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します。
37+
トレーシング はデフォルトで有効です。デフォルトでは、上記のセクションの OpenAI API キー(つまり、環境変数または設定したデフォルトキー)を使用します。トレーシング に使用する API キーを個別に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します。
3838

3939
```python
4040
from agents import set_tracing_export_api_key
4141

4242
set_tracing_export_api_key("sk-...")
4343
```
4444

45-
[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使用して、トレーシングを完全に無効化することもできます
45+
[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使用して、トレーシング を完全に無効化することもできます
4646

4747
```python
4848
from agents import set_tracing_disabled
4949

5050
set_tracing_disabled(True)
5151
```
5252

53-
## デバッグ ログ
53+
## デバッグログ
5454

55-
SDK には、ハンドラーが設定されていない Python ロガーが 2 つあります。デフォルトでは、これにより警告とエラーは `stdout` に送られますが、その他のログは抑制されます
55+
SDK には、ハンドラーが設定されていない 2 つの Python ロガーがあります。デフォルトでは、これは警告とエラーが `stdout` に送られ、それ以外のログは抑制されることを意味します
5656

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

@@ -62,7 +62,7 @@ from agents import enable_verbose_stdout_logging
6262
enable_verbose_stdout_logging()
6363
```
6464

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

6767
```python
6868
import logging
@@ -83,15 +83,15 @@ logger.addHandler(logging.StreamHandler())
8383

8484
### ログ内の機密データ
8585

86-
一部のログには機密データ(例: ユーザー データ)が含まれる場合があります。これらのデータが記録されないようにするには、以下の環境変数を設定してください。
86+
一部のログには機密データ(例: ユーザー データ)が含まれる場合があります。このデータの記録を無効化したい場合は、以下の環境変数を設定してください。
8787

88-
LLM の入力と出力の記録を無効にするには:
88+
LLM の入力と出力のログ記録を無効化するには:
8989

9090
```bash
9191
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
9292
```
9393

94-
ツールの入力と出力の記録を無効にするには:
94+
tool の入力と出力のログ記録を無効化するには:
9595

9696
```bash
9797
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1

0 commit comments

Comments
 (0)