diff --git a/docs/ja/agents.md b/docs/ja/agents.md index c2eba6300..991bae3d4 100644 --- a/docs/ja/agents.md +++ b/docs/ja/agents.md @@ -4,16 +4,16 @@ search: --- # エージェント -エージェントは、アプリにおける中核的なビルディングブロックです。エージェントは、インストラクションとツールで構成された LLM です。 +エージェントはアプリの中心的な構成要素です。エージェントとは、指示とツールで構成された大規模言語モデル（ LLM ）です。 ## 基本設定 -エージェントで最もよく設定するプロパティは次のとおりです: +エージェントを設定する際によく使うプロパティは次のとおりです。 -- `name`: エージェントを識別する必須の文字列です。 -- `instructions`: 開発者メッセージ、または system prompt とも呼ばれます。 -- `model`: 使用する LLM を指定します。`model_settings` を併用すると temperature、top_p などのモデル調整パラメーターを設定できます。 -- `tools`: エージェントがタスク達成のために使用できるツールです。 +- `name`: エージェントを識別する必須の文字列です。 +- `instructions`: 開発者メッセージ、またはシステムプロンプトとも呼ばれます。 +- `model`: 使用する LLM と、`temperature`、`top_p` などのモデル調整用パラメーターを設定する任意の `model_settings`。 +- `tools`: エージェントがタスクを達成するために利用できるツール群です。 ```python from agents import Agent, ModelSettings, function_tool @@ -33,7 +33,7 @@ agent = Agent( ## コンテキスト -エージェントは `context` 型に対してジェネリックです。コンテキストは依存性注入の仕組みで、`Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、エージェント実行時の依存関係と状態を格納する入れ物として機能します。コンテキストには任意の Python オブジェクトを指定できます。 +エージェントは `context` 型を汎用的に扱います。コンテキストは依存性注入のためのツールで、`Runner.run()` に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、エージェント実行時の依存関係や状態をまとめて保持します。任意の Python オブジェクトをコンテキストとして提供できます。 ```python @dataclass @@ -52,7 +52,7 @@ agent = Agent[UserContext]( ## 出力タイプ -既定では、エージェントはプレーンテキスト (つまり `str`) を出力します。特定の型で出力させたい場合は `output_type` パラメーターを使用できます。よく使われるのは Pydantic オブジェクトですが、Pydantic の TypeAdapter でラップできる型 — dataclass、list、TypedDict など — であれば何でもサポートしています。 +デフォルトでは、エージェントはプレーンテキスト（`str`）を出力します。特定の型で出力させたい場合は `output_type` パラメーターを使用します。一般的には [Pydantic](https://docs.pydantic.dev/) オブジェクトを指定しますが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップできる型（ dataclass、リスト、TypedDict など）であれば利用できます。 ```python from pydantic import BaseModel @@ -73,11 +73,11 @@ agent = Agent( !!! note - `output_type` を渡すと、モデルは通常のプレーンテキスト応答の代わりに structured outputs を使用するよう指示されます。 + `output_type` を渡すと、モデルは通常のプレーンテキスト応答ではなく [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するようになります。 ## ハンドオフ -ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフのリストを渡すと、必要に応じてエージェントがそれらに処理を委譲できます。これは、単一タスクに特化したモジュール式のエージェントをオーケストレーションする強力なパターンです。詳細は [handoffs](handoffs.md) ドキュメントをご覧ください。 +ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフのリストを渡すと、エージェントは必要に応じてそれらに委譲します。これにより、単一タスクに特化したモジュール型のエージェントをオーケストレーションする強力なパターンが実現します。詳細は [handoffs](handoffs.md) ドキュメントをご覧ください。 ```python from agents import Agent @@ -98,7 +98,7 @@ triage_agent = Agent( ## 動的インストラクション -通常はエージェント作成時にインストラクションを指定しますが、関数を介して動的に渡すこともできます。その関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方が利用可能です。 +多くの場合、エージェント作成時に instructions を指定しますが、関数を通じて動的に instructions を提供することも可能です。その関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方を使用できます。 ```python def dynamic_instructions( @@ -115,13 +115,13 @@ agent = Agent[UserContext]( ## ライフサイクルイベント（フック） -エージェントのライフサイクルを観察したい場合があります。たとえば、イベントをログに記録したり、特定のイベント発生時にデータをプリフェッチしたりするケースです。そのようなときは `hooks` プロパティを使ってライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスを継承し、関心のあるメソッドをオーバーライドしてください。 +エージェントのライフサイクルを監視したい場合があります。たとえば、イベントをログに記録したり、特定のイベント発生時にデータを事前取得したりできます。`hooks` プロパティを使ってエージェントのライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、必要なメソッドをオーバーライドしてください。 ## ガードレール -ガードレールを使用すると、エージェントの実行と並行してユーザー入力のチェックやバリデーションを行えます。たとえば、ユーザー入力の関連性をスクリーニングできます。詳細は [guardrails](guardrails.md) ドキュメントを参照してください。 +ガードレールを使用すると、エージェント実行と並行してユーザー入力に対するチェックやバリデーションを実行できます。たとえば、ユーザー入力の関連性をスクリーニングすることが可能です。詳細は [guardrails](guardrails.md) ドキュメントをご覧ください。 -## エージェントのクローン/コピー +## エージェントのクローン／コピー エージェントの `clone()` メソッドを使用すると、エージェントを複製し、任意のプロパティを変更できます。 @@ -140,15 +140,109 @@ robot_agent = pirate_agent.clone( ## ツール使用の強制 -ツールのリストを指定しても、 LLM が必ずしもツールを使用するとは限りません。[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツール使用を強制できます。指定可能な値は次のとおりです: +ツールをリストで渡しても、必ずしも LLM がツールを使用するとは限りません。[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定することでツール使用を強制できます。利用可能な値は次のとおりです。 -1. `auto` — LLM がツールを使うかどうかを判断します。 -2. `required` — LLM にツールの使用を必須とします (ただしどのツールを使うかは自動で判断)。 -3. `none` — LLM にツールを使用しないことを要求します。 -4. 具体的な文字列 (例: `my_tool`) — LLM にその特定のツールを使用させます。 +1. `auto`: LLM がツールを使用するか否かを決定します。 +2. `required`: LLM にツールの使用を必須とします（どのツールを使用するかは自動で選択）。 +3. `none`: LLM にツールを使用しないことを要求します。 +4. 特定の文字列（例: `my_tool`）を設定すると、そのツールを必ず使用します。 -!!! note +```python +from agents import Agent, Runner, function_tool, ModelSettings + +@function_tool +def get_weather(city: str) -> str: + """Returns weather info for the specified city.""" + return f"The weather in {city} is sunny" + +agent = Agent( + name="Weather Agent", + instructions="Retrieve weather details.", + tools=[get_weather], + model_settings=ModelSettings(tool_choice="get_weather") +) +``` + +## ツール使用時の挙動 + +`Agent` の `tool_use_behavior` パラメーターは、ツール出力の扱い方を制御します。 +- `"run_llm_again"`: デフォルト。ツールを実行後、その結果を LLM が処理して最終応答を生成します。 +- `"stop_on_first_tool"`: 最初のツール呼び出しの出力を最終応答として使用し、以降の LLM 処理は行いません。 - 無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループは、ツール結果が LLM に送られ、それにより `tool_choice` の設定でさらにツール呼び出しが生成される、というサイクルが延々と続くために発生します。 +```python +from agents import Agent, Runner, function_tool, ModelSettings + +@function_tool +def get_weather(city: str) -> str: + """Returns weather info for the specified city.""" + return f"The weather in {city} is sunny" + +agent = Agent( + name="Weather Agent", + instructions="Retrieve weather details.", + tools=[get_weather], + tool_use_behavior="stop_on_first_tool" +) +``` + +- `StopAtTools(stop_at_tool_names=[...])`: 指定したいずれかのツールが呼び出された時点で停止し、そのツールの出力を最終応答として使用します。 +```python +from agents import Agent, Runner, function_tool +from agents.agent import StopAtTools + +@function_tool +def get_weather(city: str) -> str: + """Returns weather info for the specified city.""" + return f"The weather in {city} is sunny" + +@function_tool +def sum_numbers(a: int, b: int) -> int: + """Adds two numbers.""" + return a + b + +agent = Agent( + name="Stop At Stock Agent", + instructions="Get weather or sum numbers.", + tools=[get_weather, sum_numbers], + tool_use_behavior=StopAtTools(stop_at_tool_names=["get_weather"]) +) +``` +- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM 継続かを決定するカスタム関数です。 + +```python +from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper +from agents.agent import ToolsToFinalOutputResult +from typing import List, Any + +@function_tool +def get_weather(city: str) -> str: + """Returns weather info for the specified city.""" + return f"The weather in {city} is sunny" + +def custom_tool_handler( + context: RunContextWrapper[Any], + tool_results: List[FunctionToolResult] +) -> ToolsToFinalOutputResult: + """Processes tool results to decide final output.""" + for result in tool_results: + if result.output and "sunny" in result.output: + return ToolsToFinalOutputResult( + is_final_output=True, + final_output=f"Final weather: {result.output}" + ) + return ToolsToFinalOutputResult( + is_final_output=False, + final_output=None + ) + +agent = Agent( + name="Weather Agent", + instructions="Retrieve weather details.", + tools=[get_weather], + tool_use_behavior=custom_tool_handler +) +``` + +!!! note - ツール呼び出し後に (auto モードで続行するのではなく) エージェントを完全に停止させたい場合は、[`Agent.tool_use_behavior="stop_on_first_tool"`] を設定してください。これにより、ツールの出力をそのまま最終レスポンスとして使用し、追加の LLM 処理を行いません。 \ No newline at end of file + 無限ループを防ぐため、ツール呼び出し後にフレームワークは自動的に `tool_choice` を "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定可能です。ツール結果が LLM に送られるたびに `tool_choice` により再度ツール呼び出しが発生し、無限に続く可能性があるためです。 \ No newline at end of file diff --git a/docs/ja/config.md b/docs/ja/config.md index bfaabb3a3..b7e6417d2 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 は環境変数で指定された API キーまたは上記で設定したデフォルトキーを使って `AsyncOpenAI` インスタンスを生成します。 [set_default_openai_client()][agents.set_default_openai_client] 関数を使うことでこれを変更できます。 +別の方法として、使用する OpenAI クライアントを設定することもできます。デフォルトでは、 SDK は環境変数にある API キー、または上記で設定したデフォルトキーを使用して `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 キー（環境変数または設定したデフォルトキー）を使用します。 [`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使ってトレーシングに使用する API キーを個別に設定できます。 +トレーシングはデフォルトで有効になっています。デフォルトでは、上記の OpenAI API キー（つまり環境変数またはあなたが設定したデフォルトキー）を使用します。[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使って、トレーシング専用の API キーを設定できます。 ```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 にはハンドラーが設定されていない Python ロガーが 2 つあります。デフォルトでは警告とエラーが `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 @@ -62,7 +62,7 @@ from agents import enable_verbose_stdout_logging enable_verbose_stdout_logging() ``` -ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることもできます。詳細は [Python logging ガイド](https://docs.python.org/3/howto/logging.html) をご覧ください。 +あるいは、ハンドラ、フィルタ、フォーマッタなどを追加してログをカスタマイズすることもできます。詳しくは [Python logging guide](https://docs.python.org/3/howto/logging.html) をご覧ください。 ```python import logging @@ -81,9 +81,9 @@ logger.setLevel(logging.WARNING) logger.addHandler(logging.StreamHandler()) ``` -### ログに含まれる機密データ +### ログ内の機密データ -一部のログには機密データ（例: ユーザー データ）が含まれる場合があります。これらのデータをログに残さないようにするには、次の環境変数を設定してください。 +一部のログには機密データ（例: ユーザー データ）が含まれる場合があります。これらのデータが記録されないようにするには、次の環境変数を設定してください。 LLM の入力と出力をログに残さないようにするには: diff --git a/docs/ja/context.md b/docs/ja/context.md index 53a100b18..98eeaffba 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` からアクセスできます。 -**最も重要** な注意点: 同じエージェント実行内のすべてのエージェント、ツール関数、ライフサイクルフックは、同一 _型_ のコンテキストを使用しなければなりません。 +最も重要なのは、特定のエージェント実行（run）において、エージェント・ツール関数・ライフサイクルフックなどが **同じ型** のコンテキストを共有しなければならない点です。 -コンテキストは次のような用途に利用できます。 +コンテキストは次のような用途で利用できます。 -- 実行に関するコンテキストデータ（例: ユーザー名 / uid など user に関する情報） -- 依存関係（例: ロガーオブジェクト、データフェッチャーなど） -- ヘルパー関数 +- 実行時の状況依存データ（例: ユーザー名 / 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` でマークすることで、型チェッカーが誤り（例: 異なるコンテキスト型のツールを渡した場合）を検出できます。 -4. `run` 関数にコンテキストを渡しています。 -5. エージェントはツールを正しく呼び出し、年齢を取得します。 +1. これがコンテキストオブジェクトです。ここでは dataclass を使っていますが、任意の型を利用できます。 +2. これはツールです。`RunContextWrapper[UserInfo]` を受け取り、実装側でコンテキストを読み取ります。 +3. エージェントをジェネリック型 `UserInfo` でマークし、型チェッカーでエラーを検出できるようにします（例: 別のコンテキスト型を受け取るツールを渡そうとした場合）。 +4. `run` 関数にコンテキストを渡します。 +5. エージェントはツールを正しく呼び出し、年齢を取得します。 -## エージェント / LLM コンテキスト +## エージェント／LLM コンテキスト -LLM が呼び出される際、**唯一** 参照できるデータは会話履歴からのものです。そのため、新しいデータを LLM に利用させたい場合は、その履歴に組み込む形で提供しなければなりません。主な方法は次のとおりです。 +LLM が呼び出されるとき、LLM が参照可能なデータは会話履歴だけです。そのため、新しいデータを LLM に渡したい場合は、そのデータが会話履歴に含まれるようにしなければなりません。方法は次のとおりです。 -1. エージェントの `instructions` に追加する。これは「system prompt」や「developer message」としても知られます。system prompt は静的文字列でも、コンテキストを受け取って文字列を出力する動的関数でも構いません。たとえば user の名前や現在の日付など、常に役立つ情報を提供する一般的な手法です。 -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. function tools を通じて公開する。必要に応じて LLM がデータを取得できるオンデマンド型のコンテキストに適しています。 -4. リトリーバルや Web 検索を利用する。これらはファイルやデータベースから関連データを取得する（リトリーバル）、または Web から取得する（Web 検索）特殊なツールです。関連するコンテキストデータで応答を「グラウンディング」したい場合に有効です。 \ No newline at end of file +1. Agent の `instructions` に追加する。これは「system prompt」や「developer message」とも呼ばれます。System prompt は静的な文字列でも、コンテキストを受け取って文字列を返す動的関数でも構いません。たとえばユーザー名や現在の日付など、常に役立つ情報を渡す一般的な方法です。 +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 5b4cf5d35..df7ad9a95 100644 --- a/docs/ja/examples.md +++ b/docs/ja/examples.md @@ -2,43 +2,46 @@ search: exclude: true --- -# コード例 +# サンプル -さまざまな sample implementation of the SDK は、[リポジトリ](https://github.com/openai/openai-agents-python/tree/main/examples) の examples セクションでご覧いただけます。これらのコード例は、異なるパターンや機能を示す複数のカテゴリーに整理されています。 +[`repo`](https://github.com/openai/openai-agents-python/tree/main/examples) の examples セクションでは、SDK の多彩な実装サンプルを確認できます。例は、さまざまなパターンと機能を示す複数のカテゴリーに整理されています。 ## カテゴリー -- **[agent_patterns](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns):** - このカテゴリーのコード例では、一般的なエージェント設計パターンを示しています。例： - - 決定論的ワークフロー - - ツールとしてのエージェント - - エージェントの並列実行 +- **[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 の基礎的な機能を紹介しています。例： - - 動的なシステムプロンプト - - 出力のストリーミング - - ライフサイクルイベント + - 決定論的ワークフロー + - ツールとしてのエージェント + - エージェントの並列実行 -- **[tool examples](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** - Web 検索やファイル検索など、OpenAI がホストするツールを実装し、エージェントに統合する方法を学べます。 +- **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** + ここでは、SDK の基礎的な機能を紹介します。例: -- **[model providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** - OpenAI 以外のモデルを SDK で利用する方法を紹介します。 + - 動的な system prompt + - ストリーミング出力 + - ライフサイクルイベント -- **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** - エージェントのハンドオフの実践例をご覧ください。 +- **[tool examples](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** + Web 検索やファイル検索など、OpenAI がホストするツールの実装方法と、それらをエージェントに統合する方法を学べます。 -- **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** - MCP を用いてエージェントを構築する方法を学びます。 +- **[model providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** + OpenAI 以外のモデルを SDK と共に利用する方法を探ることができます。 -- **[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**: シンプルなディープリサーチクローン。 +- **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** + エージェントのハンドオフに関する実践的な例を確認できます。 -- **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** - TTS と STT モデルを使った音声エージェントの例をご覧ください。 +- **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** + MCP を用いたエージェントの構築方法を学べます。 -- **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** - SDK を使ってリアルタイム体験を構築する方法を示すコード例。 \ No newline at end of file +- **[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**: シンプルなディープリサーチ クローン。 + +- **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** + TTS と STT モデルを使用した音声エージェントの例を確認できます。 + +- **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** + SDK を用いたリアルタイム体験の構築方法を示す例です。 \ No newline at end of file diff --git a/docs/ja/guardrails.md b/docs/ja/guardrails.md index 1acd066b6..d2400f0ac 100644 --- a/docs/ja/guardrails.md +++ b/docs/ja/guardrails.md @@ -4,44 +4,44 @@ search: --- # ガードレール -ガードレールはエージェントと _並列_ に実行され、ユーザー入力のチェックやバリデーションを行います。たとえば、顧客リクエストを支援するためにとても賢い（その分、遅く・高価な）モデルを使うエージェントがあるとします。悪意あるユーザーがそのモデルに数学の宿題を手伝わせるような要求をしてほしくはありません。そのため、速く・安価なモデルでガードレールを実行できます。ガードレールが悪意ある使用を検出した場合、直ちにエラーを発生させ、高価なモデルの実行を停止し、時間とコストを節約できます。 +ガードレールはエージェントと _並列_ に実行され、ユーザー入力のチェックとバリデーションを行えます。たとえば、非常に賢い（つまり遅く／高価な）モデルを使ってカスタマーリクエストに対応するエージェントがあるとします。悪意のあるユーザーがモデルに数学の宿題を手伝わせようとするのは避けたいでしょう。そこで、速く／安価なモデルを使ってガードレールを実行できます。ガードレールが悪意のある利用を検知した場合、即座にエラーを送出し、高価なモデルの実行を停止して時間とコストを節約します。 -ガードレールには 2 種類あります: +ガードレールには 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. これがワークフローを定義する実際のエージェントです。 出力ガードレールも同様です。 @@ -155,4 +155,4 @@ async def main(): 1. これは実際のエージェントの出力型です。 2. これはガードレールの出力型です。 3. これはエージェントの出力を受け取り、結果を返すガードレール関数です。 -4. これはワークフローを定義する実際のエージェントです。 \ No newline at end of file +4. これがワークフローを定義する実際のエージェントです。 \ No newline at end of file diff --git a/docs/ja/handoffs.md b/docs/ja/handoffs.md index 15535e4a0..7114ea6c3 100644 --- a/docs/ja/handoffs.md +++ b/docs/ja/handoffs.md @@ -4,19 +4,19 @@ search: --- # ハンドオフ -ハンドオフを使用すると、エージェントはタスクを別のエージェントに委任できます。これは、異なるエージェントがそれぞれ特定の分野に特化しているシナリオで特に有用です。たとえば、カスタマーサポート アプリでは、注文状況、返金、FAQ などのタスクをそれぞれ担当するエージェントが存在する場合があります。 +Handoffs は、エージェント がタスクを別のエージェント に委譲できるしくみです。これは、異なるエージェント がそれぞれ異なる分野を専門としているシナリオで特に有用です。たとえばカスタマーサポートアプリでは、注文状況、返金、FAQ などを個別に処理するエージェント を用意できます。 -ハンドオフは LLM には tool として表現されます。そのため、`Refund Agent` というエージェントへのハンドオフであれば、tool 名は `transfer_to_refund_agent` になります。 +ハンドオフは LLM からは tool として扱われます。たとえば `Refund Agent` というエージェント へのハンドオフがある場合、その tool 名は `transfer_to_refund_agent` になります。 ## ハンドオフの作成 -すべてのエージェントには [`handoffs`][agents.agent.Agent.handoffs] パラメーターがあり、`Agent` を直接渡すことも、ハンドオフをカスタマイズする `Handoff` オブジェクトを渡すこともできます。 +すべてのエージェント には [`handoffs`][agents.agent.Agent.handoffs] パラメーター があり、`Agent` を直接指定することも、ハンドオフをカスタマイズする `Handoff` オブジェクトを渡すこともできます。 -Agents SDK が提供する [`handoff()`][agents.handoffs.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()`][agents.handoffs.handoff] 関数を使用すると、さまざまなカスタマイズが可能です。 +[`handoff()`][agents.handoffs.handoff] 関数では、次の項目をカスタマイズできます。 -- `agent`: ハンドオフ先となるエージェントです。 -- `tool_name_override`: 既定では `Handoff.default_tool_name()` により `transfer_to_` が使用されます。これを上書きできます。 -- `tool_description_override`: `Handoff.default_tool_description()` で生成される既定の tool 説明を上書きします。 -- `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()` の既定の tool 説明を上書きします。 +- `on_handoff`: ハンドオフが呼び出されたときに実行されるコールバック関数です。ハンドオフが確定したタイミングでデータ取得を開始するなどに便利です。この関数はエージェント コンテキストを受け取り、`input_type` に応じて LLM が生成した入力も受け取れます。 +- `input_type`: ハンドオフが期待する入力の型 (オプション)。 +- `input_filter`: 次のエージェント が受け取る入力をフィルタリングします。詳しくは後述します。 ```python from agents import Agent, handoff, RunContextWrapper @@ -57,9 +57,9 @@ handoff_obj = handoff( ) ``` -## ハンドオフ入力 +## ハンドオフの入力 -状況によっては、LLM がハンドオフを呼び出す際にデータを渡してほしい場合があります。たとえば「エスカレーション エージェント」へのハンドオフでは、理由を受け取り、それを記録したいことが考えられます。 +状況によっては、LLM がハンドオフを呼び出す際にデータを渡してほしい場合があります。たとえば「エスカレーション エージェント」へのハンドオフでは、記録用に理由を受け取りたいかもしれません。 ```python from pydantic import BaseModel @@ -83,9 +83,9 @@ handoff_obj = handoff( ## 入力フィルター -ハンドオフが発生すると、新しいエージェントが会話を引き継ぎ、それまでの全履歴を閲覧できる状態になります。これを変更したい場合は、[`input_filter`][agents.handoffs.Handoff.input_filter] を設定できます。入力フィルターは [`HandoffInputData`][agents.handoffs.HandoffInputData] を受け取り、新しい `HandoffInputData` を返す関数です。 +ハンドオフが発生すると、新しいエージェント が会話を引き継ぎ、これまでの会話履歴全体を閲覧できます。これを変更したい場合は、[`input_filter`][agents.handoffs.Handoff.input_filter] を設定します。入力フィルターは [`HandoffInputData`][agents.handoffs.HandoffInputData] を受け取り、新しい `HandoffInputData` を返す関数です。 -一般的なパターン (たとえば履歴からすべての tool 呼び出しを削除するなど) は、[`agents.extensions.handoff_filters`][] に実装されています。 +よくあるパターン (たとえば履歴からすべての tool コールを削除する) は [`agents.extensions.handoff_filters`][] に実装済みです。 ```python from agents import Agent, handoff @@ -99,11 +99,11 @@ handoff_obj = handoff( ) ``` -1. これにより `FAQ agent` が呼び出される際、履歴からすべての tool が自動的に除去されます。 +1. これにより、`FAQ agent` が呼び出されたとき履歴からすべての tool が自動的に削除されます。 ## 推奨プロンプト -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 e0a58b1ac..a009f34de 100644 --- a/docs/ja/index.md +++ b/docs/ja/index.md @@ -4,31 +4,31 @@ 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 アプリを構築できます。これは、以前にエージェント向けに実験的に公開していた [Swarm](https://github.com/openai/swarm/tree/main) の本番運用向けアップグレード版です。Agents SDK には、基本コンポーネントがごく少数しかありません: -- **エージェント**： instructions と tools を備えた LLM です -- **ハンドオフ**：特定のタスクを他のエージェントに委任できます -- **ガードレール**：エージェントへの入力を検証できます -- **セッション**：エージェントの実行間で会話履歴を自動的に維持します +- **エージェント**: instructions と tools を備えた LLM +- **ハンドオフ**: 特定のタスクを他のエージェントに委任 +- **ガードレール**: エージェントへの入力を検証 +- **セッション**: エージェントの実行間で会話履歴を自動保持 -Python と組み合わせることで、これらの基本コンポーネントは tools とエージェント間の複雑な関係を表現でき、急な学習コストなしに実用的なアプリケーションを構築できます。さらに、SDK には組み込みの tracing が付属しており、エージェントのフローを可視化・デバッグできるほか、評価やモデルのファインチューニングにも活用できます。 +Python と組み合わせることで、これらの基本コンポーネントはツールとエージェント間の複雑な関係を表現でき、急な学習曲線なく実用的なアプリを構築できます。さらに、SDK には組み込みの **トレーシング** があり、エージェントフローを可視化・デバッグできるほか、評価やモデルのファインチューニングにも活用できます。 -## Agents SDK を使用する理由 +## Agents SDK を使う理由 -SDK には 2 つの設計原則があります。 +SDK には次の 2 つの設計原則があります。 -1. 使う価値のある十分な機能を備えつつ、学習を早めるために基本コンポーネントは少なくする。 -2. デフォルトで優れた動作を提供しつつ、必要に応じて挙動を細かくカスタマイズできる。 +1. 使う価値があるだけの機能は備えつつ、学習コストを抑えるために基本コンポーネントの数は最小限にする。 +2. すぐに使えるが、挙動を細かくカスタマイズできる。 -以下は SDK の主な機能です。 +主な機能は次のとおりです。 -- エージェントループ: ツールの呼び出し、結果を LLM に送信、LLM が完了するまでループを実行する処理を内蔵 -- Python ファースト: 新しい抽象を学ぶことなく、言語の標準機能だけでエージェントをオーケストレーションし連携可能 -- ハンドオフ: 複数のエージェント間で調整・委任を行える強力な機能 -- ガードレール: エージェントと並行して入力バリデーションやチェックを実行し、失敗時には早期に処理を終了 -- セッション: エージェント実行間の会話履歴を自動で管理し、手動で状態を保持する手間を排除 -- 関数ツール: 任意の Python 関数をツールに変換し、自動スキーマ生成と Pydantic ベースのバリデーションを提供 -- トレーシング: ワークフローの可視化・デバッグ・モニタリングを行い、 OpenAI の評価、ファインチューニング、蒸留ツールも活用可能 +- Agent loop: tools の呼び出し、結果を LLM へ渡す処理、LLM が完了するまでのループを自動で実行。 +- Python ファースト: 新しい抽象を覚えることなく、Python の言語機能でエージェントをオーケストレーション・連鎖。 +- ハンドオフ: 複数のエージェント間で調整・委任を行う強力な機能。 +- ガードレール: エージェントと並行して入力の検証・チェックを実行し、失敗時には早期に停止。 +- セッション: エージェントの実行間で会話履歴を自動管理し、手動で状態を扱う必要を排除。 +- 関数ツール: 任意の Python 関数をツール化し、自動スキーマ生成と Pydantic ベースのバリデーションを提供。 +- トレーシング: ワークフローを可視化・デバッグ・監視できる組み込みトレーシング。さらに OpenAI の評価、ファインチューニング、蒸留ツールを利用可能。 ## インストール @@ -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 e0d188205..5e72f149c 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 は、アプリケーションが LLM へコンテキストを提供する方法を標準化するオープンプロトコルです。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`、`MCPServerSse`、`MCPServerStreamableHttp` クラスを用いて接続できます。 +これらのサーバーには [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]、[`MCPServerSse`][agents.mcp.server.MCPServerSse]、[`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] クラスを使って接続できます。 -たとえば、公式 MCP ファイルシステムサーバーを使用する場合は次のようになります。 +たとえば、[公式 MCP filesystem サーバー](https://www.npmjs.com/package/@modelcontextprotocol/server-filesystem) を使用する場合は次のようになります。 ```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 @@ -52,13 +52,13 @@ 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,21 @@ server = MCPServerStdio( ) ``` -`ToolFilterContext` でアクセスできる情報 -- `run_context`: 現在のランコンテキスト +`ToolFilterContext` では次の情報を取得できます。 +- `run_context`: 現在の実行コンテキスト - `agent`: ツールを要求しているエージェント - `server_name`: MCP サーバー名 ## プロンプト -MCP サーバーはプロンプトも提供でき、これを使ってエージェントの instructions を動的に生成できます。これにより、パラメーターでカスタマイズ可能な再利用可能な instructions テンプレートを作成できます。 +MCP サーバーは、エージェント の instructions を動的に生成するためのプロンプトも提供できます。これにより、パラメーターでカスタマイズ可能な再利用可能な instruction テンプレートを作成できます。 ### プロンプトの使用 プロンプトをサポートする MCP サーバーは、次の 2 つの主要メソッドを提供します。 -- `list_prompts()`: サーバー上で利用可能なすべてのプロンプトを一覧表示します。 -- `get_prompt(name, arguments)`: オプションのパラメーター付きで特定のプロンプトを取得します。 +- `list_prompts()`: サーバーで利用可能なプロンプトを一覧表示します +- `get_prompt(name, arguments)`: オプションのパラメーター付きで特定のプロンプトを取得します ```python # List available prompts @@ -173,19 +173,19 @@ agent = Agent( ## キャッシュ -エージェントが実行されるたびに、MCP サーバーへ `list_tools()` を呼び出します。サーバーがリモートの場合、これはレイテンシの原因になります。ツール一覧を自動的にキャッシュするには、`MCPServerStdio`、`MCPServerSse`、`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()` を呼び出します。 +キャッシュを無効化したい場合は、サーバーの `invalidate_tools_cache()` を呼び出します。 ## エンドツーエンドのコード例 -動作する完全なコード例は [examples/mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp) をご覧ください。 +動作する完全なコード例は [examples/mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp) を参照してください。 ## トレーシング -[トレーシング](./tracing.md) は MCP 操作を自動的に取得します。対象は次のとおりです。 +[Tracing](./tracing.md) では以下を自動的にキャプチャします。 -1. MCP サーバーへのツール一覧取得呼び出し -2. 関数呼び出しに関する 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 663c11ed0..34a4351ba 100644 --- a/docs/ja/models/index.md +++ b/docs/ja/models/index.md @@ -4,54 +4,56 @@ search: --- # モデル -Agents SDK には、OpenAI モデルを以下 2 種類でサポートしています。 +Agents SDK には、すぐに使える 2 種類の 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 モデル +## Non-OpenAI モデル -ほとんどの非 OpenAI モデルは [LiteLLM 連携](./litellm.md) 経由で利用できます。まずは litellm の依存関係グループをインストールしてください。 +ほとんどの Non-OpenAI モデルは [LiteLLM integration](./litellm.md) 経由で利用できます。まず、litellm の依存グループをインストールします。 ```bash pip install "openai-agents[litellm]" ``` -次に、`litellm/` プレフィックスを付けて [対応モデル](https://docs.litellm.ai/docs/providers) を利用します。 +その後、`litellm/` プレフィックスを付けて [supported models](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 モデルを利用するその他の方法 +### Non-OpenAI モデルを使用するその他の方法 -他社 LLM プロバイダーを連携する方法は 3 つあります（[コード例はこちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)）。 +他の LLM プロバイダーを統合する方法はさらに 3 つあります（[こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/) に code examples があります）。 1. [`set_default_openai_client`][agents.set_default_openai_client] - グローバルに `AsyncOpenAI` インスタンスを LLM クライアントとして利用したい場合に便利です。OpenAI 互換エンドポイントを持つプロバイダーで、`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) に設定例があります。 + グローバルに `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` レベルで指定できます。「この実行内のすべてのエージェントでカスタムモデルプロバイダーを使う」といった場合に利用します。[examples/model_providers/custom_example_provider.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_provider.py) をご覧ください。 + `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) を参照してください。 3. [`Agent.model`][agents.agent.Agent.model] - 個々のエージェントごとにモデルを指定できます。エージェントごとに異なるプロバイダーを組み合わせたい場合に便利です。[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) が手軽です。 + 個々の 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 integration](./litellm.md) があります。 -`platform.openai.com` の API キーをお持ちでない場合は、`set_tracing_disabled()` でトレーシングを無効化するか、[別のトレーシングプロセッサー](../tracing.md) を設定することを推奨します。 +`platform.openai.com` の API キーがない場合は、`set_tracing_disabled()` でトレーシングを無効化するか、[別の tracing processor](../tracing.md) を設定することを推奨します。 !!! note - これらのコード例では Chat Completions API／モデルを使用しています。多くの LLM プロバイダーがまだ Responses API をサポートしていないためです。もしご利用のプロバイダーが Responses API をサポートしている場合は、Responses の利用をお勧めします。 + これらの例では、ほとんどの LLM プロバイダーがまだ Responses API をサポートしていないため、Chat Completions API／モデルを使用しています。ご利用の LLM プロバイダーが Responses API をサポートしている場合は、Responses の使用を推奨します。 ## モデルの組み合わせ -単一のワークフロー内でエージェントごとに異なるモデルを使いたい場合があります。たとえば、振り分けには小型で高速なモデルを使い、複雑なタスクには高性能モデルを使う、といったケースです。[`Agent`][agents.Agent] を設定する際は、以下のいずれかでモデルを指定できます。 +1 つのワークフロー内で エージェント ごとに異なるモデルを使用したい場合があります。たとえば、トリアージには小さく高速なモデルを、複雑なタスクにはより大きく高性能なモデルを使用するなどです。[`Agent`][agents.Agent] を設定する際には、以下のいずれかでモデルを選択できます。 1. モデル名を直接渡す。 -2. 任意のモデル名と、その名前を [`ModelProvider`][agents.models.interface.ModelProvider] が `Model` インスタンスへマッピングできるようにする。 -3. [`Model`][agents.models.interface.Model] 実装を直接渡す。 +2. 任意のモデル名 + それをモデルインスタンスにマッピングできる [`ModelProvider`][agents.models.interface.ModelProvider] を渡す。 +3. [`Model`][agents.models.interface.Model] 実装を直接提供する。 !!!note - SDK は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] と [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] の両方をサポートしていますが、1 つのワークフローではどちらか 1 つのモデル形状を使うことを推奨します。両者は利用できる機能やツールが異なるためです。もし混在させる場合は、使用する機能が両モデルでサポートされていることを確認してください。 + SDK は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] と [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] の両方の形状をサポートしていますが、各ワークフローでは 1 つのモデル形状のみを使用することを推奨します。2 つの形状はサポートする機能やツールが異なるためです。ワークフローでモデル形状を混在させる場合は、使用するすべての機能が両方で利用可能であることを確認してください。 ```python from agents import Agent, Runner, AsyncOpenAI, OpenAIChatCompletionsModel @@ -84,10 +86,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] を渡せます。 +エージェントで使用するモデルをさらに詳細に設定したい場合は、温度などのオプション設定パラメーターを持つ [`ModelSettings`][agents.models.interface.ModelSettings] を渡せます。 ```python from agents import Agent, ModelSettings @@ -100,7 +102,7 @@ english_agent = Agent( ) ``` -また、OpenAI の Responses API を利用する場合、`user` や `service_tier` など [追加のオプションパラメーター](https://platform.openai.com/docs/api-reference/responses/create) がいくつかあります。トップレベルで指定できない場合は、`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 @@ -116,29 +118,29 @@ english_agent = Agent( ) ``` -## 他社 LLM プロバイダー使用時によくある問題 +## 他の LLM プロバイダー使用時の一般的な問題 -### トレーシングクライアントの 401 エラー +### Tracing クライアントエラー 401 -トレーシングは OpenAI サーバーへアップロードされるため、OpenAI API キーがないとエラーになります。解決策は次の 3 つです。 +トレーシング関連のエラーが発生する場合、これはトレースが OpenAI サーバーにアップロードされるためで、OpenAI API キーがないことが原因です。解決策は 3 つあります。 -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 ドキュメント](../tracing.md#custom-tracing-processors) を参照してください。 +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 以外の trace processor を使用する。詳細は [tracing docs](../tracing.md#custom-tracing-processors) を参照してください。 ### Responses API のサポート -SDK はデフォルトで Responses API を使用しますが、多くの LLM プロバイダーは未対応です。そのため 404 などのエラーが発生する場合があります。解決策は次の 2 つです。 +SDK はデフォルトで Responses API を使用しますが、ほとんどの他の LLM プロバイダーはまだ対応していません。このため 404 などのエラーが発生する場合があります。解決策は 2 つあります。 1. [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api] を呼び出す。 - これは環境変数 `OPENAI_API_KEY` と `OPENAI_BASE_URL` を設定している場合に機能します。 + これは `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/) を参照してください。 + 例は [こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/) にあります。 ### structured outputs のサポート -一部のモデルプロバイダーは [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) をサポートしていません。その場合、次のようなエラーが発生することがあります。 +一部のモデルプロバイダーは [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) をサポートしていません。その結果、次のようなエラーが発生することがあります。 ``` @@ -146,12 +148,12 @@ BadRequestError: Error code: 400 - {'error': {'message': "'response_format.type' ``` -これは一部プロバイダーの制限で、JSON 出力はサポートしていても `json_schema` を指定できないためです。現在修正に取り組んでいますが、JSON スキーマ出力をサポートするプロバイダーを利用することを推奨します。そうでない場合、JSON が不正でアプリが破損することが頻繁に起こります。 +これは一部のプロバイダーの制限で、JSON 出力には対応していても `json_schema` を指定できないためです。現在修正に取り組んでいますが、JSON スキーマ出力をサポートするプロバイダーを利用することを推奨します。さもないと、不正な JSON によりアプリが頻繁に壊れる可能性があります。 ## プロバイダーをまたいだモデルの混在 -プロバイダーごとにサポート機能が異なるため、注意が必要です。たとえば、OpenAI は structured outputs、マルチモーダル入力、ホスト型 file search・web search をサポートしていますが、多くの他社プロバイダーは未対応です。以下の点にご注意ください。 +モデルプロバイダーごとの機能差異を理解しておかないと、エラーに遭遇する可能性があります。たとえば、OpenAI は structured outputs、マルチモーダル入力、ホストされた file search と Web 検索をサポートしていますが、多くの他プロバイダーはこれらをサポートしていません。以下の制限に注意してください。 -- 対応していない `tools` を理解できないプロバイダーに送らない -- テキスト専用モデルを呼び出す前にマルチモーダル入力を除外する -- structured JSON outputs をサポートしないプロバイダーでは無効な JSON が生成される可能性があることを理解する \ No newline at end of file +- 対応していない `tools` を理解しないプロバイダーに送らない +- テキストのみのモデルを呼ぶ前にマルチモーダル入力を除外する +- structured JSON outputs をサポートしないプロバイダーでは、無効な JSON が生成されることがあることを理解する \ No newline at end of file diff --git a/docs/ja/models/litellm.md b/docs/ja/models/litellm.md index 5f4f923d0..e62c9f250 100644 --- a/docs/ja/models/litellm.md +++ b/docs/ja/models/litellm.md @@ -2,33 +2,33 @@ search: exclude: true --- -# LiteLLM を介した任意モデルの利用 +# LiteLLM 経由で任意モデルを使用 !!! note - LiteLLM インテグレーションはベータ版です。特に小規模なモデルプロバイダーで問題が発生する可能性があります。[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/) は、単一のインターフェースで 100 以上のモデルを利用できるライブラリです。Agents SDK では LiteLLM インテグレーションを追加し、任意の AI モデルを使用できるようにしました。 +[LiteLLM](https://docs.litellm.ai/docs/) は、1 つのインターフェースで 100 以上のモデルを扱えるライブラリです。Agents SDK に LiteLLM インテグレーションを追加し、任意の AI モデルを利用できるようにしました。 ## セットアップ -`litellm` が利用可能であることを確認してください。これは、オプションの `litellm` 依存グループをインストールすることで実現できます。 +`litellm` が利用可能であることを確認してください。オプションの `litellm` 依存グループをインストールすることで対応できます。 ```bash pip install "openai-agents[litellm]" ``` -インストール後は、任意のエージェントで [`LitellmModel`][agents.extensions.models.litellm_model.LitellmModel] を使用できます。 +インストールが完了したら、どのエージェントでも [`LitellmModel`][agents.extensions.models.litellm_model.LitellmModel] を使用できます。 ## 例 -以下は完全に動作する例です。実行するとモデル名と API キーの入力を求められます。たとえば次のように入力できます。 +以下は完全に動作するコード例です。実行するとモデル名と API キーの入力を求められます。例として次のように入力できます。 -- モデルに `openai/gpt-4.1`、API キーに OpenAI API キー -- モデルに `anthropic/claude-3-5-sonnet-20240620`、API キーに Anthropic API キー -- など +- モデルに `openai/gpt-4.1`、API キーに OpenAI のキー +- モデルに `anthropic/claude-3-5-sonnet-20240620`、API キーに Anthropic のキー +- そのほか -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 507416f10..b66b0339a 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 は自律的にタスクの進め方を計画し、ツールを使ってアクションを実行してデータを取得し、 handoffs を使ってサブエージェントへタスクを委任できます。たとえば、リサーチ用のエージェントには次のようなツールを持たせられます。 -- Web 検索でオンライン情報を取得 -- ファイル検索 とリトリーバルで独自データや接続情報を検索 -- コンピュータ操作 でコンピュータ上のアクションを実行 -- コード実行でデータ分析を行う -- 優れた計画立案やレポート作成を行う専門 エージェント への handoffs +- Web 検索でオンライン情報を収集 +- ファイル検索と取得で社内データや接続先を探索 +- コンピュータ操作でコンピュータ上の操作を実行 +- コード実行でデータ分析を実施 +- ハンドオフで、計画策定やレポート作成に特化したエージェントへ委任 -このパターンはタスクがオープンエンドで、LLM の知能に頼りたい場合に最適です。重要な戦術は次のとおりです: +このパターンはタスクがオープンエンドで、 LLM の知性に頼りたい場合に特に有効です。以下の戦略が重要です: -1. 良いプロンプトに投資する。利用可能な tools とその使い方、そして守るべきパラメーターを明確にします。 -2. アプリをモニタリングして反復改善する。問題が起きた箇所を確認し、プロンプトを改善します。 -3. エージェント に内省と改善を許可する。たとえばループで実行し、自身を批評させたり、エラーメッセージを与えて改善させたりします。 -4. 何でもこなす汎用 エージェント ではなく、単一タスクに優れる専門 エージェント を用意します。 -5. [evals](https://platform.openai.com/docs/guides/evals) に投資する。これにより エージェント を訓練し、タスク遂行能力を向上できます。 +1. 良いプロンプトに投資する。利用可能なツール、その使い方、および守るべきパラメーターを明確に伝えます。 +2. アプリをモニタリングし、イテレーションを重ねる。問題が起きる箇所を確認し、プロンプトを改良します。 +3. エージェント自身に内省させて改善させる。たとえばループで実行し、自分で批評させる、あるいはエラーメッセージを提供して改善させます。 +4. 何でもこなす汎用エージェントを期待するのではなく、 1 つのタスクに特化したエージェントを用意する。 +5. [evals](https://platform.openai.com/docs/guides/evals) に投資する。これによりエージェントを訓練してタスク遂行能力を向上できます。 ## コードによるオーケストレーション -LLM によるオーケストレーションは強力ですが、コードでオーケストレーションすると速度・コスト・性能面でより決定論的かつ予測可能になります。一般的なパターンは次のとおりです: +LLM によるオーケストレーションは強力ですが、コードでオーケストレーションすると速度・コスト・パフォーマンスの面でより決定論的かつ予測可能になります。一般的なパターンは次のとおりです: -- [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を用いて、コードで検査できる 適切な形式のデータ を生成する。たとえば エージェント にタスクをいくつかの カテゴリー に分類させ、その カテゴリー に基づいて次の エージェント を選択します。 -- 複数の エージェント をチェーンし、1 つの出力を次の入力へ変換する。ブログ記事執筆のタスクを、リサーチ → アウトライン作成 → 記事執筆 → 批評 → 改善という一連のステップに分解できます。 -- タスクを実行する エージェント を `while` ループで回し、別の エージェント が評価とフィードバックを行い、評価者が基準を満たしたと判断するまで繰り返します。 -- `asyncio.gather` など Python の basic components を使って複数の エージェント を並列実行する。互いに依存しない複数タスクがある場合に速度向上に有効です。 +- [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用して、コードで検査できる適切な形式のデータを生成する。たとえば、エージェントにタスクをいくつかのカテゴリーに分類させ、そのカテゴリーに応じて次のエージェントを選択できます。 +- 1 つのエージェントの出力を次のエージェントの入力に変換して複数のエージェントをチェーンする。ブログ記事の執筆を「リサーチ→アウトライン作成→本文執筆→批評→改善」の一連のステップに分割するなどが可能です。 +- タスクを実行するエージェントを `while` ループで回し、評価とフィードバックを行うエージェントと組み合わせ、評価者が所定の基準を満たしたと判断するまで繰り返します。 +- Python の基本コンポーネントである `asyncio.gather` などを使い、複数エージェントを並列で実行する。相互に依存しない複数のタスクを高速化したい場合に便利です。 -[`examples/agent_patterns`](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns) には多数の code examples を用意しています。 \ No newline at end of file +[`examples/agent_patterns`](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns) には多数のコード例があります。 \ No newline at end of file diff --git a/docs/ja/quickstart.md b/docs/ja/quickstart.md index f86f3dd88..50455a2c7 100644 --- a/docs/ja/quickstart.md +++ b/docs/ja/quickstart.md @@ -6,7 +6,7 @@ search: ## プロジェクトと仮想環境の作成 -これは一度だけ実行すれば十分です。 +これは最初の一度だけ実行すれば十分です。 ```bash mkdir my_project @@ -14,7 +14,7 @@ cd my_project python -m venv .venv ``` -### 仮想環境のアクティブ化 +### 仮想環境の有効化 新しいターミナルセッションを開始するたびに実行してください。 @@ -30,15 +30,15 @@ pip install openai-agents # or `uv add openai-agents`, etc ### 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-... ``` -## 最初の エージェント を作成する +## 最初のエージェントを作成する -エージェント は instructions、名前、任意の config（例: `model_config`）で定義されます。 +エージェントは instructions、名前、そして `model_config` のようなオプション設定で定義します。 ```python from agents import Agent @@ -49,9 +49,9 @@ agent = Agent( ) ``` -## さらに数個の エージェント を追加する +## エージェントをさらに追加する -追加の エージェント も同じ方法で定義できます。`handoff_descriptions` は、ハンドオフのルーティングを判断するための追加コンテキストを提供します。 +追加のエージェントも同じ方法で定義できます。`handoff_descriptions` はハンドオフのルーティングを判断するための追加コンテキストを提供します。 ```python from agents import Agent @@ -69,9 +69,9 @@ math_tutor_agent = Agent( ) ``` -## ハンドオフを定義する +## ハンドオフの定義 -各 エージェント では、タスクを進める方法を選択できるように、発信側ハンドオフオプションの一覧を定義できます。 +各エージェントには、タスクを進めるために選択できる送信側ハンドオフのインベントリを定義できます。 ```python triage_agent = Agent( @@ -81,9 +81,9 @@ triage_agent = Agent( ) ``` -## エージェント オーケストレーションを実行する +## エージェントオーケストレーションの実行 -ワークフローが実行され、トリアージ エージェント が 2 つのスペシャリスト エージェント 間で正しくルートすることを確認しましょう。 +ワークフローが正しく動作し、トリアージエージェントが 2 つのスペシャリストエージェント間で正しくルーティングするか確認してみましょう。 ```python from agents import Runner @@ -95,7 +95,7 @@ async def main(): ## ガードレールを追加する -入力または出力に対して実行するカスタム ガードレール を定義できます。 +入力または出力に対して実行するカスタムガードレールを定義できます。 ```python from agents import GuardrailFunctionOutput, Agent, Runner @@ -121,9 +121,9 @@ async def homework_guardrail(ctx, agent, input_data): ) ``` -## すべてを組み合わせる +## すべてをまとめる -ハンドオフと入力 ガードレール を使用して、すべてを組み合わせたワークフロー全体を実行してみましょう。 +ハンドオフと入力ガードレールを使って、ワークフロー全体を実行してみましょう。 ```python from agents import Agent, InputGuardrail, GuardrailFunctionOutput, Runner @@ -190,14 +190,14 @@ if __name__ == "__main__": asyncio.run(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](tools.md)、[guardrails](guardrails.md)、[models](models/index.md) について学ぶ \ No newline at end of file diff --git a/docs/ja/realtime/guide.md b/docs/ja/realtime/guide.md index 40833e17b..5691d1f59 100644 --- a/docs/ja/realtime/guide.md +++ b/docs/ja/realtime/guide.md @@ -4,65 +4,63 @@ search: --- # ガイド -このガイドでは、 OpenAI Agents SDK のリアルタイム機能を使用して音声対応 AI エージェントを構築する方法を詳しく解説します。 +このガイドでは、 OpenAI Agents SDK の realtime 機能を使用して音声対応 AI エージェントを構築する方法を詳しく説明します。 -!!! warning "Beta feature" -リアルタイム エージェントはベータ版です。実装の改善に伴い、破壊的変更が発生する可能性があります。 +!!! warning "Beta 機能" +Realtime エージェントはベータ版です。実装の改善に伴い、破壊的変更が入る可能性があります。 ## 概要 -リアルタイム エージェントは、音声とテキスト入力をリアルタイムで処理し、リアルタイム音声で応答する会話フローを実現します。 OpenAI の Realtime API と永続的に接続することで、低レイテンシーかつ割り込みに強い自然な音声対話を提供します。 +Realtime エージェントは会話フローをリアルタイムで処理し、音声やテキスト入力を受け取って即時に音声で応答します。 OpenAI の Realtime API と永続接続を維持することで、低レイテンシかつ自然な音声対話を実現し、発話の割り込みにも柔軟に対応できます。 ## アーキテクチャ ### コアコンポーネント -リアルタイム システムは次の主要コンポーネントで構成されます。 - -- **RealtimeAgent** : インストラクション、ツール、ハンドオフで構成された エージェント です。 -- **RealtimeRunner** : 設定を管理します。 `runner.run()` を呼び出して セッション を取得できます。 -- **RealtimeSession** : 1 つの対話セッションを表します。通常、 ユーザー が会話を開始するたびに作成し、会話が終了するまで保持します。 -- **RealtimeModel** : 基盤となるモデル インターフェース (通常は OpenAI の WebSocket 実装) です。 +- **RealtimeAgent**: instructions、 tools、 handoffs で構成されたエージェント。 +- **RealtimeRunner**: 設定を管理します。 `runner.run()` を呼び出してセッションを取得できます。 +- **RealtimeSession**: 1 回の対話セッション。ユーザーが会話を開始するたびに作成し、会話が終了するまで維持します。 +- **RealtimeModel**: 基盤となるモデルインターフェース (一般的には OpenAI の WebSocket 実装) ### セッションフロー -典型的なリアルタイム セッションの流れは次のとおりです。 +典型的な Realtime セッションは次の流れで進みます。 -1. **RealtimeAgent** をインストラクション、ツール、ハンドオフ付きで作成します。 -2. その エージェント と設定オプションを使って **RealtimeRunner** をセットアップします。 -3. `await runner.run()` を呼び出して **セッションを開始** します。これにより RealtimeSession が返されます。 -4. `send_audio()` または `send_message()` を使用して **音声またはテキスト** をセッションへ送信します。 -5. セッションをイテレートして **イベントを受信** します。イベントには音声出力、文字起こし、ツール呼び出し、ハンドオフ、エラーなどが含まれます。 -6. ユーザー が重ねて話した場合は **割り込み** を処理し、現在の音声生成を自動停止させます。 +1. instructions、 tools、 handoffs を指定して **RealtimeAgent** を作成します。 +2. **RealtimeRunner** をセットアップし、エージェントと各種設定を渡します。 +3. `await runner.run()` で **セッションを開始** し、 RealtimeSession を取得します。 +4. `send_audio()` または `send_message()` で **音声またはテキストメッセージを送信** します。 +5. セッションをイテレートして **イベントを監視** します。イベントには音声出力、文字起こし、ツール呼び出し、 handoffs、エラーが含まれます。 +6. ユーザーが発話を割り込んだ場合には **割り込みを処理** し、現在の音声生成を自動停止します。 -セッションは会話履歴を保持し、リアルタイム モデルとの永続接続を管理します。 +セッションは会話履歴を保持し、 Realtime モデルとの永続接続を管理します。 -## エージェントの設定 +## エージェント設定 -RealtimeAgent は通常の Agent クラスとほぼ同様に動作しますが、いくつか重要な違いがあります。詳細は [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API リファレンスをご覧ください。 +RealtimeAgent は通常の Agent クラスとほぼ同じですが、いくつか重要な違いがあります。詳細は [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API リファレンスをご覧ください。 主な違い: -- モデルの選択は エージェント レベルではなくセッション レベルで設定します。 -- 適切な形式のデータ (structured outputs) はサポートされません (`outputType` は使用不可)。 -- 音声は エージェント 単位で設定できますが、最初の エージェント が話した後は変更できません。 -- ツール、ハンドオフ、インストラクションなどその他の機能は同じ方法で利用できます。 +- モデル選択はエージェントではなくセッションレベルで設定します。 +- structured outputs (`outputType`) はサポートされません。 +- 音声はエージェントごとに設定できますが、最初のエージェントが発話した後は変更できません。 +- tools、 handoffs、 instructions などその他の機能は同じように動作します。 -## セッションの設定 +## セッション設定 ### モデル設定 -セッション設定では基盤となるリアルタイム モデルの動作を制御できます。モデル名 (例: `gpt-4o-realtime-preview`)、音声 (alloy, echo, fable, onyx, nova, shimmer) の選択、対応モダリティ (テキスト / 音声) を指定できます。入力・出力ともに音声フォーマットを設定でき、デフォルトは PCM16 です。 +セッション設定では基盤となる Realtime モデルの挙動を制御できます。モデル名 (たとえば `gpt-4o-realtime-preview`) や音声 (alloy、 echo、 fable、 onyx、 nova、 shimmer) の選択、対応モダリティ (テキスト / 音声) を指定できます。入力・出力の音声フォーマットは PCM16 がデフォルトです。 ### オーディオ設定 -音声設定では、セッションが音声入出力をどのように扱うかを制御します。Whisper などのモデルを使った入力音声の文字起こし、言語設定、ドメイン固有用語の精度向上のための文字起こしプロンプトを指定できます。ターン検出では、音声活動検出のしきい値、無音時間、検出された音声前後のパディングなどを調整できます。 +オーディオ設定では音声入力と出力の取り扱いを制御します。 Whisper などのモデルを用いた入力音声の文字起こし、言語設定、ドメイン特有の用語精度を高める transcription prompt を指定できます。ターン検出設定では、音声活動検知のしきい値、無音時間、検知した音声前後のパディングなどを設定し、エージェントがいつ応答を開始・終了すべきかを制御します。 -## ツールと関数 +## Tools と Functions -### ツールの追加 +### Tools の追加 -通常の エージェント と同様に、リアルタイム エージェントでも会話中に実行される 関数ツール をサポートします。 +通常のエージェントと同様に、 Realtime エージェントも会話中に実行される function tools をサポートします。 ```python from agents import function_tool @@ -86,11 +84,11 @@ agent = RealtimeAgent( ) ``` -## ハンドオフ +## Handoffs -### ハンドオフの作成 +### Handoffs の作成 -ハンドオフにより、会話を専門化された エージェント 間で移譲できます。 +Handoffs を使用すると、会話を専門エージェント間で引き継げます。 ```python from agents.realtime import realtime_handoff @@ -119,40 +117,40 @@ main_agent = RealtimeAgent( ## イベント処理 -セッションはイベントを ストリーミング し、セッション オブジェクトをイテレートして受信できます。主なイベントは以下のとおりです。 +セッションはイベントをストリーミングし、セッションオブジェクトをイテレートすることで取得できます。イベントには音声出力チャンク、文字起こし結果、ツール実行開始 / 終了、エージェント handoffs、エラーなどがあります。主なイベントは次のとおりです。 -- **audio** : エージェント 応答の raw 音声データ -- **audio_end** : エージェント が話し終えたことを示します -- **audio_interrupted** : ユーザー による割り込み -- **tool_start/tool_end** : ツール実行の開始 / 終了 -- **handoff** : エージェント ハンドオフが発生 -- **error** : 処理中にエラーが発生 +- **audio**: エージェントの応答からの raw 音声データ +- **audio_end**: エージェントの発話が終了 +- **audio_interrupted**: ユーザーがエージェントの発話を割り込み +- **tool_start/tool_end**: ツール実行ライフサイクル +- **handoff**: エージェントの handoff が発生 +- **error**: 処理中にエラーが発生 -完全なイベント一覧は [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent] を参照してください。 +詳細は [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent] をご参照ください。 ## ガードレール -リアルタイム エージェントでは出力ガードレールのみサポートされます。パフォーマンス低下を避けるためデバウンス処理が行われ、リアルタイム生成中に毎語ではなく定期的に実行されます。デフォルトのデバウンス長は 100 文字ですが、設定で変更可能です。 +Realtime エージェントでは出力ガードレールのみサポートされます。パフォーマンスを保つためにデバウンス処理が施されており、毎単語ではなく定期的に実行されます。デフォルトのデバウンス長は 100 文字ですが、変更可能です。 -ガードレールが発火すると `guardrail_tripped` イベントが生成され、 エージェント の現在の応答を割り込むことがあります。テキスト エージェント と異なり、リアルタイム エージェントではガードレール発火時に例外は送出されません。 +ガードレールが発火すると `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 692d18e17..a0e0f0a01 100644 --- a/docs/ja/realtime/quickstart.md +++ b/docs/ja/realtime/quickstart.md @@ -4,26 +4,26 @@ search: --- # クイックスタート -Realtime エージェントは、OpenAI の Realtime API を使用して AI エージェントとの音声会話を実現します。本ガイドでは、最初の Realtime 音声エージェントを作成する方法を説明します。 +Realtime エージェントを使うと、 OpenAI の Realtime API を利用して AI エージェントとの音声会話が可能になります。このガイドでは、最初の Realtime 音声エージェントを作成する手順を説明します。 -!!! warning "ベータ版機能" -Realtime エージェントは現在ベータ版です。実装を改善する過程で破壊的変更が発生する可能性があります。 +!!! warning "Beta 機能" +Realtime エージェントはベータ版です。実装の改善に伴い、互換性のない変更が発生する可能性があります。 ## 前提条件 -- Python 3.9 以上 -- OpenAI API キー -- OpenAI Agents SDK への基本的な理解 +- Python 3.9 以上 +- OpenAI API キー +- OpenAI Agents SDK の基本的な知識 ## インストール -まだインストールしていない場合は、OpenAI Agents SDK をインストールしてください: +まだインストールしていない場合は、 OpenAI Agents SDK をインストールしてください: ```bash pip install openai-agents ``` -## 最初の Realtime エージェントの作成 +## 最初の Realtime エージェント作成 ### 1. 必要なコンポーネントのインポート @@ -79,9 +79,9 @@ async def main(): asyncio.run(main()) ``` -## 完全なコード例 +## 完全な例 -以下に完全に動作するコード例を示します: +以下は動作する完全な例です: ```python import asyncio @@ -139,30 +139,30 @@ if __name__ == "__main__": ### モデル設定 -- `model_name`: 利用可能な Realtime モデルから選択します（例: `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) フォルダーの動作するサンプルを確認する +- エージェントにツールを追加する +- エージェント間のハンドオフを実装する +- 安全のためのガードレールを設定する ## 認証 @@ -172,7 +172,7 @@ OpenAI API キーが環境変数に設定されていることを確認してく 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 5acd129f3..e94274445 100644 --- a/docs/ja/release.md +++ b/docs/ja/release.md @@ -2,31 +2,31 @@ search: exclude: true --- -# リリースプロセス／変更履歴 +# リリースプロセス/変更履歴 -このプロジェクトでは、`0.Y.Z` 形式を用いた semantic versioning を若干修正したルールを採用しています。先頭の `0` は、 SDK がまだ急速に進化していることを示します。各コンポーネントの増分ルールは次のとおりです: +このプロジェクトは、形式 `0.Y.Z` を用いた、わずかに変更された semantic versioning に従います。先頭の `0` は SDK がまだ急速に進化していることを示しています。各コンポーネントは次のようにインクリメントします。 ## マイナー (`Y`) バージョン -ベータでない公開インターフェースに **破壊的変更** が入った場合、マイナー バージョン `Y` を増やします。たとえば `0.0.x` から `0.1.x` へのアップデートには破壊的変更が含まれる可能性があります。 +**breaking changes** が beta でないパブリックインターフェースに加わる場合、マイナーバージョン `Y` を増やします。たとえば、`0.0.x` から `0.1.x` への更新には互換性破壊変更が含まれることがあります。 -破壊的変更を避けたい場合は、プロジェクトで `0.0.x` のバージョンに固定することをおすすめします。 +互換性破壊変更を避けたい場合は、プロジェクトで `0.0.x` バージョンを固定することをおすすめします。 ## パッチ (`Z`) バージョン -互換性を壊さない変更の場合は `Z` を増やします: +`Z` は互換性を壊さない変更でインクリメントします。 -- バグ修正 -- 新機能 -- 非公開インターフェースの変更 -- ベータ機能の更新 +- バグ修正 +- 新機能 +- プライベートインターフェースへの変更 +- beta 機能の更新 -## 破壊的変更の変更履歴 +## 互換性破壊変更の変更履歴 ### 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` の 2 つの新しいパラメーターが追加されました。`MCPServer` を継承するクラスでは、これらのパラメーターを追加する必要があります。 \ No newline at end of file +このバージョンでは、[`MCPServer.list_tools()`][agents.mcp.server.MCPServer] に新しいパラメーター `run_context` と `agent` が追加されました。`MCPServer` を継承するすべてのクラスにこれらのパラメーターを追加する必要があります。 \ No newline at end of file diff --git a/docs/ja/repl.md b/docs/ja/repl.md index 2765fe092..4fdac4164 100644 --- a/docs/ja/repl.md +++ b/docs/ja/repl.md @@ -4,7 +4,7 @@ search: --- # REPL ユーティリティ -SDK は、迅速なインタラクティブテスト用に `run_demo_loop` を提供します。 +SDK は、手軽にインタラクティブテストを行うための `run_demo_loop` を提供します。 ```python import asyncio @@ -18,6 +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 1638d0f9e..d531a1c73 100644 --- a/docs/ja/results.md +++ b/docs/ja/results.md @@ -4,53 +4,53 @@ search: --- # 結果 -`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] を継承しており、ほとんどの有用な情報はここに含まれています。 +どちらも [`RunResultBase`][agents.result.RunResultBase] を継承しており、多くの有用な情報はここに含まれています。 ## 最終出力 [`final_output`][agents.result.RunResultBase.final_output] プロパティには、最後に実行されたエージェントの最終出力が入ります。内容は次のいずれかです。 -- `str` 型 — 最後のエージェントに `output_type` が設定されていない場合 -- `last_agent.output_type` 型のオブジェクト — エージェントに `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] を使用すると、元の入力とエージェント実行中に生成されたアイテムを連結した入力リストに変換できます。これにより、あるエージェント実行の出力を次の実行へ渡したり、ループで実行して毎回新しいユーザー入力を追加したりするのが簡単になります。 ## 最後のエージェント -[`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] でラップされており、 raw アイテムは LLM が生成した生データです。 +[`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 アイテムはハンドオフツール呼び出しへのツール応答です。このアイテムからソース／ターゲットのエージェントにもアクセスできます。 -- [`ToolCallItem`][agents.items.ToolCallItem] — LLM がツールを呼び出したことを示します。 -- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem] — ツールが呼び出されたことを示します。 raw アイテムはツール応答で、ツール出力にもアクセスできます。 -- [`ReasoningItem`][agents.items.ReasoningItem] — LLM からの推論内容を示します。 raw アイテムは生成された推論テキストです。 +- [`MessageOutputItem`][agents.items.MessageOutputItem] は LLM からのメッセージを示します。raw アイテムは生成されたメッセージです。 +- [`HandoffCallItem`][agents.items.HandoffCallItem] は LLM が handoff ツールを呼び出したことを示します。raw アイテムは LLM からのツールコールです。 +- [`HandoffOutputItem`][agents.items.HandoffOutputItem] はハンドオフが発生したことを示します。raw アイテムは handoff ツールコールへのツール応答です。アイテムからソース／ターゲットエージェントにもアクセスできます。 +- [`ToolCallItem`][agents.items.ToolCallItem] は LLM がツールを呼び出したことを示します。 +- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem] はツールが呼び出されたことを示します。raw アイテムはツール応答です。アイテムからツール出力にもアクセスできます。 +- [`ReasoningItem`][agents.items.ReasoningItem] は LLM からの推論アイテムを示します。raw アイテムは生成された推論です。 ## その他の情報 ### ガードレール結果 -[`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 343e231c0..f55fd126e 100644 --- a/docs/ja/running_agents.md +++ b/docs/ja/running_agents.md @@ -7,11 +7,11 @@ search: エージェントは [`Runner`][agents.run.Runner] クラスを介して実行できます。オプションは 3 つあります。 1. [`Runner.run()`][agents.run.Runner.run] - 非同期で実行され、[`RunResult`][agents.result.RunResult] を返します。 + 非同期で実行し、[`RunResult`][agents.result.RunResult] を返します。 2. [`Runner.run_sync()`][agents.run.Runner.run_sync] - 同期メソッドで、内部では `.run()` を呼び出します。 + 同期メソッドで、内部的には `.run()` を呼び出します。 3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed] - 非同期で実行され、[`RunResultStreaming`][agents.result.RunResultStreaming] を返します。LLM をストリーミング モードで呼び出し、受信したイベントをそのままストリーム配信します。 + 非同期で実行し、[`RunResultStreaming`][agents.result.RunResultStreaming] を返します。LLM をストリーミングモードで呼び出し、受信したイベントをリアルタイムでストリーミングします。 ```python from agents import Agent, Runner @@ -30,49 +30,49 @@ async def main(): ## エージェントループ -`Runner` の run メソッドを使用する際は、開始エージェントと入力を渡します。入力は文字列（ユーザー メッセージと見なされます）か、OpenAI Responses API のアイテムである入力アイテムのリストのいずれかです。 +`Runner` の run メソッドでは、開始エージェントと入力を渡します。入力は文字列（ユーザー メッセージと見なされます）または入力アイテムのリスト（OpenAI Responses API のアイテム）を指定できます。 Runner は次のループを実行します。 -1. 現在のエージェントに対して現在の入力を用い、LLM を呼び出します。 +1. 現在のエージェントと入力を使って LLM を呼び出します。 2. LLM が出力を生成します。 - 1. LLM が `final_output` を返した場合、ループを終了して結果を返します。 + 1. LLM が `final_output` を返した場合、ループは終了し結果を返します。 2. LLM がハンドオフを行った場合、現在のエージェントと入力を更新し、ループを再実行します。 - 3. LLM がツール呼び出しを生成した場合、それらを実行し結果を追加して、ループを再実行します。 + 3. LLM がツール呼び出しを生成した場合、それらを実行し結果を追加して再度ループを実行します。 3. 渡された `max_turns` を超えた場合、[`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 例外を送出します。 !!! note - LLM 出力が「最終出力」と見なされるルールは、望ましい型のテキスト出力を生成し、ツール呼び出しが存在しない場合です。 + LLM 出力が「final output」と見なされる条件は、望ましい型のテキスト出力であり、かつツール呼び出しが 1 つも含まれていない場合です。 ## ストリーミング -ストリーミングを使用すると、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]: 各 Agent の `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` を設定することを推奨します。`group_id` は任意で、複数の実行間でトレースを関連付ける際に使用します。 -- [`trace_metadata`][agents.run.RunConfig.trace_metadata]: すべてのトレースに付与するメタデータです。 +- [`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]: 実行時のトレーシング用 workflow 名、trace ID、trace group ID を設定します。少なくとも `workflow_name` の設定を推奨します。group ID は複数実行間でトレースを関連付けるための任意フィールドです。 +- [`trace_metadata`][agents.run.RunConfig.trace_metadata]: すべてのトレースに含めるメタデータ。 -## 会話 / チャットスレッド +## 会話／チャットスレッド -いずれかの run メソッド呼び出しにより、1 つ以上のエージェントが実行され（つまり 1 回以上の LLM 呼び出しが行われ）ますが、チャット会話における 1 つの論理ターンとして扱われます。例: +いずれの run メソッドを呼び出しても、1 回の実行で 1 つ以上のエージェント（すなわち複数の LLM 呼び出し）が走る可能性がありますが、チャット会話としては 1 つの論理的ターンを表します。例: 1. ユーザーターン: ユーザーがテキストを入力 -2. Runner 実行: 最初のエージェントが LLM を呼び出し、ツールを実行し、2 番目のエージェントへハンドオフ。2 番目のエージェントがさらにツールを実行し、出力を生成。 +2. Runner 実行: 1 つ目のエージェントが LLM を呼び出しツールを実行し、2 つ目のエージェントへハンドオフ。2 つ目のエージェントがさらにツールを実行し、最終出力を生成。 -エージェント実行の終了時に、ユーザーへ何を表示するかを選択できます。たとえば、エージェントが生成したすべての新規アイテムを表示するか、最終出力のみを表示するかを決められます。いずれの場合でも、ユーザーが追質問を行ったら、再度 run メソッドを呼び出せます。 +エージェント実行後、ユーザーに何を表示するかを選択できます。たとえば、エージェントが生成したすべての新しいアイテムを表示することも、最終出力だけを表示することも可能です。いずれの場合も、ユーザーが追質問をすれば再度 run メソッドを呼び出します。 -### 会話の手動管理 +### 手動での会話管理 [`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] メソッドを使用して次ターンの入力を取得し、会話履歴を手動で管理できます。 @@ -94,9 +94,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 @@ -119,20 +119,20 @@ async def main(): # California ``` -Sessions は以下を自動で行います。 +Sessions は次のことを自動で行います。 - 各実行前に会話履歴を取得 -- 各実行後に新規メッセージを保存 -- 異なるセッション ID ごとに個別の会話を維持 +- 各実行後に新しいメッセージを保存 +- 異なる session ID ごとに別々の会話を維持 -詳細は [Sessions のドキュメント](sessions.md) を参照してください。 +詳細は [Sessions ドキュメント](sessions.md) を参照してください。 ## 例外 -SDK は特定のケースで例外を送出します。完全な一覧は [`agents.exceptions`][] にあります。概要は以下のとおりです。 +特定の状況で SDK は例外を送出します。完全な一覧は [`agents.exceptions`][] にあります。概要は以下のとおりです。 -- [`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 +- [`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 c88f840af..5c6ad76fd 100644 --- a/docs/ja/sessions.md +++ b/docs/ja/sessions.md @@ -4,9 +4,9 @@ search: --- # セッション -Agents SDK には、組み込みのセッションメモリが用意されており、複数回のエージェント実行にわたって会話履歴を自動的に保持できます。そのため、ターンごとに `.to_input_list()` を手動で扱う必要がありません。 +Agents SDK には組み込みのセッションメモリーがあり、複数のエージェント実行にわたって会話履歴を自動的に保持します。これにより、ターン間で `.to_input_list()` を手動で扱う必要がなくなります。 -セッションは特定のセッションごとに会話履歴を保存し、明示的にメモリを管理しなくてもエージェントがコンテキストを維持できるようにします。これは、エージェントに過去のやり取りを記憶させたいチャットアプリケーションやマルチターンの会話を構築する際に特に便利です。 +Sessions は特定のセッションの会話履歴を保存し、明示的なメモリー管理を必要とせずにエージェントがコンテキストを維持できるようにします。これは、エージェントに以前のやり取りを覚えさせたいチャットアプリケーションやマルチターン会話を構築する際に特に便利です。 ## クイックスタート @@ -49,19 +49,19 @@ print(result.final_output) # "Approximately 39 million" ## 仕組み -セッションメモリを有効にすると、次のように動作します。 +セッションメモリーを有効にすると、次のように動作します。 -1. **実行前**: Runner はセッションの会話履歴を自動的に取得し、入力アイテムの先頭に追加します。 -2. **実行後**: 実行中に生成された新しいアイテム（ユーザー入力、アシスタントの応答、ツール呼び出しなど）はすべて、自動的にセッションに保存されます。 -3. **コンテキストの保持**: 同じセッションで次回以降の実行を行うと、完全な会話履歴が入力に含まれるため、エージェントはコンテキストを維持できます。 +1. **各実行前**: Runner はそのセッションの会話履歴を自動で取得し、入力アイテムの先頭に追加します。 +2. **各実行後**: 実行中に生成された新しいアイテム (ユーザー入力、アシスタント応答、ツール呼び出しなど) がすべて自動でセッションに保存されます。 +3. **コンテキスト保持**: 同じセッションでの後続の実行には完全な会話履歴が含まれ、エージェントはコンテキストを維持できます。 これにより、`.to_input_list()` を手動で呼び出したり、実行間で会話状態を管理したりする必要がなくなります。 -## メモリ操作 +## メモリー操作 ### 基本操作 -セッションは会話履歴を管理するためのいくつかの操作をサポートしています。 +Sessions では会話履歴を管理するためのいくつかの操作がサポートされています。 ```python from agents import SQLiteSession @@ -86,7 +86,7 @@ print(last_item) # {"role": "assistant", "content": "Hi there!"} await session.clear_session() ``` -### pop_item を使った修正 +### 訂正のための pop_item の使用 `pop_item` メソッドは、会話の最後のアイテムを取り消したり修正したりしたい場合に特に便利です。 @@ -117,16 +117,16 @@ result = await Runner.run( print(f"Agent: {result.final_output}") ``` -## メモリオプション +## メモリーオプション -### メモリなし（デフォルト） +### メモリーなし (デフォルト) ```python # Default behavior - no session memory result = await Runner.run(agent, "Hello") ``` -### SQLite メモリ +### SQLite メモリー ```python from agents import SQLiteSession @@ -168,9 +168,9 @@ result2 = await Runner.run( ) ``` -## カスタムメモリ実装 +## カスタムメモリー実装 -[`Session`][agents.memory.session.Session] プロトコルに従うクラスを作成することで、独自のセッションメモリを実装できます。 +[`Session`][agents.memory.session.Session] プロトコルに従うクラスを作成することで、独自のセッションメモリーを実装できます。 ````python from agents.memory import Session @@ -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 + # 実行間で保持されるセッションインスタンスを作成 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 2f29e0135..3f1c58e6f 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()`][agents.run.Runner.run_streamed] を呼び出します。これにより [`RunResultStreaming`][agents.result.RunResultStreaming] が返されます。`result.stream_events()` を呼び出すと、以下で説明する [`StreamEvent`][agents.stream_events.StreamEvent] オブジェクトの非同期ストリームが取得できます。 -## Raw response イベント +## raw response イベント -[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent] は LLM から直接渡される raw イベントです。これらは OpenAI Responses API フォーマットで提供され、各イベントには `response.created` や `response.output_text.delta` などの type と data が含まれます。生成されたメッセージを即座に ユーザー にストリーミングしたい場合に便利です。 +[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent] は LLM から直接渡される raw イベントです。これらは OpenAI Responses API フォーマットであり、各イベントには `response.created`、`response.output_text.delta` などの type と data が含まれます。生成され次第、ユーザーへレスポンスメッセージをストリーミングしたい場合に便利です。 -たとえば、以下のコードは LLM が生成するテキストをトークンごとに出力します。 +例えば、以下のコードは LLM が生成したテキストをトークンごとに出力します。 ```python import asyncio @@ -35,11 +35,11 @@ if __name__ == "__main__": asyncio.run(main()) ``` -## Run item イベント と エージェント イベント +## Run item イベントとエージェントイベント -[`RunItemStreamEvent`][agents.stream_events.RunItemStreamEvent] はより高レベルのイベントで、アイテムが完全に生成されたタイミングを通知します。これにより、各トークンではなく「メッセージ生成完了」「ツール実行完了」などのレベルで進捗を ユーザー に送信できます。同様に、 [`AgentUpdatedStreamEvent`][agents.stream_events.AgentUpdatedStreamEvent] はハンドオフの結果などで現在のエージェントが変更された際に通知を行います。 +[`RunItemStreamEvent`][agents.stream_events.RunItemStreamEvent] はより高レベルのイベントです。アイテムが完全に生成されたことを通知します。これにより、各トークンではなく「メッセージが生成された」「ツールが実行された」などのレベルで進捗をプッシュできます。同様に、[`AgentUpdatedStreamEvent`][agents.stream_events.AgentUpdatedStreamEvent] は現在のエージェントが変更されたとき（ハンドオフの結果など）に更新を提供します。 -たとえば、以下のコードは raw イベントを無視し、 ユーザー へ更新のみをストリーミングします。 +例えば、次のコードは raw イベントを無視し、ユーザーへ更新をストリーミングします。 ```python import asyncio diff --git a/docs/ja/tools.md b/docs/ja/tools.md index 0c7425dfa..d76c16067 100644 --- a/docs/ja/tools.md +++ b/docs/ja/tools.md @@ -4,20 +4,20 @@ search: --- # ツール -ツールを利用することで エージェント は、データの取得、コードの実行、外部 API の呼び出し、さらには コンピュータ操作 までも行えます。 Agents SDK には 3 種類のツールがあります： +ツールは エージェント がアクションを実行するための手段です。たとえばデータ取得、コード実行、外部 API 呼び出し、さらにはコンピュータ操作まで行えます。Agents SDK には 3 種類のツールがあります。 -- ホスト型ツール: これらは LLM サーバー上で AI モデルと並行して実行されます。OpenAI は retrieval、 Web 検索、 コンピュータ操作 をホスト型ツールとして提供しています。 -- Function calling: 任意の Python 関数をツールとして利用できます。 -- エージェントをツールとして使用: これにより、ハンドオフせずに エージェント 同士を呼び出すことができます。 +- ホスト型ツール: これらは LLM サーバー上で AI モデルと同じ場所で動作します。OpenAI は retrieval、Web 検索、コンピュータ操作をホスト型ツールとして提供しています。 +- 関数ツール: 任意の Python 関数をツールとして利用できます。 +- ツールとしてのエージェント: ハンドオフせずに他の エージェント を呼び出すため、エージェント自体をツールとして扱うことができます。 ## ホスト型ツール -[`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] を使用する際、OpenAI にはいくつかの組み込みツールがあります: +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] は サンドボックス環境でコードを実行します。 +- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] は LLM がサンドボックス環境でコードを実行できるようにします。 - [`HostedMCPTool`][agents.tool.HostedMCPTool] はリモート MCP サーバーのツールをモデルに公開します。 - [`ImageGenerationTool`][agents.tool.ImageGenerationTool] はプロンプトから画像を生成します。 - [`LocalShellTool`][agents.tool.LocalShellTool] はローカルマシンでシェルコマンドを実行します。 @@ -43,14 +43,14 @@ async def main(): ## 関数ツール -任意の Python 関数をツールとして利用できます。 Agents SDK が自動的に設定を行います: +任意の Python 関数をツールとして使用できます。Agents SDK が自動的にツールを設定します。 -- ツール名には Python 関数名が使用されます（または自分で指定可能） -- ツールの説明は関数の docstring から取得されます（または自分で指定可能） +- ツール名は Python 関数の名前になります（任意で名前を指定可能） +- ツールの説明は関数の docstring から取得されます（任意で説明を指定可能） - 関数入力のスキーマは関数の引数から自動生成されます -- 各入力の説明は 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. デコレートした関数をツールのリストに渡してください。 +1. 引数には任意の Python 型を使用でき、関数は sync / async いずれでも構いません。 +2. docstring がある場合、ツールおよび各引数の説明を取得します。 +3. 関数はオプションで `context`（先頭の引数である必要があります）を受け取れます。また、ツール名や説明、docstring スタイルなどをオーバーライド可能です。 +4. 装飾した関数を tools のリストに渡せます。 -??? note "出力を確認するには展開" +??? note "展開して出力を確認する" ``` fetch_weather @@ -179,12 +179,12 @@ for tool in agent.tools: ### カスタム関数ツール -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 関数） +- `params_json_schema` : 引数の JSON スキーマ +- `on_invoke_tool` : [`ToolContext`][agents.tool_context.ToolContext] と引数（JSON 文字列）を受け取り、ツール出力を文字列で返す async 関数 ```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` にすると docstring 解析を無効にできます。 +1. `inspect` モジュールでシグネチャを解析します。型アノテーションを利用して引数の型を把握し、Pydantic モデルを動的に構築してスキーマを生成します。Python の基本型、Pydantic モデル、TypedDict など多くの型をサポートします。 +2. `griffe` で docstring を解析します。対応フォーマットは `google`、`sphinx`、`numpy` です。フォーマットは自動検出を試みますが、`function_tool` 呼び出し時に明示指定することもできます。`use_docstring_info` に `False` を設定すると docstring 解析を無効化できます。 スキーマ抽出のコードは [`agents.function_schema`][] にあります。 -## エージェントをツールとして使用 +## ツールとしてのエージェント -ワークフローによっては、ハンドオフせずに中央の エージェント が複数の専門 エージェント をオーケストレーションしたい場合があります。その際は エージェント をツールとしてモデル化できます。 +一部のワークフローでは、制御を渡さずに中央のエージェントが専門 エージェント 群をオーケストレーションしたい場合があります。その場合、エージェント をツールとしてモデル化できます。 ```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 @@ -290,13 +290,13 @@ async def run_my_agent() -> str: ### 出力のカスタム抽出 -場合によっては、ツール エージェント の出力を中央 エージェント に返す前に加工したいことがあります。たとえば、以下のようなケースです: +場合によっては、ツールエージェントの出力を中央エージェントに返す前に加工したいことがあります。たとえば以下のようなケースです。 -- サブ エージェント のチャット履歴から特定の情報（例: 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: @@ -317,10 +317,10 @@ json_tool = data_agent.as_tool( ## 関数ツールでのエラー処理 -`@function_tool` で関数ツールを作成する際、`failure_error_function` を渡すことができます。これはツール呼び出しがクラッシュしたときに LLM にエラーレスポンスを返す関数です。 +`@function_tool` で関数ツールを作成する際、`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 c42dd6efe..b6e1a6575 100644 --- a/docs/ja/tracing.md +++ b/docs/ja/tracing.md @@ -4,52 +4,52 @@ search: --- # トレーシング -Agents SDK にはトレーシング機能が組み込まれており、エージェント実行中に発生する LLM 生成、tool 呼び出し、handoffs、guardrail、カスタムイベントなどの包括的な記録を収集します。[Traces ダッシュボード](https://platform.openai.com/traces) を使用すると、開発時および本番環境でワークフローをデバッグ・可視化・監視できます。 +Agents SDK にはビルトインのトレーシング機能が含まれており、エージェントの実行中に発生する LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、カスタムイベントなどの包括的なイベント履歴を収集します。[Traces ダッシュボード](https://platform.openai.com/traces) を使用すると、開発時や本番環境でワークフローをデバッグ、可視化、モニタリングできます。 !!!note - Tracing はデフォルトで有効になっています。無効化する方法は 2 つあります。 + トレーシングはデフォルトで有効です。無効にする方法は 2 つあります。 - 1. 環境変数 `OPENAI_AGENTS_DISABLE_TRACING=1` を設定してグローバルに無効化する - 2. 単一の実行で無効化する場合は [`agents.run.RunConfig.tracing_disabled`][] を `True` に設定する + 1. 環境変数 `OPENAI_AGENTS_DISABLE_TRACING=1` を設定して、グローバルにトレーシングを無効化する + 2. 1 回の実行だけ無効にする場合は [`agents.run.RunConfig.tracing_disabled`][] を `True` に設定する -***OpenAI の API を Zero Data Retention (ZDR) ポリシーで利用している組織では、トレーシングは利用できません。*** +***OpenAI の API を Zero Data Retention (ZDR) ポリシーで運用している組織では、トレーシングは利用できません。*** ## トレースとスパン -- **トレース (Trace)** は 1 回のワークフローのエンドツーエンドの操作を表します。トレースは複数のスパンで構成され、以下のプロパティを持ちます。 - - `workflow_name`: 論理的なワークフローまたはアプリ名。例: "Code generation" や "Customer service" - - `trace_id`: トレースの一意 ID。指定しない場合は自動生成されます。形式は `trace_<32_alphanumeric>` でなければなりません。 - - `group_id`: 会話内の複数トレースを関連付ける任意のグループ ID。たとえばチャットスレッド ID など。 - - `disabled`: True の場合、このトレースは記録されません。 - - `metadata`: トレースに付与する任意のメタデータ。 -- **スパン (Span)** は開始時刻と終了時刻を持つ操作を表します。スパンは以下を持ちます。 +- **トレース (Trace)** は 1 回の「ワークフロー」のエンドツーエンドの操作を表します。複数のスパンで構成されます。トレースには以下のプロパティがあります。 + - `workflow_name`：論理的なワークフローまたはアプリ名。例：「Code generation」や「Customer service」 + - `trace_id`：トレースごとの一意 ID。指定しない場合は自動生成されます。形式は `trace_<32_alphanumeric>` + - `group_id`：オプションのグループ ID。同じ会話から発生した複数のトレースを紐付けるために使用します。例としてチャットスレッド ID など + - `disabled`：`True` の場合、このトレースは記録されません + - `metadata`：トレースの任意メタデータ +- **スパン (Span)** は開始時刻と終了時刻を持つ操作を表します。スパンには以下があります。 - `started_at` と `ended_at` タイムスタンプ - - 所属するトレースを示す `trace_id` - - 親スパンを指す `parent_id` (存在する場合) - - スパン情報を保持する `span_data`。例として `AgentSpanData` はエージェント情報を、`GenerationSpanData` は LLM 生成情報を保持します。 + - `trace_id`：所属するトレースを示します + - `parent_id`：このスパンの親スパンを指します（存在する場合） + - `span_data`：スパンに関する情報。例として `AgentSpanData` はエージェント情報、`GenerationSpanData` は LLM 生成情報など ## デフォルトのトレーシング -デフォルトでは SDK が次をトレースします。 +デフォルトでは、SDK は以下をトレースします。 -- `Runner.{run, run_sync, run_streamed}()` 全体を `trace()` でラップ -- エージェント実行ごとに `agent_span()` でラップ -- LLM 生成を `generation_span()` でラップ -- function tool 呼び出しを `function_span()` でラップ -- guardrail を `guardrail_span()` でラップ -- handoffs を `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()` でラップされます +- 音声入力 (speech-to-text) は `transcription_span()` でラップされます +- 音声出力 (text-to-speech) は `speech_span()` でラップされます +- 関連する音声スパンは `speech_group_span()` の下にネストされる場合があります -デフォルトのトレース名は "Agent workflow" です。`trace` を使用して名前を設定するか、[`RunConfig`][agents.run.RunConfig] で名前やその他のプロパティを設定できます。 +デフォルトでは、トレース名は "Agent workflow" です。`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,61 +64,61 @@ async def main(): print(f"Rating: {second_result.final_output}") ``` -1. `Runner.run` への 2 回の呼び出しが `with trace()` に包まれているため、個別のトレースを作成せず 1 つのトレース内に含まれます。 +1. `Runner.run` の 2 回の呼び出しが `with trace()` でラップされているため、それぞれが個別のトレースを生成するのではなく、全体で 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) で追跡されている最も近い現在のスパンの下にネストされます。 +スパンは自動的に現在のトレースに含まれ、Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) により追跡される最も近い現在のスパンの下にネストされます。 ## 機微データ -一部のスパンは機微データを記録する可能性があります。 +一部のスパンは機微データを含む可能性があります。 -`generation_span()` は LLM 生成の入出力を保存し、`function_span()` は function 呼び出しの入出力を保存します。機微データを含む可能性があるため、[`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] でデータ収集を無効化できます。 -同様に、Audio スパンはデフォルトで入出力音声の 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] に送信します。Exporter はスパンとトレースをバッチで OpenAI バックエンドへ送信します。 -このデフォルト設定を変更し、別のバックエンドへ送信したりエクスポータの挙動を変更したりするには、次の 2 つの方法があります。 +デフォルト設定をカスタマイズし、別のバックエンドへ送信したり Exporter の挙動を変更したりするには、以下の 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]：**追加**のトレースプロセッサーを登録します。これにより、OpenAI バックエンドへの送信に加えて独自処理が可能です。 +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) +- [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) - [LangDB AI](https://docs.langdb.ai/getting-started/working-with-agent-frameworks/working-with-openai-agents-sdk) \ No newline at end of file diff --git a/docs/ja/visualization.md b/docs/ja/visualization.md index 462c2fdb4..400ea24f9 100644 --- a/docs/ja/visualization.md +++ b/docs/ja/visualization.md @@ -4,7 +4,7 @@ search: --- # エージェントの可視化 -エージェントの可視化を利用すると、 **Graphviz** を使ってエージェントとそれらの関係を構造化したグラフィカル表現として生成できます。これにより、アプリケーション内でエージェント、ツール、ハンドオフがどのように相互作用しているかを理解しやすくなります。 +エージェントの可視化では、 **Graphviz** を使用してエージェントとそれらの関係を構造化されたグラフィカル表現として生成できます。これにより、アプリケーション内でエージェント、ツール、ハンドオフがどのように相互作用するかを理解しやすくなります。 ## インストール @@ -18,9 +18,9 @@ pip install "openai-agents[viz]" `draw_graph` 関数を使用してエージェントの可視化を生成できます。この関数は次のような有向グラフを作成します: -- **エージェント** は黄色いボックスで表されます。 -- **ツール** は緑色の楕円で表されます。 -- **ハンドオフ** はあるエージェントから別のエージェントへ向かう有向エッジとして表されます。 +- **エージェント** は黄色のボックスで表されます。 +- **ツール** は緑色の楕円で表されます。 +- **ハンドオフ** は一方のエージェントから別のエージェントへ向かう有向エッジとして示されます。 ### 使用例 @@ -52,33 +52,33 @@ triage_agent = Agent( draw_graph(triage_agent) ``` -![Agent Graph](../assets/images/graph.png) +![エージェント グラフ](../assets/images/graph.png) -これにより、 **triage agent** の構造とサブエージェントおよびツールとの接続を視覚的に表したグラフが生成されます。 +これにより、 **triage agent** の構造と、そのサブエージェントおよびツールとの接続を視覚的に示すグラフが生成されます。 ## 可視化の理解 -生成されたグラフには次が含まれます: +生成されたグラフには次の要素が含まれます: -- エントリポイントを示す **start node** (`__start__`)。 -- 黄色で塗りつぶされた **長方形** で表されるエージェント。 -- 緑色で塗りつぶされた **楕円** で表されるツール。 -- 相互作用を示す有向エッジ: - - エージェント間のハンドオフには **実線の矢印**。 - - ツール呼び出しには **点線の矢印**。 -- 実行が終了する場所を示す **end node** (`__end__`)。 +- **start node** (`__start__`) がエントリーポイントを示します。 +- エージェントは黄色で塗りつぶされた長方形として表示されます。 +- ツールは緑色で塗りつぶされた楕円として表示されます。 +- 相互作用を示す有向エッジ: + - **Solid arrows** はエージェント間のハンドオフを示します。 + - **Dotted arrows** はツール呼び出しを示します。 +- **end node** (`__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 4884bf3c7..5ee5f78fe 100644 --- a/docs/ja/voice/pipeline.md +++ b/docs/ja/voice/pipeline.md @@ -4,7 +4,7 @@ search: --- # パイプラインとワークフロー -[`VoicePipeline`][agents.voice.pipeline.VoicePipeline] は、エージェント的なワークフローを音声アプリへ簡単に変換できるクラスです。ワークフローを渡すだけで、入力音声の文字起こし、音声終了の検知、適切なタイミングでのワークフロー呼び出し、そしてワークフロー出力を音声へ変換する処理までをパイプラインが自動で処理します。 +[`VoicePipeline`][agents.voice.pipeline.VoicePipeline] は、エージェント型ワークフローを音声アプリに簡単に変換できるクラスです。実行したいワークフローを渡すと、入力音声の文字起こし、音声終了の検出、適切なタイミングでのワークフロー呼び出し、そしてワークフロー出力を音声へ再変換する処理をパイプラインが自動で行います。 ```mermaid graph LR @@ -34,29 +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] モデル +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 モデルの設定：プロンプト、言語、データタイプなど + さまざまな設定が可能です。 + - モデルプロバイダー：モデル名をモデルにマッピングします。 + - トレーシング：トレーシングの無効化、音声ファイルのアップロード有無、ワークフロー名、トレース 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] - ユーザーの発話終了を検知する必要がある場合に使用します。音声チャンクを順次送信でき、パイプラインがアクティビティ検知を通じて適切なタイミングでエージェントワークフローを実行します。 + ユーザーが話し終わるタイミングを検出する必要がある場合に使用します。音声チャンクを順次プッシュでき、パイプラインが「アクティビティ検出」により適切なタイミングでワークフローを自動実行します。 ## 結果 -音声パイプラインの実行結果は [`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] 音声チャンクを含みます。 @@ -83,8 +83,4 @@ async for event in result.stream(): ### 割り込み -Agents SDK は現時点で [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput] に対する組み込みの割り込み処理をサポートしていません。検知された各ターンごとに個別にワークフローが実行されます。アプリケーション側で割り込みを処理したい場合は、[`VoiceStreamEventLifecycle`][agents.voice.events.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 187c1dbaa..a84376caa 100644 --- a/docs/ja/voice/quickstart.md +++ b/docs/ja/voice/quickstart.md @@ -6,7 +6,7 @@ search: ## 前提条件 -OpenAI Agents SDK の [クイックスタート手順](../quickstart.md) に従い、仮想環境をセットアップしてください。その後、SDK から音声用のオプション依存関係をインストールします。 +Agents SDK の基本的な [クイックスタート手順](../quickstart.md) に従い、仮想環境をセットアップしていることを確認してください。その後、SDK から任意の音声依存関係をインストールします: ```bash pip install 'openai-agents[voice]' @@ -14,11 +14,11 @@ 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. 結果のテキストを再び音声に変換するために text-to-speech モデルを実行します。 ```mermaid graph LR @@ -48,7 +48,7 @@ graph LR ## エージェント -まず、エージェントをいくつか設定します。本 SDK でエージェントを構築した経験があれば、見覚えのある手順です。ここでは複数のエージェント、ハンドオフ、そしてツールを用意します。 +まず、いくつかのエージェントをセットアップしましょう。すでにこの SDK でエージェントを構築したことがある場合は、馴染みがあるはずです。ここでは複数のエージェント、ハンドオフ、そしてツールを用意します。 ```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 47e85d15e..5698b2109 100644 --- a/docs/ja/voice/tracing.md +++ b/docs/ja/voice/tracing.md @@ -2,17 +2,17 @@ search: exclude: true --- -# トレーシング +# Tracing -[エージェントのトレーシング](../tracing.md) と同様に、voice パイプラインも自動でトレーシングされます。 +[エージェント](../tracing.md) がトレーシングされるのと同様に、Voice パイプラインも自動的にトレーシングされます。 -基本的なトレーシング情報については上記ドキュメントをご参照ください。さらに、[`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig] を使用してパイプラインのトレーシングを設定できます。 +基本的なトレーシングの情報については上記のドキュメントをご覧ください。加えて、[`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig] を使用してパイプラインのトレーシングを設定できます。 -主なトレーシング関連フィールドは次のとおりです。 +Key tracing related fields are: -- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: トレーシングを無効にするかどうかを制御します。デフォルトでは有効です。 -- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: オーディオの書き起こしなど、機微なデータをトレースに含めるかどうかを制御します。これは voice パイプライン専用で、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` で、複数のトレースをリンクできます。 +- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: トレーシングを無効にするかどうかを制御します。デフォルトではトレーシングは有効です。 +- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: トレースに音声の文字起こしなどの機微情報を含めるかどうかを制御します。これは Voice パイプライン専用で、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