Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 33 additions & 33 deletions docs/ja/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ search:
---
# エージェント

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

## 基本設定
## 基本構成

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

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

```python
from agents import Agent, ModelSettings, function_tool
Expand All @@ -33,7 +33,7 @@ agent = Agent(

## コンテキスト

エージェントは自分の `context` 型に対してジェネリックです。コンテキストは依存性注入のためのツールで、あなたが作成して `Runner.run()` に渡すオブジェクトです。これはあらゆるエージェント、ツール、ハンドオフなどに渡され、エージェント実行のための依存関係と状態の寄せ集めとして機能します。コンテキストには任意の Python オブジェクトを指定できます
エージェントはその `context` 型についてジェネリックです。コンテキストは依存性注入のためのツールで、あなたが作成して `Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、実行時の依存関係や状態をまとめて保持します。コンテキストには任意の Python オブジェクトを渡せます

```python
@dataclass
Expand All @@ -52,7 +52,7 @@ agent = Agent[UserContext](

## 出力タイプ

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

```python
from pydantic import BaseModel
Expand All @@ -73,20 +73,20 @@ agent = Agent(

!!! note

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

## マルチエージェントの設計パターン
## 複数エージェントのシステム設計パターン

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

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

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

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

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

```python
from agents import Agent
Expand Down Expand Up @@ -115,7 +115,7 @@ customer_facing_agent = Agent(

### ハンドオフ

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

```python
from agents import Agent
Expand All @@ -136,7 +136,7 @@ triage_agent = Agent(

## 動的 instructions

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

```python
def dynamic_instructions(
Expand All @@ -153,15 +153,15 @@ agent = Agent[UserContext](

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

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

## ガードレール

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

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

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

```python
pirate_agent = Agent(
Expand All @@ -178,12 +178,12 @@ robot_agent = pirate_agent.clone(

## ツール使用の強制

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

1. `auto`: LLM がツールを使用するかどうかを判断します
2. `required`: LLM にツールの使用を要求します(どのツールを使うかは賢く判断できます)。
1. `auto`: ツールを使用するかどうかを LLM に任せます
2. `required`: LLM にツールの使用を必須にします(どのツールを使うかは知的に判断します)。
3. `none`: LLM にツールを _使用しない_ ことを要求します。
4. 特定の文字列(例: `my_tool`)を設定: その特定のツールを LLM に使用させます
4. 特定の文字列(例: `my_tool`)を設定: LLM にその特定のツールの使用を要求します

```python
from agents import Agent, Runner, function_tool, ModelSettings
Expand All @@ -201,12 +201,12 @@ agent = Agent(
)
```

## ツール使用の挙動
## ツール使用の動作

`Agent` `tool_use_behavior` パラメーターは、ツールの出力をどのように扱うかを制御します
`Agent` の設定パラメーター `tool_use_behavior` は、ツール出力の取り扱い方法を制御します

- `"run_llm_again"`: デフォルト。ツールを実行し、LLM が結果を処理して最終応答を生成します
- `"stop_on_first_tool"`: 最初のツール呼び出しの出力を、追加の LLM 処理なしで最終応答として使用します。
- `"run_llm_again"`: デフォルト。ツールを実行し、その結果を LLM が処理して最終応答を生成します
- `"stop_on_first_tool"`: 最初のツール呼び出しの出力を、その後の LLM 処理なしで最終応答として使用します。

```python
from agents import Agent, Runner, function_tool, ModelSettings
Expand All @@ -224,7 +224,7 @@ agent = Agent(
)
```

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

```python
from agents import Agent, Runner, function_tool
Expand All @@ -248,7 +248,7 @@ agent = Agent(
)
```

- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM を継続するかを判断するカスタム関数
- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM を継続するかを判断するカスタム関数です

```python
from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper
Expand Down Expand Up @@ -286,4 +286,4 @@ agent = Agent(

!!! note

無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループは、ツール結果が LLM に送られ、`tool_choice` によって LLM がさらに別のツール呼び出しを生成し続けることで発生します
無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この動作は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループは、ツール結果が LLM に送られ、`tool_choice` により LLM が再度ツール呼び出しを生成し続けることによって発生します
22 changes: 11 additions & 11 deletions docs/ja/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ search:

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

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

```python
from agents import set_default_openai_key
Expand All @@ -24,7 +24,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...")
set_default_openai_client(custom_client)
```

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

```python
from agents import set_default_openai_api
Expand All @@ -34,25 +34,25 @@ set_default_openai_api("chat_completions")

## トレーシング

トレーシングはデフォルトで有効です。デフォルトでは、上記の OpenAI API キー(すなわち環境変数または設定したデフォルトキー)を使用します。トレーシングに使用する API キーを個別に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します。
トレーシングはデフォルトで有効になっています。デフォルトでは、上記の OpenAI API キー(つまり、環境変数または設定したデフォルトキー)を使用します。トレーシングに使用する API キーを個別に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します。

```python
from agents import set_tracing_export_api_key

set_tracing_export_api_key("sk-...")
```

また、[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数でトレーシングを完全に無効化できます
[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使用すると、トレーシングを完全に無効化できます

```python
from agents import set_tracing_disabled

set_tracing_disabled(True)
```

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

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

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

Expand All @@ -62,7 +62,7 @@ from agents import enable_verbose_stdout_logging
enable_verbose_stdout_logging()
```

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

```python
import logging
Expand All @@ -81,17 +81,17 @@ logger.setLevel(logging.WARNING)
logger.addHandler(logging.StreamHandler())
```

### ログ内の機微情報
### ログ内の機微なデータ

一部のログには機微情報(例: ユーザー データ)が含まれる場合があります。これらのデータを記録しないようにするには、次の環境変数を設定してください。
一部のログには機微なデータ(たとえば、ユーザーデータ)が含まれる場合があります。これらのデータの記録を無効にしたい場合は、次の環境変数を設定してください。

LLM の入力と出力のロギングを無効化するには:
LLM の入力と出力の記録を無効にするには:

```bash
export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
```

ツールの入力と出力のロギングを無効化するには:
ツールの入力と出力の記録を無効にするには:

```bash
export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1
Expand Down
Loading