diff --git a/docs/ja/agents.md b/docs/ja/agents.md index 4a6bc16ec..790739ebf 100644 --- a/docs/ja/agents.md +++ b/docs/ja/agents.md @@ -4,16 +4,16 @@ search: --- # エージェント -エージェントはアプリの中心的な構成要素です。エージェントは、instructions と tools で設定された大規模言語モデル ( LLM ) です。 +エージェントはアプリケーションの中核となる構成要素です。エージェントとは、`instructions` と `tools` で設定された大規模言語モデル ( LLM ) です。 ## 基本設定 -エージェントでよく設定するプロパティは次のとおりです。 +エージェントでよく設定する主なプロパティは次のとおりです: -- `name`: エージェントを識別する必須の文字列です。 -- `instructions`: developer message（開発者メッセージ）または システムプロンプト とも呼ばれます。 -- `model`: 使用する LLM を指定します。また、temperature や top_p などのモデル調整パラメーターを設定する `model_settings` を任意で指定できます。 -- `tools`: エージェントがタスクを達成するために使用できる tools です。 +- `name`: エージェントを識別する必須の文字列。 +- `instructions`: developer メッセージまたは system prompt とも呼ばれます。 +- `model`: 使用する LLM と、temperature や top_p などのモデル調整パラメーターを設定する省略可能な `model_settings`。 +- `tools`: エージェントがタスク達成のために使用できるツール。 ```python from agents import Agent, ModelSettings, function_tool @@ -32,7 +32,7 @@ agent = Agent( ## コンテキスト -エージェントは汎用的な `context` 型を取ります。コンテキストは依存性注入用のツールで、あなたが作成して `Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、tool、handoff などに渡され、実行時に必要な依存関係や状態を格納する入れ物として機能します。コンテキストには任意の Python オブジェクトを渡せます。 +エージェントはその `context` 型に対してジェネリックです。コンテキストは依存性注入の仕組みで、あなたが作成して `Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、実行時の依存関係や状態をまとめて保持します。任意の Python オブジェクトをコンテキストとして指定できます。 ```python @dataclass @@ -50,7 +50,7 @@ agent = Agent[UserContext]( ## 出力タイプ -デフォルトでは、エージェントはプレーンテキスト、つまり `str` を出力します。特定の型で出力させたい場合は、`output_type` パラメーターを使用します。一般的には [Pydantic](https://docs.pydantic.dev/) オブジェクトを使うことが多いですが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップできる型であれば何でもサポートされています。たとえば dataclass、list、TypedDict などです。 +デフォルトでは、エージェントはプレーンテキスト (つまり `str`) を出力します。特定の型で出力させたい場合は `output_type` パラメーターを使用します。一般的によく使われるのは Pydantic オブジェクトですが、Pydantic の TypeAdapter でラップできる型であれば、dataclasses、lists、TypedDict など何でもサポートしています。 ```python from pydantic import BaseModel @@ -71,11 +71,11 @@ agent = Agent( !!! note - `output_type` を渡すと、モデルは通常のプレーンテキスト応答ではなく structured outputs を使用するよう指示されます。 + `output_type` を渡すと、モデルは通常のプレーンテキストではなく [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するよう指示されます。 ## ハンドオフ -ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフのリストを渡すと、エージェントは関連性がある場合にそれらへ委譲できます。これは、単一タスクに特化したモジュール型エージェントを編成する強力なパターンです。詳細は [ハンドオフ](handoffs.md) のドキュメントをご覧ください。 +ハンドオフは、エージェントが委任できるサブエージェントです。ハンドオフのリストを渡すと、エージェントは関連性がある場合にそれらへ委任できます。これにより、単一タスクに特化したモジュール型エージェントを編成できる強力なパターンが実現します。詳しくは [ハンドオフ](handoffs.md) ドキュメントをご覧ください。 ```python from agents import Agent @@ -96,7 +96,7 @@ triage_agent = Agent( ## 動的 instructions -通常はエージェント作成時に instructions を渡しますが、関数を通じて動的に instructions を提供することもできます。この関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。同期関数でも `async` 関数でも利用可能です。 +ほとんどの場合、エージェント作成時に `instructions` を指定できますが、関数を介して動的に提供することも可能です。関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。同期関数と async 関数のどちらも利用できます。 ```python def dynamic_instructions( @@ -113,15 +113,15 @@ agent = Agent[UserContext]( ## ライフサイクルイベント (hooks) -エージェントのライフサイクルを監視したい場合があります。たとえば、イベントをログに記録したり、特定のイベント発生時にデータを事前取得したりするケースです。`hooks` プロパティを使うことでエージェントのライフサイクルにフックを追加できます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスを継承し、必要なメソッドをオーバーライドしてください。 +エージェントのライフサイクルを観察したい場合があります。たとえば、イベントをログに残したり、特定のイベント発生時にデータを事前取得したりするケースです。`hooks` プロパティを使用してエージェントのライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、必要なメソッドをオーバーライドしてください。 ## ガードレール -ガードレールを使うと、エージェントの実行と並行してユーザー入力に対するチェック／バリデーションを実行できます。たとえば、ユーザー入力の関連性をフィルタリングすることが可能です。詳細は [guardrails](guardrails.md) のドキュメントをご参照ください。 +ガードレールを使用すると、エージェントの実行と並行してユーザー入力に対するチェックやバリデーションを実行できます。たとえば、ユーザー入力の関連性を検査するなどが可能です。詳しくは [guardrails](guardrails.md) ドキュメントを参照してください。 -## エージェントのクローンとコピー +## エージェントのクローン／コピー -エージェントの `clone()` メソッドを使用すると、エージェントを複製し、必要に応じて任意のプロパティを変更できます。 +`clone()` メソッドを使うと、エージェントを複製し、任意のプロパティを変更できます。 ```python pirate_agent = Agent( @@ -136,17 +136,17 @@ robot_agent = pirate_agent.clone( ) ``` -## ツール使用の強制 +## Tool の使用を強制する -tools のリストを渡しても、LLM が必ずツールを使用するわけではありません。`ModelSettings.tool_choice` を設定することでツール使用を強制できます。設定可能な値は次のとおりです。 +ツールのリストを渡しても、LLM が必ずツールを使用するとは限りません。[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツール使用を強制できます。有効な値は次のとおりです: -1. `auto` : LLM がツールを使用するかどうかを判断します。 -2. `required` : LLM にツールの使用を必須とします (どのツールを使うかは LLM が判断)。 -3. `none` : LLM にツールを使用しないことを要求します。 -4. 特定の文字列 (例: `my_tool`) を設定すると、そのツールの使用を必須とします。 +1. `auto` : LLM がツールを使うかどうかを判断します。 +2. `required` : LLM にツール使用を必須とします (どのツールを使うかは自動で判断)。 +3. `none` : LLM にツールを使用しないように要求します。 +4. 具体的な文字列 (例: `my_tool`) を設定すると、その特定のツールを必ず使用させます。 !!! note - 無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループが発生するのは、ツールの結果が LLM へ送られ、`tool_choice` により再びツール呼び出しが生成されるというサイクルが続くためです。 + 無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定可能です。ツールの結果が LLM に送られ、`tool_choice` の設定により再度ツール呼び出しが生成されることで無限ループが発生します。 - ツール呼び出し後に自動モードへ移行せず完全に処理を終了したい場合は、[`Agent.tool_use_behavior="stop_on_first_tool"`] を設定してください。これにより、ツールの出力をそのまま最終応答として使用し、追加の LLM 処理を行いません。 \ No newline at end of file + ツール呼び出し後にエージェントを完全に停止させたい場合 (自動モードに戻さずに終了したい場合) は、[`Agent.tool_use_behavior="stop_on_first_tool"`] を設定すると、ツールの出力をそのまま最終応答として使用し、追加の LLM 処理を行いません。 \ No newline at end of file diff --git a/docs/ja/config.md b/docs/ja/config.md index 193045490..b2a3adad9 100644 --- a/docs/ja/config.md +++ b/docs/ja/config.md @@ -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 @@ -14,7 +14,7 @@ from agents import set_default_openai_key set_default_openai_key("sk-...") ``` -また、使用する OpenAIクライアントを設定することもできます。デフォルトでは、 SDK は環境変数または上記で設定したデフォルトキーを用いて `AsyncOpenAI` インスタンスを作成します。これを変更したい場合は、 [set_default_openai_client()][agents.set_default_openai_client] 関数を使用してください。 +また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、 SDK は環境変数または上記で設定した既定のキーを用いて `AsyncOpenAI` インスタンスを生成します。[set_default_openai_client()][agents.set_default_openai_client] 関数を使用すると、これを変更できます。 ```python from openai import AsyncOpenAI @@ -24,7 +24,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...") set_default_openai_client(custom_client) ``` -さらに、使用する OpenAI API をカスタマイズすることもできます。デフォルトでは OpenAI Responses API を使用しますが、 [set_default_openai_api()][agents.set_default_openai_api] 関数を使用して Chat Completions API に切り替えることができます。 +さらに、利用する OpenAI API をカスタマイズすることもできます。デフォルトでは OpenAI Responses API を使用しますが、[set_default_openai_api()][agents.set_default_openai_api] 関数を使って Chat Completions API に切り替えられます。 ```python from agents import set_default_openai_api @@ -34,7 +34,7 @@ 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 @@ -42,7 +42,7 @@ 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 @@ -50,11 +50,11 @@ from agents import set_tracing_disabled set_tracing_disabled(True) ``` -## デバッグログ +## デバッグロギング -SDK にはハンドラーが設定されていない 2 つの Python ロガーが用意されています。デフォルトでは、 warning と error は `stdout` に出力されますが、それ以外のログは抑制されます。 +SDK にはハンドラーが設定されていない Python ロガーが 2 つあります。デフォルト状態では、警告とエラーは `stdout` に出力されますが、それ以外のログは抑制されます。 -詳細なログを有効にするには、 [`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用してください。 +詳細なログ出力を有効にするには、[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。 ```python from agents import enable_verbose_stdout_logging @@ -83,15 +83,15 @@ logger.addHandler(logging.StreamHandler()) ### ログに含まれる機密データ -ログの中には機密データ (例: ユーザーデータ) を含むものがあります。これらのデータを記録しないようにする場合は、次の環境変数を設定してください。 +一部のログには、ユーザー データなどの機密データが含まれる場合があります。これらのデータをログに出力したくない場合は、以下の環境変数を設定してください。 -LLM の入力および出力のロギングを無効化する: +LLM の入力と出力のログを無効にするには: ```bash export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1 ``` -ツールの入力および出力のロギングを無効化する: +ツールの入力と出力のログを無効にするには: ```bash export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1 diff --git a/docs/ja/context.md b/docs/ja/context.md index 77eae1e81..3cfa6f9c7 100644 --- a/docs/ja/context.md +++ b/docs/ja/context.md @@ -4,30 +4,30 @@ search: --- # コンテキスト管理 -コンテキストという用語は多義的です。ここでは主に 2 つのコンテキスト クラスがあります。 +コンテキストという言葉には多くの意味があります。ここでは主に 2 つのコンテキストについて説明します: -1. コード内でローカルに利用できるコンテキスト: これはツール関数の実行時や `on_handoff` などのコールバック、ライフサイクル フック内で必要となるデータや依存関係です。 -2. LLM が利用できるコンテキスト: これは LLM が応答を生成する際に参照できるデータです。 +1. コードでローカルに利用できるコンテキスト: これは、ツール関数実行時や `on_handoff` のようなコールバック、ライフサイクルフックなどで必要となるデータおよび依存関係です。 +2. LLM が応答を生成するときに参照できるコンテキスト: これは LLM が見るデータです。 -## ローカル コンテキスト +## ローカルコンテキスト -ローカル コンテキストは [`RunContextWrapper`][agents.run_context.RunContextWrapper] クラスと、その中の [`context`][agents.run_context.RunContextWrapper.context] プロパティで表現されます。基本的な流れは次のとおりです。 +これは [`RunContextWrapper`][agents.run_context.RunContextWrapper] クラスとその [`context`][agents.run_context.RunContextWrapper.context] プロパティで表現されます。仕組みは次のとおりです。 -1. 任意の Python オブジェクトを作成します。一般的には dataclass や Pydantic オブジェクトを利用するパターンが多いです。 -2. そのオブジェクトを各種 `run` メソッド（例: `Runner.run(..., **context=whatever**)`）に渡します。 -3. すべてのツール呼び出しやライフサイクル フックなどには、`RunContextWrapper[T]` というラッパー オブジェクトが渡されます。ここで `T` はコンテキスト オブジェクトの型で、`wrapper.context` からアクセスできます。 +1. 任意の Python オブジェクトを作成します。よく使われるパターンは dataclass や Pydantic オブジェクトです。 +2. そのオブジェクトを各種 `run` メソッドに渡します (例: `Runner.run(..., **context=whatever**)`)。 +3. すべてのツール呼び出しやライフサイクルフックには `RunContextWrapper[T]` というラッパーオブジェクトが渡されます。ここで `T` は作成したコンテキストオブジェクトの型で、`wrapper.context` からアクセスできます。 -**最も重要な点**: ひとつのエージェント実行において、エージェント・ツール関数・ライフサイクル フックなどはすべて同じ _型_ のコンテキストを使用しなければなりません。 +最も重要なポイント: 同じエージェント実行内のすべてのエージェント、ツール関数、ライフサイクルフックは、同一の _型_ のコンテキストを共有しなければなりません。 -コンテキストは次のような用途に利用できます。 +コンテキストでできることの例: -- 実行に関するコンテキスト データ（例: ユーザー名 / UID などのユーザー情報） -- 依存関係（例: ロガー オブジェクト、データフェッチャーなど） -- ヘルパー関数 +- 実行時の状況データ (例: ユーザー名 / UID などユーザーに関する情報) +- 依存オブジェクト (例: ロガー、データフェッチャーなど) +- ヘルパー関数 !!! danger "Note" - コンテキスト オブジェクトは **LLM に送信されません**。あくまでローカル オブジェクトであり、読み書きやメソッド呼び出しが可能です。 + コンテキストオブジェクトは **LLM に送信されません**。これはあくまでローカルオブジェクトであり、読み書きやメソッド呼び出しのみが可能です。 ```python import asyncio @@ -66,17 +66,17 @@ if __name__ == "__main__": asyncio.run(main()) ``` -1. これはコンテキスト オブジェクトです。ここでは dataclass を使用していますが、任意の型を利用できます。 -2. これはツールです。`RunContextWrapper[UserInfo]` を受け取ることが分かります。ツール実装はコンテキストからデータを読み取ります。 -3. エージェントにジェネリック型 `UserInfo` を指定し、型チェッカーがエラーを検出できるようにしています（例: 異なるコンテキスト型を取るツールを渡そうとした場合など）。 +1. これはコンテキストオブジェクトです。ここでは dataclass を使用していますが、任意の型を利用できます。 +2. これはツールです。`RunContextWrapper[UserInfo]` を受け取り、実装内でコンテキストを参照しています。 +3. エージェントをジェネリック型 `UserInfo` でマークすることで、型チェッカーが (異なるコンテキスト型を持つツールを渡した場合などの) エラーを検出できます。 4. `run` 関数にコンテキストを渡します。 5. エージェントはツールを正しく呼び出し、年齢を取得します。 -## エージェント / LLM コンテキスト +## エージェント／LLM コンテキスト -LLM が呼び出されるとき、LLM が参照できるデータは会話履歴からのみ取得されます。そのため、新しいデータを LLM に渡したい場合は、履歴に含める形で提供する必要があります。主な方法は以下のとおりです。 +LLM が呼び出されるとき、LLM が参照できるデータは会話履歴に含まれるものだけです。そのため、新しいデータを LLM に提供したい場合は、そのデータを履歴に含める必要があります。主な方法は次のとおりです。 -1. エージェントの `instructions` に追加する。これは「system prompt」や「developer message」とも呼ばれます。システム プロンプトは静的な文字列でも、コンテキストを受け取って文字列を返す動的関数でも構いません。ユーザー名や現在の日付など、常に有用な情報を渡す際によく使われます。 -2. `Runner.run` を呼び出す際の `input` に追加する。この方法は `instructions` と似ていますが、[chain of command](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command) 上で下位に位置するメッセージを扱える点が異なります。 -3. 関数ツール経由で公開する。これはオンデマンドのコンテキストに適しており、LLM が必要になったタイミングでツールを呼び出してデータを取得できます。 -4. リトリーバルまたは Web 検索を使用する。これらはファイルやデータベース（リトリーバル）、あるいは Web（Web 検索）から関連データを取得できる特殊なツールです。回答を関連するコンテキスト データに「グラウンディング」するのに役立ちます。 \ No newline at end of file +1. エージェントの `instructions` に追加する。これは「system prompt」や「developer message」とも呼ばれます。システムプロンプトは静的文字列でも、コンテキストを受け取って文字列を返す動的関数でもかまいません。ユーザー名や現在の日付のように常に役立つ情報を渡す定番の手法です。 +2. `Runner.run` を呼び出す際の `input` に追加する。`instructions` と似ていますが、[chain of command](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command) 上でより下位にメッセージを配置できます。 +3. 関数ツール経由で公開する。これはオンデマンドのコンテキストに便利です。LLM が必要になったときにツールを呼び出してデータを取得できます。 +4. リトリーバルや Web 検索を利用する。これらはファイルやデータベースから関連データを取得する (リトリーバル) 、あるいは Web から取得する (Web 検索) 特殊なツールです。関連するコンテキストデータで応答を「グラウンディング」する際に有効です。 \ No newline at end of file diff --git a/docs/ja/examples.md b/docs/ja/examples.md index 177729613..e0480f5bb 100644 --- a/docs/ja/examples.md +++ b/docs/ja/examples.md @@ -4,45 +4,41 @@ search: --- # コード例 -[リポジトリ](https://github.com/openai/openai-agents-python/tree/main/examples) の examples セクションには、 SDK のさまざまなサンプル実装が用意されています。これらのコード例は、異なるパターンや機能を示す複数のカテゴリーに整理されています。 - +さまざまな SDK の実装サンプルは、[リポジトリ](https://github.com/openai/openai-agents-python/tree/main/examples)の examples セクションでご覧いただけます。これらのコード例は、異なるパターンと機能を示す複数のカテゴリーに整理されています。 ## カテゴリー - **[agent_patterns](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns):** - このカテゴリーのコード例では、一般的なエージェント設計パターンを紹介しています。例: - - - 決定的ワークフロー - - エージェントをツールとして利用 - - エージェントの並列実行 + このカテゴリーでは、一般的な エージェント の設計パターンを示しています。 + - 決定論的ワークフロー + - ツールとしてのエージェント + - エージェント の並列実行 - **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** - ここでは、以下のような SDK の基礎的な機能を紹介しています。例: - - - 動的なシステムプロンプト - - ストリーミング出力 - - ライフサイクルイベント + このカテゴリーでは、SDK の基本的な機能を紹介します。 + - 動的な システムプロンプト + - ストリーミング出力 + - ライフサイクルイベント - **[tool examples](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** - Web 検索やファイル検索など、 OpenAI がホストするツールの実装方法と、それらをエージェントに統合する方法を学べます。 + Web 検索やファイル検索といった OpenAI がホストするツールの実装方法と、それらを エージェント に統合する方法を学べます。 - **[model providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** - OpenAI 以外のモデルを SDK と併用する方法を探求できます。 + OpenAI 以外のモデルを SDK で利用する方法を紹介します。 - **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** - エージェントのハンドオフに関する実践的なコード例です。 + エージェント ハンドオフの実践的な例をご覧いただけます。 - **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** - MCP を用いたエージェントの構築方法を学べます。 + MCP を使った エージェント の構築方法を学べます。 - **[customer_service](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service)** と **[research_bot](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):** - 実際のユースケースを想定した、より充実した 2 つのコード例 - - - **customer_service**: 航空会社向けのカスタマーサービスシステム例 - - **research_bot**: シンプルなディープリサーチ クローン + 実際のユースケースを想定した、さらに作り込まれた 2 つの例です。 + - **customer_service**: 航空会社向けカスタマーサービス システムの例。 + - **research_bot**: シンプルな ディープリサーチ クローン。 - **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** - TTS と STT モデルを利用した音声エージェントのコード例です。 + TTS および STT モデルを使用した音声 エージェント の例をご覧いただけます。 - **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** - SDK を用いてリアルタイム体験を構築する方法を示すコード例です。 \ No newline at end of file + SDK を使ってリアルタイム体験を構築する方法を示す例です。 \ No newline at end of file diff --git a/docs/ja/guardrails.md b/docs/ja/guardrails.md index 4b20832c1..f344c4be2 100644 --- a/docs/ja/guardrails.md +++ b/docs/ja/guardrails.md @@ -4,44 +4,44 @@ search: --- # ガードレール -ガードレール は エージェント と _並行して_ 実行され、ユーザー 入力のチェックおよびバリデーションを行えます。たとえば、とても賢い（つまり遅く / 高価な）モデルを使ってカスタマーリクエストを処理する エージェント があるとします。悪意のあるユーザーがモデルに数学の宿題を手伝わせようとするのは避けたいでしょう。そこで、速く / 安価なモデルでガードレールを実行できます。ガードレールが悪意のある利用を検出した場合、直ちにエラーを送出し、高価なモデルの実行を停止して時間とコストを節約します。 +ガードレールは エージェント と _並列_ で動作し、ユーザー入力のチェックとバリデーションを行えます。たとえば、とても高性能 (そのぶん遅く / 高価) なモデルを使って顧客対応を行うエージェントがあるとします。悪意のある ユーザー がそのモデルに数学の宿題を解かせようとした場合、高価なモデルを無駄に動かしたくありません。そこで、低コスト / 高速なモデルを使ったガードレールを事前に実行し、悪用を検知したらただちにエラーを発生させることで、時間とコストを節約できます。 ガードレールには 2 種類あります: -1. 入力ガードレール は最初のユーザー入力で実行されます -2. 出力ガードレール は最終的なエージェントの出力で実行されます +1. 入力ガードレール: 最初のユーザー入力に対して実行されます +2. 出力ガードレール: 最終的なエージェント出力に対して実行されます ## 入力ガードレール -入力ガードレールは 3 ステップで実行されます: +入力ガードレールは 3 ステップで動作します: 1. まず、ガードレールはエージェントに渡されたものと同じ入力を受け取ります。 -2. 次に、ガードレール関数が実行され、[`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput] を生成し、それを [`InputGuardrailResult`][agents.guardrail.InputGuardrailResult] でラップします。 -3. 最後に [`.tripwire_triggered`][agents.guardrail.GuardrailFunctionOutput.tripwire_triggered] が true かどうかを確認します。true の場合、[`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered] 例外が送出され、ユーザーへの適切な応答や例外処理を行えます。 +2. 次に、ガードレール関数が実行され [`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput] を生成し、それを [`InputGuardrailResult`][agents.guardrail.InputGuardrailResult] でラップします。 +3. 最後に [`.tripwire_triggered`][agents.guardrail.GuardrailFunctionOutput.tripwire_triggered] が true かどうかを確認します。true の場合、[`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered] 例外が発生し、適切に ユーザー へ応答するか例外を処理できます。 !!! Note - 入力ガードレールはユーザー入力に対して実行されることを想定しているため、エージェントが *最初の* エージェントの場合にのみ実行されます。「guardrails」プロパティをエージェントに持たせるのではなく `Runner.run` に渡す形にしない理由は？ガードレールは実際のエージェントと密接に関連していることが多く、エージェントごとに異なるガードレールを実行するため、コードを同じ場所に置く方が可読性に優れるからです。 + 入力ガードレールはユーザー入力に対して実行されることを想定しているため、ガードレールは *最初* のエージェントの場合にのみ実行されます。「なぜ `guardrails` プロパティがエージェント側にあり、`Runner.run` に渡さないのか」と疑問に思うかもしれません。これはガードレールが実際のエージェントと密接に関連しているためです。エージェントごとに異なるガードレールを実行することが多く、コードを同じ場所に置いたほうが可読性が高まります。 ## 出力ガードレール -出力ガードレールは 3 ステップで実行されます: +出力ガードレールは 3 ステップで動作します: 1. まず、ガードレールはエージェントが生成した出力を受け取ります。 -2. 次に、ガードレール関数が実行され、[`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput] を生成し、それを [`OutputGuardrailResult`][agents.guardrail.OutputGuardrailResult] でラップします。 -3. 最後に [`.tripwire_triggered`][agents.guardrail.GuardrailFunctionOutput.tripwire_triggered] が true かどうかを確認します。true の場合、[`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered] 例外が送出され、ユーザーへの適切な応答や例外処理を行えます。 +2. 次に、ガードレール関数が実行され [`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput] を生成し、それを [`OutputGuardrailResult`][agents.guardrail.OutputGuardrailResult] でラップします。 +3. 最後に [`.tripwire_triggered`][agents.guardrail.GuardrailFunctionOutput.tripwire_triggered] が true かどうかを確認します。true の場合、[`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered] 例外が発生し、適切に ユーザー へ応答するか例外を処理できます。 !!! Note - 出力ガードレールは最終的なエージェント出力に対して実行されることを想定しているため、エージェントが *最後の* エージェントの場合にのみ実行されます。入力ガードレールと同様に、ガードレールは実際のエージェントと密接に関連しているため、コードを同じ場所に置く方が可読性に優れます。 + 出力ガードレールは最終的なエージェント出力に対して実行されることを想定しているため、ガードレールは *最後* のエージェントの場合にのみ実行されます。入力ガードレールと同様に、ガードレールはエージェントごとに異なることが多いため、コードを同じ場所に置いたほうが可読性が高まります。 -## トリップワイヤ +## トリップワイヤー -入力あるいは出力がガードレールを通過できなかった場合、ガードレールはトリップワイヤでその旨を通知できます。トリップワイヤが起動したガードレールを検出するとすぐに `{Input,Output}GuardrailTripwireTriggered` 例外を送出し、エージェントの実行を停止します。 +入力または出力がガードレール検査に失敗した場合、ガードレールはトリップワイヤーでそれを通知できます。トリップワイヤーが発火したガードレールを検知した時点で、ただちに `{Input,Output}GuardrailTripwireTriggered` 例外を発生させ、エージェントの実行を停止します。 ## ガードレールの実装 -入力を受け取り、[`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput] を返す関数を用意する必要があります。この例では、内部でエージェントを実行してこれを行います。 +入力を受け取り、[`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput] を返す関数を用意する必要があります。この例では、そのために内部でエージェントを実行します。 ```python from pydantic import BaseModel @@ -95,9 +95,9 @@ async def main(): ``` 1. このエージェントをガードレール関数内で使用します。 -2. これはエージェントの入力 / コンテキストを受け取り、結果を返すガードレール関数です。 +2. ここがガードレール関数で、エージェントの入力 / コンテキストを受け取り、結果を返します。 3. ガードレール結果に追加情報を含めることもできます。 -4. これはワークフローを定義する実際のエージェントです。 +4. ワークフローを定義する実際のエージェントです。 出力ガードレールも同様です。 @@ -154,5 +154,5 @@ async def main(): 1. これは実際のエージェントの出力型です。 2. これはガードレールの出力型です。 -3. これはエージェントの出力を受け取り、結果を返すガードレール関数です。 -4. これはワークフローを定義する実際のエージェントです。 \ No newline at end of file +3. ここがガードレール関数で、エージェントの出力を受け取り、結果を返します。 +4. ワークフローを定義する実際のエージェントです。 \ No newline at end of file diff --git a/docs/ja/handoffs.md b/docs/ja/handoffs.md index 5e55ddc49..e23cf51ae 100644 --- a/docs/ja/handoffs.md +++ b/docs/ja/handoffs.md @@ -4,19 +4,19 @@ search: --- # ハンドオフ -ハンドオフを使用すると、あるエージェントが別のエージェントにタスクを委譲できます。これは、異なるエージェントがそれぞれ得意分野を持っている場面で特に有用です。たとえば、カスタマーサポートアプリでは、注文状況・返金・FAQ などをそれぞれ担当するエージェントを用意することがあります。 +ハンドオフを使用すると、あるエージェントがタスクを別のエージェントへ委任できます。これは、異なるエージェントがそれぞれ得意分野を持つシナリオで特に有用です。たとえばカスタマーサポート アプリでは、注文状況、返金、FAQ などをそれぞれ担当するエージェントが存在する場合があります。 -ハンドオフは LLM からはツールとして扱われます。したがって `Refund Agent` というエージェントへのハンドオフがある場合、ツール名は `transfer_to_refund_agent` となります。 +ハンドオフは、 LLM にとってツールとして表現されます。たとえば `Refund Agent` というエージェントへハンドオフする場合、そのツール名は `transfer_to_refund_agent` になります。 ## ハンドオフの作成 -すべてのエージェントには `handoffs` パラメーターがあり、ここには `Agent` を直接渡すことも、ハンドオフをカスタマイズした `Handoff` オブジェクトを渡すこともできます。 +すべてのエージェントには [`handoffs`][agents.agent.Agent.handoffs] というパラメーターがあり、 `Agent` を直接渡すことも、ハンドオフをカスタマイズする ` Handoff ` オブジェクトを渡すこともできます。 -Agents SDK が提供する `handoff()` 関数を使ってハンドオフを作成できます。この関数では、委譲先のエージェントを指定できるほか、各種オーバーライドや入力フィルターも設定できます。 +Agents SDK が提供する [`handoff()`][agents.handoffs.handoff] 関数を使用してハンドオフを作成できます。この関数では、ハンドオフ先のエージェントに加え、オーバーライドや入力フィルターをオプションで指定できます。 ### 基本的な使い方 -シンプルなハンドオフの作成例は次のとおりです。 +以下はシンプルなハンドオフの例です。 ```python from agents import Agent, handoff @@ -28,18 +28,18 @@ refund_agent = Agent(name="Refund agent") triage_agent = Agent(name="Triage agent", handoffs=[billing_agent, handoff(refund_agent)]) ``` -1. `billing_agent` のようにエージェントを直接渡す方法と、`handoff()` 関数を使う方法のどちらも利用できます。 +1. `billing_agent` のようにエージェントを直接指定するか、 `handoff()` 関数を使用できます。 ### `handoff()` 関数によるハンドオフのカスタマイズ -`handoff()` 関数では、さまざまなカスタマイズが可能です。 +[`handoff()`][agents.handoffs.handoff] 関数では、次の項目をカスタマイズできます。 -- `agent`: タスクを委譲するエージェント。 -- `tool_name_override`: 既定では `Handoff.default_tool_name()` が使用され、`transfer_to_` に評価されます。ここを上書きできます。 -- `tool_description_override`: `Handoff.default_tool_description()` によるデフォルトのツール説明を上書きします。 -- `on_handoff`: ハンドオフ実行時に呼び出されるコールバック関数。ハンドオフが呼び出された瞬間にデータ取得を開始するなどに便利です。この関数はエージェントコンテキストを受け取り、オプションで LLM が生成した入力も受け取れます。この入力データは `input_type` パラメーターで制御します。 -- `input_type`: ハンドオフで期待される入力の型（任意）。 -- `input_filter`: 次のエージェントが受け取る入力をフィルターできます。詳細は後述します。 +- `agent` : ハンドオフ先のエージェントです。 +- `tool_name_override` : 既定では ` Handoff.default_tool_name()` が使用され、 `transfer_to_` に解決されます。これを上書きできます。 +- `tool_description_override` : ` Handoff.default_tool_description()` による既定のツール説明を上書きします。 +- `on_handoff` : ハンドオフが呼び出されたときに実行されるコールバック関数です。ハンドオフが発生した時点でデータ取得を開始するなどの用途に便利です。この関数はエージェント コンテキストを受け取り、オプションで LLM が生成した入力も受け取れます。入力データは `input_type` パラメーターで制御されます。 +- `input_type` : ハンドオフが想定する入力の型（オプション）です。 +- `input_filter` : 次のエージェントが受け取る入力をフィルタリングできます。詳細は後述します。 ```python from agents import Agent, handoff, RunContextWrapper @@ -59,7 +59,7 @@ handoff_obj = handoff( ## ハンドオフ入力 -状況によっては、LLM がハンドオフを呼び出す際に何らかのデータを渡してほしい場合があります。たとえば「Escalation agent（エスカレーション エージェント）」へのハンドオフでは、ログ用に理由を渡してもらいたいかもしれません。 +状況によっては、 LLM にハンドオフを呼び出す際にデータを渡してほしい場合があります。たとえば「エスカレーション エージェント」へハンドオフする場合、理由を渡してログに残せるようにしたいかもしれません。 ```python from pydantic import BaseModel @@ -83,9 +83,9 @@ handoff_obj = handoff( ## 入力フィルター -ハンドオフが行われると、新しいエージェントが会話を引き継ぎ、以前の会話履歴をすべて閲覧できる状態になります。これを変更したい場合は `input_filter` を設定してください。入力フィルターは `HandoffInputData` として渡された既存の入力を受け取り、新しい `HandoffInputData` を返す関数です。 +ハンドオフが発生すると、新しいエージェントが会話を引き継ぎ、これまでの会話履歴全体を閲覧できます。これを変更したい場合は、 [`input_filter`][agents.handoffs.Handoff.input_filter] を設定できます。入力フィルターは [` HandoffInputData`][agents.handoffs.HandoffInputData] を受け取り、新しい ` HandoffInputData` を返す関数です。 -よくあるパターン（履歴からすべてのツール呼び出しを削除するなど）は、`agents.extensions.handoff_filters` に実装済みです。 +よくあるパターン（たとえば履歴からすべてのツール呼び出しを削除するなど）は [`agents.extensions.handoff_filters`][] に実装されています。 ```python from agents import Agent, handoff @@ -99,11 +99,11 @@ handoff_obj = handoff( ) ``` -1. これにより `FAQ agent` が呼び出された際に、履歴からすべてのツール呼び出しが自動的に削除されます。 +1. これにより、 `FAQ agent` が呼び出されたときに履歴からすべてのツールが自動的に削除されます。 ## 推奨プロンプト -LLM がハンドオフを正しく理解できるよう、エージェント内にハンドオフに関する情報を含めることを推奨します。`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX` に推奨のプリフィックスが用意されているほか、`agents.extensions.handoff_prompt.prompt_with_handoff_instructions` を呼び出すことで推奨情報をプロンプトに自動追加できます。 + LLM がハンドオフを正しく理解できるよう、エージェントにハンドオフに関する情報を含めることを推奨します。 [`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX`][] に提案するプレフィックスが用意されているほか、 [`agents.extensions.handoff_prompt.prompt_with_handoff_instructions`][] を呼び出して、推奨されるデータを自動的にプロンプトへ追加することもできます。 ```python from agents import Agent diff --git a/docs/ja/index.md b/docs/ja/index.md index e077c29aa..f11349271 100644 --- a/docs/ja/index.md +++ b/docs/ja/index.md @@ -4,39 +4,39 @@ search: --- # OpenAI Agents SDK -[OpenAI Agents SDK](https://github.com/openai/openai-agents-python) は、非常に少ない抽象化で軽量かつ使いやすいパッケージとして、エージェント指向の AI アプリを構築できるツールです。これは、以前のエージェント向け実験的プロジェクトである [Swarm](https://github.com/openai/swarm/tree/main) を、本番環境向けにアップグレードしたものです。Agents SDK にはごく少数の基本コンポーネントがあります。 +[OpenAI Agents SDK](https://github.com/openai/openai-agents-python) は、ごく少ない抽象化で軽量かつ使いやすいパッケージとして、エージェント指向の AI アプリを構築できる SDK です。これは、以前のエージェント向け実験プロジェクト [Swarm](https://github.com/openai/swarm/tree/main) を、プロダクションレベルにアップグレードしたものです。Agents SDK には、ごく少数の basic components（プリミティブ）が含まれています: -- **エージェント**: instructions と tools を備えた LLM -- **ハンドオフ**: 特定タスクを他のエージェントへ委任する仕組み -- **ガードレール**: エージェントへの入力を検証する仕組み -- **セッション**: エージェント実行間で会話履歴を自動的に保持 +- **Agents**: instructions と tools を備えた LLM +- **Handoffs**: 特定のタスクを別のエージェントへ委任する仕組み +- **Guardrails**: エージェントへの入力を検証する仕組み +- **Sessions**: エージェント実行間で会話履歴を自動的に保持 -Python と組み合わせることで、これらの基本コンポーネントはツールとエージェント間の複雑な関係を表現でき、急な学習コストなしに実用的なアプリケーションを構築できます。さらに、SDK には **トレーシング** が組み込まれており、エージェントフローの可視化やデバッグ、評価、さらにはアプリ固有のモデルのファインチューニングも行えます。 + Python と組み合わせることで、これらのプリミティブは tools とエージェント間の複雑な関係を十分に表現でき、急な学習曲線なしで実世界のアプリケーションを構築できます。さらに、SDK には **tracing** が組み込まれており、エージェントフローを可視化・デバッグできるほか、評価やモデルのファインチューニングにも利用できます。 ## Agents SDK を使用する理由 -SDK の設計には 2 つの原則があります。 +SDK には次の 2 つの設計原則があります。 -1. 学ぶ価値のある十分な機能を備えつつ、覚えるべきコンポーネント数は最小限に抑える。 -2. そのままでも優れた体験を提供しつつ、処理内容を細かくカスタマイズできる。 +1. 利用する価値があるだけの機能を備えつつ、プリミティブを最小限に抑え、学習を迅速にする。 +2. デフォルトで十分に機能するが、動作を細かくカスタマイズできる。 -主な特徴は次のとおりです。 +SDK の主な機能は次のとおりです。 -- エージェントループ: tools の呼び出し、結果を LLM へ送信、LLM が完了するまでループ処理を自動で実行。 -- Python ファースト: 新しい抽象を学習することなく、Python の言語機能でエージェントをオーケストレーションおよび連鎖。 -- ハンドオフ: 複数エージェント間の調整と委任を可能にする強力な機能。 -- ガードレール: エージェントと並行して入力検証を実行し、チェック失敗時には早期終了。 -- セッション: エージェント実行間の会話履歴を自動管理し、手動での状態管理を排除。 -- 関数ツール: 任意の Python 関数を自動スキーマ生成と Pydantic 検証付きの tool へ変換。 -- トレーシング: ワークフローの可視化・デバッグ・監視だけでなく、OpenAI の評価、ファインチューニング、蒸留ツールも利用可能。 +- Agent ループ: tools の呼び出し、結果を LLM へ送信、LLM が完了するまでループする処理を内蔵。 +- Python ファースト: 新しい抽象概念を学ぶことなく、組み込みの言語機能でエージェントをオーケストレーション・連鎖。 +- Handoffs: 複数のエージェント間で調整・委任を行う強力な機能。 +- Guardrails: エージェントと並行して入力検証を実行し、チェック失敗時には早期に処理を中断。 +- Sessions: エージェント実行間の会話履歴を自動管理し、手動での状態管理を排除。 +- Function tools: 任意の Python 関数を tool に変換し、スキーマを自動生成。Pydantic によるバリデーションもサポート。 +- Tracing: ワークフローを可視化・デバッグ・モニタリングできる tracing を内蔵し、OpenAI の評価・ファインチューニング・蒸留ツールも利用可能。 -## インストール +## Installation ```bash pip install openai-agents ``` -## Hello World 例 +## Hello world example ```python from agents import Agent, Runner @@ -51,7 +51,7 @@ print(result.final_output) # Infinite loop's dance. ``` -(_実行の際は `OPENAI_API_KEY` 環境変数を設定してください_) +(_実行する場合は、`OPENAI_API_KEY` 環境変数を設定してください_) ```bash export OPENAI_API_KEY=sk-... diff --git a/docs/ja/mcp.md b/docs/ja/mcp.md index 69d45fa73..9a928623e 100644 --- a/docs/ja/mcp.md +++ b/docs/ja/mcp.md @@ -2,25 +2,25 @@ search: exclude: true --- -# Model context protocol (MCP) +# モデルコンテキストプロトコル (MCP) -[Model context protocol](https://modelcontextprotocol.io/introduction)（別名 MCP）は、 LLM にツールとコンテキストを提供する方法です。MCP ドキュメントによると: +[Model context protocol](https://modelcontextprotocol.io/introduction)（略称 MCP）は、 LLM にツールとコンテキストを提供する方法です。MCP のドキュメントからの引用です。 -> MCP は、アプリケーションが LLMs にコンテキストを提供する方法を標準化するオープンプロトコルです。MCP を AI アプリケーション向けの USB-C ポートのようなものと考えてください。USB-C がデバイスをさまざまな周辺機器やアクセサリに接続する標準化された方法を提供するのと同様に、MCP は AI モデルを異なるデータソースやツールに接続する標準化された方法を提供します。 +> MCP は、アプリケーションが LLM にコンテキストを渡す方法を標準化するオープンプロトコルです。MCP を AI アプリケーション向けの USB-C ポートのように考えてください。USB-C がデバイスをさまざまな周辺機器やアクセサリに接続するための標準化された方法を提供するのと同様に、MCP は AI モデルを異なるデータソースやツールに接続するための標準化された方法を提供します。 -Agents SDK は MCP をサポートしています。これにより、幅広い MCP サーバーを使用してエージェントにツールやプロンプトを提供できます。 +Agents SDK は MCP をサポートしています。これにより、幅広い MCP サーバーを利用してエージェントにツールやプロンプトを提供できます。 ## MCP サーバー -現在、MCP 仕様では使用するトランスポートメカニズムに基づき、3 種類のサーバーが定義されています: +現在、 MCP 仕様では使用するトランスポートメカニズムに応じて 3 種類のサーバーが定義されています。 -1. **stdio** サーバー: アプリケーションのサブプロセスとして実行されます。ローカルで動作していると考えてください。 -2. **HTTP over SSE** サーバー: リモートで実行され、URL で接続します。 -3. **Streamable HTTP** サーバー: MCP 仕様で定義された Streamable HTTP トランスポートを用いてリモートで実行されます。 +1. **stdio** サーバー: アプリケーションのサブプロセスとして実行されます。ローカルで動作していると考えることができます。 +2. **HTTP over SSE** サーバー: リモートで実行され、 URL で接続します。 +3. **Streamable HTTP** サーバー: MCP 仕様で定義されている Streamable HTTP トランスポートを使用してリモートで実行されます。 -これらのサーバーへは [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]、[`MCPServerSse`][agents.mcp.server.MCPServerSse]、[`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] クラスを使って接続できます。 +これらのサーバーへは [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]、 [`MCPServerSse`][agents.mcp.server.MCPServerSse]、 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] クラスを使用して接続できます。 -たとえば、[公式 MCP ファイルシステムサーバー](https://www.npmjs.com/package/@modelcontextprotocol/server-filesystem) を利用する場合は次のようになります。 +たとえば、公式の MCP ファイルシステムサーバー を使用する場合は次のようになります。 ```python from agents.run_context import RunContextWrapper @@ -41,7 +41,7 @@ async with MCPServerStdio( ## MCP サーバーの利用 -MCP サーバーはエージェントに追加できます。Agents SDK はエージェント実行時に毎回 MCP サーバーの `list_tools()` を呼び出し、 LLM に MCP サーバーのツールを認識させます。 LLM が MCP サーバーのツールを呼び出すと、SDK はサーバーの `call_tool()` を実行します。 +MCP サーバーはエージェントに追加できます。 Agents SDK はエージェントが実行されるたびに MCP サーバーの `list_tools()` を呼び出し、 LLM に MCP サーバーのツールを認識させます。 LLM が MCP サーバーのツールを呼び出すと、 SDK はそのサーバーの `call_tool()` を実行します。 ```python @@ -54,11 +54,11 @@ agent=Agent( ## ツールフィルタリング -MCP サーバーでツールフィルターを設定すると、エージェントが利用できるツールを制限できます。SDK は静的および動的フィルタリングの両方をサポートしています。 +MCP サーバーにツールフィルターを設定することで、エージェントが利用可能なツールを制限できます。 SDK は静的および動的の両方のツールフィルタリングをサポートします。 ### 静的ツールフィルタリング -単純な許可 / ブロックリストには静的フィルタリングを使用できます: +単純な許可 / ブロックリストであれば、静的フィルタリングを利用できます。 ```python from agents.mcp import create_static_tool_filter @@ -87,15 +87,15 @@ server = MCPServerStdio( ``` -**`allowed_tool_names` と `blocked_tool_names` の両方が設定されている場合の処理順序:** -1. まず `allowed_tool_names`（許可リスト）を適用し、指定したツールのみを残します -2. 次に `blocked_tool_names`（ブロックリスト）を適用し、残ったツールから指定したツールを除外します +**`allowed_tool_names` と `blocked_tool_names` の両方を設定した場合の処理順は次のとおりです。** +1. まず `allowed_tool_names`（許可リスト）を適用し、指定されたツールのみを残します +2. 次に `blocked_tool_names`（ブロックリスト）を適用し、残ったツールから指定されたツールを除外します -たとえば `allowed_tool_names=["read_file", "write_file", "delete_file"]` と `blocked_tool_names=["delete_file"]` を設定すると、利用可能なのは `read_file` と `write_file` だけになります。 +たとえば `allowed_tool_names=["read_file", "write_file", "delete_file"]` と `blocked_tool_names=["delete_file"]` を設定した場合、利用可能なのは `read_file` と `write_file` のみになります。 ### 動的ツールフィルタリング -より複雑なロジックが必要な場合は、関数を使った動的フィルターを利用できます: +より複雑なフィルタリングロジックが必要な場合は、関数を使った動的フィルターを使用できます。 ```python from agents.mcp import ToolFilterContext @@ -134,21 +134,20 @@ server = MCPServerStdio( ) ``` -`ToolFilterContext` では次の情報にアクセスできます: -- `run_context`: 現在の実行コンテキスト -- `agent`: ツールを要求しているエージェント -- `server_name`: MCP サーバー名 +`ToolFilterContext` では次の情報にアクセスできます。 +- `run_context`: 現在の実行コンテキスト +- `agent`: ツールを要求しているエージェント +- `server_name`: MCP サーバー名 ## プロンプト -MCP サーバーは、agent instructions を動的に生成できるプロンプトも提供します。これにより、パラメーターでカスタマイズ可能な再利用可能な instruction テンプレートを作成できます。 +MCP サーバーは、エージェントの instructions を動的に生成するためのプロンプトも提供できます。これにより、パラメーターでカスタマイズ可能な再利用可能な instructions テンプレートを作成できます。 ### プロンプトの利用 -プロンプトをサポートする MCP サーバーは、次の 2 つの主要メソッドを提供します: - -- `list_prompts()`: サーバー上のすべてのプロンプトを一覧表示 -- `get_prompt(name, arguments)`: 任意のパラメーター付きで特定のプロンプトを取得 +プロンプトをサポートする MCP サーバーは次の 2 つの主要メソッドを提供します。 +- `list_prompts()`: サーバー上で利用可能なすべてのプロンプトを一覧表示します +- `get_prompt(name, arguments)`: 任意のパラメーターとともに指定したプロンプトを取得します ```python # List available prompts @@ -173,19 +172,18 @@ agent = Agent( ## キャッシュ -エージェントが実行されるたびに、MCP サーバーの `list_tools()` が呼ばれます。サーバーがリモートの場合、これはレイテンシーの原因になります。ツール一覧を自動でキャッシュするには、[`MCPServerStdio`][agents.mcp.server.MCPServerStdio]、[`MCPServerSse`][agents.mcp.server.MCPServerSse]、[`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] に `cache_tools_list=True` を渡します。ツール一覧が変更されないと確信できる場合のみ実行してください。 +エージェントが実行されるたびに、 MCP サーバーの `list_tools()` が呼び出されます。サーバーがリモートの場合は特に、これがレイテンシの要因になることがあります。ツール一覧を自動でキャッシュするには、 [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]、 [`MCPServerSse`][agents.mcp.server.MCPServerSse]、 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] に `cache_tools_list=True` を渡してください。ツール一覧が変化しないことが確実な場合のみ使用してください。 キャッシュを無効化したい場合は、サーバーの `invalidate_tools_cache()` を呼び出します。 -## End-to-end コード例 +## エンドツーエンドのコード例 [examples/mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp) で完全な動作例をご覧いただけます。 ## トレーシング -[Tracing](./tracing.md) を使用すると、MCP 操作が自動的に記録されます。対象は次のとおりです: - -1. MCP サーバーへのツール一覧要求 -2. 関数呼び出しに関する MCP 関連情報 +[トレーシング](./tracing.md) では MCP の操作を自動で記録します。具体的には次の情報が含まれます。 +1. MCP サーバーへのツール一覧取得呼び出し +2. 関数呼び出しに関する MCP 関連情報 ![MCP Tracing Screenshot](../assets/images/mcp-tracing.jpg) \ No newline at end of file diff --git a/docs/ja/models/index.md b/docs/ja/models/index.md index 04c7d99e8..54a9fb332 100644 --- a/docs/ja/models/index.md +++ b/docs/ja/models/index.md @@ -4,51 +4,54 @@ search: --- # モデル -Agents SDK には、すぐに使える 2 種類の OpenAI モデル対応が含まれています。 +Agents SDK には、OpenAI モデルをすぐに利用できる２種類のサポートがあります。 -- **推奨**: [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] — 新しい [Responses API](https://platform.openai.com/docs/api-reference/responses) を使用して OpenAI API を呼び出します。 -- [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] — [Chat Completions API](https://platform.openai.com/docs/api-reference/chat) を使用して OpenAI API を呼び出します。 +- **推奨**: [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] は、新しい [Responses API](https://platform.openai.com/docs/api-reference/responses) を使用して OpenAI API を呼び出します。 +- [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] は、[Chat Completions API](https://platform.openai.com/docs/api-reference/chat) を使用して OpenAI API を呼び出します。 ## 非 OpenAI モデル -ほとんどの非 OpenAI モデルは [LiteLLM インテグレーション](./litellm.md) 経由で利用できます。まず、litellm 依存グループをインストールしてください。 +ほとんどの非 OpenAI モデルは、[LiteLLM 統合](./litellm.md) を利用して使用できます。まず、litellm の依存関係グループをインストールします。 ```bash pip install "openai-agents[litellm]" ``` -その後、`litellm/` プレフィックスを付けて [サポートされているモデル](https://docs.litellm.ai/docs/providers) を指定します。 +次に、`litellm/` プレフィックスを付けて任意の [サポートされているモデル](https://docs.litellm.ai/docs/providers) を利用します。 ```python claude_agent = Agent(model="litellm/anthropic/claude-3-5-sonnet-20240620", ...) gemini_agent = Agent(model="litellm/gemini/gemini-2.5-flash-preview-04-17", ...) ``` -### 非 OpenAI モデルを利用するその他の方法 +### 非 OpenAI モデルを使用するその他の方法 -他の LLM プロバイダーを統合する方法はさらに 3 つあります（[こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/) に code examples あり）。 +他の LLM プロバイダーを統合する方法は、さらに３つあります（コード例は [こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)）。 -1. [`set_default_openai_client`][agents.set_default_openai_client] — `AsyncOpenAI` インスタンスを LLM クライアントとしてグローバルに使用したい場合に便利です。LLM プロバイダーが OpenAI 互換 API エンドポイントを持ち、`base_url` と `api_key` を設定できるケース向けです。設定例は [examples/model_providers/custom_example_global.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_global.py) をご覧ください。 -2. [`ModelProvider`][agents.models.interface.ModelProvider] — `Runner.run` レベルで指定できます。「この run 内のすべての エージェント ではカスタムモデルプロバイダーを使う」といった指定が可能です。設定例は [examples/model_providers/custom_example_provider.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_provider.py) をご覧ください。 -3. [`Agent.model`][agents.agent.Agent.model] — 特定の Agent インスタンスにモデルを指定できます。これにより、エージェントごとに異なるプロバイダーを混在させることができます。設定例は [examples/model_providers/custom_example_agent.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_agent.py) をご覧ください。ほとんどのモデルを簡単に利用するには [LiteLLM インテグレーション](./litellm.md) が便利です。 +1. [`set_default_openai_client`][agents.set_default_openai_client] + `AsyncOpenAI` のインスタンスを LLM クライアントとしてグローバルに使用したい場合に便利です。LLM プロバイダーが OpenAI 互換の API エンドポイントを持ち、`base_url` と `api_key` を設定できる場合にご利用ください。設定例は [examples/model_providers/custom_example_global.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_global.py) を参照してください。 -`platform.openai.com` の API キーをお持ちでない場合は、`set_tracing_disabled()` でトレーシングを無効化するか、[別のトレーシング プロセッサー](../tracing.md) を設定することをおすすめします。 +2. [`ModelProvider`][agents.models.interface.ModelProvider] + `Runner.run` レベルで指定します。実行中のすべての エージェント に対してカスタムモデルプロバイダーを使用できます。設定例は [examples/model_providers/custom_example_provider.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_provider.py) を参照してください。 -!!! note +3. [`Agent.model`][agents.agent.Agent.model] + 個々の Agent インスタンスにモデルを指定できます。エージェントごとに異なるプロバイダーを組み合わせることが可能です。設定例は [examples/model_providers/custom_example_agent.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_agent.py) を参照してください。多くのモデルを簡単に使用する方法として、[LiteLLM 統合](./litellm.md) もご活用いただけます。 + +`platform.openai.com` の API キーをお持ちでない場合は、`set_tracing_disabled()` でトレーシングを無効化するか、[別のトレーシングプロセッサー](../tracing.md) を設定することを推奨します。 - これらの例では Chat Completions API/モデルを使用しています。多くの LLM プロバイダーがまだ Responses API をサポートしていないためです。もしお使いの LLM プロバイダーが Responses API をサポートしている場合は、Responses を使用することを推奨します。 +!!! note + これらの例では、ほとんどの LLM プロバイダーが Responses API をまだサポートしていないため、Chat Completions API／モデルを使用しています。ご利用の LLM プロバイダーが Responses API をサポートしている場合は、Responses の利用をお勧めします。 ## モデルの組み合わせ -1 つのワークフロー内で、エージェントごとに異なるモデルを使用したい場合があります。たとえば、トリアージにはより小さく高速なモデルを使い、複雑なタスクにはより大型で高性能なモデルを使うといったケースです。[`Agent`][agents.Agent] を設定するとき、以下のいずれかの方法で特定のモデルを選択できます。 +１つのワークフロー内で、エージェントごとに異なるモデルを使用したい場合があります。たとえば、簡易的なタスクには小型で高速なモデル、複雑なタスクには高性能な大型モデルを使うといったケースです。[`Agent`][agents.Agent] を設定する際、以下のいずれかでモデルを選択できます。 -1. モデル名を直接渡す。 -2. どのモデル名でも渡し、その名前を Model インスタンスにマッピングできる [`ModelProvider`][agents.models.interface.ModelProvider] を渡す。 -3. [`Model`][agents.models.interface.Model] 実装を直接渡す。 +1. モデル名を直接渡す +2. 任意のモデル名と、それを [`ModelProvider`][agents.models.interface.ModelProvider] が `Model` インスタンスにマッピングできるよう指定する +3. [`Model`][agents.models.interface.Model] 実装を直接渡す !!!note - - SDK は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] と [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] の両方の形をサポートしますが、ワークフローごとに 1 つのモデル形に統一することを推奨します。2 つの形では利用できる機能や tools が異なるためです。モデル形を混在させる場合は、使用するすべての機能が両方で利用可能であることを確認してください。 + SDK は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] と [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] の両方に対応していますが、ワークフローごとに１つのモデル形状のみを使用することを推奨します。２つのモデル形状では利用できる機能やツールが異なるためです。モデル形状を混在させる必要がある場合は、使用するすべての機能が両方で利用可能かを確認してください。 ```python from agents import Agent, Runner, AsyncOpenAI, OpenAIChatCompletionsModel @@ -81,10 +84,10 @@ async def main(): print(result.final_output) ``` -1. OpenAI モデル名を直接設定しています。 -2. [`Model`][agents.models.interface.Model] 実装を提供しています。 +1. OpenAI モデル名を直接指定しています。 +2. [`Model`][agents.models.interface.Model] 実装を提供しています。 -エージェントで使用するモデルをさらに細かく設定したい場合は、`temperature` などのオプションパラメーターを指定できる [`ModelSettings`][agents.models.interface.ModelSettings] を渡せます。 +エージェントで使用するモデルをさらに詳細に設定したい場合は、`temperature` などの任意パラメーターを含む [`ModelSettings`][agents.models.interface.ModelSettings] を渡せます。 ```python from agents import Agent, ModelSettings @@ -97,7 +100,7 @@ english_agent = Agent( ) ``` -また、OpenAI の Responses API を使用する場合は [その他のオプションパラメーター](https://platform.openai.com/docs/api-reference/responses/create)（`user`、`service_tier` など）もあります。トップレベルで指定できない場合は、`extra_args` を利用して渡すことができます。 +また、OpenAI の Responses API を使用する場合は、`user` や `service_tier` など[追加の任意パラメーター](https://platform.openai.com/docs/api-reference/responses/create) を指定できます。トップレベルで指定できない場合は、`extra_args` を利用して渡してください。 ```python from agents import Agent, ModelSettings @@ -113,26 +116,28 @@ english_agent = Agent( ) ``` -## 他の LLM プロバイダー利用時の一般的な問題 +## 他の LLM プロバイダーを使用する際の一般的な問題 -### トレーシング クライアント 401 エラー +### トレーシング クライアントの 401 エラー -トレーシング関連のエラーが発生する場合、トレースが OpenAI サーバーにアップロードされる仕組みであり、OpenAI API キーがないことが原因です。解決策は次の 3 つです。 +トレーシング関連のエラーが発生する場合、トレースが OpenAI サーバーにアップロードされる際に OpenAI API キーが無いことが原因です。以下の３つの方法で解決できます。 1. トレーシングを完全に無効化する: [`set_tracing_disabled(True)`][agents.set_tracing_disabled] -2. トレーシング用に OpenAI キーを設定する: [`set_tracing_export_api_key(...)`][agents.set_tracing_export_api_key] — この API キーはトレースのアップロードのみに使用され、[platform.openai.com](https://platform.openai.com/) のキーである必要があります。 -3. 非 OpenAI のトレース プロセッサーを使用する。詳細は [tracing docs](../tracing.md#custom-tracing-processors) を参照してください。 +2. トレーシング用の OpenAI キーを設定する: [`set_tracing_export_api_key(...)`][agents.set_tracing_export_api_key]（このキーはトレースのアップロードのみに使用され、[platform.openai.com](https://platform.openai.com/) から取得する必要があります） +3. OpenAI 以外のトレースプロセッサーを使用する: [トレーシングドキュメント](../tracing.md#custom-tracing-processors) を参照 -### Responses API サポート +### Responses API のサポート -SDK はデフォルトで Responses API を使用しますが、ほとんどの他社 LLM プロバイダーはまだ対応していません。その結果、404 エラーなどが発生することがあります。対処方法は次の 2 つです。 +SDK はデフォルトで Responses API を使用しますが、多くの LLM プロバイダーはまだ対応していません。そのため 404 などのエラーが発生する場合があります。解決策は２つです。 -1. [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api] を呼び出す。これは環境変数 `OPENAI_API_KEY` と `OPENAI_BASE_URL` を設定している場合に機能します。 -2. [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] を使用する。code examples は [こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/) にあります。 +1. [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api] を呼び出す + （`OPENAI_API_KEY` と `OPENAI_BASE_URL` を環境変数で設定している場合に機能します）。 +2. [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] を使用する + 例は [こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/) でご覧いただけます。 -### structured outputs サポート +### structured outputs のサポート -一部のモデルプロバイダーは [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) をサポートしていません。その場合、次のようなエラーが発生することがあります。 +一部のモデルプロバイダーは、[structured outputs](https://platform.openai.com/docs/guides/structured-outputs) をサポートしていません。その結果、次のようなエラーが発生することがあります。 ``` @@ -140,12 +145,12 @@ BadRequestError: Error code: 400 - {'error': {'message': "'response_format.type' ``` -これは一部プロバイダーの制限で、JSON 出力には対応しているものの、出力に使用する `json_schema` を指定できません。現在修正に取り組んでいますが、JSON schema 出力をサポートするプロバイダーを利用することを推奨します。そうでない場合、壊れた JSON が返され、アプリが頻繁に失敗する可能性があります。 +これは一部プロバイダーの制限で、JSON 出力には対応していても `json_schema` を指定できないためです。現在修正に取り組んでいますが、JSON スキーマ出力をサポートするプロバイダーの利用を推奨します。そうでない場合、JSON が不正な形式で返され、アプリが頻繁に壊れる恐れがあります。 -## プロバイダー間でのモデルの組み合わせ +## プロバイダーを跨いでモデルを混在させる -モデルプロバイダーごとの機能差を理解しておかないと、エラーが発生する可能性があります。たとえば、OpenAI は structured outputs、マルチモーダル入力、ホスト型の file search と web search をサポートしていますが、多くの他社プロバイダーはこれらをサポートしていません。以下の制限に注意してください。 +モデルプロバイダーごとの機能差に注意しないと、エラーが発生する可能性があります。たとえば、OpenAI は structured outputs、マルチモーダル入力、ホスト型の file search や web search をサポートしていますが、多くの他プロバイダーはこれらをサポートしていません。以下の点にご注意ください。 -- 未対応の `tools` を理解しないプロバイダーへ送らない -- テキストのみのモデルに呼び出す前にマルチモーダル入力をフィルタリングする -- structured JSON outputs をサポートしないプロバイダーでは、無効な JSON が返る場合があることを理解する \ No newline at end of file +- サポートされていない `tools` を理解しないプロバイダーには送信しない +- テキストのみのモデルを呼び出す前にマルチモーダル入力を除外する +- structured JSON 出力をサポートしないプロバイダーでは、不正な JSON が返る場合があることを認識する \ No newline at end of file diff --git a/docs/ja/models/litellm.md b/docs/ja/models/litellm.md index e4c914414..4c99bd4f9 100644 --- a/docs/ja/models/litellm.md +++ b/docs/ja/models/litellm.md @@ -2,17 +2,17 @@ search: exclude: true --- -# LiteLLM 経由の任意モデル利用 +# LiteLLM 経由でのモデル利用 !!! note - LiteLLM との統合は現在 beta 版です。特に小規模なモデルプロバイダーでは問題が発生する場合があります。問題を見つけた際は [Github issues](https://github.com/openai/openai-agents-python/issues) からご報告ください。迅速に対応いたします。 + LiteLLM とのインテグレーションは現在ベータ版です。特に規模の小さいモデルプロバイダーでは問題が発生する可能性があります。問題を発見された場合は [Github issues](https://github.com/openai/openai-agents-python/issues) からご報告ください。迅速に修正いたします。 -[LiteLLM](https://docs.litellm.ai/docs/) は、1 つのインターフェースで 100+ のモデルを利用できるライブラリです。Agents SDK に LiteLLM との統合を追加したことで、任意の AI モデルを使用できるようになりました。 +[LiteLLM](https://docs.litellm.ai/docs/) は、1 つのインターフェースで 100 以上のモデルを利用できるライブラリです。Agents SDK で任意の AI モデルを使用できるよう、LiteLLM インテグレーションを追加しました。 -## Setup +## セットアップ -`litellm` が利用可能であることを確認する必要があります。オプションの `litellm` 依存グループをインストールすることで設定できます: +`litellm` が利用可能であることを確認してください。オプションの `litellm` 依存関係グループをインストールすることで実行できます: ```bash pip install "openai-agents[litellm]" @@ -20,15 +20,15 @@ pip install "openai-agents[litellm]" インストールが完了すると、任意のエージェントで [`LitellmModel`][agents.extensions.models.litellm_model.LitellmModel] を使用できます。 -## Example +## 例 -以下は完全に動作する例です。実行するとモデル名と API キーの入力を求められます。例えば、次のように入力できます。 +これは完全に動作するサンプルです。実行すると、モデル名と API キーの入力を求められます。たとえば、次のように入力できます。 -- `openai/gpt-4.1` をモデルに指定し、OpenAI API キーを入力 -- `anthropic/claude-3-5-sonnet-20240620` をモデルに指定し、Anthropic API キーを入力 +- モデルに `openai/gpt-4.1` 、そして OpenAI API キー +- モデルに `anthropic/claude-3-5-sonnet-20240620` 、そして Anthropic API キー - など -LiteLLM でサポートされているモデルの全リストは [litellm providers docs](https://docs.litellm.ai/docs/providers) をご覧ください。 +LiteLLM がサポートしているモデルの全リストは、[litellm providers docs](https://docs.litellm.ai/docs/providers) をご覧ください。 ```python from __future__ import annotations diff --git a/docs/ja/multi_agent.md b/docs/ja/multi_agent.md index 7cdebc5a7..25d98476f 100644 --- a/docs/ja/multi_agent.md +++ b/docs/ja/multi_agent.md @@ -4,38 +4,38 @@ search: --- # 複数エージェントのオーケストレーション -オーケストレーションとは、アプリ内でのエージェントのフローを指します。どのエージェントがどの順番で実行され、次に何をするかをどう決定するかということです。エージェントをオーケストレーションする主な方法は 2 つあります。 +オーケストレーションとは、アプリ内でのエージェントのフローを指します。どのエージェントが、どの順序で実行され、次に何をするかをどのように決定するかということです。エージェントをオーケストレーションする方法は主に 2 つあります。 -1. LLM に意思決定させる方法: LLM の知能を利用して計画・推論し、それに基づいて次のステップを決定します。 -2. コードによるオーケストレーション: 自分のコードでエージェントのフローを決定します。 +1. LLM に意思決定させる方法: LLM の知能を活用して計画・推論し、次に取るステップを決定します。 +2. コードでオーケストレーションする方法: コードでエージェントのフローを決定します。 -これらのパターンは組み合わせて使用できます。それぞれにトレードオフがあり、以下で説明します。 +これらのパターンは組み合わせて使用できます。それぞれにトレードオフがあるため、以下で説明します。 ## LLM によるオーケストレーション -エージェントとは、instructions、tools、handoffs を備えた LLM です。これにより、オープンエンドなタスクが与えられた場合でも、LLM は自律的に計画を立て、tools を用いてアクションを実行・データを取得し、handoffs でサブエージェントにタスクを委譲できます。たとえば、リサーチエージェントには次のような tools を装備できます。 +エージェントとは、instructions、tools、handoffs を備えた LLM です。オープンエンドなタスクが与えられたとき、LLM はタスクをどのように処理するかを自律的に計画し、tools を使ってアクションを実行・データ取得し、handoffs を使ってサブエージェントにタスクを委譲できます。たとえば、リサーチエージェントは次のような tools を備えることができます。 -- Web 検索でオンライン情報を取得 -- ファイル検索と取得で独自データや接続先を検索 -- コンピュータ操作で PC 上の操作を実行 -- コード実行でデータ分析を行う -- 計画立案やレポート作成に優れた専門エージェントへの handoffs +- Web 検索: オンラインで情報を探す +- ファイル検索と取得: 社内データや接続先を検索する +- コンピュータ操作: コンピュータ上でアクションを実行する +- コード実行: データ分析を行う +- Handoffs: 計画立案やレポート作成などに特化したエージェントへ委譲する このパターンはタスクがオープンエンドで、LLM の知能に頼りたい場合に最適です。重要なポイントは次のとおりです。 -1. 良いプロンプトに投資する。利用可能な tools、その使い方、守るべきパラメーターを明確にしましょう。 -2. アプリをモニタリングして改善を重ねる。問題が起きた箇所を確認し、プロンプトを改善します。 -3. エージェントに内省と改善を許可する。たとえばループで実行し自己批判させる、エラーメッセージを渡して改善させるなどです。 -4. 何でもこなす汎用エージェントではなく、特定タスクに特化したエージェントを用意しましょう。 -5. [evals](https://platform.openai.com/docs/guides/evals) に投資する。これによりエージェントを訓練し、タスク性能を向上できます。 +1. 良いプロンプトに投資する: 利用可能な tools、その使い方、守るべきパラメーターを明確にします。 +2. アプリをモニタリングし、改善を繰り返す: 問題が起きる箇所を確認し、プロンプトを調整します。 +3. エージェントに内省と改善を許可する: 例えばループで実行して自己批評させる、またはエラーメッセージを渡して改善させます。 +4. 何でもこなす汎用エージェントより、特定タスクに特化したエージェントを用意する。 +5. [evals](https://platform.openai.com/docs/guides/evals) に投資する: エージェントを訓練し、タスク遂行能力を高められます。 ## コードによるオーケストレーション -LLM によるオーケストレーションは強力ですが、コードでオーケストレーションすると速度、コスト、パフォーマンスの面でより決定論的かつ予測可能になります。代表的なパターンは次のとおりです。 +LLM によるオーケストレーションは強力ですが、コードでオーケストレーションすると速度・コスト・性能の面でより決定論的かつ予測可能になります。代表的なパターンは以下です。 -- [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使って、コードで検査可能な適切な形式のデータを生成する。たとえばエージェントにタスクをいくつかのカテゴリーに分類させ、そのカテゴリーに基づいて次のエージェントを選択します。 -- あるエージェントの出力を次のエージェントの入力へと変換して複数エージェントをチェーンする。ブログ記事作成なら、リサーチ → アウトライン作成 → 記事執筆 → 批評 → 改善という一連のステップに分解できます。 -- タスクを実行するエージェントを `while` ループで回し、評価とフィードバックを行うエージェントが合格と判断するまで繰り返します。 -- `asyncio.gather` など Python の基本コンポーネントで複数エージェントを並列実行する。相互依存のない複数タスクを高速化する際に有効です。 +- structured outputs を用いて適切な形式のデータを生成し、コードで検査する。例として、エージェントにタスクをいくつかの カテゴリー に分類させ、その カテゴリー に基づき次のエージェントを選択する方法があります。 +- あるエージェントの出力を次のエージェントの入力に変換し、複数エージェントをチェーンする。ブログ記事の作成を「リサーチ → アウトライン作成 → 記事執筆 → 批評 → 改善」の一連のステップに分解するなどです。 +- タスクを実行するエージェントを `while` ループで回し、別のエージェントが評価とフィードバックを行い、評価者が基準を満たしたと判断するまで繰り返す。 +- Python の基本コンポーネントである `asyncio.gather` などを用いて複数エージェントを並列実行する。互いに依存しない複数タスクを高速に処理したい場合に有用です。 -[`examples/agent_patterns`](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns) には多数のコード例があります。 \ No newline at end of file +[`examples/agent_patterns`](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns) に多数の code examples があります。 \ No newline at end of file diff --git a/docs/ja/quickstart.md b/docs/ja/quickstart.md index f79d74523..8d8c89d3c 100644 --- a/docs/ja/quickstart.md +++ b/docs/ja/quickstart.md @@ -6,7 +6,7 @@ search: ## プロジェクトと仮想環境の作成 -これは一度だけ実行すれば十分です。 +一度だけ実行すれば十分です。 ```bash mkdir my_project @@ -14,9 +14,9 @@ cd my_project python -m venv .venv ``` -### 仮想環境の有効化 +### 仮想環境のアクティベート -新しいターミナルセッションを開始するたびに実行してください。 +新しいターミナルセッションを開始するたびに実行します。 ```bash source .venv/bin/activate @@ -28,9 +28,9 @@ source .venv/bin/activate pip install openai-agents # or `uv add openai-agents`, etc ``` -### OpenAI API キーを設定する +### OpenAI API キーの設定 -お持ちでない場合は、[こちらの手順](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key)に従って OpenAI API キーを作成してください。 +まだお持ちでない場合は、[こちらの手順](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key)に従って OpenAI API キーを作成してください。 ```bash export OPENAI_API_KEY=sk-... @@ -38,7 +38,7 @@ export OPENAI_API_KEY=sk-... ## 最初のエージェントを作成する -エージェントは instructions、名前、そして `model_config` などのオプションの config で定義します。 +エージェントは instructions、名前、および `model_config` などのオプション設定で定義します。 ```python from agents import Agent @@ -49,9 +49,9 @@ agent = Agent( ) ``` -## さらにいくつかのエージェントを追加する +## さらにエージェントを追加する -追加のエージェントも同じ方法で定義できます。`handoff_descriptions` は、ハンドオフのルーティングを決定するための追加コンテキストを提供します。 +追加のエージェントも同じ方法で定義できます。`handoff_descriptions` によってハンドオフのルーティング判断に必要な追加コンテキストを提供します。 ```python from agents import Agent @@ -71,7 +71,7 @@ math_tutor_agent = Agent( ## ハンドオフを定義する -各エージェントでは、タスクを進める方法を選択できるよう、送信先ハンドオフのオプション一覧を定義できます。 +各エージェントで、タスクを進めるために選択できる送信側ハンドオフオプションのインベントリを定義できます。 ```python triage_agent = Agent( @@ -83,7 +83,7 @@ triage_agent = Agent( ## エージェントオーケストレーションを実行する -ワークフローが実行され、トリアージエージェントが 2 つのスペシャリストエージェント間を正しくルーティングすることを確認しましょう。 +ワークフローが実行され、トリアージエージェントが 2 つの専門エージェント間で正しくルーティングすることを確認しましょう。 ```python from agents import Runner @@ -121,9 +121,9 @@ async def homework_guardrail(ctx, agent, input_data): ) ``` -## すべてを組み合わせる +## すべてまとめて実行する -ハンドオフと入力ガードレールを使って、すべてを組み合わせたワークフロー全体を実行してみましょう。 +ハンドオフと入力ガードレールを使用して、ワークフロー全体を実行してみましょう。 ```python from agents import Agent, InputGuardrail, GuardrailFunctionOutput, Runner @@ -192,12 +192,12 @@ if __name__ == "__main__": ## トレースを表示する -エージェント実行中に何が起こったかを確認するには、[OpenAI ダッシュボードの Trace viewer](https://platform.openai.com/traces) に移動してエージェント実行のトレースを表示してください。 +エージェント実行中に何が起こったかを確認するには、[OpenAI ダッシュボードの Trace viewer](https://platform.openai.com/traces) に移動してトレースを確認してください。 ## 次のステップ -より複雑なエージェントフローを構築する方法を学びましょう: +より複雑なエージェントフローの構築方法を学びましょう。 -- [エージェントの設定方法](agents.md) について学びます。 -- [エージェントの実行](running_agents.md) について学びます。 -- [ツール](tools.md)、[ガードレール](guardrails.md)、そして [モデル](models/index.md) について学びます。 \ No newline at end of file +- [エージェント](agents.md) の設定方法を学ぶ +- [エージェントの実行](running_agents.md) について学ぶ +- [ツール](tools.md)、[ガードレール](guardrails.md)、[モデル](models/index.md) について学ぶ \ No newline at end of file diff --git a/docs/ja/realtime/guide.md b/docs/ja/realtime/guide.md index 3f3fe8217..dcce83cdf 100644 --- a/docs/ja/realtime/guide.md +++ b/docs/ja/realtime/guide.md @@ -4,65 +4,65 @@ search: --- # ガイド -本ガイドでは、 OpenAI Agents SDK の realtime 機能を使用して音声対応の AI エージェントを構築する方法を詳しく説明します。 +このガイドでは、 OpenAI Agents SDK の realtime 機能を用いて音声対応 AI エージェントを構築する方法を詳しく解説します。 -!!! warning "ベータ機能" -Realtime エージェントはベータ版です。実装を改良する過程で互換性が壊れる変更が入る可能性があります。 +!!! warning "Beta feature" +Realtime エージェントはベータ版です。実装の改善に伴い、破壊的変更が行われる可能性があります。 ## 概要 -Realtime エージェントは、音声とテキスト入力をリアルタイムに処理し、リアルタイム音声で応答することで対話フローを実現します。 OpenAI の Realtime API と永続的に接続を維持し、低レイテンシで自然な音声会話と割り込みへのスムーズな対応を可能にします。 +Realtime エージェントは、音声とテキスト入力をリアルタイムで処理し、リアルタイム音声で応答する対話フローを実現します。 OpenAI の Realtime API と永続接続を維持し、低レイテンシかつ割り込みにも柔軟に対応できる自然な音声会話を可能にします。 ## アーキテクチャ ### コアコンポーネント -リアルタイムシステムは、以下の主要コンポーネントで構成されています。 +realtime システムは、次の主要コンポーネントで構成されます。 -- **RealtimeAgent**: instructions、tools、handoffs で構成されるエージェントです。 -- **RealtimeRunner**: 設定を管理します。`runner.run()` を呼び出すことでセッションを取得できます。 -- **RealtimeSession**: 1 回の対話セッションを表します。ユーザーが会話を開始するたびに作成し、会話が終了するまで保持します。 -- **RealtimeModel**: 基盤となるモデルインターフェース（通常は OpenAI の WebSocket 実装） +- ** RealtimeAgent **: instructions、tools、handoffs で構成されたエージェントです。 +- ** RealtimeRunner **: 設定を管理します。 `runner.run()` を呼び出すとセッションを取得できます。 +- ** RealtimeSession **: 1 回の対話セッションを表します。通常、ユーザーが会話を開始するたびに作成し、会話が終了するまで保持します。 +- ** RealtimeModel **: 基盤となるモデルインターフェース（通常は OpenAI の WebSocket 実装） ### セッションフロー -典型的なリアルタイムセッションは次の流れで進みます。 +典型的な realtime セッションは次のフローで進行します。 -1. **RealtimeAgent** を instructions、tools、handoffs と共に作成します。 -2. エージェントと各種設定を指定して **RealtimeRunner** をセットアップします。 -3. `await runner.run()` を実行してセッション (**RealtimeSession**) を開始します。 -4. `send_audio()` または `send_message()` を使用して音声またはテキストを送信します。 -5. セッションを反復処理してイベントを受信します。イベントには音声出力、トランスクリプト、ツール呼び出し、ハンドオフ、エラーなどが含まれます。 -6. ユーザーがエージェントの発話中に話し始めた場合は **割り込み** が発生し、現在の音声生成が自動で停止します。 +1. ** RealtimeAgent ** を instructions、tools、handoffs と共に作成します。 +2. エージェントと設定オプションを使用して ** RealtimeRunner ** をセットアップします。 +3. `await runner.run()` で **セッションを開始** し、 RealtimeSession を取得します。 +4. `send_audio()` または `send_message()` で **音声またはテキストメッセージを送信** します。 +5. セッションを反復処理して **イベントをリッスン** します。イベントには音声出力、転写、ツール呼び出し、ハンドオフ、エラーなどがあります。 +6. ユーザーがエージェントの発話をさえぎった場合に **割り込みを処理** します。これにより現在の音声生成が自動的に停止します。 -セッションは会話履歴を保持し、リアルタイムモデルとの永続接続を管理します。 +セッションは会話履歴を保持し、 realtime モデルとの永続接続を管理します。 ## エージェント設定 -RealtimeAgent は通常の Agent クラスとほぼ同じですが、いくつか重要な違いがあります。詳細は [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API リファレンスをご覧ください。 +RealtimeAgent は通常の Agent クラスとほぼ同様に機能しますが、いくつかの重要な違いがあります。詳細は [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API リファレンスをご覧ください。 主な違い: -- モデルの選択はエージェントではなくセッション単位で指定します。 -- structured outputs (`outputType`) はサポートされていません。 -- ボイスはエージェントごとに設定できますが、最初のエージェントが話し始めた後は変更できません。 -- tools、handoffs、instructions などその他の機能は通常のエージェントと同様に機能します。 +- モデルの選択はエージェントレベルではなくセッションレベルで設定します。 +- structured outputs のサポートはありません（`outputType` はサポートされていません）。 +- 音声はエージェントごとに設定できますが、最初のエージェントが発話した後に変更できません。 +- それ以外の tools、handoffs、instructions などの機能は同じです。 ## セッション設定 ### モデル設定 -セッション設定では基盤となるリアルタイムモデルの挙動を制御できます。モデル名（`gpt-4o-realtime-preview` など）、ボイス（alloy、echo、fable、onyx、nova、shimmer）、対応モダリティ（text / audio）を指定できます。入力・出力の音声フォーマットは PCM16 がデフォルトですが変更可能です。 +セッション設定では、基盤となる realtime モデルの挙動を制御できます。モデル名（例: `gpt-4o-realtime-preview`）、音声（alloy, echo, fable, onyx, nova, shimmer）や対応モダリティ（text / audio）を指定できます。音声フォーマットは入力・出力ともに設定可能で、デフォルトは PCM16 です。 ### オーディオ設定 -オーディオ設定では音声入力・出力の扱いを制御します。Whisper などのモデルで音声をトランスクリプトし、言語設定やドメイン固有語の精度を上げる transcription prompt を指定できます。ターン検出では、音声活動検出のしきい値、無音継続時間、検出前後のパディングなどを設定して、エージェントがいつ応答を開始・終了すべきかを調整します。 +オーディオ設定では、音声入力と出力の扱いを制御します。Whisper などのモデルを用いた入力音声の転写、言語設定、ドメイン固有用語の精度を高める転写プロンプトを指定できます。ターン検出設定では、音声活動検出しきい値、無音時間、検出された発話周辺のパディングなどにより、エージェントがいつ応答を開始・停止すべきかを制御します。 ## ツールと関数 ### ツールの追加 -通常のエージェントと同様に、Realtime エージェントでも会話中に実行される function tools を追加できます。 +通常のエージェントと同様に、 realtime エージェントは会話中に実行される function tools をサポートしています。 ```python from agents import function_tool @@ -90,7 +90,7 @@ agent = RealtimeAgent( ### ハンドオフの作成 -ハンドオフを利用すると、会話を専門エージェントへ引き継げます。 +ハンドオフを利用すると、会話を専門特化したエージェント間で引き継ぐことができます。 ```python from agents.realtime import realtime_handoff @@ -119,40 +119,40 @@ main_agent = RealtimeAgent( ## イベント処理 -セッションを反復処理することでストリーミングされるイベントを監視できます。主なイベントは以下のとおりです。 +セッションはイベントをストリーミングし、セッションオブジェクトを反復処理することでリッスンできます。イベントには音声出力チャンク、転写結果、ツール実行開始・終了、エージェントハンドオフ、エラーなどがあります。主に扱うべきイベントは以下です。 - **audio**: エージェント応答の raw 音声データ - **audio_end**: エージェントの発話終了 -- **audio_interrupted**: ユーザーによる割り込み発話 -- **tool_start / tool_end**: ツール実行の開始・終了 -- **handoff**: エージェント間のハンドオフ発生 -- **error**: 処理中に発生したエラー +- **audio_interrupted**: ユーザーがエージェントを割り込み +- **tool_start/tool_end**: ツール実行ライフサイクル +- **handoff**: エージェントのハンドオフ発生 +- **error**: 処理中にエラー発生 -詳細は [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent] を参照してください。 +完全なイベント詳細は [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent] を参照してください。 ## ガードレール -Realtime エージェントでは出力ガードレールのみサポートされます。パフォーマンス維持のため、ガードレールはデバウンスされて定期的に（すべての単語ではなく）評価されます。デフォルトのデバウンス長は 100 文字ですが、変更可能です。 +Realtime エージェントでサポートされるのは出力ガードレールのみです。リアルタイム生成中のパフォーマンスを維持するため、ガードレールはデバウンスされ定期的に実行されます（毎単語ではありません）。デフォルトのデバウンス長は 100 文字ですが、設定可能です。 -ガードレールが発火すると `guardrail_tripped` イベントが生成され、エージェントの現在の応答が中断される場合があります。リアルタイム性能と安全性を両立させるための挙動です。テキストエージェントと異なり、Realtime エージェントではガードレール発火時に Exception は送出されません。 +ガードレールがトリガーされると `guardrail_tripped` イベントが生成され、エージェントの現在の応答を割り込むことがあります。デバウンス動作により、安全性とリアルタイム性能のバランスを取ります。テキストエージェントと異なり、 realtime エージェントはガードレール発動時に Exception を発生させません。 ## オーディオ処理 -[`session.send_audio(audio_bytes)`][agents.realtime.session.RealtimeSession.send_audio] で音声を、[`session.send_message()`][agents.realtime.session.RealtimeSession.send_message] でテキストをセッションに送信できます。 +[`session.send_audio(audio_bytes)`][agents.realtime.session.RealtimeSession.send_audio] で音声を、 [`session.send_message()`][agents.realtime.session.RealtimeSession.send_message] でテキストをセッションへ送信します。 -音声出力を再生するには、`audio` イベントを監視して取得したデータをお好みのオーディオライブラリで再生してください。ユーザーが割り込んだ際には `audio_interrupted` イベントを受信して即座に再生を停止し、キューに溜まった音声をクリアする必要があります。 +音声出力を取得するには `audio` イベントをリッスンし、お好みのオーディオライブラリで再生してください。ユーザーが割り込んだ際に即座に再生を停止しキューにある音声をクリアするため、 `audio_interrupted` イベントも必ずリッスンしてください。 -## 直接モデルへアクセス +## 直接モデルにアクセス -より低レベルの制御やカスタムリスナー追加など、高度な用途では基盤モデルへ直接アクセスできます。 +低レベルでの接続制御やカスタムリスナー追加など高度な操作が必要な場合、基盤モデルに直接アクセスできます。 ```python # Add a custom listener to the model session.model.add_listener(my_custom_listener) ``` -これにより、[`RealtimeModel`][agents.realtime.model.RealtimeModel] インターフェースを直接操作できます。 +これにより、 [`RealtimeModel`][agents.realtime.model.RealtimeModel] インターフェースへ直接アクセスし、より柔軟なユースケースに対応できます。 -## 例 +## コード例 -動作する完全なサンプルは、[examples/realtime ディレクトリ](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) をご覧ください。 UI あり／なしのデモが含まれています。 \ No newline at end of file +完全な動作例は [examples/realtime ディレクトリ](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) を参照してください。 UI コンポーネントあり・なし両方のデモを含みます。 \ No newline at end of file diff --git a/docs/ja/realtime/quickstart.md b/docs/ja/realtime/quickstart.md index cad94d19c..4188a472c 100644 --- a/docs/ja/realtime/quickstart.md +++ b/docs/ja/realtime/quickstart.md @@ -4,16 +4,16 @@ search: --- # クイックスタート -Realtime エージェントを使用すると、OpenAI の Realtime API を介して AI エージェントとの音声会話が可能になります。本ガイドでは、初めてのリアルタイム音声エージェントの作成手順を説明します。 +Realtime エージェントを使うと、OpenAI の Realtime API で AI エージェントと音声会話ができます。このガイドでは、初めての Realtime 音声エージェントの作成方法を説明します。 !!! warning "Beta feature" -Realtime エージェントはベータ版です。実装を改善する過程で破壊的変更が発生する可能性があります。 +Realtime エージェントはベータ版です。実装の改善に伴い、破壊的変更が発生する可能性があります。 ## 前提条件 -- Python 3.9 以上 -- OpenAI API キー -- OpenAI Agents SDK の基本的な知識 +- Python 3.9 以上 +- OpenAI API キー +- OpenAI Agents SDK の基本的な知識 ## インストール @@ -23,16 +23,16 @@ Realtime エージェントはベータ版です。実装を改善する過程 pip install openai-agents ``` -## 最初のリアルタイム エージェントの作成 +## 最初の Realtime エージェントの作成 -### 1. 必要なコンポーネントのインポート +### 1. 必要なコンポーネントをインポート ```python import asyncio from agents.realtime import RealtimeAgent, RealtimeRunner ``` -### 2. リアルタイム エージェントの作成 +### 2. Realtime エージェントを作成 ```python agent = RealtimeAgent( @@ -41,7 +41,7 @@ agent = RealtimeAgent( ) ``` -### 3. Runner の設定 +### 3. Runner を設定 ```python runner = RealtimeRunner( @@ -56,7 +56,7 @@ runner = RealtimeRunner( ) ``` -### 4. セッションの開始 +### 4. セッションを開始 ```python async def main(): @@ -79,9 +79,9 @@ async def main(): asyncio.run(main()) ``` -## 完全なコード例 +## 完全な例 -以下は動作する完全なコード例です: +以下は動作する完全な例です: ```python import asyncio @@ -139,40 +139,40 @@ if __name__ == "__main__": ### モデル設定 -- `model_name`: 利用可能なリアルタイムモデルから選択します（例: `gpt-4o-realtime-preview`） -- `voice`: 音声を選択します (`alloy`, `echo`, `fable`, `onyx`, `nova`, `shimmer`) -- `modalities`: テキストおよび／またはオーディオを有効化します (`["text", "audio"]`) +- `model_name`: 利用可能な Realtime モデルを選択 (例: `gpt-4o-realtime-preview`) +- `voice`: 音声を選択 (`alloy`, `echo`, `fable`, `onyx`, `nova`, `shimmer`) +- `modalities`: テキストおよび/またはオーディオを有効化 (`["text", "audio"]`) ### オーディオ設定 -- `input_audio_format`: 入力オーディオの形式 (`pcm16`, `g711_ulaw`, `g711_alaw`) -- `output_audio_format`: 出力オーディオの形式 -- `input_audio_transcription`: 文字起こしの設定 +- `input_audio_format`: 入力オーディオの形式 (`pcm16`, `g711_ulaw`, `g711_alaw`) +- `output_audio_format`: 出力オーディオの形式 +- `input_audio_transcription`: 文字起こし設定 ### ターン検出 -- `type`: 検出方法 (`server_vad`, `semantic_vad`) -- `threshold`: 音声アクティビティしきい値 (0.0-1.0) -- `silence_duration_ms`: ターン終了を検出する無音時間 -- `prefix_padding_ms`: 発話前のオーディオパディング +- `type`: 検出方法 (`server_vad`, `semantic_vad`) +- `threshold`: 音声活動の閾値 (0.0-1.0) +- `silence_duration_ms`: ターン終了を検出する無音時間 +- `prefix_padding_ms`: 発話前のオーディオパディング ## 次のステップ -- [Realtime エージェントについてさらに学ぶ](guide.md) -- [examples/realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) フォルダーにある動作するコード例を確認してください -- エージェントにツールを追加する -- エージェント間のハンドオフを実装する -- 安全性のためのガードレールを設定する +- [Realtime エージェントについて詳しく学ぶ](guide.md) +- [examples/realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) フォルダーの動作する code examples を確認 +- エージェントにツールを追加 +- エージェント間のハンドオフを実装 +- セーフティのためのガードレールを設定 ## 認証 -OpenAI API キーが環境に設定されていることを確認してください: +OpenAI API キーを環境変数に設定してください: ```bash export OPENAI_API_KEY="your-api-key-here" ``` -またはセッション作成時に直接渡します: +または、セッション作成時に直接渡すこともできます: ```python session = await runner.run(model_config={"api_key": "your-api-key"}) diff --git a/docs/ja/release.md b/docs/ja/release.md index 47f3b5613..fe2d7ab7c 100644 --- a/docs/ja/release.md +++ b/docs/ja/release.md @@ -2,31 +2,31 @@ search: exclude: true --- -# リリースプロセス／変更履歴 +# リリースプロセス / 変更履歴 -プロジェクトでは、 `0.Y.Z` 形式を用いたセマンティックバージョニングのやや変更されたバージョンを採用しています。先頭の `0` は SDK がまだ急速に進化していることを示します。各コンポーネントの増分規則は以下のとおりです。 +プロジェクトは、`0.Y.Z` 形式を用いたやや変更されたセマンティック バージョニングに従います。先頭の `0` は、 SDK がまだ急速に進化していることを示します。各コンポーネントの増分ルールは次のとおりです: -## マイナー ( `Y` ) バージョン +## Minor ( `Y` ) バージョン -ベータでない公開インターフェースに **互換性を壊す変更 (breaking changes)** が入る場合、マイナーバージョン `Y` を増やします。たとえば `0.0.x` から `0.1.x` への更新には互換性を壊す変更が含まれることがあります。 +ベータでない公開インターフェースに **破壊的変更** が入る場合、 Minor バージョン `Y` を増やします。たとえば、`0.0.x` から `0.1.x` に上がる際には破壊的変更が含まれる可能性があります。 -互換性を壊す変更を避けたい場合は、プロジェクトで `0.0.x` 系にバージョンを固定することを推奨します。 +破壊的変更を避けたい場合は、プロジェクトで `0.0.x` バージョンを固定することを推奨します。 -## パッチ ( `Z` ) バージョン +## Patch ( `Z` ) バージョン -互換性を壊さない変更では `Z` を増やします。 +非破壊的変更があるたびに `Z` を増やします: -- バグ修正 -- 新機能 -- プライベートインターフェースの変更 -- ベータ機能の更新 +- バグ修正 +- 新機能 +- プライベート インターフェースの変更 +- ベータ機能の更新 -## 互換性を壊す変更の変更履歴 +## 破壊的変更の変更履歴 ### 0.2.0 -このバージョンでは、これまで `Agent` を引数に取っていたいくつかの箇所が、代わりに `AgentBase` を引数に取るようになりました。例としては MCP サーバーの `list_tools()` 呼び出しなどです。型に関する変更のみであり、受け取るオブジェクトは引き続き `Agent` です。更新する際は、型エラーを解消するために `Agent` を `AgentBase` に置き換えてください。 +このバージョンでは、以前は `Agent` を引数として受け取っていたいくつかの箇所が、代わりに `AgentBase` を受け取るようになりました。たとえば、 MCP サーバーの `list_tools()` 呼び出しなどです。これは型情報のみの変更であり、依然として `Agent` オブジェクトを受け取ります。アップデートするには、`Agent` を `AgentBase` に置き換えて型エラーを修正してください。 ### 0.1.0 -このバージョンでは、[`MCPServer.list_tools()`][agents.mcp.server.MCPServer] に新しいパラメーター `run_context` と `agent` が追加されました。`MCPServer` を継承するクラスでは、これらのパラメーターを追加する必要があります。 \ No newline at end of file +このバージョンでは、[`MCPServer.list_tools()`][agents.mcp.server.MCPServer] に `run_context` と `agent` という 2 つの新しいパラメーターが追加されました。`MCPServer` をサブクラス化しているクラスには、これらのパラメーターを追加する必要があります。 \ No newline at end of file diff --git a/docs/ja/repl.md b/docs/ja/repl.md index b72953e49..46b060d9a 100644 --- a/docs/ja/repl.md +++ b/docs/ja/repl.md @@ -4,7 +4,7 @@ search: --- # REPL ユーティリティ -この SDK は、簡単にインタラクティブにテストできる `run_demo_loop` を提供しています。 +Agents SDK は迅速な対話テスト用に `run_demo_loop` を提供します。 ```python import asyncio @@ -18,4 +18,4 @@ if __name__ == "__main__": asyncio.run(main()) ``` -`run_demo_loop` はループ内で ユーザー への入力プロンプトを表示し、各ターン間の会話履歴を保持します。デフォルトでは、生成されると同時にモデル出力をストリーミングします。ループを終了するには `quit` または `exit` と入力するか、`Ctrl-D` を押してください。 \ No newline at end of file +`run_demo_loop` はループでユーザー入力を促し、ターン間の会話履歴を保持します。デフォルトでは、生成され次第モデルの出力をストリーミングします。ループを終了するには `quit` または `exit` と入力するか、`Ctrl-D` を押してください。 \ No newline at end of file diff --git a/docs/ja/results.md b/docs/ja/results.md index 5870ac833..ff5300b60 100644 --- a/docs/ja/results.md +++ b/docs/ja/results.md @@ -2,55 +2,55 @@ search: exclude: true --- -# 実行結果 +# 結果 -`Runner.run` メソッドを呼び出すと、返される値は次のいずれかです。 +`Runner.run` メソッドを呼び出すと、返されるのは次のいずれかです。 -- [`RunResult`][agents.result.RunResult] を返すのは `run` もしくは `run_sync` を呼び出した場合 -- [`RunResultStreaming`][agents.result.RunResultStreaming] を返すのは `run_streamed` を呼び出した場合 +- [`RunResult`][agents.result.RunResult] — `run` または `run_sync` を呼び出した場合 +- [`RunResultStreaming`][agents.result.RunResultStreaming] — `run_streamed` を呼び出した場合 これらはいずれも [`RunResultBase`][agents.result.RunResultBase] を継承しており、ほとんどの有用な情報はここに含まれています。 ## 最終出力 -[`final_output`][agents.result.RunResultBase.final_output] プロパティには、最後に実行された エージェント からの最終出力が入っています。内容は次のいずれかです。 +[`final_output`][agents.result.RunResultBase.final_output] プロパティには、最後に実行されたエージェントの最終出力が入ります。内容は次のいずれかです。 -- 最後の エージェント に `output_type` が定義されていない場合は `str` -- エージェント に `output_type` が定義されている場合は `last_agent.output_type` 型のオブジェクト +- エージェントに `output_type` が定義されていない場合は `str` +- エージェントに `output_type` が定義されている場合は `last_agent.output_type` 型のオブジェクト !!! note - `final_output` の型は `Any` です。ハンドオフが発生する可能性があるため、静的型付けはできません。ハンドオフが起こると、どの エージェント が最後になるか分からないため、可能な出力型の集合を静的に特定できないのです。 + `final_output` の型は `Any` です。ハンドオフが発生する可能性があるため静的型付けはできません。ハンドオフが起こると、どのエージェントが最後になるか分からないため、可能な出力型の集合を静的に特定できないからです。 -## 次のターン用入力 +## 次のターンへの入力 -[`result.to_input_list()`][agents.result.RunResultBase.to_input_list] を使うと、実行時に生成されたアイテムを元の入力と連結した入力リストに変換できます。これにより、ある エージェント の実行結果をそのまま別の実行に渡したり、ループで実行して毎回新しい ユーザー 入力を追加したりするのが簡単になります。 +[`result.to_input_list()`][agents.result.RunResultBase.to_input_list] を使うと、元の入力に加えてエージェント実行中に生成されたアイテムを連結した input list を取得できます。これにより、あるエージェント実行の出力を別の実行に渡したり、ループで回して毎回新しい ユーザー 入力を追加したりするのが簡単になります。 -## 最後に実行されたエージェント +## 最後のエージェント -[`last_agent`][agents.result.RunResultBase.last_agent] プロパティには、最後に実行された エージェント が入っています。アプリケーションによっては、これは次回 ユーザー が入力を送ってきたときに便利です。たとえば、一次トリアージを行い言語別 エージェント へハンドオフするフロントライン エージェント がいる場合、最後の エージェント を保存しておけば、次回のメッセージで再利用できます。 +[`last_agent`][agents.result.RunResultBase.last_agent] プロパティには、最後に実行されたエージェントが入ります。アプリケーションによっては、次に ユーザー が何か入力したときにこれが役立つことがよくあります。たとえば、最初に受付を行うエージェントが言語別のエージェントへハンドオフする場合、最後のエージェントを保持しておき、次回の ユーザー メッセージで再利用できます。 -## 新しく生成されたアイテム +## 新しいアイテム -[`new_items`][agents.result.RunResultBase.new_items] プロパティには、実行中に生成された新しいアイテムが入っています。アイテムは [`RunItem`][agents.items.RunItem] でラップされており、その中に LLM が生成した raw アイテムが含まれます。 +[`new_items`][agents.result.RunResultBase.new_items] プロパティには、実行中に生成された新しいアイテムが入ります。アイテムは [`RunItem`][agents.items.RunItem] でラップされています。RunItem は LLM が生成した raw アイテムを包んでいます。 -- [`MessageOutputItem`][agents.items.MessageOutputItem] は LLM からのメッセージを表します。raw アイテムは生成されたメッセージです。 -- [`HandoffCallItem`][agents.items.HandoffCallItem] は LLM がハンドオフツールを呼び出したことを示します。raw アイテムは LLM からのツール呼び出しアイテムです。 -- [`HandoffOutputItem`][agents.items.HandoffOutputItem] はハンドオフが発生したことを示します。raw アイテムはハンドオフツール呼び出しへのツール応答です。また、アイテムからソース / ターゲット エージェント にもアクセスできます。 +- [`MessageOutputItem`][agents.items.MessageOutputItem] は LLM からのメッセージを示します。raw アイテムは生成されたメッセージです。 +- [`HandoffCallItem`][agents.items.HandoffCallItem] は LLM がハンドオフツールを呼び出したことを示します。raw アイテムはツール呼び出しアイテムです。 +- [`HandoffOutputItem`][agents.items.HandoffOutputItem] はハンドオフが発生したことを示します。raw アイテムはハンドオフツール呼び出しに対するツール応答です。アイテムからソース／ターゲットのエージェントにもアクセスできます。 - [`ToolCallItem`][agents.items.ToolCallItem] は LLM がツールを呼び出したことを示します。 -- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem] はツールが呼び出されたことを示します。raw アイテムはツール応答です。また、アイテムからツール出力にもアクセスできます。 -- [`ReasoningItem`][agents.items.ReasoningItem] は LLM からの推論アイテムを示します。raw アイテムは生成された推論です。 +- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem] はツールが呼び出されたことを示します。raw アイテムはツール応答です。アイテムからツール出力にもアクセスできます。 +- [`ReasoningItem`][agents.items.ReasoningItem] は LLM の reasoning アイテムを示します。raw アイテムは生成された reasoning です。 ## その他の情報 ### ガードレール結果 -[`input_guardrail_results`][agents.result.RunResultBase.input_guardrail_results] と [`output_guardrail_results`][agents.result.RunResultBase.output_guardrail_results] プロパティには、ガードレールがあればその結果が格納されます。ガードレール結果にはログ出力や保存に役立つ情報が含まれることがあるため、利用できるようにしています。 +[`input_guardrail_results`][agents.result.RunResultBase.input_guardrail_results] と [`output_guardrail_results`][agents.result.RunResultBase.output_guardrail_results] プロパティには、ガードレールの結果が入ります（存在する場合）。ガードレール結果にはログや保存に役立つ情報が含まれることがあるため、こちらで取得できます。 -### raw 応答 +### Raw 応答 -[`raw_responses`][agents.result.RunResultBase.raw_responses] プロパティには、LLM が生成した [`ModelResponse`][agents.items.ModelResponse] が入っています。 +[`raw_responses`][agents.result.RunResultBase.raw_responses] プロパティには、 LLM が生成した [`ModelResponse`][agents.items.ModelResponse] が入ります。 ### 元の入力 -[`input`][agents.result.RunResultBase.input] プロパティには、`run` メソッドに渡した元の入力が入っています。通常は必要ありませんが、必要に応じて利用できます。 \ No newline at end of file +[`input`][agents.result.RunResultBase.input] プロパティには、`run` メソッドに渡した元の入力が入ります。ほとんどの場合必要ありませんが、必要なときのために利用可能にしています。 \ No newline at end of file diff --git a/docs/ja/running_agents.md b/docs/ja/running_agents.md index 08ef6d888..e3431fcce 100644 --- a/docs/ja/running_agents.md +++ b/docs/ja/running_agents.md @@ -4,11 +4,11 @@ search: --- # エージェントの実行 -エージェントは [`Runner`][agents.run.Runner] クラスを介して実行できます。方法は 3 つあります: +`Runner` クラスを使ってエージェントを実行できます。方法は 3 つあります: -1. [`Runner.run()`][agents.run.Runner.run] — 非同期で実行され、 [`RunResult`][agents.result.RunResult] を返します。 -2. [`Runner.run_sync()`][agents.run.Runner.run_sync] — 同期メソッドで、内部で `.run()` を呼び出します。 -3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed] — 非同期で実行され、 [`RunResultStreaming`][agents.result.RunResultStreaming] を返します。LLM をストリーミングモードで呼び出し、受信したイベントをそのままストリームします。 +1. [`Runner.run()`][agents.run.Runner.run] — 非同期で実行され、[`RunResult`][agents.result.RunResult] を返します。 +2. [`Runner.run_sync()`][agents.run.Runner.run_sync] — 同期メソッドで、内部的には `.run()` を呼び出します。 +3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed] — 非同期で実行され、[`RunResultStreaming`][agents.result.RunResultStreaming] を返します。LLM をストリーミングモードで呼び出し、受信したイベントをリアルタイムでストリーミングします。 ```python from agents import Agent, Runner @@ -27,51 +27,51 @@ async def main(): ## エージェントループ -`Runner` で `run` メソッドを使用すると、開始エージェントと入力を渡します。入力は文字列 (ユーザー メッセージと見なされます) か、OpenAI Responses API のアイテム リストのいずれかです。 +`Runner` の run メソッドでは、開始エージェントと入力を渡します。入力は文字列（ユーザーのメッセージと見なされます）または入力アイテムのリスト（OpenAI Responses API のアイテム）です。 -`Runner` は次のループを実行します: +`Runner` は以下のループを実行します: -1. 現在のエージェントに対して、現在の入力を用いて LLM を呼び出します。 +1. 現在のエージェントと入力で LLM を呼び出します。 2. LLM が出力を生成します。 - 1. LLM が `final_output` を返した場合、ループを終了し結果を返します。 + 1. LLM が `final_output` を返した場合、ループを終了して結果を返します。 2. LLM がハンドオフを行った場合、現在のエージェントと入力を更新し、ループを再実行します。 - 3. LLM がツール呼び出しを生成した場合、それらを実行し結果を追加してから、ループを再実行します。 -3. 渡された `max_turns` を超えた場合、 [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 例外を送出します。 + 3. LLM がツール呼び出しを生成した場合、それらを実行し、結果を追加してループを再実行します。 +3. 渡された `max_turns` を超えた場合、[`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 例外を発生させます。 !!! note - LLM の出力が「最終出力」と見なされるルールは、望ましい型のテキスト出力を生成し、ツール呼び出しが 1 つもないことです。 + LLM の出力が「最終出力」と見なされる条件は、求められた型のテキスト出力であり、ツール呼び出しが含まれていない場合です。 ## ストリーミング -ストリーミングを利用すると、LLM 実行中のイベントを逐次受け取れます。ストリーム終了後、 [`RunResultStreaming`][agents.result.RunResultStreaming] には実行に関する完全な情報 (生成されたすべての新しい出力を含む) が格納されます。ストリーミングイベントは `.stream_events()` で取得できます。詳しくは [ストリーミングガイド](streaming.md) を参照してください。 +ストリーミングを使用すると、LLM 実行中のストリーミングイベントを受け取れます。ストリーム終了後、[`RunResultStreaming`][agents.result.RunResultStreaming] に実行全体の情報（生成された新しい出力を含む）が格納されます。ストリーミングイベントは `.stream_events()` で受け取ります。詳細は [ストリーミングガイド](streaming.md) を参照してください。 -## 実行設定 +## Run config -`run_config` パラメーターを使って、エージェント実行のグローバル設定を行えます: +`run_config` パラメーターでは、エージェント実行のグローバル設定を行えます: -- [`model`][agents.run.RunConfig.model]: 各エージェントの `model` 設定に関わらず、グローバルで使用する LLM モデルを指定します。 -- [`model_provider`][agents.run.RunConfig.model_provider]: モデル名の検索に用いるモデルプロバイダー。デフォルトは OpenAI です。 -- [`model_settings`][agents.run.RunConfig.model_settings]: エージェント固有の設定を上書きします。例: グローバルで `temperature` や `top_p` を設定。 -- [`input_guardrails`][agents.run.RunConfig.input_guardrails], [`output_guardrails`][agents.run.RunConfig.output_guardrails]: すべての実行に適用する入力または出力ガードレールのリスト。 -- [`handoff_input_filter`][agents.run.RunConfig.handoff_input_filter]: ハンドオフに入力フィルターが設定されていない場合に適用されるグローバル入力フィルター。新しいエージェントへ送る入力を編集できます。詳細は [`Handoff.input_filter`][agents.handoffs.Handoff.input_filter] を参照してください。 -- [`tracing_disabled`][agents.run.RunConfig.tracing_disabled]: 実行全体での [トレーシング](tracing.md) を無効にします。 -- [`trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data]: LLM やツール呼び出しの入出力など、機微情報をトレースに含めるかどうかを設定します。 -- [`workflow_name`][agents.run.RunConfig.workflow_name], [`trace_id`][agents.run.RunConfig.trace_id], [`group_id`][agents.run.RunConfig.group_id]: 実行のトレーシング用にワークフロー名、トレース ID、グループ ID を設定します。少なくとも `workflow_name` の設定を推奨します。グループ ID は複数の実行にわたるトレースをリンクする際に使用できます。 +- [`model`][agents.run.RunConfig.model]: 各エージェントの `model` 設定に関係なく、使用する LLM モデルをグローバルに指定します。 +- [`model_provider`][agents.run.RunConfig.model_provider]: モデル名を解決するモデルプロバイダー。デフォルトは OpenAI です。 +- [`model_settings`][agents.run.RunConfig.model_settings]: エージェント固有の設定を上書きします。たとえば、グローバルな `temperature` や `top_p` を設定できます。 +- [`input_guardrails`][agents.run.RunConfig.input_guardrails], [`output_guardrails`][agents.run.RunConfig.output_guardrails]: すべての実行に適用する入力／出力ガードレールのリスト。 +- [`handoff_input_filter`][agents.run.RunConfig.handoff_input_filter]: ハンドオフに入力フィルターが設定されていない場合に適用するグローバル入力フィルター。新しいエージェントに送信される入力を編集できます。詳細は [`Handoff.input_filter`][agents.handoffs.Handoff.input_filter] を参照してください。 +- [`tracing_disabled`][agents.run.RunConfig.tracing_disabled]: 実行全体の [トレーシング](tracing.md) を無効にします。 +- [`trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data]: LLM やツール呼び出しの入出力など、機微なデータをトレースに含めるかどうかを設定します。 +- [`workflow_name`][agents.run.RunConfig.workflow_name], [`trace_id`][agents.run.RunConfig.trace_id], [`group_id`][agents.run.RunConfig.group_id]: トレーシングに使用するワークフロー名、トレース ID、トレース グループ ID を設定します。少なくとも `workflow_name` の設定を推奨します。グループ ID は複数実行間でトレースを関連付ける任意フィールドです。 - [`trace_metadata`][agents.run.RunConfig.trace_metadata]: すべてのトレースに含めるメタデータ。 ## 会話 / チャットスレッド -いずれかの `run` メソッドを呼び出すと、1 つ以上のエージェント (つまり 1 回以上の LLM 呼び出し) が実行されますが、チャット会話の論理的には 1 ターンとして扱われます。例: +いずれの run メソッドを呼び出しても、1 回の呼び出しで 1 つ以上のエージェント（つまり 1 回以上の LLM 呼び出し）が実行されますが、チャット会話上は 1 つの論理的ターンとなります。例: 1. ユーザーのターン: ユーザーがテキストを入力 -2. `Runner` の実行: 最初のエージェントが LLM を呼び出しツールを実行、次に 2 番目のエージェントへハンドオフしさらにツールを実行、最後に出力を生成 +2. Runner の実行: 1 つ目のエージェントが LLM を呼び出し、ツールを実行し、2 つ目のエージェントへハンドオフ。2 つ目のエージェントがさらにツールを実行し、最終出力を生成。 -エージェント実行の終了時に、ユーザーへ何を表示するかを選択できます。エージェントが生成したすべての新規アイテムを表示することも、最終出力だけを表示することも可能です。いずれにせよ、ユーザーがフォローアップの質問をした場合は再度 `run` メソッドを呼び出せます。 +エージェント実行後、ユーザーに何を表示するかは自由です。エージェントが生成したすべてのアイテムを表示しても、最終出力だけを表示しても構いません。いずれの場合も、ユーザーがフォローアップ質問をすると、再度 run メソッドを呼び出せます。 -### 手動での会話管理 +### 手動の会話管理 -次のターンの入力を取得するために、 [`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] メソッドを使用して会話履歴を手動で管理できます: +[`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] メソッドを使用して次のターンの入力を取得し、手動で会話履歴を管理できます: ```python async def main(): @@ -91,9 +91,9 @@ async def main(): # California ``` -### Sessions を用いた自動会話管理 +### Sessions を使った自動会話管理 -より簡単な方法として、 [Sessions](sessions.md) を使えば `.to_input_list()` を手動で呼び出さずに会話履歴を自動で扱えます: +よりシンプルな方法として、[Sessions](sessions.md) を使用すれば `.to_input_list()` を手動で呼び出すことなく会話履歴を自動管理できます: ```python from agents import Agent, Runner, SQLiteSession @@ -116,20 +116,20 @@ async def main(): # California ``` -Sessions は自動的に以下を行います: +Sessions は自動で以下を行います: - 各実行前に会話履歴を取得 - 各実行後に新しいメッセージを保存 - 異なるセッション ID ごとに会話を分離して管理 -詳細は [Sessions ドキュメント](sessions.md) を参照してください。 +詳細は [Sessions のドキュメント](sessions.md) を参照してください。 ## 例外 -SDK は特定の状況で例外を送出します。完全な一覧は [`agents.exceptions`][] にあります。概要は次のとおりです: +SDK は状況に応じて例外を発生させます。完全な一覧は [`agents.exceptions`][] を参照してください。概要は以下のとおりです: -- [`AgentsException`][agents.exceptions.AgentsException] — SDK で送出されるすべての例外の基底クラス。 -- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] — 実行が `max_turns` を超えたときに送出。 -- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError] — モデルが不正な出力 (例: JSON の不備や存在しないツールの使用) を返したときに送出。 -- [`UserError`][agents.exceptions.UserError] — SDK を使用する開発者側の誤りがあったときに送出。 -- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered], [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered] — [ガードレール](guardrails.md) がトリガーされたときに送出。 \ No newline at end of file +- [`AgentsException`][agents.exceptions.AgentsException]: SDK で発生するすべての例外の基底クラスです。 +- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded]: 実行が run メソッドに渡した `max_turns` を超えた場合に発生します。 +- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError]: モデルが無効な出力（JSON の構文エラーや存在しないツールの使用など）を生成した場合に発生します。 +- [`UserError`][agents.exceptions.UserError]: SDK を使用するコード側のミスで発生します。 +- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered], [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]: [ガードレール](guardrails.md) が作動した場合に発生します。 \ No newline at end of file diff --git a/docs/ja/sessions.md b/docs/ja/sessions.md index 3529900ce..7ebb2aa2d 100644 --- a/docs/ja/sessions.md +++ b/docs/ja/sessions.md @@ -4,9 +4,9 @@ search: --- # セッション -Agents SDK には組み込みのセッションメモリがあり、複数回のエージェント実行をまたいで会話履歴を自動的に維持します。そのため、ターン間で `.to_input_list()` を手動で扱う必要がありません。 +Agents SDK には、ビルトインのセッションメモリが用意されており、複数回のエージェント run をまたいで会話履歴を自動的に保持します。そのため、ターンごとに `.to_input_list()` を手動で扱う必要がありません。 -Sessions は特定のセッションの会話履歴を保存し、明示的なメモリ管理を行わなくてもエージェントがコンテキストを維持できるようにします。これは、エージェントに過去のやり取りを覚えさせたいチャットアプリケーションやマルチターンの会話を構築する際に特に便利です。 +セッションは特定のセッションに対して会話履歴を保存し、明示的なメモリ管理を行わなくてもエージェントがコンテキストを保持できるようにします。これは、チャットアプリケーションやマルチターンの会話で、エージェントに過去の対話を覚えさせたい場合に特に便利です。 ## クイックスタート @@ -49,19 +49,19 @@ print(result.final_output) # "Approximately 39 million" ## 仕組み -セッションメモリを有効にすると、次の処理が行われます。 +セッションメモリを有効にすると、次の処理が自動的に行われます。 -1. **各実行前**: Runner は自動的にそのセッションの会話履歴を取得し、入力アイテムの先頭に追加します。 -2. **各実行後**: 実行中に生成された新しいアイテム（ユーザー入力、アシスタントの応答、ツール呼び出しなど）がすべて自動的にセッションに保存されます。 -3. **コンテキストの保持**: 同じセッションでの後続の実行では、完全な会話履歴が含まれるため、エージェントがコンテキストを維持できます。 +1. **各 run の前**: Runner がセッションの会話履歴を取得し、入力アイテムの前に追加します。 +2. **各 run の後**: 実行中に生成された新しいアイテム（ユーザー入力、アシスタントの応答、ツール呼び出しなど）がすべてセッションに保存されます。 +3. **コンテキストの保持**: 同じセッションで後続の run を行うたびに完全な会話履歴が含まれるため、エージェントはコンテキストを維持できます。 -これにより、`.to_input_list()` を手動で呼び出したり、実行間で会話状態を管理したりする必要がなくなります。 +これにより、`.to_input_list()` を手動で呼び出したり、会話状態を管理したりする必要がなくなります。 ## メモリ操作 ### 基本操作 -Sessions では、会話履歴を管理するために次の操作が利用できます。 +セッションでは、会話履歴を管理するためにいくつかの操作をサポートしています。 ```python from agents import SQLiteSession @@ -86,9 +86,9 @@ print(last_item) # {"role": "assistant", "content": "Hi there!"} await session.clear_session() ``` -### pop_item を使った修正 +### pop_item を使った訂正 -`pop_item` メソッドは、会話の最後のアイテムを取り消したり変更したりしたい場合に特に役立ちます。 +`pop_item` メソッドは、会話の最後のアイテムを取り消したり修正したりしたい場合に特に役立ちます。 ```python from agents import Agent, Runner, SQLiteSession @@ -230,15 +230,15 @@ Use meaningful session IDs that help you organize conversations: ### Session management ```python -# Clear a session when conversation should start fresh +# 会話をリセットしたいときにセッションをクリア await session.clear_session() -# Different agents can share the same session +# 複数のエージェントで同じセッションを共有 support_agent = Agent(name="Support") billing_agent = Agent(name="Billing") session = SQLiteSession("user_123") -# Both agents will see the same conversation history +# 両方のエージェントが同じ会話履歴を参照 result1 = await Runner.run( support_agent, "Help me with my account", @@ -261,19 +261,19 @@ from agents import Agent, Runner, SQLiteSession async def main(): - # Create an agent + # エージェントを作成 agent = Agent( name="Assistant", instructions="Reply very concisely.", ) - # Create a session instance that will persist across runs + # 複数回の run で永続化されるセッションを作成 session = SQLiteSession("conversation_123", "conversation_history.db") print("=== Sessions Example ===") print("The agent will remember previous messages automatically.\n") - # First turn + # 1 ターン目 print("First turn:") print("User: What city is the Golden Gate Bridge in?") result = await Runner.run( @@ -284,7 +284,7 @@ async def main(): print(f"Assistant: {result.final_output}") print() - # Second turn - the agent will remember the previous conversation + # 2 ターン目 - エージェントは前回の会話を覚えている print("Second turn:") print("User: What state is it in?") result = await Runner.run( @@ -295,7 +295,7 @@ async def main(): print(f"Assistant: {result.final_output}") print() - # Third turn - continuing the conversation + # 3 ターン目 - 会話を続ける print("Third turn:") print("User: What's the population of that state?") result = await Runner.run( diff --git a/docs/ja/streaming.md b/docs/ja/streaming.md index 0a3b6e735..ff56c5035 100644 --- a/docs/ja/streaming.md +++ b/docs/ja/streaming.md @@ -4,15 +4,15 @@ search: --- # ストリーミング -ストリーミング を利用すると、 エージェント の実行中に発生する更新を購読できます。これにより、エンドユーザーへ進捗状況や部分的な応答を表示するのに役立ちます。 +ストリーミングを利用すると、エージェントの実行をリアルタイムで購読できます。これは、エンドユーザーに進行状況や部分的なレスポンスを表示する際に役立ちます。 -ストリーミング を行うには、 [`Runner.run_streamed()`][agents.run.Runner.run_streamed] を呼び出します。これにより [`RunResultStreaming`][agents.result.RunResultStreaming] が返されます。その後、 `result.stream_events()` を呼び出すと、後述する [`StreamEvent`][agents.stream_events.StreamEvent] オブジェクトの非同期ストリームを取得できます。 +ストリーミングを行うには `Runner.run_streamed()` を呼び出します。これにより `RunResultStreaming` が返されます。`result.stream_events()` を呼び出すと、以下で説明する `StreamEvent` オブジェクトの非同期ストリームを取得できます。 -## raw 応答イベント +## Raw response events -[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent] は、 LLM から直接渡される raw イベントです。これらは OpenAI Responses API 形式であり、各イベントには `response.created`、`response.output_text.delta` などの type と data が含まれます。生成された直後の応答メッセージを ユーザー にストリーム配信したい場合に便利です。 +`RawResponsesStreamEvent` は LLM から直接渡される raw イベントです。OpenAI Responses API 形式であり、各イベントには `response.created`、`response.output_text.delta` などの type と data が含まれます。これらのイベントは、生成されたメッセージを即座にユーザーへストリーム配信したい場合に便利です。 -例えば、次のコードは LLM が生成するテキストをトークンごとに出力します。 +たとえば、次のコードは LLM が生成したテキストをトークンごとに出力します。 ```python import asyncio @@ -37,9 +37,9 @@ if __name__ == "__main__": ## Run item イベントと エージェント イベント -[`RunItemStreamEvent`][agents.stream_events.RunItemStreamEvent] は、より高レベルなイベントです。アイテムが完全に生成されたタイミングを通知します。これにより、トークン単位ではなく「メッセージが生成された」「ツールが実行された」といった粒度で進捗を ユーザー に配信できます。同様に、 [`AgentUpdatedStreamEvent`][agents.stream_events.AgentUpdatedStreamEvent] は現在の エージェント が変更された際（たとえば ハンドオフ の結果）に更新を通知します。 +`RunItemStreamEvent` はより高レベルのイベントで、アイテムが完全に生成された時点を通知します。これにより、各トークンではなく「メッセージが生成された」「ツールが実行された」などのレベルで進行状況をプッシュできます。同様に `AgentUpdatedStreamEvent` は、ハンドオフの結果として現在のエージェントが変更された際に更新を通知します。 -例えば、次のコードは raw イベントを無視し、 ユーザー に対して更新のみをストリーム配信します。 +たとえば、次のコードは raw イベントを無視し、ユーザーへ更新のみをストリーム配信します。 ```python import asyncio diff --git a/docs/ja/tools.md b/docs/ja/tools.md index 72d4f42b9..034bf3a4e 100644 --- a/docs/ja/tools.md +++ b/docs/ja/tools.md @@ -4,23 +4,23 @@ search: --- # ツール -エージェントはツールを利用することで、データの取得、コードの実行、外部 API の呼び出し、さらにはコンピュータ操作まで多彩なアクションを実行できます。Agents SDK には次の 3 つのツールクラスがあります。 +ツールは エージェント にデータの取得、コードの実行、外部 API の呼び出し、さらにはコンピュータ操作まで行わせることができます。Agents SDK には 3 種類のツールがあります。 -- Hosted ツール: これらは LLM サーバー上で AI モデルと並行して動作します。OpenAI は retrieval、Web 検索、コンピュータ操作 を Hosted ツールとして提供しています。 -- Function calling: 任意の Python 関数をツールとして利用できます。 -- Agents as tools: エージェント自体をツール化することで、ハンドオフすることなくエージェント同士を呼び出せます。 +- Hosted ツール: これらは LLM サーバー上で AI モデルと並行して実行されます。OpenAI は retrieval、Web 検索、コンピュータ操作を Hosted ツールとして提供しています。 +- Function calling: 任意の Python 関数をツールとして利用できます。 +- Agents as tools: エージェントをツールとして扱い、ハンドオフせずに他の エージェント を呼び出せます。 ## Hosted ツール -OpenAI は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] を使用する際に、いくつかの組み込みツールを提供しています。 +OpenAI は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] を使用する際にいくつかの組み込みツールを提供しています。 -- [`WebSearchTool`][agents.tool.WebSearchTool] により、エージェントは Web 検索 を実行できます。 -- [`FileSearchTool`][agents.tool.FileSearchTool] は OpenAI ベクトルストアから情報を取得します。 -- [`ComputerTool`][agents.tool.ComputerTool] はコンピュータ操作タスクを自動化します。 -- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] は LLM がサンドボックス環境でコードを実行できます。 -- [`HostedMCPTool`][agents.tool.HostedMCPTool] はリモート MCP サーバーのツールをモデルへ公開します。 -- [`ImageGenerationTool`][agents.tool.ImageGenerationTool] はプロンプトから画像を生成します。 -- [`LocalShellTool`][agents.tool.LocalShellTool] はローカルマシンでシェルコマンドを実行します。 +- [`WebSearchTool`][agents.tool.WebSearchTool] は エージェント に Web を検索させます。 +- [`FileSearchTool`][agents.tool.FileSearchTool] は OpenAI ベクトルストアから情報を取得できます。 +- [`ComputerTool`][agents.tool.ComputerTool] はコンピュータ操作タスクを自動化します。 +- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] は LLM がサンドボックス環境でコードを実行できるようにします。 +- [`HostedMCPTool`][agents.tool.HostedMCPTool] はリモート MCP サーバーのツールをモデルに公開します。 +- [`ImageGenerationTool`][agents.tool.ImageGenerationTool] はプロンプトから画像を生成します。 +- [`LocalShellTool`][agents.tool.LocalShellTool] はローカルマシンでシェルコマンドを実行します。 ```python from agents import Agent, FileSearchTool, Runner, WebSearchTool @@ -41,16 +41,16 @@ async def main(): print(result.final_output) ``` -## Function tools +## Function ツール -任意の Python 関数をそのままツールとして利用できます。Agents SDK が自動で設定を行います。 +任意の Python 関数をツールとして利用できます。Agents SDK が自動で設定を行います。 -- ツール名には Python 関数名が使用されます (別名を指定することも可能)。 -- ツール説明は関数の docstring から取得されます (カスタム説明も可)。 -- 関数の引数から自動で入力スキーマを生成します。 -- 各入力の説明は docstring から取得されます (無効化も可能)。 +- ツールの名前は Python 関数名になります（任意で上書き可能）。 +- ツールの説明は関数の docstring から取得されます（任意で上書き可能）。 +- 関数引数から入力用スキーマを自動生成します。 +- 各入力の説明は、無効化しない限り docstring から取得されます。 -Python の `inspect` モジュールで関数シグネチャを抽出し、[`griffe`](https://mkdocstrings.github.io/griffe/) で docstring を解析し、`pydantic` でスキーマを生成しています。 +Python の `inspect` モジュールで関数シグネチャを抽出し、[`griffe`](https://mkdocstrings.github.io/griffe/) で docstring を解析し、`pydantic` でスキーマを生成します。 ```python import json @@ -102,12 +102,12 @@ for tool in agent.tools: ``` -1. 引数には任意の Python 型を使用でき、同期／非同期どちらの関数もサポートします。 -2. docstring があれば、ツールおよび引数の説明を取得します。 -3. 関数の最初の引数に `context` を受け取ることができ、ツール名や説明、docstring スタイルなどのオーバーライドも設定可能です。 -4. デコレートした関数を tools のリストに渡すだけで利用できます。 +1. 関数には任意の Python 型を引数として使用でき、同期・非同期の両方に対応しています。 +2. docstring があれば、ツールと引数の説明を自動取得します。 +3. 関数は任意で `context`（最初の引数である必要があります）を受け取れます。また、ツール名や説明、docstring スタイルなどのオーバーライドも設定できます。 +4. 装飾済み関数をツールのリストに渡してください。 -??? note "出力を展開して表示" +??? note "Expand to see output" ``` fetch_weather @@ -177,14 +177,14 @@ for tool in agent.tools: } ``` -### カスタム function ツール +### カスタム Function ツール -Python 関数を使わずに [`FunctionTool`][agents.tool.FunctionTool] を直接作成することもできます。その場合、次を指定してください。 +Python 関数をツールとして使いたくない場合は、[`FunctionTool`][agents.tool.FunctionTool] を直接作成できます。必要な項目は次のとおりです。 -- `name` -- `description` -- `params_json_schema` ― 引数の JSON スキーマ -- `on_invoke_tool` ― [`ToolContext`][agents.tool_context.ToolContext] と引数(JSON 文字列)を受け取り、ツール出力を文字列で返す async 関数 +- `name` +- `description` +- `params_json_schema` : 引数用の JSON スキーマ +- `on_invoke_tool` : [`ToolContext`][agents.tool_context.ToolContext] と引数（JSON 文字列）を受け取り、ツール出力を文字列で返す非同期関数 ```python from typing import Any @@ -219,16 +219,16 @@ tool = FunctionTool( ### 引数と docstring の自動解析 -前述のとおり、関数シグネチャを解析してスキーマを生成し、docstring からツール説明や各引数の説明を抽出します。ポイントは以下のとおりです。 +前述のとおり、関数シグネチャを自動解析してツールのスキーマを生成し、docstring を解析してツールと各引数の説明を取得します。詳細は次のとおりです。 -1. `inspect` モジュールでシグネチャを解析し、型アノテーションから Pydantic モデルを動的に生成します。Python の基本型、Pydantic モデル、TypedDict など大半の型をサポートします。 -2. `griffe` で docstring を解析します。サポートする形式は `google`、`sphinx`、`numpy` です。自動判定はベストエフォートのため、`function_tool` 呼び出し時に明示設定もできます。`use_docstring_info` を `False` にすると解析を無効化できます。 +1. シグネチャ解析は `inspect` モジュールで行います。型アノテーションから引数の型を判断し、全体スキーマを表す Pydantic モデルを動的に作成します。Python の基本型、Pydantic モデル、TypedDict など大半の型をサポートしています。 +2. docstring 解析には `griffe` を使用します。サポートする docstring 形式は `google`、`sphinx`、`numpy` です。形式は自動検出を試みますが、`function_tool` 呼び出し時に明示的に指定することもできます。`use_docstring_info` を `False` に設定すると docstring 解析を無効化できます。 スキーマ抽出のコードは [`agents.function_schema`][] にあります。 ## Agents as tools -ワークフローによっては、複数の専門エージェントを中央のエージェントがオーケストレーションする方が便利な場合があります。その際、エージェントをツールとして扱うことでハンドオフせずに実現できます。 +ワークフローによっては、中央のエージェントが専門特化した エージェント 群をオーケストレーションしたい場合があります。このときは エージェント をツールとしてモデル化できます。 ```python from agents import Agent, Runner @@ -267,9 +267,9 @@ async def main(): print(result.final_output) ``` -### ツール化エージェントのカスタマイズ +### ツール化したエージェントのカスタマイズ -`agent.as_tool` はエージェントを手軽にツール化するためのヘルパーです。ただし `max_turns` などすべての設定をサポートしているわけではありません。高度な構成が必要な場合は、ツール実装内で `Runner.run` を直接呼び出してください。 +`agent.as_tool` は エージェント を簡単にツールへ変換するためのヘルパーです。ただしすべての設定をサポートしているわけではなく、例えば `max_turns` は設定できません。高度なユースケースでは、ツール実装内で `Runner.run` を直接呼び出してください。 ```python @function_tool @@ -288,15 +288,15 @@ async def run_my_agent() -> str: return str(result.final_output) ``` -### 出力のカスタム抽出 +### カスタム出力抽出 -ツール化したエージェントの出力を中央エージェントへ返す前に加工したいケースがあります。たとえば以下のような場合です。 +場合によっては、ツール化した エージェント の出力を中央エージェントへ返す前に加工したいことがあります。以下のようなケースです。 -- チャット履歴から特定の情報 (例: JSON ペイロード) のみを抽出したい。 -- Markdown をプレーンテキストや CSV に変換するなど、最終回答のフォーマットを変更したい。 -- レスポンスが欠落・不正な場合に検証やフォールバック値を設定したい。 +- サブエージェントのチャット履歴から特定情報（例: JSON ペイロード）のみ抽出したい。 +- 最終回答を変換・再フォーマットしたい（例: Markdown をプレーンテキストや CSV に変換）。 +- 出力を検証し、欠落または不正な場合にフォールバック値を返したい。 -`as_tool` メソッドの `custom_output_extractor` 引数に関数を渡すことで実現できます。 +その場合は `as_tool` メソッドに `custom_output_extractor` 引数を渡してください。 ```python async def extract_json_payload(run_result: RunResult) -> str: @@ -315,12 +315,12 @@ json_tool = data_agent.as_tool( ) ``` -## function ツールでのエラー処理 +## Function ツールでのエラー処理 -`@function_tool` でツールを作成する際、`failure_error_function` を指定できます。これはツール呼び出しが失敗した場合に LLM へ返すエラーメッセージを生成する関数です。 +`@function_tool` で Function ツールを作成する際、`failure_error_function` を渡せます。これはツール呼び出しが失敗した場合に LLM へエラーレスポンスを返す関数です。 -- 何も渡さなかった場合、デフォルトの `default_tool_error_function` が実行され、「エラーが発生した」と LLM へ通知します。 -- 独自のエラー関数を渡すと、それが実行され LLM へ送信されます。 -- 明示的に `None` を渡すと、ツール呼び出し時のエラーは再スローされ、呼び出し側で処理できます。たとえばモデルが無効な JSON を生成した場合は `ModelBehaviorError`、ユーザーコードがクラッシュした場合は `UserError` などです。 +- 何も渡さない場合、デフォルトで `default_tool_error_function` が実行され、エラーが発生したことを LLM に伝えます。 +- 独自のエラー関数を渡すと、その関数が実行され、その結果が LLM に送信されます。 +- 明示的に `None` を渡すと、ツール呼び出しエラーは再スローされます。モデルが無効な JSON を生成した場合は `ModelBehaviorError`、ユーザーのコードがクラッシュした場合は `UserError` などになります。 -`FunctionTool` オブジェクトを手動で作成する場合は、`on_invoke_tool` 内でエラーを処理する必要があります。 \ No newline at end of file +`FunctionTool` オブジェクトを手動で作成する場合は、`on_invoke_tool` 関数内でエラー処理を実装する必要があります。 \ No newline at end of file diff --git a/docs/ja/tracing.md b/docs/ja/tracing.md index 5e19f19a2..a4a1e4a71 100644 --- a/docs/ja/tracing.md +++ b/docs/ja/tracing.md @@ -4,52 +4,52 @@ search: --- # トレーシング -Agents SDK にはトレーシング機能が組み込まれており、エージェント実行中に発生する LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、カスタムイベントなどの詳細なイベント記録を収集します。[Traces ダッシュボード](https://platform.openai.com/traces) を使用すると、開発中や本番環境でワークフローをデバッグ、可視化、監視できます。 +Agents SDK には組み込みのトレーシング機能があり、エージェント実行中に発生する LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、カスタムイベントなどを包括的に記録します。[Traces ダッシュボード](https://platform.openai.com/traces) を利用すると、開発中および本番環境でワークフローをデバッグ、可視化、監視できます。 !!!note - トレーシングはデフォルトで有効になっています。無効化する方法は 2 つあります。 + トレーシングはデフォルトで有効です。無効化する方法は 2 つあります。 1. 環境変数 `OPENAI_AGENTS_DISABLE_TRACING=1` を設定してグローバルに無効化する - 2. 単一の実行で無効化する場合は [`agents.run.RunConfig.tracing_disabled`][] を `True` に設定する + 2. 単一の実行に対して [`agents.run.RunConfig.tracing_disabled`][] を `True` に設定する -***OpenAI の API を Zero Data Retention (ZDR) ポリシーで利用している組織では、トレーシングは利用できません。*** +***OpenAI の API を Zero Data Retention (ZDR) ポリシーで運用している組織では、トレーシングは利用できません。*** ## トレースとスパン -- **トレース** は 1 つのワークフローのエンドツーエンド操作を表します。トレースは複数のスパンで構成されます。トレースのプロパティは次のとおりです。 - - `workflow_name`: 論理的なワークフローまたはアプリ名。例: 「Code generation」や「Customer service」 - - `trace_id`: トレースの一意 ID。渡さなかった場合は自動生成されます。形式は `trace_<32_alphanumeric>` である必要があります。 - - `group_id`: オプションのグループ ID。同じ会話からの複数トレースをリンクするために使用します。例としてチャットスレッド ID など。 - - `disabled`: `True` の場合、このトレースは記録されません。 - - `metadata`: トレースに付与するオプションメタデータ。 -- **スパン** は開始時刻と終了時刻を持つ操作を表します。スパンのプロパティは次のとおりです。 +- **トレース**: 1 つのワークフローのエンドツーエンド操作を表します。複数のスパンで構成され、以下のプロパティを持ちます。 + - `workflow_name`: 論理的なワークフローまたはアプリ名。例: 「コード生成」や「カスタマーサービス」 + - `trace_id`: トレース固有の ID。渡さなければ自動生成されます。形式は `trace_<32_alphanumeric>` + - `group_id`: 省略可。複数のトレースを同一の会話に紐づけるための ID。例: チャットスレッド ID + - `disabled`: `True` の場合、このトレースは記録されません + - `metadata`: トレースに付与する任意のメタデータ +- **スパン**: 開始時刻と終了時刻を持つ操作を表します。 - `started_at` と `ended_at` タイムスタンプ - 所属するトレースを示す `trace_id` - - 親スパンを指す `parent_id` (存在する場合) - - スパンに関する情報を含む `span_data`。例: `AgentSpanData` はエージェント情報、`GenerationSpanData` は LLM 生成情報など。 + - 親スパンを指す `parent_id`（存在する場合） + - スパンに関する情報を格納する `span_data`。例: `AgentSpanData` はエージェント情報、`GenerationSpanData` は LLM 生成情報など ## デフォルトのトレーシング -デフォルトでは、SDK は次をトレースします。 +デフォルトでは、SDK は以下をトレースします。 -- `Runner.{run, run_sync, run_streamed}()` 全体を `trace()` でラップ -- エージェントが実行されるたびに `agent_span()` でラップ -- LLM 生成を `generation_span()` でラップ -- 関数ツール呼び出しをそれぞれ `function_span()` でラップ -- ガードレールを `guardrail_span()` でラップ -- ハンドオフを `handoff_span()` でラップ -- 音声入力 (speech-to-text) を `transcription_span()` でラップ -- 音声出力 (text-to-speech) を `speech_span()` でラップ -- 関連する音声スパンは `speech_group_span()` の下にネストされることがあります +- `Runner.{run, run_sync, run_streamed}()` 全体を `trace()` でラップ +- エージェント実行ごとに `agent_span()` でラップ +- LLM 生成を `generation_span()` でラップ +- 関数ツール呼び出しを `function_span()` でラップ +- ガードレールを `guardrail_span()` でラップ +- ハンドオフを `handoff_span()` でラップ +- 音声入力（音声→テキスト）を `transcription_span()` でラップ +- 音声出力（テキスト→音声）を `speech_span()` でラップ +- 関連する音声スパンは `speech_group_span()` の下に配置される場合があります -デフォルトではトレース名は「Agent trace」です。`trace` を使用して名前を設定するか、[`RunConfig`][agents.run.RunConfig] で名前やその他のプロパティを設定できます。 +デフォルトのトレース名は「Agent trace」です。`trace` を使用して名前を設定するか、[`RunConfig`][agents.run.RunConfig] で名前やその他プロパティを構成できます。 -さらに、[カスタムトレースプロセッサ](#custom-tracing-processors) を設定して、トレースを別の送信先にプッシュすることもできます (置き換えまたは追加送信先として)。 +さらに、[カスタムトレーシングプロセッサ](#custom-tracing-processors) を設定して、別の送信先へトレースを送る（置き換えまたは追加送信）ことも可能です。 ## 上位レベルのトレース -複数回の `run()` 呼び出しを 1 つのトレースにまとめたい場合があります。これを行うには、コード全体を `trace()` でラップします。 +複数回の `run()` 呼び出しを 1 つのトレースにまとめたい場合、コード全体を `trace()` でラップできます。 ```python from agents import Agent, Runner, trace @@ -64,60 +64,61 @@ async def main(): print(f"Rating: {second_result.final_output}") ``` -1. `Runner.run` への 2 回の呼び出しが `with trace()` 内にラップされているため、個々の実行は 2 つのトレースを作成せず、全体トレースの一部になります。 +1. `with trace()` で 2 回の `Runner.run` をラップしているため、それぞれが個別のトレースを作成せず、1 つのトレース内に含まれます。 ## トレースの作成 -[`trace()`][agents.tracing.trace] 関数を使用してトレースを作成できます。トレースは開始と終了が必要です。方法は 2 つあります。 +[`trace()`][agents.tracing.trace] 関数を使用してトレースを作成できます。トレースは開始と終了が必要で、次の 2 通りの方法があります。 -1. **推奨**: コンテキストマネージャとして使用する (例: `with trace(...) as my_trace`)。これにより開始と終了が自動化されます。 -2. [`trace.start()`][agents.tracing.Trace.start] と [`trace.finish()`][agents.tracing.Trace.finish] を手動で呼び出すことも可能です。 +1. **推奨**: コンテキストマネージャとして使用（例: `with trace(...) as my_trace`）。自動的に開始と終了が行われます。 +2. [`trace.start()`][agents.tracing.Trace.start] と [`trace.finish()`][agents.tracing.Trace.finish] を手動で呼び出す -現在のトレースは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) で管理されます。これにより並行処理でも自動的に機能します。トレースを手動で開始／終了する場合は、`start()`／`finish()` に `mark_as_current` と `reset_current` を渡して現在のトレースを更新してください。 +現在のトレースは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) で管理されるため、並行処理にも自動対応します。トレースを手動で開始／終了する場合は、`start()`／`finish()` に `mark_as_current` と `reset_current` を渡して現在のトレースを更新してください。 ## スパンの作成 -各種 [`*_span()`][agents.tracing.create] メソッドを使ってスパンを作成できます。通常は手動でスパンを作成する必要はありません。カスタムスパン情報を追跡するための [`custom_span()`][agents.tracing.custom_span] も用意されています。 +各種 [`*_span()`][agents.tracing.create] メソッドでスパンを作成できますが、通常は手動でスパンを作成する必要はありません。カスタム情報を追跡したい場合は [`custom_span()`][agents.tracing.custom_span] が利用可能です。 スパンは自動的に現在のトレースに含まれ、最も近い現在のスパンの下にネストされます。これも Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) で管理されます。 -## 機微なデータ +## 機微データ -一部のスパンは機微なデータを含む可能性があります。 +一部のスパンは機微なデータを含む場合があります。 -`generation_span()` は LLM 生成の入出力を、`function_span()` は関数呼び出しの入出力を保存します。これらに機微なデータが含まれる場合があるため、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] でデータの取得を無効化できます。 +`generation_span()` には LLM 生成の入出力が、`function_span()` には関数呼び出しの入出力が保存されます。機微データを含む可能性があるため、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] でこれらのデータ記録を無効化できます。 -同様に、オーディオスパンはデフォルトで入力・出力オーディオの base64 エンコード PCM データを含みます。[`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] を設定することで、このオーディオデータの取得を無効化できます。 +同様に、オーディオスパンにはデフォルトで base64 エンコードされた PCM データ（音声入力・出力）が含まれます。録音データの記録を無効にするには、[`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] を設定してください。 ## カスタムトレーシングプロセッサ -トレーシングの高レベルアーキテクチャは次のとおりです。 +トレーシングのハイレベルな構成は以下のとおりです。 -- 初期化時にグローバルな [`TraceProvider`][agents.tracing.setup.TraceProvider] を作成し、トレースの生成を担当します。 -- `TraceProvider` を [`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] で構成し、スパンとトレースをバッチで [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] に送信し、OpenAI バックエンドへエクスポートします。 +- 初期化時にグローバル [`TraceProvider`][agents.tracing.setup.TraceProvider] を作成し、トレースを生成 +- `TraceProvider` に [`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] を設定し、トレース／スパンをバッチで [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] へ送信 +- `BackendSpanExporter` が OpenAI バックエンドへバッチ送信 -デフォルト設定をカスタマイズして別のバックエンドへ送信したり、エクスポーター動作を変更したりする場合は、次の 2 つの方法があります。 +このデフォルト設定をカスタマイズして別のバックエンドへ送信したり、エクスポーターの動作を変更したりするには次の 2 つの方法があります。 -1. [`add_trace_processor()`][agents.tracing.add_trace_processor] で **追加の** トレースプロセッサを登録し、トレース／スパンを受け取って独自処理を行いつつ OpenAI バックエンドにも送信する -2. [`set_trace_processors()`][agents.tracing.set_trace_processors] でデフォルトプロセッサを **置き換え**、独自のプロセッサのみを使用する (OpenAI バックエンドへ送信したい場合は、その機能を持つ `TracingProcessor` を含める必要があります) +1. [`add_trace_processor()`][agents.tracing.add_trace_processor]: 既定の送信に加え、**追加** のトレースプロセッサを登録 +2. [`set_trace_processors()`][agents.tracing.set_trace_processors]: 既定のプロセッサを **置き換え**、独自のトレースプロセッサを使用（OpenAI バックエンドへ送信したい場合は対応する `TracingProcessor` を含める必要があります） ## 外部トレーシングプロセッサ一覧 -- [Weights & Biases](https://weave-docs.wandb.ai/guides/integrations/openai_agents) -- [Arize-Phoenix](https://docs.arize.com/phoenix/tracing/integrations-tracing/openai-agents-sdk) -- [Future AGI](https://docs.futureagi.com/future-agi/products/observability/auto-instrumentation/openai_agents) -- [MLflow (self-hosted/OSS)](https://mlflow.org/docs/latest/tracing/integrations/openai-agent) -- [MLflow (Databricks hosted)](https://docs.databricks.com/aws/en/mlflow/mlflow-tracing#-automatic-tracing) -- [Braintrust](https://braintrust.dev/docs/guides/traces/integrations#openai-agents-sdk) -- [Pydantic Logfire](https://logfire.pydantic.dev/docs/integrations/llms/openai/#openai-agents) -- [AgentOps](https://docs.agentops.ai/v1/integrations/agentssdk) -- [Scorecard](https://docs.scorecard.io/docs/documentation/features/tracing#openai-agents-sdk-integration) -- [Keywords AI](https://docs.keywordsai.co/integration/development-frameworks/openai-agent) -- [LangSmith](https://docs.smith.langchain.com/observability/how_to_guides/trace_with_openai_agents_sdk) -- [Maxim AI](https://www.getmaxim.ai/docs/observe/integrations/openai-agents-sdk) -- [Comet Opik](https://www.comet.com/docs/opik/tracing/integrations/openai_agents) -- [Langfuse](https://langfuse.com/docs/integrations/openaiagentssdk/openai-agents) -- [Langtrace](https://docs.langtrace.ai/supported-integrations/llm-frameworks/openai-agents-sdk) -- [Okahu-Monocle](https://github.com/monocle2ai/monocle) -- [Galileo](https://v2docs.galileo.ai/integrations/openai-agent-integration#openai-agent-integration) -- [Portkey AI](https://portkey.ai/docs/integrations/agents/openai-agents) \ No newline at end of file +- Weights & Biases +- Arize-Phoenix +- Future AGI +- MLflow (self-hosted/OSS +- MLflow (Databricks hosted +- Braintrust +- Pydantic Logfire +- AgentOps +- Scorecard +- Keywords AI +- LangSmith +- Maxim AI +- Comet Opik +- Langfuse +- Langtrace +- Okahu-Monocle +- Galileo +- Portkey AI \ No newline at end of file diff --git a/docs/ja/visualization.md b/docs/ja/visualization.md index fdbd268dd..7aa219cc4 100644 --- a/docs/ja/visualization.md +++ b/docs/ja/visualization.md @@ -4,7 +4,7 @@ search: --- # エージェント可視化 -エージェント可視化を使用すると、 ** Graphviz ** を使ってエージェントとその関係を構造的なグラフィカル表現として生成できます。これは、アプリケーション内でエージェント、ツール、ハンドオフがどのように相互作用するかを理解するのに役立ちます。 +エージェント可視化では、 ** Graphviz ** を使用してエージェントとその関係を構造化されたグラフィカル表現として生成できます。これにより、アプリケーション内でエージェント、ツール、ハンドオフがどのように相互作用するかを理解しやすくなります。 ## インストール @@ -16,11 +16,11 @@ pip install "openai-agents[viz]" ## グラフの生成 -`draw_graph` 関数を使用してエージェントの可視化を生成できます。この関数は有向グラフを作成し、次のように表現します: +`draw_graph` 関数を使用してエージェント可視化を生成できます。この関数は有向グラフを作成し、次のように表現します: - ** エージェント ** は黄色のボックスで表示されます。 - ** ツール ** は緑色の楕円で表示されます。 -- ** ハンドオフ ** は一方のエージェントから別のエージェントへの有向エッジで示されます。 +- ** ハンドオフ ** はあるエージェントから別のエージェントへの有向エッジで表されます。 ### 使用例 @@ -52,34 +52,33 @@ triage_agent = Agent( draw_graph(triage_agent) ``` -![エージェントグラフ](../assets/images/graph.png) - -これにより、 ** triage agent ** の構造とサブエージェントおよびツールへの接続を視覚的に表現したグラフが生成されます。 +![Agent Graph](../assets/images/graph.png) +これにより、 ** トリアージ エージェント ** とそのサブエージェントやツールへの接続を視覚的に表したグラフが生成されます。 ## 可視化の理解 -生成されたグラフには次の要素が含まれます: +生成されたグラフには次が含まれます: -- エントリーポイントを示す ** start ノード ** ( `__start__` ) -- 黄色で塗りつぶされた ** 四角形 ** で示されるエージェント -- 緑色で塗りつぶされた ** 楕円 ** で示されるツール -- 相互作用を示す有向エッジ - - エージェント間のハンドオフには ** 実線矢印 ** - - ツール呼び出しには ** 破線矢印 ** -- 実行終了地点を示す ** end ノード ** ( `__end__` ) +- エントリーポイントを示す ** start ノード ** (`__start__`)。 +- 黄色で塗りつぶされた ** 長方形 ** で表されるエージェント。 +- 緑色で塗りつぶされた ** 楕円 ** で表されるツール。 +- 相互作用を示す有向エッジ: + - エージェント間ハンドオフには ** 実線矢印 **。 + - ツール呼び出しには ** 点線矢印 **。 +- 実行が終了する場所を示す ** end ノード ** (`__end__`)。 ## グラフのカスタマイズ ### グラフの表示 -デフォルトでは、`draw_graph` はグラフをインラインで表示します。別ウィンドウで表示するには、次のように記述します: +既定では、`draw_graph` はグラフをインラインで表示します。別ウィンドウで表示するには、次のように記述します: ```python draw_graph(triage_agent).view() ``` ### グラフの保存 -デフォルトでは、`draw_graph` はグラフをインラインで表示します。ファイルとして保存するには、ファイル名を指定します: +既定では、`draw_graph` はグラフをインラインで表示します。ファイルとして保存するには、ファイル名を指定してください: ```python draw_graph(triage_agent, filename="agent_graph") diff --git a/docs/ja/voice/pipeline.md b/docs/ja/voice/pipeline.md index 7cb9374e3..93fb1c92c 100644 --- a/docs/ja/voice/pipeline.md +++ b/docs/ja/voice/pipeline.md @@ -4,7 +4,7 @@ search: --- # パイプラインとワークフロー -` VoicePipeline ` クラスは、エージェントワークフローを音声アプリに簡単に組み込めます。ワークフローを渡すと、入力音声の文字起こし、音声終了の検出、適切なタイミングでのワークフロー呼び出し、そしてワークフロー出力を音声へ変換する処理をパイプラインが自動で行います。 +[`VoicePipeline`][agents.voice.pipeline.VoicePipeline] クラスは、エージェントベースのワークフローを音声アプリへ簡単に変換できます。ワークフローを渡すだけで、入力音声の文字起こし、音声の終了検知、適切なタイミングでのワークフロー実行、そしてワークフロー出力を音声へ変換する処理までをパイプラインが自動で行います。 ```mermaid graph LR @@ -34,37 +34,29 @@ graph LR ## パイプラインの設定 -パイプラインを作成するときに、次の項目を設定できます。 +パイプラインを作成する際に、次の項目を設定できます。 -1. [`workflow`][agents.voice.workflow.VoiceWorkflowBase] - 新しい音声が文字起こしされるたびに実行されるコードです。 -2. [`speech-to-text`][agents.voice.model.STTModel] と [`text-to-speech`][agents.voice.model.TTSModel] - 使用するモデルです。 -3. [`config`][agents.voice.pipeline_config.VoicePipelineConfig] - 以下のような設定が行えます。 - - モデルプロバイダー: モデル名をモデルにマッピングします。 - - トレーシング: トレーシングを無効化するか、音声ファイルをアップロードするか、ワークフロー名やトレース ID などを指定できます。 - - TTS と STT モデルの設定: プロンプト、言語、データ型などを指定します。 +1. [`workflow`][agents.voice.workflow.VoiceWorkflowBase] — 新しい音声が文字起こしされるたびに実行されるコード +2. [`speech-to-text`][agents.voice.model.STTModel] と [`text-to-speech`][agents.voice.model.TTSModel] モデル +3. [`config`][agents.voice.pipeline_config.VoicePipelineConfig] — 以下のような設定を含みます + - モデルプロバイダー: モデル名をモデルにマッピング + - トレーシング: トレーシングの無効化、音声ファイルのアップロード有無、ワークフロー名、トレース ID など + - TTS / STT モデルの設定: プロンプト、言語、データ型 など ## パイプラインの実行 -パイプラインは [`run()`][agents.voice.pipeline.VoicePipeline.run] メソッドで実行します。音声入力は次の 2 つの形式で渡せます。 +パイプラインは [`run()`][agents.voice.pipeline.VoicePipeline.run] メソッドで実行でき、音声入力を次の 2 形式で渡せます。 -1. [`AudioInput`][agents.voice.input.AudioInput] - 音声の全文文字起こしが既にあり、その結果だけを取得したい場合に使用します。事前録音された音声や、プッシュトゥトーク方式でユーザーが話し終えたタイミングが明確な場合などに便利です。 -2. [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput] - ユーザーが話し終えたかどうかを検出する必要がある場合に使用します。音声チャンクを検出ごとにプッシュでき、パイプラインが「アクティビティ検出」により適切なタイミングでエージェントワークフローを自動実行します。 +1. [`AudioInput`][agents.voice.input.AudioInput] — 既に音声全体の文字起こしがあり、その結果に対してただちに処理を行いたい場合に使用します。録音済み音声や、ユーザーが話し終わるタイミングが明確なプッシュ・トゥ・トーク型アプリなど、話者の終了検知が不要なケースに便利です。 +2. [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput] — ユーザーが話し終わったかを検知する必要がある場合に使用します。音声チャンクを検出次第プッシュでき、パイプラインが「アクティビティ検知」を通じて適切なタイミングでエージェントワークフローを自動実行します。 ## 結果 -音声パイプライン実行の結果は [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult] です。このオブジェクトを通じてイベントをストリーム形式で受け取れます。イベントの種類は [`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] がいくつかあります。 +音声パイプラインの実行結果は [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult] です。このオブジェクトにより、発生するイベントをストリーミング形式で受け取れます。いくつかの [`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] 種類があります。 -1. [`VoiceStreamEventAudio`][agents.voice.events.VoiceStreamEventAudio] - 音声チャンクを含みます。 -2. [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle] - ターンの開始・終了などライフサイクルイベントを通知します。 -3. [`VoiceStreamEventError`][agents.voice.events.VoiceStreamEventError] - エラーイベントです。 +1. [`VoiceStreamEventAudio`][agents.voice.events.VoiceStreamEventAudio] — 音声チャンクを含みます。 +2. [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle] — ターンの開始や終了などライフサイクルイベントを通知します。 +3. [`VoiceStreamEventError`][agents.voice.events.VoiceStreamEventError] — エラーイベントです。 ```python @@ -84,4 +76,5 @@ async for event in result.stream(): ### 割り込み -Agents SDK には現在、` StreamedAudioInput ` に対する組み込みの割り込みサポートはありません。検出された各ターンごとにワークフローが個別に実行されます。アプリケーション内で割り込みを処理したい場合は、` VoiceStreamEventLifecycle ` イベントを監視してください。` turn_started ` は新しいターンが文字起こしされ、処理が開始されたことを示します。` turn_ended ` は該当ターンの音声がすべて送信された後に発火します。モデルがターンを開始したときにマイクをミュートし、関連する音声をすべて送信し終えた後にマイクをアンミュートする、といった制御にこれらのイベントを利用できます。 \ No newline at end of file +Agents SDK には現在、[`StreamedAudioInput`][agents.voice.input.StreamedAudioInput] 向けの組み込み割り込み機能がありません。そのため、検出された各ターンごとにワークフローの個別実行がトリガーされます。アプリケーション内で割り込みを処理したい場合は、[`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle] を監視してください。 +`turn_started` は新しいターンが文字起こしされ処理が開始されたことを示し、`turn_ended` はそのターンに関連するすべての音声が送信された後に発火します。これらのイベントを利用して、モデルがターンを開始した際に話者のマイクをミュートし、関連音声をすべて送信し終えた後にアンミュートするといった制御が可能です。 \ No newline at end of file diff --git a/docs/ja/voice/quickstart.md b/docs/ja/voice/quickstart.md index c24b92b40..8775f3e84 100644 --- a/docs/ja/voice/quickstart.md +++ b/docs/ja/voice/quickstart.md @@ -6,19 +6,19 @@ search: ## 前提条件 -まず、 Agents SDK の基本クイックスタート手順に従い、仮想環境をセットアップしてください。その後、SDK から音声用のオプション依存関係をインストールします: +まず、 Agents SDK の基本クイックスタート手順に従い、仮想環境をセットアップしていることを確認してください。その後、SDK から音声用のオプション依存関係をインストールします: ```bash pip install 'openai-agents[voice]' ``` -## 基本概念 +## 概念 -押さえておくべき主な概念は [`VoicePipeline`][agents.voice.pipeline.VoicePipeline] で、次の 3 ステップから成るプロセスです: +中心となる概念は [`VoicePipeline`][agents.voice.pipeline.VoicePipeline] で、これは 3 段階のプロセスです。 -1. 音声をテキストに変換する speech-to-text モデルを実行します。 -2. 通常はエージェント的ワークフローであるあなたのコードを実行し、結果を生成します。 -3. 結果のテキストを音声に戻す text-to-speech モデルを実行します。 +1. 音声をテキストへ変換する speech-to-text モデルを実行します。 +2. 通常はエージェント的ワークフローであるあなたのコードを実行し、実行結果を生成します。 +3. result テキストを再び音声へ変換する text-to-speech モデルを実行します。 ```mermaid graph LR @@ -48,7 +48,7 @@ graph LR ## エージェント -まず、いくつかのエージェントをセットアップしましょう。すでにこの SDK でエージェントを構築したことがあれば、馴染みがあるはずです。ここでは複数のエージェント、ハンドオフ、ツールを用意します。 +まずはエージェントをいくつか設定しましょう。この SDK でエージェントを構築したことがある方にはおなじみの流れです。ここでは複数のエージェントとハンドオフ、ツールを用意します。 ```python import asyncio @@ -92,7 +92,7 @@ agent = Agent( ## 音声パイプライン -[`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow] をワークフローとして使用し、シンプルな音声パイプラインをセットアップします。 +[`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow] をワークフローとして、シンプルな音声パイプラインを設定します。 ```python from agents.voice import SingleAgentVoiceWorkflow, VoicePipeline @@ -124,7 +124,7 @@ async for event in result.stream(): ``` -## 統合例 +## 統合 ```python import asyncio @@ -195,4 +195,4 @@ if __name__ == "__main__": asyncio.run(main()) ``` -このサンプルを実行すると、エージェントがあなたに話しかけてくれます。実際に自分でエージェントと会話できるデモは、[examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static) の例をご覧ください。 \ No newline at end of file +この例を実行すると、エージェントがあなたに話しかけます！自分でエージェントと会話するデモについては、[examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static) の例を参照してください。 \ No newline at end of file diff --git a/docs/ja/voice/tracing.md b/docs/ja/voice/tracing.md index e8dbda2a9..39382d71f 100644 --- a/docs/ja/voice/tracing.md +++ b/docs/ja/voice/tracing.md @@ -4,15 +4,15 @@ search: --- # トレーシング -[エージェントがトレーシングされる方法](../tracing.md) と同様に、音声パイプラインも自動的にトレーシングされます。 +[エージェントがトレーシングされる](../tracing.md) のと同様に、voice pipeline も自動的にトレーシングされます。 -トレーシングの基本情報については上記のドキュメントをご覧ください。また、 `VoicePipelineConfig` を使用してパイプラインのトレーシングを追加で設定できます。 +基本的なトレーシングの情報については上記のドキュメントをご覧ください。加えて、[`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig] を介して pipeline のトレーシングを設定することもできます。 -主なトレーシング関連フィールドは次のとおりです。 +主なトレーシング関連フィールドは次のとおりです: -- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: トレーシングを無効にするかどうかを制御します。デフォルトではトレーシングは有効です。 -- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: 音声の書き起こしなど、機微情報をトレースに含めるかどうかを制御します。これは音声パイプライン専用であり、 Workflow 内の処理には影響しません。 -- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]: トレースに音声データを含めるかどうかを制御します。 -- [`workflow_name`][agents.voice.pipeline_config.VoicePipelineConfig.workflow_name]: トレースワークフローの名前です。 -- [`group_id`][agents.voice.pipeline_config.VoicePipelineConfig.group_id]: 複数のトレースを関連付けるための `group_id` です。 +- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: トレーシングを無効にするかどうかを制御します。既定ではトレーシングは有効です。 +- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: オーディオの書き起こしなどの機密データをトレースに含めるかどうかを制御します。これは voice pipeline 専用で、Workflow 内部で行われる処理には影響しません。 +- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]: トレースにオーディオ データを含めるかどうかを制御します。 +- [`workflow_name`][agents.voice.pipeline_config.VoicePipelineConfig.workflow_name]: トレース Workflow の名前です。 +- [`group_id`][agents.voice.pipeline_config.VoicePipelineConfig.group_id]: トレースの `group_id` で、複数のトレースをリンクできます。 - [`trace_metadata`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: トレースに追加するメタデータです。 \ No newline at end of file