Skip to content

Commit 5639606

Browse files
authored
Docs: Switch to o3 model; exclude translated pages from search (#533)
This pull request introduces the following changes: 1. **Exclude translated pages from search**: I explored ways to make the search plugin work with the i18n plugin, but it would require extensive custom JavaScript hacks. So for now, I’m holding off on this work. 2. **Switch from GPT-4.1 to o3 for even better translation quality**: While 4.1 performs well, o3 shows even greater quality for this task, and there’s no reason to avoid using it.
1 parent 472e8c1 commit 5639606

23 files changed

+719
-402
lines changed

docs/ja/agents.md

+26-22
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1+
---
2+
search:
3+
exclude: true
4+
---
15
# エージェント
26

3-
エージェントは、アプリケーションの中核となる基本コンポーネントです。エージェントとは、instructions とツールで構成された大規模言語モデル(LLM)のことです
7+
エージェントはアプリの主要な構成ブロックです。エージェントは、大規模言語モデル ( LLM ) に instructions と tools を設定したものです
48

59
## 基本設定
610

7-
エージェントで最も一般的に設定するプロパティは以下の通りです
11+
エージェントで最も一般的に設定するプロパティは次のとおりです
812

9-
- `instructions`:developer message や システムプロンプト(system prompt)とも呼ばれます。
10-
- `model`:どの LLM を使用するか、また `model_settings`temperature や top_p などのモデル調整パラメーターを設定できます
11-
- `tools`:エージェントがタスクを達成するために使用できるツールです
13+
- `instructions`: 開発者メッセージまたは system prompt とも呼ばれます。
14+
- `model`: 使用する LLM と、temperature や top_p などのモデル調整パラメーターを指定する任意の `model_settings`
15+
- `tools`: エージェントがタスクを達成するために利用できるツール
1216

1317
```python
1418
from agents import Agent, ModelSettings, function_tool
@@ -27,7 +31,7 @@ agent = Agent(
2731

2832
## コンテキスト
2933

30-
エージェントは `context` 型に対して汎用的です。コンテキストは依存性注入ツールであり`Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、エージェント実行時の依存関係や状態をまとめて管理します。任意の Python オブジェクトを context として指定できます
34+
エージェントはその `context` 型について汎用的です。コンテキストは依存性注入の手段で`Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、エージェント実行時の依存関係や状態をまとめて保持します。任意の Python オブジェクトをコンテキストとして渡せます
3135

3236
```python
3337
@dataclass
@@ -45,7 +49,7 @@ agent = Agent[UserContext](
4549

4650
## 出力タイプ
4751

48-
デフォルトでは、エージェントはプレーンテキストつまり `str`)出力を生成します。特定の型の出力をエージェントに生成させたい場合は、`output_type` パラメーターを使用できます。一般的な選択肢として [Pydantic](https://docs.pydantic.dev/) オブジェクトがありますが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップできる型(dataclasses、リスト、TypedDict など)であればサポートしています
52+
デフォルトでは、エージェントはプレーンテキスト ( つまり `str` ) を出力します。特定の型で出力させたい場合は `output_type` パラメーターを使用します。一般的には [Pydantic](https://docs.pydantic.dev/) オブジェクトを利用しますが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップ可能な型であれば何でも対応します。たとえば dataclass、list、TypedDict などです
4953

5054
```python
5155
from pydantic import BaseModel
@@ -66,11 +70,11 @@ agent = Agent(
6670

6771
!!! note
6872

69-
`output_type` を指定すると、モデルは通常のプレーンテキスト応答の代わりに [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するよう指示されます。
73+
`output_type` を渡すと、モデルは通常のプレーンテキスト応答の代わりに [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するよう指示されます。
7074

7175
## ハンドオフ
7276

73-
ハンドオフは、エージェントが委任できるサブエージェントです。ハンドオフのリストを指定すると、エージェントは必要に応じてそれらに処理を委任できます。これは、単一タスクに特化したモジュール型のエージェントをオーケストレーションする強力なパターンです。詳細は [handoffs](handoffs.md) ドキュメントをご覧ください。
77+
ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフのリストを渡しておくと、エージェントは必要に応じてそれらに処理を委譲できます。これにより、単一のタスクに特化したモジュール式エージェントを編成できる強力なパターンが実現します。詳細は [handoffs](handoffs.md) ドキュメントをご覧ください。
7478

7579
```python
7680
from agents import Agent
@@ -91,7 +95,7 @@ triage_agent = Agent(
9195

9296
## 動的 instructions
9397

94-
多くの場合、エージェント作成時に instructions を指定できますが、関数を使って動的に instructions を提供することも可能です。この関数はエージェントと context を受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方が利用可能です
98+
通常はエージェント作成時に instructions を指定しますが、関数を介して動的に instructions を提供することもできます。その関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。同期関数と `async` 関数の両方に対応しています
9599

96100
```python
97101
def dynamic_instructions(
@@ -106,17 +110,17 @@ agent = Agent[UserContext](
106110
)
107111
```
108112

109-
## ライフサイクルイベント(フック)
113+
## ライフサイクルイベント (hooks)
110114

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

113117
## ガードレール
114118

115-
ガードレールを使うと、エージェントの実行と並行して user 入力のチェックやバリデーションを行えます。たとえば、user の入力が関連性のある内容かどうかをスクリーニングできます。詳細は [guardrails](guardrails.md) ドキュメントをご覧ください。
119+
ガードレールを使うと、エージェントの実行と並行してユーザー入力に対するチェックやバリデーションを実行できます。たとえば、ユーザーの入力内容が関連しているかをスクリーニングできます。詳細は [guardrails](guardrails.md) ドキュメントをご覧ください。
116120

117-
## エージェントのクローン/コピー
121+
## エージェントの複製
118122

119-
エージェントの `clone()` メソッドを使うことで、エージェントを複製し、任意のプロパティを変更できます
123+
`clone()` メソッドを使用すると、エージェントを複製し、必要に応じて任意のプロパティを変更できます
120124

121125
```python
122126
pirate_agent = Agent(
@@ -133,15 +137,15 @@ robot_agent = pirate_agent.clone(
133137

134138
## ツール使用の強制
135139

136-
ツールのリストを指定しても、必ずしも LLM がツールを使用するとは限りません[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツールの使用を強制できます。有効な値は以下の通りです
140+
ツールの一覧を渡しても、LLM が必ずツールを使用するとは限りません[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツール使用を強制できます。有効な値は次のとおりです
137141

138-
1. `auto`LLM がツールを使うかどうかを自動で判断します
139-
2. `required`LLM にツールの使用を必須とします(どのツールを使うかは賢く選択されます)
140-
3. `none`:LLM にツールを _使わない_ ことを要求します
141-
4. 特定の文字列(例:`my_tool`)を指定すると、その特定のツールの使用を必須とします
142+
1. `auto` — ツールを使用するかどうかを LLM が判断します
143+
2. `required`LLM にツール使用を必須化します ( ただし使用するツールは自動選択 )
144+
3. `none` — LLM にツールを使用しないことを要求します
145+
4. 特定の文字列 ( 例: `my_tool` ) — その特定のツールを LLM に使用させます
142146

143147
!!! note
144148

145-
無限ループを防ぐため、フレームワークはツール呼び出し後に自動的に `tool_choice` "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定可能です。無限ループは、ツールの execution results が LLM に送信され、`tool_choice` のために再度ツール呼び出しが発生し、これが繰り返されることで発生します
149+
無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この動作は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループが起こる理由は、ツールの結果が LLM に送られ、`tool_choice` により再びツール呼び出しが生成される、という流れが繰り返されるからです
146150

147-
ツール呼び出し後にエージェントを完全に停止させたい場合auto モードで継続させたくない場合)は、[`Agent.tool_use_behavior="stop_on_first_tool"`] を設定できます。これにより、ツールの出力がそのまま最終応答として使用され、以降の LLM 処理は行われません
151+
ツール呼び出し後にエージェントを完全に停止させたい場合 ( auto モードで続行させたくない場合 ) は、[`Agent.tool_use_behavior="stop_on_first_tool"`] を設定してください。これにより、ツールの出力を LL M の追加処理なしにそのまま最終応答として返します

docs/ja/config.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
1+
---
2+
search:
3+
exclude: true
4+
---
15
# SDK の設定
26

37
## API キーとクライアント
48

5-
デフォルトでは、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] 関数を利用してキーを設定できます
610

711
```python
812
from agents import set_default_openai_key
913

1014
set_default_openai_key("sk-...")
1115
```
1216

13-
また、使用する OpenAI クライアントを設定することも可能です。デフォルトでは、SDK は環境変数または上記で設定したデフォルトキーを使って `AsyncOpenAI` インスタンスを作成します。これを変更したい場合は、[set_default_openai_client()][agents.set_default_openai_client] 関数を利用してください
17+
また、使用する OpenAI クライアントを構成することも可能です。デフォルトでは、 SDK は環境変数または上記で設定したデフォルトキーを用いて `AsyncOpenAI` インスタンスを作成します。これを変更するには、 [set_default_openai_client()][agents.set_default_openai_client] 関数を使用します
1418

1519
```python
1620
from openai import AsyncOpenAI
@@ -20,7 +24,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
2024
set_default_openai_client(custom_client)
2125
```
2226

23-
さらに、使用する OpenAI API をカスタマイズすることもできます。デフォルトでは OpenAI Responses API を使用していますが、[set_default_openai_api()][agents.set_default_openai_api] 関数を使って Chat Completions API を利用するように上書きできます
27+
さらに、使用する OpenAI API をカスタマイズすることもできます。既定では OpenAI Responses API を利用します。これを Chat Completions API に変更するには、 [set_default_openai_api()][agents.set_default_openai_api] 関数を使用してください
2428

2529
```python
2630
from agents import set_default_openai_api
@@ -30,15 +34,15 @@ set_default_openai_api("chat_completions")
3034

3135
## トレーシング
3236

33-
トレーシングはデフォルトで有効になっています。デフォルトでは、上記のセクションで説明した 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] 関数を利用してください。
3438

3539
```python
3640
from agents import set_tracing_export_api_key
3741

3842
set_tracing_export_api_key("sk-...")
3943
```
4044

41-
また、[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使ってトレーシングを完全に無効化することもできます
45+
トレーシングを完全に無効化するには、 [`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を呼び出します
4246

4347
```python
4448
from agents import set_tracing_disabled
@@ -48,17 +52,17 @@ set_tracing_disabled(True)
4852

4953
## デバッグログ
5054

51-
SDK には、ハンドラーが設定されていない 2 つの Python ロガーがあります。デフォルトでは、警告やエラーは `stdout` に送信されますが、それ以外のログは抑制されます。
55+
SDK にはハンドラーが設定されていない Python ロガーが 2 つあります。デフォルトでは、警告とエラーは `stdout` に出力されますが、それ以外のログは抑制されます。
5256

53-
詳細なログ出力を有効にするには、[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用してください
57+
詳細なログを有効にするには、 [`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します
5458

5559
```python
5660
from agents import enable_verbose_stdout_logging
5761

5862
enable_verbose_stdout_logging()
5963
```
6064

61-
また、ハンドラーやフィルター、フォーマッターなどを追加してログをカスタマイズすることも可能です。詳細は [Python ロギングガイド](https://docs.python.org/3/howto/logging.html) をご覧ください
65+
必要に応じて、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることも可能です。詳しくは [Python ロギングガイド](https://docs.python.org/3/howto/logging.html) を参照してください
6266

6367
```python
6468
import logging
@@ -77,17 +81,17 @@ logger.setLevel(logging.WARNING)
7781
logger.addHandler(logging.StreamHandler())
7882
```
7983

80-
### ログ内の機微なデータ
84+
### ログに含まれる機微情報
8185

82-
一部のログには機微なデータ(たとえば ユーザー データ)が含まれる場合があります。これらのデータのログ出力を無効にしたい場合は、以下の環境変数を設定してください
86+
特定のログには機微情報(たとえば ユーザー データ)が含まれる場合があります。この情報が記録されるのを防ぎたい場合は、次の環境変数を設定してください
8387

84-
LLM の入力および出力のログ出力を無効にするには:
88+
LLM の入力および出力のログを無効にする:
8589

8690
```bash
8791
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
8892
```
8993

90-
ツールの入力および出力のログ出力を無効にするには:
94+
ツールの入力および出力のログを無効にする:
9195

9296
```bash
9397
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1

0 commit comments

Comments
 (0)