diff --git a/docs/ja/agents.md b/docs/ja/agents.md index 4f8427d6d..327952556 100644 --- a/docs/ja/agents.md +++ b/docs/ja/agents.md @@ -4,16 +4,16 @@ search: --- # エージェント -エージェントはアプリの中核となる基本コンポーネントです。エージェントは、instructions と tools で構成された大規模言語モデル（ LLM ）です。 +エージェントはアプリの中核となる基本コンポーネントです。エージェントは instructions とツールで構成された大規模言語モデル（ LLM ）です。 -## 基本構成 +## 基本設定 -よく設定するエージェントのプロパティは以下のとおりです。 +エージェントで最も一般的に設定するプロパティは次のとおりです。 -- `name`: エージェントを識別する必須の文字列です。 -- `instructions`: developer message または システムプロンプト とも呼ばれます。 -- `model`: どの LLM を使用するか、また任意の `model_settings` で temperature、top_p などのモデル調整パラメーターを設定できます。 -- `tools`: エージェントがタスクを達成するために使用できるツールです。 +- `name`: エージェントを識別する必須の文字列です。 +- `instructions`: developer メッセージまたは system prompt とも呼ばれます。 +- `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](https://docs.pydantic.dev/) オブジェクトを使いますが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップできる任意の型（dataclasses、lists、TypedDict など）をサポートします。 +デフォルトでは、エージェントはプレーンテキスト（すなわち `str`）を出力します。特定の型の出力をエージェントに生成させたい場合は、`output_type` パラメーターを使用できます。一般的な選択肢は [Pydantic](https://docs.pydantic.dev/) オブジェクトですが、Pydantic の [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) でラップできる任意の型（dataclasses、リスト、TypedDict など）をサポートします。 ```python from pydantic import BaseModel @@ -73,20 +73,20 @@ agent = Agent( !!! note - `output_type` を渡すと、モデルは通常のプレーンテキスト応答ではなく、[structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用するよう指示されます。 + `output_type` を渡すと、モデルは通常のプレーンテキスト応答ではなく [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使用します。 -## 複数エージェントのシステム設計パターン +## マルチエージェント システム設計パターン -マルチエージェントシステムの設計方法は多数ありますが、幅広く適用できるパターンとして次の 2 つがよく使われます。 +マルチエージェント システムの設計方法は多数ありますが、一般に広く適用できるパターンを 2 つよく見かけます。 -1. マネージャー（ツールとしてのエージェント）: 中央のマネージャー／オーケストレーターが、ツールとして公開された専門サブエージェントを呼び出し、会話の主導権を保持します。 -2. ハンドオフ: 対等なエージェント同士が、会話を引き継ぐ専門エージェントに主導権を渡します。これは分散型です。 +1. マネージャー（エージェントをツールとして）: 中央のマネージャー／オーケストレーターが、ツールとして公開された専門のサブエージェントを呼び出し、会話の制御を保持します。 +2. ハンドオフ: ピアのエージェントが制御を専門のエージェントに引き渡し、そのエージェントが会話を引き継ぎます。これは分散型です。 -詳細は、[エージェント構築の実践ガイド](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf)をご覧ください。 +詳細は [エージェント構築の実践ガイド](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf) を参照してください。 -### マネージャー（ツールとしてのエージェント） +### マネージャー（エージェントをツールとして） -`customer_facing_agent` がすべてのユーザーとのやり取りを担当し、ツールとして公開された専門サブエージェントを呼び出します。詳しくは [ツール](tools.md#agents-as-tools) のドキュメントをご覧ください。 +`customer_facing_agent` はすべてのユーザーとの対話を処理し、ツールとして公開された専門のサブエージェントを呼び出します。詳しくは [ツール](tools.md#agents-as-tools) のドキュメントを参照してください。 ```python from agents import Agent @@ -115,7 +115,7 @@ customer_facing_agent = Agent( ### ハンドオフ -ハンドオフは、エージェントが委任できるサブエージェントです。ハンドオフが発生すると、委任先のエージェントが会話履歴を受け取り、会話を引き継ぎます。このパターンにより、単一タスクに長けたモジュール式・専門特化のエージェントを実現できます。詳しくは [ハンドオフ](handoffs.md) のドキュメントをご覧ください。 +ハンドオフは、エージェントが委任できるサブエージェントです。ハンドオフが発生すると、委任先のエージェントが会話履歴を受け取り、会話を引き継ぎます。このパターンにより、単一のタスクに秀でたモジュール式の専門エージェントが実現します。詳しくは [ハンドオフ](handoffs.md) のドキュメントを参照してください。 ```python from agents import Agent @@ -136,7 +136,7 @@ triage_agent = Agent( ## 動的 instructions -多くの場合、エージェントを作成するときに instructions を指定しますが、関数を通じて動的な instructions を提供することもできます。関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方が利用できます。 +多くの場合、エージェント作成時に instructions を指定できますが、関数を通じて動的な instructions を提供することもできます。関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と `async` 関数の両方が使用できます。 ```python def dynamic_instructions( @@ -151,17 +151,17 @@ agent = Agent[UserContext]( ) ``` -## ライフサイクルイベント（フック） +## ライフサイクル イベント（フック） -場合によっては、エージェントのライフサイクルを観察したいことがあります。たとえば、イベントをログ出力したり、特定のイベント発生時にデータを事前取得したりできます。`hooks` プロパティでエージェントのライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスを継承し、関心のあるメソッドをオーバーライドしてください。 +ときには、エージェントのライフサイクルを観察したいことがあります。たとえば、イベントを記録したり、特定のイベント発生時にデータを事前取得したりです。`hooks` プロパティでエージェントのライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、関心のあるメソッドをオーバーライドしてください。 ## ガードレール -ガードレールにより、エージェントの実行と並行して ユーザー入力 に対するチェック／検証を行い、また、エージェントが出力を生成した後にその出力に対してもチェックを実行できます。たとえば、ユーザー入力とエージェント出力を関連性でスクリーニングできます。詳しくは [ガードレール](guardrails.md) のドキュメントをご覧ください。 +ガードレールにより、エージェントの実行と並行してユーザー入力に対するチェック／検証を行い、またエージェントの出力が生成された後にそれを検証できます。たとえば、ユーザー入力やエージェント出力の関連性チェックが可能です。詳しくは [ガードレール](guardrails.md) のドキュメントを参照してください。 ## エージェントのクローン／コピー -エージェントの `clone()` メソッドを使うと、エージェントを複製し、任意のプロパティを変更できます。 +エージェントの `clone()` メソッドを使うと、エージェントを複製し、必要に応じて任意のプロパティを変更できます。 ```python pirate_agent = Agent( @@ -178,12 +178,12 @@ robot_agent = pirate_agent.clone( ## ツール使用の強制 -ツールのリストを渡しても、常に LLM がツールを使用するとは限りません。[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定するとツール使用を強制できます。有効な値は次のとおりです。 +ツールのリストを提供しても、LLM が必ずしもツールを使用するとは限りません。[`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] を設定してツール使用を強制できます。有効な値は次のとおりです。 -1. `auto`: ツールを使用するかどうかを LLM に任せます。 -2. `required`: LLM にツールの使用を必須にします（どのツールを使うかは知的に判断します）。 -3. `none`: LLM にツールを _使用しない_ ことを要求します。 -4. 特定の文字列（例: `my_tool`）を設定: LLM にその特定のツールの使用を要求します。 +1. `auto`: LLM がツールを使用するかどうかを判断します。 +2. `required`: LLM にツールの使用を要求します（どのツールかは賢く選択します）。 +3. `none`: LLM にツールを使用しないこと（_not_）を要求します。 +4. 特定の文字列（例: `my_tool`）を設定して、その特定のツールを使用するよう LLM に要求します。 ```python from agents import Agent, Runner, function_tool, ModelSettings @@ -203,7 +203,7 @@ agent = Agent( ## ツール使用の動作 -`Agent` の設定パラメーター `tool_use_behavior` は、ツール出力の取り扱い方法を制御します。 +`Agent` の `tool_use_behavior` パラメーターは、ツール出力の扱いを制御します。 - `"run_llm_again"`: デフォルト。ツールを実行し、その結果を LLM が処理して最終応答を生成します。 - `"stop_on_first_tool"`: 最初のツール呼び出しの出力を、その後の LLM 処理なしで最終応答として使用します。 @@ -224,7 +224,7 @@ agent = Agent( ) ``` -- `StopAtTools(stop_at_tool_names=[...])`: 指定したいずれかのツールが呼び出されたら停止し、その出力を最終応答として使用します. +- `StopAtTools(stop_at_tool_names=[...])`: 指定したいずれかのツールが呼び出された場合に停止し、その出力を最終応答として使用します。 ```python from agents import Agent, Runner, function_tool @@ -248,7 +248,7 @@ agent = Agent( ) ``` -- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM を継続するかを判断するカスタム関数です。 +- `ToolsToFinalOutputFunction`: ツール結果を処理し、停止するか LLM を継続するかを決定するカスタム関数です。 ```python from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper @@ -286,4 +286,4 @@ agent = Agent( !!! note - 無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この動作は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定できます。無限ループは、ツール結果が LLM に送られ、`tool_choice` により LLM が再度ツール呼び出しを生成し続けることによって発生します。 \ No newline at end of file + 無限ループを防ぐため、フレームワークはツール呼び出しの後に `tool_choice` を自動的に "auto" にリセットします。この動作は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定可能です。無限ループは、ツール結果が LLM に送られ、`tool_choice` により LLM が再びツール呼び出しを生成し続けるために発生します。 \ No newline at end of file diff --git a/docs/ja/config.md b/docs/ja/config.md index 9e4e2d80c..8b3b39eea 100644 --- a/docs/ja/config.md +++ b/docs/ja/config.md @@ -6,7 +6,7 @@ search: ## API キーとクライアント -デフォルトで、SDK は LLM リクエストとトレーシングのために、インポートされた時点で `OPENAI_API_KEY` 環境変数を探します。アプリ起動前にその環境変数を設定できない場合は、[set_default_openai_key()][agents.set_default_openai_key] 関数でキーを設定できます。 +デフォルトでは、SDK はインポートされるとすぐに、LLM リクエストと トレーシング のための `OPENAI_API_KEY` 環境変数を探します。アプリ起動前にその環境変数を設定できない場合は、[set_default_openai_key()][agents.set_default_openai_key] 関数でキーを設定できます。 ```python from agents import set_default_openai_key @@ -14,7 +14,7 @@ from agents import set_default_openai_key set_default_openai_key("sk-...") ``` -また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数または上記で設定したデフォルトキーを用いて `AsyncOpenAI` インスタンスを作成します。これを変更するには、[set_default_openai_client()][agents.set_default_openai_client] 関数を使用します。 +また、使用する OpenAI クライアントを設定することもできます。デフォルトでは、SDK は環境変数の 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 を使用します。これを上書きして Chat Completions API を使うには、[set_default_openai_api()][agents.set_default_openai_api] 関数を使用します。 +最後に、使用する OpenAI API をカスタマイズすることもできます。デフォルトでは OpenAI Responses API を使用します。[set_default_openai_api()][agents.set_default_openai_api] 関数でこれを上書きし、Chat Completions API を使用できます。 ```python from agents import set_default_openai_api @@ -34,7 +34,7 @@ set_default_openai_api("chat_completions") ## トレーシング -トレーシングはデフォルトで有効になっています。デフォルトでは、上記の OpenAI API キー（つまり、環境変数または設定したデフォルトキー）を使用します。トレーシングに使用する API キーを個別に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します。 +トレーシング はデフォルトで有効です。デフォルトでは、上記の OpenAI API キー（つまり、環境変数または設定したデフォルトキー）を使用します。トレーシング に使用する API キーを個別に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します。 ```python from agents import set_tracing_export_api_key @@ -42,7 +42,7 @@ from agents import set_tracing_export_api_key set_tracing_export_api_key("sk-...") ``` -[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使用すると、トレーシングを完全に無効化できます。 +[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使用して、トレーシング を完全に無効化することもできます。 ```python from agents import set_tracing_disabled @@ -52,7 +52,7 @@ set_tracing_disabled(True) ## デバッグログ -SDK にはハンドラーが設定されていない Python ロガーが 2 つあります。デフォルトでは、これは警告とエラーが `stdout` に送られ、それ以外のログは抑制されることを意味します。 +SDK にはハンドラーが設定されていない 2 つの Python ロガーがあります。デフォルトでは、これは warning と error が `stdout` に送られ、その他のログは抑制されることを意味します。 詳細なログを有効にするには、[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。 @@ -62,7 +62,7 @@ from agents import enable_verbose_stdout_logging enable_verbose_stdout_logging() ``` -また、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることもできます。詳しくは [Python logging guide](https://docs.python.org/3/howto/logging.html) を参照してください。 +また、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズすることもできます。詳しくは [Python logging ガイド](https://docs.python.org/3/howto/logging.html)をご覧ください。 ```python import logging @@ -83,15 +83,15 @@ logger.addHandler(logging.StreamHandler()) ### ログ内の機微なデータ -一部のログには機微なデータ（たとえば、ユーザーデータ）が含まれる場合があります。これらのデータの記録を無効にしたい場合は、次の環境変数を設定してください。 +一部のログには（例: ユーザー データなど）機微なデータが含まれる場合があります。これらのデータがログに出力されないようにするには、次の環境変数を設定します。 -LLM の入力と出力の記録を無効にするには: +LLM の入力と出力のログを無効化するには: ```bash export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1 ``` -ツールの入力と出力の記録を無効にするには: +ツールの入力と出力のログを無効化するには: ```bash export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1 diff --git a/docs/ja/context.md b/docs/ja/context.md index db74fd76e..f221970d6 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. そのオブジェクトを各種の実行メソッドに渡します（例: `Runner.run(..., **context=whatever**)`）。 -3. すべてのツール呼び出しやライフサイクルフックなどに、ラッパーオブジェクト `RunContextWrapper[T]` が渡されます。ここで `T` はあなたのコンテキストオブジェクトの型で、`wrapper.context` からアクセスできます。 +3. すべてのツール呼び出しやライフサイクルフックに、`RunContextWrapper[T]` というラッパーオブジェクトが渡されます。`T` はコンテキストオブジェクトの型で、`wrapper.context` からアクセスできます。 -**最も重要** な注意点: 特定のエージェントの実行において、すべてのエージェント、ツール関数、ライフサイクルなどは同じ型のコンテキストを使用しなければなりません。 + **最重要ポイント**: 特定のエージェント実行に関わるすべてのエージェント、ツール関数、ライフサイクルは、同じ _型_ のコンテキストを使用する必要があります。 -コンテキストは次のような用途に使えます。 +コンテキストは次のような用途に使えます: -- 実行時のコンテキストデータ（例: ユーザー名 / uid やその他の ユーザー 情報） +- 実行に関する状況データ（例: ユーザー名 / UID その他のユーザー情報） - 依存関係（例: ロガーオブジェクト、データフェッチャーなど） - ヘルパー関数 !!! danger "注意" - コンテキストオブジェクトは LLM に **送信されません**。これは純粋にローカルのオブジェクトで、読み書きやメソッド呼び出しができます。 + コンテキストオブジェクトは LLM に **送信されません**。これは純粋にローカルなオブジェクトで、読み書きやメソッドの呼び出しができます。 ```python import asyncio @@ -67,8 +67,8 @@ if __name__ == "__main__": ``` 1. これはコンテキストオブジェクトです。ここでは dataclass を使っていますが、任意の型を使用できます。 -2. これはツールです。`RunContextWrapper[UserInfo]` を受け取っていることがわかります。ツールの実装はコンテキストから読み取ります。 -3. エージェントにはジェネリクス `UserInfo` を付けます。これにより、型チェッカーがエラーを検出できます（たとえば、異なるコンテキスト型を受け取るツールを渡そうとした場合など）。 +2. これはツールです。`RunContextWrapper[UserInfo]` を受け取り、ツールの実装はコンテキストから読み取ります。 +3. エージェントにジェネリック型 `UserInfo` を付与し、型チェッカーがエラーを検出できるようにします（たとえば、異なるコンテキスト型を受け取るツールを渡そうとした場合）。 4. `run` 関数にコンテキストを渡します。 5. エージェントはツールを正しく呼び出し、年齢を取得します。 @@ -76,8 +76,8 @@ if __name__ == "__main__": ### 応用: `ToolContext` -場合によっては、実行中のツールに関する追加メタデータ（名前、呼び出し ID、raw の引数文字列など）にアクセスしたいことがあります。 -そのためには、`RunContextWrapper` を拡張した [`ToolContext`][agents.tool_context.ToolContext] クラスを使用できます。 +実行中のツールに関する追加メタデータ（ツール名、呼び出し ID、raw な引数文字列など）にアクセスしたい場合があります。 +そのために、`RunContextWrapper` を拡張した [`ToolContext`][agents.tool_context.ToolContext] クラスを使用できます。 ```python from typing import Annotated @@ -105,12 +105,11 @@ agent = Agent( ) ``` -`ToolContext` は `RunContextWrapper` と同じ `.context` プロパティに加えて、 -現在のツール呼び出しに固有のフィールドを提供します。 +`ToolContext` は `RunContextWrapper` と同じ `.context` プロパティに加えて、現在のツール呼び出しに固有の追加フィールドを提供します: - `tool_name` – 呼び出されているツールの名前 -- `tool_call_id` – このツール呼び出しの一意な識別子 -- `tool_arguments` – ツールに渡された raw の引数文字列 +- `tool_call_id` – このツール呼び出しの一意の識別子 +- `tool_arguments` – ツールに渡された raw な引数文字列 実行時にツールレベルのメタデータが必要な場合は `ToolContext` を使用してください。 エージェントとツール間で一般的にコンテキストを共有するだけであれば、`RunContextWrapper` で十分です。 @@ -119,9 +118,9 @@ agent = Agent( ## エージェント / LLM のコンテキスト -LLM が呼び出されるとき、LLM が参照できるのは会話履歴のデータ **のみ** です。つまり、LLM に新しいデータを利用させたい場合は、その履歴に含める形で提供する必要があります。いくつかの方法があります。 +LLM が呼び出されると、参照できるのは会話履歴のデータ **のみ** です。つまり、LLM に新しいデータを利用させたい場合は、そのデータが履歴で参照できるようにする必要があります。方法はいくつかあります: -1. エージェントの `instructions` に追加します。これは「システムプロンプト」または「開発者メッセージ」とも呼ばれます。システムプロンプトは静的な文字列でも、コンテキストを受け取って文字列を出力する動的な関数でもかまいません。常に有用な情報（例: ユーザー名や現在の日付）に適した手法です。 -2. `Runner.run` 関数を呼び出すときに `input` に追加します。これは `instructions` の手法に似ていますが、[指揮系統](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command) の下位にメッセージを配置できます。 -3. 関数ツール 経由で公開します。これは _オンデマンド_ のコンテキストに有用です。LLM は必要なときにデータを要求し、ツールを呼び出してそのデータを取得できます。 -4. リトリーバルまたは Web 検索 を使用します。これらは、ファイルやデータベース（リトリーバル）や、Web（Web 検索）から関連データを取得できる特別なツールです。これは関連するコンテキストデータに基づいて応答を「グラウンディング」するのに有用です。 \ No newline at end of file +1. エージェントの `instructions` に追加します。これは「system prompt（システムプロンプト）」や「developer message」とも呼ばれます。システムプロンプトは固定の文字列でも、コンテキストを受け取って文字列を出力する動的関数でも構いません。ユーザー名や現在の日付のように常に有用な情報に適した方法です。 +2. `Runner.run` 関数を呼び出す際の `input` に追加します。これは `instructions` の戦術に似ていますが、[chain of command](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command) においてより下位のメッセージとして扱えます。 +3. 関数ツール経由で公開します。これはオンデマンドのコンテキストに有用で、LLM が必要に応じてデータ取得用のツールを呼び出せます。 +4. リトリーバルや Web 検索を使用します。これらは、ファイルやデータベース（リトリーバル）や Web（Web 検索）から関連データを取得できる特別なツールです。関連するコンテキストデータに基づいて応答を「グラウンディング」するのに役立ちます。 \ No newline at end of file diff --git a/docs/ja/examples.md b/docs/ja/examples.md index 7087bd5c3..541bc26b7 100644 --- a/docs/ja/examples.md +++ b/docs/ja/examples.md @@ -4,15 +4,15 @@ search: --- # コード例 -[リポジトリ](https://github.com/openai/openai-agents-python/tree/main/examples) の examples セクションで、SDK のさまざまなサンプル実装をご覧ください。これらのコード例は、異なるパターンや機能を示す複数のカテゴリーに整理されています。 +[repo](https://github.com/openai/openai-agents-python/tree/main/examples) の examples セクションで、 SDK のさまざまなサンプル実装をご覧ください。これらの code examples は、異なるパターンと機能を示す複数の カテゴリー に整理されています。 ## カテゴリー -- **[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):** + このカテゴリーの examples は、以下のような一般的なエージェント設計パターンを示します。 - - 決定論的ワークフロー - - ツールとしてのエージェント + - 決定的なワークフロー + - ツールとしての エージェント - エージェントの並列実行 - 条件付きツール使用 - 入出力のガードレール @@ -20,68 +20,68 @@ search: - ルーティング - ストリーミングのガードレール -- **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** - SDK の基礎的な機能を示すコード例です +- **[basic（基本）](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** + これらの examples は、以下のような SDK の基礎的な機能を紹介します。 - - Hello World のコード例（デフォルトモデル、GPT-5、オープンウェイトモデル） + - Hello World の code examples（デフォルトモデル、 GPT-5、オープンウェイトのモデル） - エージェントのライフサイクル管理 - 動的な システムプロンプト - - ストリーミング出力（テキスト、アイテム、関数呼び出し引数） + - ストリーミング出力（テキスト、項目、関数呼び出し引数） - プロンプトテンプレート - - ファイル処理（ローカルとリモート、画像と PDF） - - 利用状況のトラッキング - - 厳格でない出力型 - - 前回のレスポンス ID の利用 + - ファイル取り扱い（ローカルとリモート、画像と PDF） + - 利用状況の追跡 + - 厳密でない出力型 + - 以前のレスポンス ID の使用 -- **[customer_service](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service):** - 航空会社向けのカスタマーサービス システムの例。 +- **[customer_service（カスタマーサービス）](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service):** + 航空会社向けのカスタマーサービス システムの例です。 -- **[financial_research_agent](https://github.com/openai/openai-agents-python/tree/main/examples/financial_research_agent):** - エージェントとツールを用いた金融データ分析のための、構造化されたリサーチ ワークフローを示す金融リサーチ エージェント。 +- **[financial_research_agent（金融リサーチ エージェント）](https://github.com/openai/openai-agents-python/tree/main/examples/financial_research_agent):** + エージェントとツールを用いた、金融データ分析のための構造化されたリサーチ ワークフローを示す金融リサーチ エージェントです。 -- **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** - メッセージフィルタリング付きのエージェントのハンドオフの実用例。 +- **[handoffs（ハンドオフ）](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** + メッセージフィルタリングを伴うエージェントのハンドオフの実用的な code examples をご覧ください。 -- **[hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp):** - hosted MCP (Model Context Protocol) コネクタと承認フローの使用方法を示す例。 +- **[hosted_mcp（ホスト型 MCP）](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp):** + ホスト型の MCP（Model Context Protocol）コネクタと承認の使用方法を示す examples です。 - **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** - MCP (Model Context Protocol) を使ってエージェントを構築する方法。以下を含みます: + MCP（Model Context Protocol）でエージェントを構築する方法を学べます。以下を含みます。 - - ファイルシステムの例 - - Git の例 - - MCP プロンプト サーバーの例 - - SSE (Server-Sent Events) の例 - - ストリーミング可能な HTTP のコード例 + - ファイルシステムの examples + - Git の examples + - MCP プロンプト サーバーの examples + - SSE（Server-Sent Events）の examples + - ストリーム可能な HTTP の examples -- **[memory](https://github.com/openai/openai-agents-python/tree/main/examples/memory):** - エージェント向けのさまざまなメモリ実装の例。以下を含みます: +- **[memory（メモリー）](https://github.com/openai/openai-agents-python/tree/main/examples/memory):** + エージェント向けのさまざまなメモリー実装の examples です。以下を含みます。 - - SQLite セッションストレージ - - 高度な SQLite セッションストレージ - - Redis セッションストレージ - - SQLAlchemy セッションストレージ - - 暗号化されたセッションストレージ - - OpenAI セッションストレージ + - SQLite セッション ストレージ + - 高度な SQLite セッション ストレージ + - Redis セッション ストレージ + - SQLAlchemy セッション ストレージ + - 暗号化されたセッション ストレージ + - OpenAI セッション ストレージ -- **[model_providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** - OpenAI 以外のモデルを SDK で使う方法を紹介。カスタムプロバイダーや LiteLLM 連携を含みます。 +- **[model_providers（モデルプロバイダー）](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** + カスタムプロバイダーや LiteLLM の統合など、非 OpenAI モデルを SDK で使用する方法を学びます。 -- **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** - SDK を使ってリアルタイム体験を構築する方法を示す例。以下を含みます: +- **[realtime（リアルタイム）](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** + SDK を使ってリアルタイム体験を構築する方法を示す examples。以下を含みます。 - Web アプリケーション - コマンドライン インターフェース - Twilio 連携 -- **[reasoning_content](https://github.com/openai/openai-agents-python/tree/main/examples/reasoning_content):** - 推論コンテンツと structured outputs の扱い方を示すコード例。 +- **[reasoning_content（推論コンテンツ）](https://github.com/openai/openai-agents-python/tree/main/examples/reasoning_content):** + 推論コンテンツと structured outputs を扱う方法を示す examples です。 -- **[research_bot](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):** - 複雑なマルチエージェントのリサーチ ワークフローを示す、シンプルな ディープリサーチ クローン。 +- **[research_bot（リサーチ ボット）](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):** + 複雑なマルチエージェント リサーチ ワークフローを示す、シンプルな ディープリサーチ のクローンです。 -- **[tools](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** - 次のような OpenAI がホストするツールの実装方法: +- **[tools（ツール）](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** + 次のような OpenAI がホストするツール の実装方法を学びます。 - Web 検索 と フィルター付きの Web 検索 - ファイル検索 @@ -89,5 +89,5 @@ search: - コンピュータ操作 - 画像生成 -- **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** - TTS と STT モデルを用いた音声エージェントの例。ストリーミング音声のコード例を含みます。 \ No newline at end of file +- **[voice（ボイス）](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** + TTS と STT モデルを用いた音声エージェントの examples。ストリーミングされた音声の examples を含みます。 \ No newline at end of file diff --git a/docs/ja/guardrails.md b/docs/ja/guardrails.md index c2450a9b2..5dee68951 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] 例外が送出され、ユーザーへの適切な応答や例外処理ができます。 +1. まず、ガードレールは エージェント に渡されたものと同じ入力を受け取ります。 +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` に渡さないのか不思議に思うかもしれません。これは、ガードレールが実際のエージェントに密接に関係する傾向があるためです。エージェントごとに異なるガードレールを実行するので、コードを同じ場所に置くことで可読性が向上します。 + 入力ガードレールは ユーザー 入力での実行を想定しているため、 エージェント のガードレールはその エージェント が 1 番目の エージェント の場合にのみ実行されます。なぜ `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] 例外が送出され、ユーザーへの適切な応答や例外処理ができます。 +1. まず、ガードレールは エージェント によって生成された出力を受け取ります。 +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 @@ -94,10 +94,10 @@ async def main(): print("Math homework guardrail tripped") ``` -1. このエージェントをガードレール関数内で使用します。 -2. これはエージェントの入力/コンテキストを受け取り、結果を返すガードレール関数です。 +1. この エージェント をガードレール関数内で使用します。 +2. これは エージェント の入力/コンテキストを受け取り、結果を返すガードレール関数です。 3. ガードレール結果に追加情報を含めることができます。 -4. これはワークフローを定義する実際のエージェントです。 +4. これはワークフローを定義する実際の エージェント です。 出力ガードレールも同様です。 @@ -152,7 +152,7 @@ async def main(): print("Math output guardrail tripped") ``` -1. これは実際のエージェントの出力型です。 +1. これは実際の エージェント の出力型です。 2. これはガードレールの出力型です。 -3. これはエージェントの出力を受け取り、結果を返すガードレール関数です。 -4. これはワークフローを定義する実際のエージェントです。 \ No newline at end of file +3. これは エージェント の出力を受け取り、結果を返すガードレール関数です。 +4. これはワークフローを定義する実際の エージェント です。 \ No newline at end of file diff --git a/docs/ja/handoffs.md b/docs/ja/handoffs.md index 78835cdde..4f02ed3da 100644 --- a/docs/ja/handoffs.md +++ b/docs/ja/handoffs.md @@ -4,19 +4,19 @@ search: --- # ハンドオフ -ハンドオフは、あるエージェントが別のエージェントにタスクを委任できるようにする仕組みです。これは、異なるエージェントがそれぞれ異なる分野に特化しているシナリオで特に有用です。たとえば、カスタマーサポートアプリでは、注文状況、返金、FAQ などのタスクをそれぞれ担当するエージェントがいるかもしれません。 +ハンドオフは、ある エージェント が別の エージェント にタスクを委譲できるようにする機能です。これは、異なる エージェント がそれぞれ異なる領域を専門とするシナリオで特に有用です。たとえば、カスタマーサポートアプリでは、注文状況、返金、FAQ などを個別に処理する エージェント を用意できます。 -ハンドオフは LLM に対してツールとして表現されます。したがって、`Refund Agent` というエージェントへのハンドオフがある場合、ツール名は `transfer_to_refund_agent` となります。 +ハンドオフは LLM にとってツールとして表現されます。たとえば、`Refund Agent` にハンドオフする場合、ツール名は `transfer_to_refund_agent` となります。 ## ハンドオフの作成 -すべてのエージェントには [`handoffs`][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,19 +28,19 @@ 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()` の既定のツール説明を上書きします。 -- `on_handoff`: ハンドオフが呼び出されたときに実行されるコールバック関数です。ハンドオフが呼び出されることが分かった時点でデータ取得を開始するなどに有用です。この関数はエージェントコンテキストを受け取り、オプションで LLM が生成した入力も受け取れます。入力データは `input_type` パラメーターで制御します。 -- `input_type`: ハンドオフが想定する入力の型（任意）。 -- `input_filter`: 次のエージェントが受け取る入力をフィルタリングできます。詳細は以下を参照してください。 -- `is_enabled`: ハンドオフを有効にするかどうか。真偽値または真偽値を返す関数を指定でき、実行時に動的にハンドオフを有効化・無効化できます。 +- `agent`: ハンドオフ先の エージェント です。 +- `tool_name_override`: 既定では `Handoff.default_tool_name()` が使用され、`transfer_to_` に解決されます。これを上書きできます。 +- `tool_description_override`: `Handoff.default_tool_description()` による既定のツール説明を上書きします。 +- `on_handoff`: ハンドオフが呼び出されたときに実行されるコールバック関数です。ハンドオフの実行が判明した時点でデータ取得を開始するなどに役立ちます。この関数は エージェント のコンテキストを受け取り、オプションで LLM が生成した入力も受け取れます。入力データは `input_type` パラメーターで制御します。 +- `input_type`: ハンドオフが受け取る入力の型（任意）。 +- `input_filter`: 次の エージェント に渡す入力をフィルタリングします。詳細は以下を参照してください。 +- `is_enabled`: ハンドオフを有効にするかどうか。真偽値、または真偽値を返す関数を指定でき、実行時に動的に有効化/無効化できます。 ```python from agents import Agent, handoff, RunContextWrapper @@ -58,9 +58,9 @@ handoff_obj = handoff( ) ``` -## ハンドオフ入力 +## ハンドオフの入力 -状況によっては、ハンドオフを呼び出す際に LLM にいくつかのデータを提供してほしい場合があります。たとえば、「Escalation エージェント」へのハンドオフを想定してください。ログに記録できるよう、理由を提供してほしいかもしれません。 +状況によっては、ハンドオフを呼び出す際に LLM による追加データの提供が必要な場合があります。たとえば、「エスカレーション エージェント」へのハンドオフを想定すると、ログ用途のために理由を受け取りたいことがあります。 ```python from pydantic import BaseModel @@ -84,9 +84,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` を返す関数です。 -よくあるパターン（たとえば履歴からすべてのツール呼び出しを除去するなど）は、[`agents.extensions.handoff_filters`][] に実装されています。 +一般的なパターン（たとえば履歴からすべてのツール呼び出しを削除するなど）は、[`agents.extensions.handoff_filters`][] に実装済みです。 ```python from agents import Agent, handoff @@ -100,11 +100,11 @@ handoff_obj = handoff( ) ``` -1. これにより、`FAQ agent` が呼び出されたときに履歴から自動的にすべてのツールが削除されます。 +1. これは、`FAQ agent` が呼び出されたときに履歴からすべてのツールを自動的に削除します。 ## 推奨プロンプト -LLM がハンドオフを正しく理解できるように、エージェントにハンドオフに関する情報を含めることを推奨します。[`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX`][] に推奨のプレフィックスがあり、または [`agents.extensions.handoff_prompt.prompt_with_handoff_instructions`][] を呼び出して、プロンプトに推奨データを自動的に追加できます。 +LLM がハンドオフを正しく理解できるようにするため、エージェント にハンドオフに関する情報を含めることを推奨します。[`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX`][] に推奨のプレフィックスがあり、または [`agents.extensions.handoff_prompt.prompt_with_handoff_instructions`][] を呼び出して推奨情報を自動的にプロンプトへ追加できます。 ```python from agents import Agent diff --git a/docs/ja/index.md b/docs/ja/index.md index f2f5fdd99..01439faa4 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 にはごく少数の基本 components があります。 -- **エージェント**、instructions と tools を備えた LLM -- **ハンドオフ**、特定のタスクを他のエージェントに委譲できる機能 -- **ガードレール**、エージェントの入力と出力を検証できる機能 -- **セッション**、エージェントの実行間で会話履歴を自動的に維持 +- **エージェント** 、instructions と tools を備えた LLM +- **ハンドオフ** 、特定のタスクでエージェントが他のエージェントに委譲できる機能 +- **ガードレール** 、エージェントの入力と出力の検証を可能にする機能 +- **セッション** 、エージェントの実行間で会話履歴を自動的に維持する機能 -Python と組み合わせることで、これらの基本コンポーネントはツールとエージェント間の複雑な関係を表現でき、急な学習コストなしに実運用のアプリケーションを構築できます。さらに、SDK には内蔵の **トレーシング** があり、エージェントのフローを可視化・デバッグできるほか、評価したり、アプリケーション向けにモデルをファインチューニングすることもできます。 +Python と組み合わせることで、これらの基本 components はツールとエージェント間の複雑な関係を表現でき、急な学習コストなしに実運用アプリケーションを構築できます。さらに、SDK には組み込みの **トレーシング** が付属し、エージェントのフローを可視化・デバッグできるほか、評価やアプリ向けのモデルの微調整も行えます。 ## Agents SDK を使う理由 -この SDK は次の 2 つの設計原則に基づいています。 +SDK には 2 つの設計原則があります。 -1. 使う価値があるだけの機能を備えつつ、学習が速いように基本コンポーネントは少なく。 -2. すぐに使えて高性能、かつ挙動を細部までカスタマイズ可能。 +1. 使う価値があるだけの機能は備えつつ、学習を素早くするために基本 components は少数に抑える。 +2. そのままでも十分に動作し、必要に応じて挙動を細かくカスタマイズできる。 -主な機能は次のとおりです。 +SDK の主な機能は次のとおりです。 -- エージェントループ: ツールの呼び出し、結果の LLM への送信、LLM の完了までのループ処理を内蔵。 -- Python ファースト: 新しい抽象化を学ぶ必要はなく、言語の標準機能でエージェントのオーケストレーションや連鎖が可能。 -- ハンドオフ: 複数のエージェント間での調整と委譲を可能にする強力な機能。 -- ガードレール: エージェントと並行して入力の検証やチェックを実行し、失敗時は早期に中断。 -- セッション: エージェントの実行間で会話履歴を自動管理し、手動の状態管理を不要に。 -- 関数ツール: 任意の Python 関数をツール化し、自動スキーマ生成と Pydantic ベースの検証を提供。 -- トレーシング: ワークフローの可視化、デバッグ、監視に加え、OpenAI の評価、ファインチューニング、蒸留ツール群を活用可能。 +- エージェント ループ: ツールの呼び出し、結果を LLM に送る処理、LLM が完了するまでのループを処理する組み込みループ。 +- Python ファースト: 新しい抽象化を学ぶのではなく、言語の組み込み機能でエージェントをオーケストレーションし連鎖させます。 +- ハンドオフ: 複数のエージェント間の調整と委譲を可能にする強力な機能。 +- ガードレール: エージェントと並行して入力のバリデーションやチェックを実行し、チェックが失敗したら早期に中断します。 +- セッション: エージェントの実行間での会話履歴を自動管理し、手動の状態管理を不要にします。 +- 関数ツール: 任意の Python 関数をツール化し、自動スキーマ生成と Pydantic ベースのバリデーションを提供します。 +- トレーシング: ワークフローの可視化・デバッグ・監視を可能にする組み込みのトレーシングに加え、 OpenAI の評価、ファインチューニング、蒸留ツールのスイートを利用できます。 ## インストール @@ -36,7 +36,7 @@ Python と組み合わせることで、これらの基本コンポーネント pip install openai-agents ``` -## Hello World の例 +## Hello World example ```python from agents import Agent, Runner @@ -51,7 +51,7 @@ print(result.final_output) # Infinite loop's dance. ``` -(_これを実行する場合は、`OPENAI_API_KEY` 環境変数を設定してください_) + (_これを実行する場合は、`OPENAI_API_KEY` 環境変数を設定してください_) ```bash export OPENAI_API_KEY=sk-... diff --git a/docs/ja/mcp.md b/docs/ja/mcp.md index 1a9947b6c..23b82ea0d 100644 --- a/docs/ja/mcp.md +++ b/docs/ja/mcp.md @@ -4,32 +4,32 @@ search: --- # Model context protocol (MCP) -The [Model context protocol](https://modelcontextprotocol.io/introduction) (MCP) は、アプリケーションがツールやコンテキストを言語モデルに公開する方法を標準化します。公式ドキュメントより: +[Model context protocol](https://modelcontextprotocol.io/introduction) (MCP) は、アプリケーションがツールやコンテキストを言語モデルに公開する方法を標準化します。公式ドキュメントより: -> MCP は、アプリケーションが LLM にコンテキストを提供する方法を標準化するオープンなプロトコルです。AI アプリケーションにおける USB‑C ポートのようなものと考えてください。USB‑C がデバイスをさまざまな周辺機器やアクセサリに接続する標準化された方法を提供するのと同様に、MCP は AI モデルをさまざまなデータソースやツールに接続する標準化された方法を提供します。 +> MCP は、アプリケーションが LLM にコンテキストを提供する方法を標準化するオープンプロトコルです。MCP は AI アプリケーション向けの USB-C ポートのようなものだと考えてください。USB-C がデバイスをさまざまな周辺機器やアクセサリに接続するための標準化された方法を提供するのと同様に、MCP は AI モデルをさまざまなデータソースやツールに接続するための標準化された方法を提供します。 -Agents Python SDK は複数の MCP トランスポートを理解します。これにより、既存の MCP サーバーを再利用したり、独自に構築して、ファイルシステムや HTTP、コネクタに裏付けられたツールを エージェント に公開できます。 +Agents Python SDK は複数の MCP トランスポートに対応しています。これにより、既存の MCP サーバーを再利用したり、独自のサーバーを構築して、ファイルシステム、HTTP、またはコネクタに裏打ちされたツールをエージェントに公開できます。 -## Choosing an MCP integration +## MCP 統合の選択 -MCP サーバーを エージェント に接続する前に、ツール呼び出しをどこで実行するか、および到達可能なトランスポートを決めます。以下のマトリクスは、Python SDK がサポートするオプションをまとめたものです。 +MCP サーバーをエージェントに接続する前に、ツール呼び出しをどこで実行するか、どのトランスポートに到達できるかを決めます。以下のマトリクスは Python SDK がサポートするオプションの概要です。 -| What you need | Recommended option | +| 必要なこと | 推奨オプション | | ------------------------------------------------------------------------------------ | ----------------------------------------------------- | -| Let OpenAI's Responses API call a publicly reachable MCP server on the model's behalf| **Hosted MCP server tools** via [`HostedMCPTool`][agents.tool.HostedMCPTool] | -| Connect to Streamable HTTP servers that you run locally or remotely | **Streamable HTTP MCP servers** via [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] | -| Talk to servers that implement HTTP with Server-Sent Events | **HTTP with SSE MCP servers** via [`MCPServerSse`][agents.mcp.server.MCPServerSse] | -| Launch a local process and communicate over stdin/stdout | **stdio MCP servers** via [`MCPServerStdio`][agents.mcp.server.MCPServerStdio] | +| OpenAI の Responses API がモデルに代わって外部から到達可能な MCP サーバーを呼び出せるようにする | **Hosted MCP server tools** 経由の [`HostedMCPTool`][agents.tool.HostedMCPTool] | +| ローカルまたはリモートで稼働する Streamable HTTP サーバーに接続する | **Streamable HTTP MCP servers** 経由の [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] | +| Server-Sent Events を用いた HTTP を実装するサーバーと通信する | **HTTP with SSE MCP servers** 経由の [`MCPServerSse`][agents.mcp.server.MCPServerSse] | +| ローカルプロセスを起動し stdin/stdout 越しに通信する | **stdio MCP servers** 経由の [`MCPServerStdio`][agents.mcp.server.MCPServerStdio] | -以下のセクションでは、それぞれのオプションについて、設定方法や、どのトランスポートを選ぶべきかを説明します。 +以下のセクションでは、それぞれのオプションの設定方法と、どのトランスポートを選ぶべきかを説明します。 ## 1. Hosted MCP server tools -ホスト型ツールは、ツールの往復処理全体を OpenAI のインフラストラクチャに委ねます。あなたのコードがツールを列挙・呼び出す代わりに、[`HostedMCPTool`][agents.tool.HostedMCPTool] が サーバーラベル（および任意のコネクタメタデータ）を Responses API に転送します。モデルは、リモートサーバーのツールを列挙し、あなたの Python プロセスへの追加のコールバックなしに呼び出します。ホスト型ツールは現在、Responses API のホスト型 MCP 統合をサポートする OpenAI モデルで動作します。 +ホスト型ツールは、ツールの往復処理全体を OpenAI のインフラに任せます。あなたのコードがツールを列挙・呼び出す代わりに、[`HostedMCPTool`][agents.tool.HostedMCPTool] は サーバーラベル（および任意のコネクタメタデータ）を Responses API に転送します。モデルはリモートサーバーのツールを一覧し、あなたの Python プロセスへの追加のコールバックなしでそれらを呼び出します。ホスト型ツールは現在、Responses API の hosted MCP 統合をサポートする OpenAI モデルで動作します。 -### Basic hosted MCP tool +### 基本的な hosted MCP ツール -エージェント の `tools` リストに [`HostedMCPTool`][agents.tool.HostedMCPTool] を追加してホスト型ツールを作成します。`tool_config` 辞書は、REST API に送信する JSON を反映します: +エージェントの `tools` リストに [`HostedMCPTool`][agents.tool.HostedMCPTool] を追加してホスト型ツールを作成します。`tool_config` の dict は、REST API に送信する JSON を反映します: ```python import asyncio @@ -59,9 +59,9 @@ asyncio.run(main()) ホストされたサーバーは自動的にそのツールを公開します。`mcp_servers` に追加する必要はありません。 -### Streaming hosted MCP results +### ストリーミングする hosted MCP の実行結果 -ホスト型ツールは、関数ツール とまったく同じ方法で ストリーミング をサポートします。`Runner.run_streamed` に `stream=True` を渡して、モデルが処理中でも増分の MCP 出力を消費します: +ホスト型ツールは、関数ツールと全く同じ方法で ストリーミング をサポートします。`Runner.run_streamed` に `stream=True` を渡して、モデルがまだ処理中でも MCP の増分出力を消費します: ```python result = Runner.run_streamed(agent, "Summarise this repository's top languages") @@ -71,9 +71,9 @@ async for event in result.stream_events(): print(result.final_output) ``` -### Optional approval flows +### 任意の承認フロー -サーバーが機微な操作を実行できる場合、各ツール実行の前に人間またはプログラムによる承認を必須にできます。`tool_config` の `require_approval` を、単一のポリシー（`"always"`、`"never"`）またはツール名からポリシーへの辞書で設定します。Python 内で判断するには、`on_approval_request` コールバックを指定します。 +サーバーが機微な操作を実行できる場合、各ツール実行前に人間またはプログラムによる承認を必須にできます。`tool_config` の `require_approval` を、単一のポリシー（`"always"`、`"never"`）またはツール名からポリシーへの dict マッピングで設定します。判断を Python 内で行うには、`on_approval_request` コールバックを指定します。 ```python from agents import MCPToolApprovalFunctionResult, MCPToolApprovalRequest @@ -101,11 +101,11 @@ agent = Agent( ) ``` -コールバックは同期・非同期のどちらでもよく、モデルが継続実行のために承認データを必要とするたびに呼び出されます。 +コールバックは同期・非同期のどちらでもよく、モデルが実行を続けるために承認データを必要とするたびに呼び出されます。 -### Connector-backed hosted servers +### コネクタ対応の hosted サーバー -ホスト型 MCP は OpenAI コネクタにも対応しています。`server_url` を指定する代わりに、`connector_id` とアクセストークンを指定します。Responses API が認証を処理し、ホストされたサーバーがコネクタのツールを公開します。 +Hosted MCP は OpenAI コネクタにも対応しています。`server_url` を指定する代わりに、`connector_id` とアクセストークンを指定します。Responses API が認証を処理し、ホストされたサーバーがコネクタのツールを公開します。 ```python import os @@ -126,7 +126,8 @@ HostedMCPTool( ## 2. Streamable HTTP MCP servers -ネットワーク接続を自分で管理したい場合は、[`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] を使用します。Streamable HTTP サーバーは、トランスポートを自分で制御したい場合や、低レイテンシを維持しつつ自分のインフラ内で サーバー を実行したい場合に最適です。 +ネットワーク接続を自分で管理したい場合は、 +[`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] を使用します。Streamable HTTP サーバーは、トランスポートを自分で制御したい場合や、サーバーを自社インフラ内で稼働させつつレイテンシを低く保ちたい場合に最適です。 ```python import asyncio @@ -161,16 +162,17 @@ async def main() -> None: asyncio.run(main()) ``` -コンストラクターは追加のオプションを受け取ります: +コンストラクターは追加のオプションを受け付けます: - `client_session_timeout_seconds` は HTTP の読み取りタイムアウトを制御します。 - `use_structured_content` は、テキスト出力よりも `tool_result.structured_content` を優先するかどうかを切り替えます。 - `max_retry_attempts` と `retry_backoff_seconds_base` は、`list_tools()` と `call_tool()` に自動リトライを追加します。 -- `tool_filter` は、一部のツールのみを公開できます（[ツールのフィルタリング](#tool-filtering) を参照）。 +- `tool_filter` は、一部のツールのみを公開できます（[Tool filtering](#tool-filtering) を参照）。 ## 3. HTTP with SSE MCP servers -MCP サーバーが HTTP with SSE トランスポートを実装している場合は、[`MCPServerSse`][agents.mcp.server.MCPServerSse] をインスタンス化します。トランスポート以外は、API は Streamable HTTP サーバーと同一です。 +MCP サーバーが HTTP with SSE トランスポートを実装している場合は、 +[`MCPServerSse`][agents.mcp.server.MCPServerSse] をインスタンス化します。トランスポート以外の点では、API は Streamable HTTP サーバーと同一です。 ```python @@ -199,7 +201,7 @@ async with MCPServerSse( ## 4. stdio MCP servers -ローカルのサブプロセスとして実行される MCP サーバーには、[`MCPServerStdio`][agents.mcp.server.MCPServerStdio] を使用します。SDK はプロセスを起動し、パイプを開いたままにし、コンテキストマネージャーの終了時に自動でクローズします。これは、迅速なプロトタイプや、サーバーがコマンドラインのエントリポイントのみを公開している場合に役立ちます。 +ローカルのサブプロセスとして実行する MCP サーバーには、[`MCPServerStdio`][agents.mcp.server.MCPServerStdio] を使用します。SDK はプロセスを起動し、パイプを開いたまま維持し、コンテキストマネージャの終了時に自動でクローズします。このオプションは、迅速なプロトタイプや、サーバーがコマンドラインのエントリポイントのみを公開している場合に便利です。 ```python from pathlib import Path @@ -227,11 +229,11 @@ async with MCPServerStdio( ## Tool filtering -各 MCP サーバーはツールフィルターをサポートしており、エージェント が必要とする機能だけを公開できます。フィルタリングは、構築時または実行ごとに動的に行えます。 +各 MCP サーバーはツールフィルターをサポートしており、エージェントに必要な機能のみを公開できます。フィルタリングは、構築時または実行ごとに動的に行えます。 -### Static tool filtering +### 静的なツールフィルタリング -[`create_static_tool_filter`][agents.mcp.create_static_tool_filter] を使用して、単純な許可/ブロックリストを設定します: +[`create_static_tool_filter`][agents.mcp.create_static_tool_filter] を使用して、シンプルな許可/ブロックのリストを設定します: ```python from pathlib import Path @@ -249,11 +251,11 @@ filesystem_server = MCPServerStdio( ) ``` -`allowed_tool_names` と `blocked_tool_names` の両方が指定された場合、SDK はまず許可リストを適用し、その後、残りの集合からブロックされたツールを取り除きます。 +`allowed_tool_names` と `blocked_tool_names` の両方が指定された場合、SDK はまず許可リストを適用し、その後残りの集合からブロックされたツールを取り除きます。 -### Dynamic tool filtering +### 動的なツールフィルタリング -より複雑なロジックには、[`ToolFilterContext`][agents.mcp.ToolFilterContext] を受け取る呼び出し可能オブジェクトを渡します。呼び出し可能オブジェクトは同期・非同期のどちらでもよく、ツールを公開すべき場合に `True` を返します。 +より高度なロジックには、[`ToolFilterContext`][agents.mcp.ToolFilterContext] を受け取る呼び出し可能オブジェクトを渡します。コール可能オブジェクトは同期・非同期のどちらでもよく、ツールを公開すべき場合に `True` を返します。 ```python from pathlib import Path @@ -281,10 +283,10 @@ async with MCPServerStdio( ## Prompts -MCP サーバーは、エージェントの instructions を動的に生成する プロンプト も提供できます。プロンプトをサポートする サーバー は、次の 2 つのメソッドを公開します: +MCP サーバーは、エージェントの instructions を動的に生成するプロンプトも提供できます。プロンプトをサポートするサーバーは 2 つのメソッドを公開します: -- `list_prompts()` は、利用可能なプロンプトテンプレートを列挙します。 -- `get_prompt(name, arguments)` は、必要に応じて パラメーター 付きの具体的なプロンプトを取得します。 +- `list_prompts()` は利用可能なプロンプトテンプレートを列挙します。 +- `get_prompt(name, arguments)` は、任意のパラメーター付きで具体的なプロンプトを取得します。 ```python from agents import Agent @@ -304,19 +306,19 @@ agent = Agent( ## Caching -すべての エージェント 実行は、各 MCP サーバーに対して `list_tools()` を呼び出します。リモートサーバーは目立つレイテンシをもたらす可能性があるため、すべての MCP サーバークラスは `cache_tools_list` オプションを公開します。ツール定義が頻繁に変わらないと自信がある場合にのみ、`True` に設定してください。あとから新しいリストを強制したい場合は、サーバーインスタンス上で `invalidate_tools_cache()` を呼び出します。 +すべてのエージェント実行は、各 MCP サーバーに対して `list_tools()` を呼び出します。リモートサーバーは顕著なレイテンシをもたらす可能性があるため、すべての MCP サーバークラスは `cache_tools_list` オプションを公開します。ツール定義が頻繁に変更されないと確信できる場合にのみ `True` に設定してください。後で新しい一覧を強制するには、サーバーインスタンスで `invalidate_tools_cache()` を呼び出します。 ## Tracing -[トレーシング](./tracing.md) は MCP のアクティビティを自動的に捕捉します。含まれるもの: +[Tracing](./tracing.md) は MCP のアクティビティを自動的に捕捉します。含まれるもの: -1. ツールを列挙するための MCP サーバーへの呼び出し。 +1. MCP サーバーへのツール一覧取得の呼び出し。 2. ツール呼び出しに関する MCP 関連情報。 ![MCP Tracing Screenshot](../assets/images/mcp-tracing.jpg) -## Further reading +## 参考資料 - [Model Context Protocol](https://modelcontextprotocol.io/) – 仕様と設計ガイド。 - [examples/mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp) – 実行可能な stdio、SSE、Streamable HTTP のサンプル。 -- [examples/hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp) – 承認やコネクタを含む、完全なホスト型 MCP デモ。 \ No newline at end of file +- [examples/hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp) – 承認やコネクタを含む、完全な hosted MCP のデモ。 \ No newline at end of file diff --git a/docs/ja/models/index.md b/docs/ja/models/index.md index f1cf1a1e7..550a48be3 100644 --- a/docs/ja/models/index.md +++ b/docs/ja/models/index.md @@ -4,20 +4,20 @@ search: --- # モデル -Agents SDK には、OpenAI モデルに対する即時利用可能なサポートが 2 つの形で用意されています。 +Agents SDK には、OpenAI モデルへのサポートが次の 2 つの形で標準搭載されています。 - **推奨**: [`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 モデル -`Agent` を初期化する際にモデルを指定しない場合、デフォルトのモデルが使用されます。現在のデフォルトは [`gpt-4.1`](https://platform.openai.com/docs/models/gpt-4.1) で、エージェント的ワークフローにおける予測可能性と低レイテンシのバランスに優れています。 +`Agent` を初期化するときにモデルを指定しない場合、既定のモデルが使用されます。現在の既定は [`gpt-4.1`](https://platform.openai.com/docs/models/gpt-4.1) で、エージェント ワークフローにおける予測可能性と低レイテンシのバランスに優れています。 -[`gpt-5`](https://platform.openai.com/docs/models/gpt-5) など他のモデルに切り替えたい場合は、次のセクションの手順に従ってください。 +[`gpt-5`](https://platform.openai.com/docs/models/gpt-5) など別のモデルに切り替えたい場合は、次のセクションの手順に従ってください。 -### デフォルトの OpenAI モデル +### 既定の OpenAI モデル -カスタムモデルを設定していないすべてのエージェントで特定のモデルを一貫して使いたい場合は、エージェントを実行する前に環境変数 `OPENAI_DEFAULT_MODEL` を設定してください。 +カスタム モデルを設定していないすべての エージェント で特定のモデルを一貫して使用したい場合は、エージェント を実行する前に環境変数 `OPENAI_DEFAULT_MODEL` を設定してください。 ```bash export OPENAI_DEFAULT_MODEL=gpt-5 @@ -26,9 +26,9 @@ python3 my_awesome_agent.py #### GPT-5 モデル -この方法で GPT-5 の reasoning モデル（[`gpt-5`](https://platform.openai.com/docs/models/gpt-5)、[`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini)、[`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano)）を使用する場合、SDK は既定で妥当な `ModelSettings` を適用します。具体的には、`reasoning.effort` と `verbosity` の両方を `"low"` に設定します。これらの設定を自分で構成したい場合は、`agents.models.get_default_model_settings("gpt-5")` を呼び出してください。 +この方法で GPT-5 の reasoning モデル（[`gpt-5`](https://platform.openai.com/docs/models/gpt-5)、[`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini)、[`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano)）を使用する場合、SDK は既定で適切な `ModelSettings` を適用します。具体的には、`reasoning.effort` と `verbosity` を両方とも `"low"` に設定します。これらの設定を自分で構築したい場合は、`agents.models.get_default_model_settings("gpt-5")` を呼び出してください。 -より低レイテンシや特定の要件のために、別のモデルや設定を選択できます。デフォルトモデルの reasoning 努力度を調整するには、独自の `ModelSettings` を渡します。 +より低レイテンシや特定要件のために、別のモデルや設定を選ぶこともできます。既定モデルの reasoning effort を調整するには、独自の `ModelSettings` を渡してください。 ```python from openai.types.shared import Reasoning @@ -44,52 +44,52 @@ my_agent = Agent( ) ``` -特にレイテンシを下げたい場合は、[`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) または [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano) に `reasoning.effort="minimal"` を指定すると、デフォルト設定より高速に応答が返ることがよくあります。ただし、Responses API の一部の組み込みツール（ファイル検索や画像生成など）は `"minimal"` の reasoning 努力度をサポートしていません。そのため、この Agents SDK ではデフォルトを `"low"` にしています。 +特に低レイテンシ向けには、[`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) または [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano) モデルに `reasoning.effort="minimal"` を指定すると、既定設定より高速に応答が返ることが多いです。ただし Responses API の組み込みツール（ファイル検索 や 画像生成 など）の一部は `"minimal"` の reasoning effort をサポートしていないため、本 Agents SDK では `"low"` を既定としています。 #### 非 GPT-5 モデル -カスタムの `model_settings` なしで GPT-5 以外のモデル名を渡した場合、SDK は任意のモデルと互換性のある汎用的な `ModelSettings` にフォールバックします。 +カスタムの `model_settings` なしで GPT-5 以外のモデル名を渡した場合、SDK はどのモデルでも互換性のある汎用的な `ModelSettings` にフォールバックします。 ## 非 OpenAI モデル -[LiteLLM 連携](./litellm.md)を通じて、ほとんどの他社製（非 OpenAI）モデルを使用できます。まず、litellm の依存関係グループをインストールします。 +[LiteLLM 連携](./litellm.md) を通じて、ほとんどの非 OpenAI モデルを使用できます。まず、litellm の依存関係グループをインストールしてください。 ```bash pip install "openai-agents[litellm]" ``` -次に、`litellm/` プレフィックスを付けて [サポート対象モデル](https://docs.litellm.ai/docs/providers) を使用します。 +次に、`litellm/` プレフィックスを付けて、[サポート対象モデル](https://docs.litellm.ai/docs/providers) を使用します。 ```python claude_agent = Agent(model="litellm/anthropic/claude-3-5-sonnet-20240620", ...) gemini_agent = Agent(model="litellm/gemini/gemini-2.5-flash-preview-04-17", ...) ``` -### 非 OpenAI モデルを利用するその他の方法 +### 非 OpenAI モデルを使うその他の方法 -他の LLM プロバイダーは、さらに 3 つの方法で統合できます（code examples は[こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)）。 +他の LLM プロバイダーはさらに 3 通りの方法で統合できます（code examples は[こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)）。 -1. [`set_default_openai_client`][agents.set_default_openai_client] は、LLM クライアントとして `AsyncOpenAI` のインスタンスをグローバルに使用したい場合に便利です。これは、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) を参照してください。 -3. [`Agent.model`][agents.agent.Agent.model] を使うと、特定の Agent インスタンスに対してモデルを指定できます。これにより、エージェントごとに異なるプロバイダーを組み合わせて利用できます。設定可能な例は [examples/model_providers/custom_example_agent.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_agent.py) を参照してください。ほとんどの利用可能なモデルを簡単に使う方法として、[LiteLLM 連携](./litellm.md)を利用できます。 +1. [`set_default_openai_client`][agents.set_default_openai_client] は、LLM クライアントとして `AsyncOpenAI` のインスタンスをグローバルに使用したい場合に便利です。これは 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) を参照してください。 +3. [`Agent.model`][agents.agent.Agent.model] は、特定の Agent インスタンスでモデルを指定できます。これにより、エージェント ごとに異なるプロバイダーを組み合わせて使用できます。設定可能なサンプルは [examples/model_providers/custom_example_agent.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_agent.py) を参照してください。利用可能なモデルの多くを簡単に使う方法としては、[LiteLLM 連携](./litellm.md) の利用が挙げられます。 -`platform.openai.com` の API キーがない場合は、`set_tracing_disabled()` でトレーシングを無効化するか、[別のトレーシング プロセッサー](../tracing.md)を設定することをおすすめします。 +`platform.openai.com` の API キーを持っていない場合は、`set_tracing_disabled()` で トレーシング を無効化するか、[別のトレーシング プロセッサー](../tracing.md) を設定することをおすすめします。 !!! note - これらの例では Chat Completions API/モデルを使用しています。これは、多くの LLM プロバイダーがまだ Responses API をサポートしていないためです。LLM プロバイダーがサポートしている場合は、Responses の使用をおすすめします。 + これらの code examples では、Responses API をまだサポートしていない LLM プロバイダーが多いため、Chat Completions API/モデルを使用しています。お使いの LLM プロバイダーがサポートしている場合は、Responses の使用をおすすめします。 ## モデルの組み合わせ -単一のワークフロー内で、エージェントごとに異なるモデルを使いたい場合があります。例えば、トリアージには小型で高速なモデルを使い、複雑なタスクには大規模で高性能なモデルを使うといった具合です。[`Agent`][agents.Agent] を設定する際、次のいずれかの方法で特定のモデルを選べます。 +1 つのワークフローの中で、エージェント ごとに異なるモデルを使いたい場合があります。例えば、トリアージには小型で高速なモデルを、複雑なタスクには大型で高性能なモデルを使うといった具合です。[`Agent`][agents.Agent] を構成する際、次のいずれかの方法で特定のモデルを選べます。 -1. モデル名を渡す。 -2. 任意のモデル名と、それを Model インスタンスにマッピングできる [`ModelProvider`][agents.models.interface.ModelProvider] を渡す。 +1. モデル名を直接渡す。 +2. 任意のモデル名 + その名前を Model インスタンスにマッピングできる [`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] の両方の形に対応していますが、各ワークフローでは単一のモデル形を使用することをおすすめします。これは両者がサポートする機能やツールのセットが異なるためです。もしワークフローでモデル形の混在が必要な場合は、使用するすべての機能が両方で利用可能であることを確認してください。 + SDK は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] と [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] の両方の形をサポートしていますが、両者はサポートする機能やツールの集合が異なるため、各ワークフローでは 1 つのモデル形に統一することをおすすめします。ワークフローでモデル形の混在が必要な場合は、使用するすべての機能が両方で利用可能か確認してください。 ```python from agents import Agent, Runner, AsyncOpenAI, OpenAIChatCompletionsModel @@ -125,7 +125,7 @@ async def main(): 1. OpenAI モデルの名前を直接設定します。 2. [`Model`][agents.models.interface.Model] 実装を提供します。 -エージェントで使用するモデルをさらに構成したい場合は、[`ModelSettings`][agents.models.interface.ModelSettings] を渡すことで、temperature などのオプションのモデル構成パラメーターを指定できます。 +エージェント で使用するモデルをさらに構成したい場合は、温度などのオプションのモデル構成パラメーターを提供する [`ModelSettings`][agents.models.interface.ModelSettings] を渡せます。 ```python from agents import Agent, ModelSettings @@ -138,7 +138,7 @@ english_agent = Agent( ) ``` -また、OpenAI の Responses API を使用する場合、[他にもいくつかの任意パラメーター](https://platform.openai.com/docs/api-reference/responses/create)（例: `user`、`service_tier` など）があります。トップレベルで指定できない場合は、`extra_args` を使って渡すこともできます。 +また、OpenAI の Responses API を使用する際には、[他にもいくつかのオプション パラメーター](https://platform.openai.com/docs/api-reference/responses/create)（例: `user`、`service_tier` など）があります。トップレベルで指定できない場合は、`extra_args` を使って渡せます。 ```python from agents import Agent, ModelSettings @@ -154,26 +154,26 @@ english_agent = Agent( ) ``` -## 他の LLM プロバイダー使用時の一般的な問題 +## 他の LLM プロバイダー利用時の一般的な問題 ### トレーシング クライアント エラー 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.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 のトレース プロセッサーを使用する。[トレーシング ドキュメント](../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` を設定している場合に機能します。 -2. [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] を使用します。code examples は[こちら](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)にあります。 +1. [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api] を呼び出す。これは環境変数で `OPENAI_API_KEY` と `OPENAI_BASE_URL` を設定している場合に機能します。 +2. [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] を使用する。code examples は[こちら](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) をサポートしていません。これにより、次のようなエラーが発生する場合があります。 ``` @@ -181,12 +181,12 @@ BadRequestError: Error code: 400 - {'error': {'message': "'response_format.type' ``` -これは一部のモデルプロバイダーの制約で、JSON 出力はサポートしていても、出力に使用する `json_schema` を指定できません。現在この問題の修正に取り組んでいますが、JSON schema 出力をサポートするプロバイダーを利用することをおすすめします。そうでない場合、不正な JSON によりアプリが頻繁に壊れてしまいます。 +これは一部のモデル プロバイダー側の制約で、JSON 出力はサポートしていても、出力に使用する `json_schema` を指定できないという問題です。現在、これに対する修正に取り組んでいますが、JSON スキーマ出力をサポートするプロバイダーに依存することをおすすめします。そうでない場合、JSON の不正形式が原因でアプリが頻繁に壊れてしまいます。 -## プロバイダー間でのモデルの組み合わせ +## プロバイダーをまたぐモデルの組み合わせ -モデルプロバイダー間の機能差に注意しないと、エラーが発生する可能性があります。例えば、OpenAI は structured outputs、マルチモーダル入力、ホスト型のファイル検索と Web 検索をサポートしますが、多くの他社プロバイダーはこれらの機能をサポートしていません。次の制限に注意してください。 +モデル プロバイダー間の機能差を把握しておく必要があります。そうしないとエラーが発生する可能性があります。例えば、OpenAI は structured outputs、マルチモーダル入力、ホスト型の ファイル検索 および Web 検索 をサポートしていますが、多くの他プロバイダーはこれらの機能をサポートしていません。次の制約に注意してください。 -- サポートされていない `tools` を理解しないプロバイダーに送らないでください -- テキスト専用のモデルを呼び出す前に、マルチモーダル入力を除外してください -- structured JSON 出力をサポートしないプロバイダーは、無効な JSON を出力することがあります \ No newline at end of file +- サポートしていない `tools` を理解しないプロバイダーには送らない +- テキスト専用のモデルを呼び出す前に、マルチモーダル入力を除外する +- structured JSON 出力をサポートしていないプロバイダーは、時折無効な JSON を生成する可能性があることに注意する \ No newline at end of file diff --git a/docs/ja/models/litellm.md b/docs/ja/models/litellm.md index cd6ac3f47..5b4838047 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`、OpenAI の API キー +- モデルに `anthropic/claude-3-5-sonnet-20240620`、Anthropic の API キー - など -LiteLLM でサポートされているモデルの一覧は、[litellm のプロバイダードキュメント](https://docs.litellm.ai/docs/providers) を参照してください。 +LiteLLM でサポートされているモデルの完全な一覧は、[litellm providers docs](https://docs.litellm.ai/docs/providers) を参照してください。 ```python from __future__ import annotations @@ -76,9 +76,9 @@ if __name__ == "__main__": asyncio.run(main(model, api_key)) ``` -## 使用状況データのトラッキング +## 使用状況データの追跡 -LiteLLM のレスポンスで Agents SDK の使用状況メトリクスを埋めたい場合は、エージェント作成時に `ModelSettings(include_usage=True)` を渡してください。 +LiteLLM の応答で Agents SDK の使用状況メトリクスを集計したい場合は、エージェント作成時に `ModelSettings(include_usage=True)` を渡してください。 ```python from agents import Agent, ModelSettings @@ -91,4 +91,4 @@ agent = Agent( ) ``` -`include_usage=True` の場合、LiteLLM のリクエストは、組み込みの OpenAI モデルと同様に、`result.context_wrapper.usage` を通じてトークン数とリクエスト数を報告します。 \ No newline at end of file +`include_usage=True` の場合、LiteLLM のリクエストは、組み込みの OpenAI モデルと同様に `result.context_wrapper.usage` を介してトークン数およびリクエスト数を報告します。 \ No newline at end of file diff --git a/docs/ja/multi_agent.md b/docs/ja/multi_agent.md index dc2c279af..ce4287c30 100644 --- a/docs/ja/multi_agent.md +++ b/docs/ja/multi_agent.md @@ -2,40 +2,40 @@ search: exclude: true --- -# 複数のエージェントのオーケストレーション +# 複数の エージェント のオーケストレーション -オーケストレーションとは、アプリ内でのエージェントの流れを指します。どのエージェントを、どの順番で実行し、次に何をするかをどのように決めるのか。エージェントをオーケストレーションする主な方法は 2 つあります。 +オーケストレーションとは、あなたのアプリにおける エージェント の流れを指します。どの エージェント を、どの順序で実行し、次に何をするかをどのように決定するか、ということです。エージェント をオーケストレーションする主な方法は 2 つあります。 -1. LLM に意思決定させる: LLM の知性を活用して計画・推論し、それに基づいて取るべきステップを決めます。 -2. コードでオーケストレーションする: コードでエージェントの流れを決定します。 +1. LLM に意思決定を任せる: LLM の知性を使って計画・推論し、それに基づいて取るべき手順を決めます。 +2. コードによるオーケストレーション: コードで エージェント の流れを決定します。 -これらのパターンは組み合わせ可能です。それぞれにトレードオフがあり、以下で説明します。 +これらのパターンは組み合わせて使えます。それぞれにトレードオフがあり、以下で説明します。 ## LLM によるオーケストレーション -エージェントとは、instructions、tools、ハンドオフを備えた LLM です。これは、オープンエンドなタスクが与えられたときに、LLM が自律的に計画を立て、ツールを使ってアクションやデータ取得を行い、ハンドオフでサブエージェントにタスクを委譲できることを意味します。例えば、リサーチエージェントには次のようなツールを備えられます。 +エージェント は、instructions、tools、ハンドオフ を備えた LLM です。これは、オープンエンドなタスクに対して、LLM が自律的に計画を立て、ツールを使ってアクション実行とデータ取得を行い、ハンドオフ を使ってサブエージェントにタスクを委譲できることを意味します。たとえば、リサーチ エージェント は次のようなツールを備えられます。 -- Web 検索でオンラインの情報を見つける -- ファイル検索と取得でプロプライエタリなデータや接続を検索する -- コンピュータ操作でコンピュータ上のアクションを実行する -- コード実行でデータ分析を行う -- 計画立案やレポート作成などに優れた専門エージェントへのハンドオフ +- オンライン情報を見つけるための Web 検索 +- プロプライエタリデータや接続を検索するための ファイル検索 と取得 +- コンピュータ操作 によるコンピュータ上でのアクション実行 +- データ分析のためのコード実行 +- 計画策定、レポート作成などに優れた専門 エージェント への ハンドオフ -このパターンは、タスクがオープンエンドで、LLM の知性に依存したい場合に適しています。ここで重要な戦術は次のとおりです。 +このパターンは、タスクがオープンエンドで、LLM の知性に依拠したい場合に適しています。ここで重要な戦術は次のとおりです。 -1. 良いプロンプトに投資する。利用可能なツール、その使い方、そしてどのパラメーター内で動作しなければならないかを明確にします。 -2. アプリを監視し、反復改善する。問題が起きる箇所を特定し、プロンプトを改善します。 -3. エージェントに内省と改善を許可する。例えば、ループで実行して自己批評させる、またはエラーメッセージを提示して改善させます。 -4. 何でもこなす汎用エージェントではなく、1 つのタスクに長けた専門エージェントを用意します。 -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) を使って、コードで検査可能な 適切な形式のデータ を生成する。例えば、エージェントにタスクをいくつかのカテゴリーに分類させ、そのカテゴリーに基づいて次のエージェントを選ぶといった使い方ができます。 -- あるエージェントの出力を次のエージェントの入力に変換して、複数のエージェントを連結する。ブログ記事の作成タスクを、調査、アウトライン作成、本文執筆、批評、改善といった一連のステップに分解できます。 -- エージェントを `while` ループで実行し、もう一方のエージェントが評価とフィードバックを提供し、評価者が出力が特定の基準を満たしたと判断するまで繰り返す。 -- 複数のエージェントを並列に実行する（例: `asyncio.gather` のような Python の基本コンポーネントを利用）。互いに依存しない複数タスクがある場合に速度向上に有用です。 +- [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) を使って、コードで検査可能な 適切な形式のデータ を生成します。たとえば、タスクをいくつかの カテゴリー に分類するよう エージェント に依頼し、その カテゴリー に基づいて次の エージェント を選びます。 +- 複数の エージェント を連鎖させ、前の出力を次の入力に変換します。ブログ記事の執筆のようなタスクを、調査、アウトライン作成、本文執筆、批評、改善という一連のステップに分解できます。 +- タスクを実行する エージェント と、それを評価してフィードバックを提供する エージェント を `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 diff --git a/docs/ja/quickstart.md b/docs/ja/quickstart.md index 1e06d8b1d..823f8a62e 100644 --- a/docs/ja/quickstart.md +++ b/docs/ja/quickstart.md @@ -6,7 +6,7 @@ search: ## プロジェクトと仮想環境の作成 -これは一度だけ実行すれば十分です。 +これは 1 回だけ実行すれば十分です。 ```bash mkdir my_project @@ -30,7 +30,7 @@ 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 キーを作成してください。 +お持ちでない場合は、OpenAI API キーを作成するために [こちらの手順](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key) に従ってください。 ```bash export OPENAI_API_KEY=sk-... @@ -38,7 +38,7 @@ export OPENAI_API_KEY=sk-... ## 最初のエージェントの作成 -エージェントは、instructions、名前、任意の設定（`model_config` など）で定義します。 +エージェントは instructions、名前、および任意の config（`model_config` など）で定義されます。 ```python from agents import Agent @@ -49,9 +49,9 @@ agent = Agent( ) ``` -## いくつかのエージェントの追加 +## いくつかのエージェントを追加 -追加のエージェントも同様に定義できます。`handoff_descriptions` は、ハンドオフのルーティングを判断するための追加コンテキストを提供します。 +追加のエージェントも同様に定義できます。`handoff_descriptions` はハンドオフのルーティングを判断するための追加コンテキストを提供します。 ```python from agents import Agent @@ -71,7 +71,7 @@ math_tutor_agent = Agent( ## ハンドオフの定義 -各エージェントごとに、タスクを進めるために選択できる送信先ハンドオフ オプションの一覧を定義できます。 +各エージェントで、タスクを進める方法を判断するために選択できる送信側ハンドオフ候補の一覧を定義できます。 ```python triage_agent = Agent( @@ -83,7 +83,7 @@ triage_agent = Agent( ## エージェントのオーケストレーションの実行 -ワークフローが実行され、トリアージ エージェントが 2 つの専門エージェント間を正しくルーティングすることを確認しましょう。 +ワークフローが動作し、トリアージ エージェントが 2 つの専門エージェント間を正しくルーティングすることを確認します。 ```python from agents import Runner @@ -123,7 +123,7 @@ 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.md)、[モデル](models/index.md) について学びます。 \ No newline at end of file diff --git a/docs/ja/realtime/guide.md b/docs/ja/realtime/guide.md index 56ddc44ef..cfcbb6240 100644 --- a/docs/ja/realtime/guide.md +++ b/docs/ja/realtime/guide.md @@ -4,65 +4,65 @@ search: --- # ガイド -このガイドでは、OpenAI Agents SDK の realtime 機能を用いて音声対応の AI エージェントを構築する方法を詳しく説明します。 +このガイドでは、OpenAI Agents SDK の realtime 機能を用いた音声対応 AI エージェントの構築について詳しく説明します。 !!! warning "Beta feature" -Realtime エージェントはベータ版です。実装の改善に伴い破壊的変更が入る可能性があります。 +Realtime エージェントはベータ版です。実装の改善に伴い、破壊的変更が発生する可能性があります。 ## 概要 -Realtime エージェントは会話のフローを実現し、音声およびテキスト入力をリアルタイムに処理して realtime 音声で応答します。OpenAI の Realtime API との永続接続を維持し、低レイテンシで自然な音声会話と、割り込みへの優雅な対応を可能にします。 +Realtime エージェントは、会話フローを可能にし、音声およびテキスト入力をリアルタイムで処理し、リアルタイム音声でレスポンスします。OpenAI の Realtime API との永続接続を維持し、低レイテンシで自然な音声会話や中断へのスムーズな対応を実現します。 ## アーキテクチャ -### コアコンポーネント +### 中核コンポーネント -realtime システムは次の主要コンポーネントで構成されます。 +realtime システムは次の主要コンポーネントで構成されます: -- **RealtimeAgent** : instructions、tools、handoffs を設定したエージェント -- **RealtimeRunner** : 構成を管理します。`runner.run()` を呼び出すとセッションを取得できます。 -- **RealtimeSession** : 単一の対話セッション。通常、ユーザーが会話を開始するたびに作成し、会話が終了するまで維持します。 -- **RealtimeModel** : 基盤となるモデルインターフェース（一般的には OpenAI の WebSocket 実装） +- **RealtimeAgent**: instructions、tools、handoffs を設定したエージェント。 +- **RealtimeRunner**: 設定を管理します。`runner.run()` を呼び出すとセッションを取得できます。 +- **RealtimeSession**: 単一の対話セッション。通常は ユーザー が会話を開始するたびに作成し、会話が終了するまで維持します。 +- **RealtimeModel**: 基盤となるモデルインターフェース（通常は OpenAI の WebSocket 実装） ### セッションフロー -一般的な realtime セッションは次の流れで進みます。 +典型的な realtime セッションは次の流れに従います: 1. **RealtimeAgent を作成** し、instructions、tools、handoffs を設定します。 -2. **RealtimeRunner をセットアップ** し、エージェントと構成オプションを渡します。 -3. `await runner.run()` を使って **セッションを開始** し、RealtimeSession を取得します。 -4. `send_audio()` または `send_message()` を使って **音声またはテキストメッセージを送信** します。 -5. セッションを反復処理して **イベントを受信** します。イベントには音声出力、書き起こし、ツール呼び出し、ハンドオフ、エラーが含まれます。 -6. ユーザーがエージェントの発話に被せたときに **割り込みを処理** します。これにより現在の音声生成が自動的に停止します。 +2. **RealtimeRunner をセットアップ** し、エージェントと設定オプションを指定します。 +3. `await runner.run()` を使用して **セッションを開始** します。戻り値は RealtimeSession です。 +4. `send_audio()` または `send_message()` を使用して **音声またはテキストメッセージを送信** します。 +5. セッションを反復処理して **イベントを監視** します。イベントには音声出力、書き起こし、ツール呼び出し、ハンドオフ、エラーなどが含まれます。 +6. ユーザー がエージェントにかぶせて話す **割り込みを処理** します。現在の音声生成は自動的に停止します。 セッションは会話履歴を保持し、realtime モデルとの永続接続を管理します。 -## エージェントの設定 +## エージェント設定 -RealtimeAgent は通常の Agent クラスと同様に動作しますが、いくつか重要な違いがあります。完全な API の詳細は、[`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] の API リファレンスをご覧ください。 +RealtimeAgent は通常の Agent クラスと同様に動作しますが、いくつか重要な違いがあります。API の詳細は [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] の API リファレンスをご参照ください。 -通常のエージェントとの主な相違点: +通常のエージェントとの差異: -- モデルの選択はエージェントレベルではなくセッションレベルで構成します。 -- structured output のサポートはありません（`outputType` は非対応）。 -- 声質はエージェントごとに設定できますが、最初のエージェントが話し始めた後は変更できません。 -- tools、handoffs、instructions などのその他の機能は同様に動作します。 +- モデルの選択はエージェントレベルではなくセッションレベルで設定します。 +- structured outputs はサポートされません（`outputType` は非対応）。 +- 音声はエージェントごとに設定できますが、最初のエージェントが発話した後は変更できません。 +- その他の機能（tools、handoffs、instructions）は同様に動作します。 -## セッションの設定 +## セッション設定 ### モデル設定 -セッション設定では基盤となる realtime モデルの動作を制御できます。モデル名（例: `gpt-realtime`）、声の選択（alloy、echo、fable、onyx、nova、shimmer）、サポートするモダリティ（テキストおよび/または音声）を構成できます。音声フォーマットは入力と出力の両方で設定でき、既定は PCM16 です。 +セッション設定により、基盤となる realtime モデルの挙動を制御できます。モデル名（`gpt-realtime` など）、音声選択（alloy、echo、fable、onyx、nova、shimmer）、サポートするモダリティ（テキストおよび/または音声）を構成できます。音声フォーマットは入力と出力の両方で設定でき、デフォルトは PCM16 です。 ### 音声設定 -音声設定では、セッションが音声入力と出力をどのように処理するかを制御します。Whisper のようなモデルで入力音声の書き起こしを構成し、言語設定や、ドメイン固有用語の精度を高めるための書き起こしプロンプトを指定できます。ターン検出設定では、エージェントがいつ応答を開始・停止すべきかを制御し、音声活動検出のしきい値、無音の長さ、検出音声の前後パディングなどのオプションがあります。 +音声設定では、セッションが音声入力と出力をどのように扱うかを制御します。Whisper などのモデルを用いた入力音声の書き起こし、言語設定、専門用語の精度向上のための書き起こしプロンプトを設定できます。ターン検出設定では、音声活動検出のしきい値、無音時間、検出音声周りのパディングなど、エージェントが応答を開始・停止すべきタイミングを制御します。 ## ツールと関数 ### ツールの追加 -通常のエージェントと同様に、realtime エージェントは会話中に実行される 関数ツール をサポートします。 +通常のエージェントと同様に、realtime エージェントは会話中に実行される 関数ツール をサポートします: ```python from agents import function_tool @@ -90,7 +90,7 @@ agent = RealtimeAgent( ### ハンドオフの作成 -ハンドオフにより、専門化されたエージェント間で会話を転送できます。 +ハンドオフ により、会話を専門特化したエージェント間で引き継げます。 ```python from agents.realtime import realtime_handoff @@ -119,22 +119,22 @@ main_agent = RealtimeAgent( ## イベント処理 -セッションはストリーミングでイベントを送出します。セッションオブジェクトを反復処理してリッスンできます。イベントには、音声出力チャンク、書き起こし結果、ツール実行の開始と終了、エージェントのハンドオフ、エラーなどが含まれます。主に処理すべきイベントは次のとおりです。 +セッションは、セッションオブジェクトを反復処理することで監視できるイベントをストリーミングします。イベントには音声出力チャンク、書き起こし結果、ツール実行の開始/終了、エージェントのハンドオフ、エラーが含まれます。特に処理すべき主要イベントは次のとおりです: -- **audio** : エージェントの応答からの raw 音声データ -- **audio_end** : エージェントの発話が完了 -- **audio_interrupted** : ユーザーがエージェントを割り込み -- **tool_start/tool_end** : ツール実行のライフサイクル -- **handoff** : エージェントのハンドオフが発生 -- **error** : 処理中にエラーが発生 +- **audio**: エージェントのレスポンスからの raw 音声データ +- **audio_end**: エージェントの発話完了 +- **audio_interrupted**: ユーザー による割り込み +- **tool_start/tool_end**: ツール実行のライフサイクル +- **handoff**: エージェントのハンドオフ発生 +- **error**: 処理中にエラーが発生 -完全なイベントの詳細は、[`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent] を参照してください。 +イベントの詳細は [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent] を参照してください。 ## ガードレール -realtime エージェントでサポートされるのは出力ガードレールのみです。これらのガードレールはデバウンスされ、リアルタイム生成中のパフォーマンス問題を避けるために（毎語ではなく）定期的に実行されます。既定のデバウンス長は 100 文字ですが、構成可能です。 +Realtime エージェントでサポートされるのは出力 ガードレール のみです。リアルタイム生成時のパフォーマンス問題を避けるため、これらはデバウンスされ、（単語ごとではなく）定期的に実行されます。デフォルトのデバウンス長は 100 文字ですが、設定可能です。 -ガードレールは `RealtimeAgent` に直接アタッチするか、セッションの `run_config` を通じて提供できます。両方のソースからのガードレールは併用されます。 +ガードレール は `RealtimeAgent` に直接アタッチするか、セッションの `run_config` を通じて提供できます。両方のソースの ガードレール は併せて実行されます。 ```python from agents.guardrail import GuardrailFunctionOutput, OutputGuardrail @@ -152,17 +152,46 @@ agent = RealtimeAgent( ) ``` -ガードレールがトリガーされると、`guardrail_tripped` イベントが生成され、エージェントの現在の応答を割り込むことがあります。デバウンス動作により、安全性とリアルタイム性能要件のバランスを取ります。テキストエージェントと異なり、realtime エージェントはガードレールが作動しても Exception を **発生させません**。 +ガードレール がトリガーされると、`guardrail_tripped` イベントを生成し、エージェントの現在のレスポンスを中断できます。デバウンス動作は、安全性とリアルタイム性能要件のバランスを取るのに役立ちます。テキストエージェントと異なり、realtime エージェントは ガードレール が作動しても例外を **スローしません**。 ## 音声処理 -[`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` イベントを必ず監視してください。 -## 直接的なモデルアクセス +## SIP 連携 -基盤となるモデルにアクセスして、カスタムリスナーの追加や高度な操作を実行できます。 +[Realtime Calls API](https://platform.openai.com/docs/guides/realtime-sip) を介して着信する電話に realtime エージェントを接続できます。SDK は [`OpenAIRealtimeSIPModel`][agents.realtime.openai_realtime.OpenAIRealtimeSIPModel] を提供しており、SIP 上でメディアをネゴシエートしつつ、同じエージェントフローを再利用します。 + +使用するには、モデルインスタンスを runner に渡し、セッション開始時に SIP の `call_id` を指定します。コール ID は、着信を通知する Webhook から配信されます。 + +```python +from agents.realtime import RealtimeAgent, RealtimeRunner +from agents.realtime.openai_realtime import OpenAIRealtimeSIPModel + +runner = RealtimeRunner( + starting_agent=agent, + model=OpenAIRealtimeSIPModel(), +) + +async with await runner.run( + model_config={ + "call_id": call_id_from_webhook, + "initial_model_settings": { + "turn_detection": {"type": "semantic_vad", "interrupt_response": True}, + }, + }, +) as session: + async for event in session: + ... +``` + +発信者が電話を切ると、SIP セッションは終了し、realtime 接続は自動的に閉じられます。電話連携の完全な code examples は [`examples/realtime/twilio_sip`](https://github.com/openai/openai-agents-python/tree/main/examples/realtime/twilio_sip) を参照してください。 + +## 直接モデルアクセス + +基盤となるモデルへアクセスし、カスタムリスナーの追加や高度な操作を実行できます: ```python # Add a custom listener to the model @@ -173,4 +202,4 @@ session.model.add_listener(my_custom_listener) ## 例 -完全に動作するサンプルは、UI コンポーネントの有無それぞれのデモを含む [examples/realtime ディレクトリ](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) をご覧ください。 \ No newline at end of file +動作する完全な code examples は、[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 d759672c7..ed6fda010 100644 --- a/docs/ja/realtime/quickstart.md +++ b/docs/ja/realtime/quickstart.md @@ -4,10 +4,10 @@ search: --- # クイックスタート -リアルタイム エージェントは、OpenAI の Realtime API を使用して AI エージェントとの音声会話を可能にします。このガイドでは、最初のリアルタイム音声エージェントの作成手順を説明します。 +Realtime エージェントは、OpenAI の Realtime API を使用して AI エージェントとの音声会話を可能にします。このガイドでは、最初のリアルタイム音声エージェントを作成する手順を説明します。 !!! warning "ベータ機能" -リアルタイム エージェントはベータ版です。実装を改善する過程で破壊的変更が入る可能性があります。 +Realtime エージェントはベータ版です。実装の改善に伴い、破壊的な変更が発生する可能性があります。 ## 前提条件 @@ -23,7 +23,7 @@ search: pip install openai-agents ``` -## 最初のリアルタイム エージェントの作成 +## 最初のリアルタイムエージェントの作成 ### 1. 必要なコンポーネントのインポート @@ -32,7 +32,7 @@ import asyncio from agents.realtime import RealtimeAgent, RealtimeRunner ``` -### 2. リアルタイム エージェントの作成 +### 2. リアルタイムエージェントの作成 ```python agent = RealtimeAgent( @@ -41,7 +41,7 @@ agent = RealtimeAgent( ) ``` -### 3. ランナーのセットアップ +### 3. Runner のセットアップ ```python runner = RealtimeRunner( @@ -188,38 +188,38 @@ if __name__ == "__main__": asyncio.run(main()) ``` -## 構成オプション +## 設定オプション ### モデル設定 -- `model_name`: 使用可能なリアルタイムモデルを選択 (例: `gpt-realtime`) -- `voice`: 音声の選択 (`alloy`, `echo`, `fable`, `onyx`, `nova`, `shimmer`) -- `modalities`: テキストまたは音声を有効化 (`["text"]` または `["audio"]`) +- `model_name`: 利用可能なリアルタイムモデルから選択（例えば、`gpt-realtime`） +- `voice`: 音声の選択（`alloy`、`echo`、`fable`、`onyx`、`nova`、`shimmer`） +- `modalities`: テキストまたは音声を有効化（`["text"]` または `["audio"]`） ### 音声設定 -- `input_audio_format`: 入力音声の形式 (`pcm16`, `g711_ulaw`, `g711_alaw`) +- `input_audio_format`: 入力音声の形式（`pcm16`、`g711_ulaw`、`g711_alaw`） - `output_audio_format`: 出力音声の形式 -- `input_audio_transcription`: 音声書き起こしの設定 +- `input_audio_transcription`: 文字起こしの設定 ### ターン検出 -- `type`: 検出方式 (`server_vad`, `semantic_vad`) -- `threshold`: 音声活動のしきい値 (0.0-1.0) +- `type`: 検出方法（`server_vad`、`semantic_vad`） +- `threshold`: 音声活動のしきい値（0.0-1.0） - `silence_duration_ms`: ターン終了を検出する無音時間 - `prefix_padding_ms`: 発話前の音声パディング ## 次のステップ -- [リアルタイム エージェントの詳細を見る](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) フォルダーの動作するサンプルを確認 +- エージェントにツールを追加 +- エージェント間のハンドオフを実装 +- 安全のためのガードレールを設定 ## 認証 -OpenAI API キーが環境に設定されていることを確認してください: +OpenAI API キーが環境に設定されていることを確認します: ```bash export OPENAI_API_KEY="your-api-key-here" diff --git a/docs/ja/release.md b/docs/ja/release.md index 27a32511d..abaf6e787 100644 --- a/docs/ja/release.md +++ b/docs/ja/release.md @@ -2,39 +2,46 @@ search: exclude: true --- -# リリースプロセス/変更履歴 +# リリースプロセス / 変更履歴 -本プロジェクトは、形式 `0.Y.Z` を用いたセマンティック バージョニングの軽微に変更したバージョンに従います。先頭の `0` は、 SDK が依然として急速に進化していることを示します。各コンポーネントの増分は次のとおりです: +このプロジェクトは、`0.Y.Z` という形式を用いる、やや調整したセマンティックバージョニングに従います。先頭の `0` は、この SDK が依然として急速に進化中であることを示します。各コンポーネントの増分ルールは以下のとおりです。 -## マイナー (`Y`) バージョン +## マイナー（`Y`）バージョン -ベータとしてマークされていない公開インターフェースに対する **破壊的変更** がある場合、マイナー バージョン `Y` を上げます。たとえば、`0.0.x` から `0.1.x` への変更には破壊的変更が含まれる可能性があります。 +ベータではないパブリックインターフェースに対する **後方互換性のない変更** に対して、マイナーバージョン `Y` を増やします。たとえば、`0.0.x` から `0.1.x` になる際には、後方互換性のない変更が含まれる可能性があります。 -破壊的変更を避けたい場合は、プロジェクトで `0.0.x` バージョンにピン留めすることをお勧めします。 +後方互換性のない変更を避けたい場合は、プロジェクトで `0.0.x` のバージョンに固定することをおすすめします。 -## パッチ (`Z`) バージョン +## パッチ（`Z`）バージョン -破壊的でない変更では `Z` を増やします: +後方互換性を壊さない変更に対して、`Z` を増やします。 - バグ修正 - 新機能 -- 非公開インターフェースへの変更 +- プライベートインターフェースの変更 - ベータ機能の更新 -## 破壊的変更の変更履歴 +## 互換性を壊す変更の変更履歴 + +### 0.5.0 + +このバージョンでは目に見える互換性破壊的な変更は導入していませんが、新機能と内部実装の重要な更新をいくつか含みます。 + +- `RealtimeRunner` が [SIP プロトコル接続](https://platform.openai.com/docs/guides/realtime-sip) を扱えるようになりました +- Python 3.14 との互換性のため、`Runner#run_sync` の内部ロジックを大幅に見直しました ### 0.4.0 -このバージョンでは、[openai](https://pypi.org/project/openai/) パッケージ v1.x はサポート対象外になりました。 この SDK と併せて openai v2.x を使用してください。 +このバージョンでは、[openai](https://pypi.org/project/openai/) パッケージの v1.x はサポート対象外になりました。この SDK と併せて openai v2.x をご利用ください。 ### 0.3.0 -このバージョンでは、 Realtime API のサポートが gpt-realtime モデルおよびその API インターフェース（ GA バージョン）に移行します。 +このバージョンでは、Realtime API のサポートが gpt-realtime モデルとその API インターフェース（GA 版）に移行します。 ### 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] に新しいパラメーターが 2 つ追加されました: `run_context` と `agent`。`MCPServer` をサブクラス化するすべてのクラスに、これらのパラメーターを追加する必要があります。 \ No newline at end of file +このバージョンでは、[`MCPServer.list_tools()`][agents.mcp.server.MCPServer] に `run_context` と `agent` の 2 つの新しいパラメーターが追加されました。`MCPServer` を継承するすべてのクラスに、これらのパラメーターを追加する必要があります。 \ No newline at end of file diff --git a/docs/ja/repl.md b/docs/ja/repl.md index 799ed5f0e..056d67a45 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,6 @@ if __name__ == "__main__": asyncio.run(main()) ``` -`run_demo_loop` は、ループでユーザー入力を求め、ターン間の会話履歴を保持します。デフォルトでは、生成されたモデル出力をそのままストリーミングします。上記の例を実行すると、run_demo_loop は対話型のチャットセッションを開始します。入力を継続的に求め、ターン間で会話全体の履歴を記憶するため（エージェントが何を議論したかを把握できます）、エージェントの応答を生成と同時にリアルタイムで自動的にストリーミングします。 +`run_demo_loop` はループで ユーザー 入力を促し、ターン間の会話履歴を保持します。デフォルトでは、生成され次第モデル出力を ストリーミング します。上記のサンプルを実行すると、run_demo_loop は対話的なチャットセッションを開始します。継続的に入力を求め、ターン間の会話全体を記憶するため（エージェントが何を議論したか把握できます）、生成されるそばからエージェントの応答を リアルタイム に自動的に ストリーミング します。 -このチャットセッションを終了するには、`quit` または `exit` と入力して（Enter を押す）か、Ctrl-D キーボードショートカットを使用します。 \ No newline at end of file +このチャットセッションを終了するには、`quit` または `exit` と入力して Enter を押すか、`Ctrl-D` のキーボードショートカットを使用します。 \ No newline at end of file diff --git a/docs/ja/results.md b/docs/ja/results.md index 34d4633a2..17c9a1a87 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` を呼び出した場合） +- `run` または `run_sync` を呼び出した場合は [`RunResult`][agents.result.RunResult] +- `run_streamed` を呼び出した場合は [`RunResultStreaming`][agents.result.RunResultStreaming] -どちらも [`RunResultBase`][agents.result.RunResultBase] を継承しており、ここに最も有用な情報が含まれます。 +これらはいずれも [`RunResultBase`][agents.result.RunResultBase] を継承しており、そこに有用な情報の大半があります。 ## 最終出力 -[`final_output`][agents.result.RunResultBase.final_output] プロパティには、最後に実行されたエージェントの最終出力が含まれます。これは次のいずれかです。 +[`final_output`][agents.result.RunResultBase.final_output] プロパティには、最後に実行されたエージェントの最終出力が入ります。これは次のいずれかです: - 最後のエージェントに `output_type` が定義されていない場合は `str` - エージェントに出力タイプが定義されている場合は `last_agent.output_type` 型のオブジェクト !!! note - `final_output` の型は `Any` です。handoffs のため、これを静的に型付けすることはできません。handoffs が発生すると、どのエージェントが最後になるか分からないため、可能な出力タイプの集合を静的に把握できないためです。 + `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] プロパティには、最後に実行されたエージェントが含まれます。アプリケーションによっては、次回ユーザーが入力する際に有用です。例えば、フロントラインのトリアージ用エージェントが言語別のエージェントへ handoff する場合、最後のエージェントを保存しておき、次回ユーザーがエージェントにメッセージを送る際に再利用できます。 +[`last_agent`][agents.result.RunResultBase.last_agent] プロパティには、最後に実行されたエージェントが入ります。アプリケーションによっては、これは次回 ユーザー が入力する際に有用です。たとえば、フロントラインのトリアージ エージェントが言語特化のエージェントにハンドオフする場合、最後のエージェントを保存しておき、次回 ユーザー がエージェントにメッセージを送るときに再利用できます。 ## 新規アイテム -[`new_items`][agents.result.RunResultBase.new_items] プロパティには、実行中に生成された新しいアイテムが含まれます。アイテムは [`RunItem`][agents.items.RunItem] です。実行アイテムは、LLM が生成した raw アイテムをラップします。 +[`new_items`][agents.result.RunResultBase.new_items] プロパティには、実行中に生成された新しいアイテムが入ります。アイテムは [`RunItem`][agents.items.RunItem] です。実行アイテムは、LLM が生成した raw アイテムをラップします。 - [`MessageOutputItem`][agents.items.MessageOutputItem] は LLM からのメッセージを示します。raw アイテムは生成されたメッセージです。 -- [`HandoffCallItem`][agents.items.HandoffCallItem] は、LLM が handoff ツールを呼び出したことを示します。raw アイテムは LLM からのツール呼び出しアイテムです。 -- [`HandoffOutputItem`][agents.items.HandoffOutputItem] は、handoff が発生したことを示します。raw アイテムは handoff ツール呼び出しに対するツールのレスポンスです。アイテムから送信元/送信先のエージェントにもアクセスできます。 -- [`ToolCallItem`][agents.items.ToolCallItem] は、LLM がツールを呼び出したことを示します。 -- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem] は、ツールが呼び出されたことを示します。raw アイテムはツールのレスポンスです。アイテムからツール出力にもアクセスできます。 -- [`ReasoningItem`][agents.items.ReasoningItem] は 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 アイテムは生成された推論です。 ## その他の情報 -### ガードレール結果 +### ガードレールの結果 -[`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 fee97378d..9b7675998 100644 --- a/docs/ja/running_agents.md +++ b/docs/ja/running_agents.md @@ -4,11 +4,11 @@ search: --- # エージェントの実行 -エージェントは [`Runner`][agents.run.Runner] クラスで実行できます。方法は 3 つあります: +エージェントは [`Runner`][agents.run.Runner] クラスで実行できます。方法は 3 つあります。 1. [`Runner.run()`][agents.run.Runner.run]: 非同期で実行し、[`RunResult`][agents.result.RunResult] を返します。 2. [`Runner.run_sync()`][agents.run.Runner.run_sync]: 同期メソッドで、内部的には `.run()` を実行します。 -3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed]: 非同期で実行し、[`RunResultStreaming`][agents.result.RunResultStreaming] を返します。LLM を ストリーミング モードで呼び出し、受信したイベントを逐次ストリーミングします。 +3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed]: 非同期で実行し、[`RunResultStreaming`][agents.result.RunResultStreaming] を返します。LLM をストリーミングモードで呼び出し、受信したイベントをそのままストリーミングします。 ```python from agents import Agent, Runner @@ -23,55 +23,55 @@ async def main(): # Infinite loop's dance ``` -詳しくは[結果ガイド](results.md)をご覧ください。 +詳しくは [結果ガイド](results.md) をご覧ください。 ## エージェントループ -`Runner` の run メソッドでは、開始するエージェントと入力を渡します。入力は文字列（ユーザーメッセージとみなされます）または入力アイテムのリスト（OpenAI Responses API のアイテム）を指定できます。 +`Runner` の run メソッドを使うときは、開始するエージェントと入力を渡します。入力は文字列（ユーザーのメッセージと見なされます）か、OpenAI Responses API の入力アイテムのリストのいずれかです。 -Runner は次のループを実行します: +Runner は次のループを実行します。 -1. 現在のエージェントに対して、現在の入力で LLM を呼び出します。 +1. 現在のエージェントと入力で LLM を呼び出します。 2. LLM が出力を生成します。 - 1. LLM が `final_output` を返した場合、ループを終了し結果を返します。 - 2. LLM が ハンドオフ を行った場合、現在のエージェントと入力を更新し、ループを再実行します。 - 3. LLM が ツール呼び出し を生成した場合、それらを実行し、結果を追加して、ループを再実行します。 + 1. LLM が `final_output` を返した場合、ループを終了して結果を返します。 + 2. LLM がハンドオフした場合、現在のエージェントと入力を更新してループを再実行します。 + 3. LLM がツール呼び出しを生成した場合、それらを実行して結果を追加し、ループを再実行します。 3. 渡された `max_turns` を超えた場合、[`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 例外を送出します。 !!! note - LLM の出力が「最終出力」と見なされるルールは、目的の型でテキスト出力を生成し、ツール呼び出しが 1 つもないことです。 + LLM の出力が「最終出力」と見なされる条件は、所望の型のテキスト出力を生成し、ツール呼び出しがないことです。 ## ストリーミング -ストリーミングを使うと、LLM 実行中のストリーミング イベントも受け取れます。ストリーム完了後、[`RunResultStreaming`][agents.result.RunResultStreaming] には実行に関する完全な情報（生成されたすべての新しい出力を含む）が含まれます。ストリーミング イベントは `.stream_events()` を呼び出して取得できます。詳しくは[ストリーミング ガイド](streaming.md)をご覧ください。 +ストリーミングを使うと、LLM の実行中にストリーミングイベントも受け取れます。ストリームが完了すると、[`RunResultStreaming`][agents.result.RunResultStreaming] には、生成された新しい出力を含む実行全体の情報が含まれます。ストリーミングイベントは `.stream_events()` を呼び出してください。詳しくは [ストリーミングガイド](streaming.md) を参照してください。 -## 実行設定 +## 実行設定 (Run config) -`run_config` パラメーターでは、エージェント実行のグローバル設定を構成できます: +`run_config` パラメーターでは、エージェント実行のグローバル設定を構成できます。 - [`model`][agents.run.RunConfig.model]: 各 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` の設定を推奨します。グループ ID は任意で、複数の実行にわたるトレースを関連付けるのに役立ちます。 +- [`model_provider`][agents.run.RunConfig.model_provider]: モデル名の解決に使うモデルプロバイダーで、デフォルトは OpenAI です。 +- [`model_settings`][agents.run.RunConfig.model_settings]: エージェント固有の設定を上書きします。たとえば、グローバルな `temperature` や `top_p` を設定できます。 +- [`input_guardrails`][agents.run.RunConfig.input_guardrails], [`output_guardrails`][agents.run.RunConfig.output_guardrails]: すべての実行に含める入力/出力の ガードレール のリストです。 +- [`handoff_input_filter`][agents.run.RunConfig.handoff_input_filter]: すべてのハンドオフに適用するグローバルな入力フィルター（ハンドオフに既に設定がない場合）。入力フィルターは、新しいエージェントに送る入力を編集できます。詳しくは [`Handoff.input_filter`][agents.handoffs.Handoff.input_filter] のドキュメントをご覧ください。 +- [`tracing_disabled`][agents.run.RunConfig.tracing_disabled]: 実行全体の [トレーシング](tracing.md) を無効化できます。 +- [`trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data]: トレースに、LLM やツール呼び出しの入出力などの機微情報を含めるかを設定します。 +- [`workflow_name`][agents.run.RunConfig.workflow_name], [`trace_id`][agents.run.RunConfig.trace_id], [`group_id`][agents.run.RunConfig.group_id]: 実行のトレーシングにおけるワークフロー名、トレース ID、トレースグループ ID を設定します。少なくとも `workflow_name` の設定を推奨します。グループ ID は任意で、複数の実行にまたがるトレースを関連付けられます。 - [`trace_metadata`][agents.run.RunConfig.trace_metadata]: すべてのトレースに含めるメタデータです。 ## 会話/チャットスレッド -いずれかの run メソッドを呼び出すと、1 つ以上のエージェント（したがって 1 回以上の LLM 呼び出し）が実行される可能性がありますが、チャット会話における 1 回の論理的なターンを表します。例: +いずれの run メソッドの呼び出しでも、1 つ以上のエージェント（したがって 1 回以上の LLM 呼び出し）が実行される場合がありますが、チャット会話における 1 つの論理的なターンを表します。例: 1. ユーザーのターン: ユーザーがテキストを入力 -2. Runner の実行: 最初のエージェントが LLM を呼び出し、ツールを実行し、2 番目のエージェントにハンドオフ、2 番目のエージェントが更にツールを実行し、その後出力を生成。 +2. Runner の実行: 最初のエージェントが LLM を呼び出し、ツールを実行し、2 番目のエージェントへハンドオフ。2 番目のエージェントがさらにツールを実行し、その後に出力を生成。 -エージェント実行の最後に、ユーザーへ何を表示するかを選べます。例えば、エージェントが生成したすべての新しいアイテムを表示するか、最終出力のみを表示します。いずれの場合も、ユーザーが追質問をするかもしれず、その場合は再度 run メソッドを呼び出します。 +エージェントの実行が終わったら、ユーザーに何を表示するかを選べます。たとえば、エージェントが生成したすべての新しいアイテムを見せるか、最終出力だけを見せるかです。どちらの場合でも、ユーザーが追質問をするかもしれません。その場合は、再度 run メソッドを呼び出してください。 ### 手動の会話管理 -次のターン用の入力を取得するために、[`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] メソッドを使って会話履歴を手動で管理できます: +次のターンの入力を取得するために、[`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] メソッドを使って、会話履歴を手動で管理できます。 ```python async def main(): @@ -93,7 +93,7 @@ async def main(): ### Sessions による自動会話管理 -より簡単な方法として、[Sessions](sessions/index.md) を使用すれば、`.to_input_list()` を手動で呼び出さずに会話履歴を自動で扱えます: +より簡単な方法として、[Sessions](sessions/index.md) を使用すると、`.to_input_list()` を手動で呼び出さなくても会話履歴を自動処理できます。 ```python from agents import Agent, Runner, SQLiteSession @@ -117,24 +117,24 @@ async def main(): # California ``` -Sessions は自動的に次を行います: +Sessions は自動で次を行います。 - 各実行の前に会話履歴を取得 - 各実行の後に新しいメッセージを保存 - セッション ID ごとに別々の会話を維持 -詳しくは [Sessions のドキュメント](sessions/index.md)をご覧ください。 +詳細は [Sessions のドキュメント](sessions/index.md) を参照してください。 ### サーバー管理の会話 -`to_input_list()` や `Sessions` を使ってローカルで管理する代わりに、OpenAI の conversation state 機能に サーバー 側で会話状態を管理させることもできます。これにより、過去のすべてのメッセージを手動で再送せずに会話履歴を保持できます。詳しくは [OpenAI Conversation state ガイド](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses)をご覧ください。 +`to_input_list()` や `Sessions` でローカルに管理する代わりに、OpenAI の conversation state 機能にサーバー側で会話状態を管理させることもできます。これにより、過去のメッセージをすべて手動で再送せずに会話履歴を保持できます。詳しくは [OpenAI Conversation state ガイド](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses) を参照してください。 -OpenAI はターン間の状態を追跡する 2 つの方法を提供します: +OpenAI はターン間で状態を追跡する 2 つの方法を提供します。 -#### 1. `conversation_id` の使用 +#### 1. `conversation_id` を使う -まず OpenAI Conversations API を使用して会話を作成し、その ID を後続のすべての呼び出しで再利用します: +まず OpenAI Conversations API で会話を作成し、その ID を以降のすべての呼び出しで再利用します。 ```python from agents import Agent, Runner @@ -164,9 +164,9 @@ async def main(): # California ``` -#### 2. `previous_response_id` の使用 +#### 2. `previous_response_id` を使う -もう 1 つの方法は、各ターンを直前のターンのレスポンス ID に明示的にリンクする **レスポンス チェイニング（response chaining）** です。 +もう 1 つの方法は、各ターンが前のターンのレスポンス ID に明示的にリンクする、**レスポンスのチェイニング** です。 ```python from agents import Agent, Runner @@ -190,18 +190,18 @@ async def main(): ``` -## 長時間実行エージェントとヒューマン・イン・ザ・ループ +## 長時間実行エージェントと human-in-the-loop -Agents SDK の [Temporal](https://temporal.io/) 統合を使用すると、ヒューマン・イン・ザ・ループのタスクを含む永続的で長時間実行のワークフローを実行できます。長時間タスクを完了するために Temporal と Agents SDK が連携するデモは[この動画](https://www.youtube.com/watch?v=fFBZqzT4DD8)で、ドキュメントは[こちら](https://github.com/temporalio/sdk-python/tree/main/temporalio/contrib/openai_agents)をご覧ください。 +Agents SDK の [Temporal](https://temporal.io/) 連携を使うと、human-in-the-loop を含む耐久性のある長時間実行ワークフローを実行できます。Temporal と Agents SDK が連携して長時間のタスクを完了するデモは [この動画](https://www.youtube.com/watch?v=fFBZqzT4DD8) を、ドキュメントは [こちら](https://github.com/temporalio/sdk-python/tree/main/temporalio/contrib/openai_agents) をご覧ください。 ## 例外 -SDK は特定の場合に例外を送出します。完全な一覧は [`agents.exceptions`][] にあります。概要は次のとおりです: +SDK は特定の場合に例外を送出します。完全な一覧は [`agents.exceptions`][] にあります。概要は次のとおりです。 -- [`AgentsException`][agents.exceptions.AgentsException]: SDK 内で送出されるすべての例外の基底クラスです。他の特定の例外はすべてこの汎用タイプから派生します。 -- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded]: エージェントの実行が `Runner.run`、`Runner.run_sync`、または `Runner.run_streamed` メソッドに渡された `max_turns` 制限を超えた場合に送出されます。指定された対話ターン数内にタスクを完了できなかったことを示します。 -- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError]: 基盤となるモデル（LLM）が予期しないまたは無効な出力を生成した際に発生します。これには次が含まれます: - - 不正な JSON: 特定の `output_type` が定義されている場合に特に、ツール呼び出しや直接出力で不正な JSON 構造を返す。 - - 予期しないツール関連の失敗: モデルが想定どおりの方法でツールを使用できない場合。 -- [`UserError`][agents.exceptions.UserError]: SDK を使用する（SDK を使ってコードを書く）あなたが誤りを行った場合に送出されます。これは一般に、誤ったコード実装、無効な設定、または SDK の API の誤用に起因します。 -- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered], [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]: それぞれ、入力ガードレールまたは出力ガードレールの条件が満たされた場合に送出されます。入力ガードレールは処理前に受信メッセージをチェックし、出力ガードレールは配信前にエージェントの最終応答をチェックします。 \ No newline at end of file +- [`AgentsException`][agents.exceptions.AgentsException]: SDK 内で送出されるすべての例外の基底クラスです。他の特定の例外はすべてこの汎用型から派生します。 +- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded]: エージェントの実行が `Runner.run`、`Runner.run_sync`、`Runner.run_streamed` メソッドに渡された `max_turns` 制限を超えたときに送出されます。指定されたインタラクションのターン数内にタスクを完了できなかったことを示します。 +- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError]: 基盤のモデル (LLM) が予期しない、または無効な出力を生成したときに発生します。これには次が含まれます。 + - 不正な JSON: 特定の `output_type` が定義されている場合に特に、ツール呼び出しや直接の出力で不正な JSON 構造を返したとき。 + - 予期しないツール関連の失敗: モデルが期待どおりの方法でツールを使用できなかったとき。 +- [`UserError`][agents.exceptions.UserError]: SDK を使用する（コードを書く）あなたが、SDK の使用中にエラーを起こしたときに送出されます。これは通常、不正なコード実装、無効な設定、SDK の API の誤用に起因します。 +- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered], [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]: 入力 ガードレール または出力 ガードレール の条件が満たされたときに、それぞれ送出されます。入力 ガードレール は処理前の受信メッセージを、出力 ガードレール は配信前のエージェントの最終レスポンスを検査します。 \ No newline at end of file diff --git a/docs/ja/sessions/advanced_sqlite_session.md b/docs/ja/sessions/advanced_sqlite_session.md index 3a39da9f8..30cb3ba05 100644 --- a/docs/ja/sessions/advanced_sqlite_session.md +++ b/docs/ja/sessions/advanced_sqlite_session.md @@ -4,15 +4,15 @@ search: --- # 高度な SQLite セッション -`AdvancedSQLiteSession` は、会話の分岐、詳細な使用状況の分析、構造化された会話クエリなどの高度な会話管理機能を提供する、基本の `SQLiteSession` を強化したバージョンです。 +`AdvancedSQLiteSession` は、会話の分岐、詳細な使用状況分析、構造化された会話クエリなど、高度な会話管理機能を提供する基本の `SQLiteSession` の拡張版です。 ## 機能 - **会話の分岐**: 任意の ユーザー メッセージから代替の会話パスを作成 -- **使用状況の追跡**: 各ターンごとのトークン使用量を詳細に分析し、完全な JSON 内訳を提供 +- **使用状況の追跡**: 各ターンの詳細なトークン使用分析と完全な JSON ブレークダウン - **構造化クエリ**: ターン単位の会話取得、ツール使用統計など - **ブランチ管理**: 独立したブランチの切り替えと管理 -- **メッセージ構造のメタデータ**: メッセージタイプ、ツール使用状況、会話の流れを追跡 +- **メッセージ構造メタデータ**: メッセージ種別、ツール使用、会話フローの追跡 ## クイックスタート @@ -84,14 +84,14 @@ session = AdvancedSQLiteSession( ### パラメーター -- `session_id` (str): 会話セッションの一意の識別子 -- `db_path` (str | Path): SQLite データベースファイルへのパス。メモリ内ストレージの場合はデフォルトで `:memory:` を使用 -- `create_tables` (bool): 高度なテーブルを自動作成するかどうか。デフォルトは `False` -- `logger` (logging.Logger | None): セッション用のカスタムロガー。デフォルトはモジュールのロガー +- `session_id` ( str ): 会話セッションの一意の識別子 +- `db_path` ( str | Path ): SQLite データベースファイルへのパス。インメモリ保存の場合は `:memory:` がデフォルト +- `create_tables` ( bool ): 高度なテーブルを自動作成するかどうか。デフォルトは `False` +- `logger` ( logging.Logger | None ): セッション用のカスタム logger。デフォルトはモジュールの logger ## 使用状況の追跡 -AdvancedSQLiteSession は、会話の各ターンごとにトークン使用データを保存することで、詳細な使用状況分析を提供します。 **これは各エージェントの実行後に `store_run_usage` メソッドが呼び出されることに完全に依存します。** +AdvancedSQLiteSession は、会話の各ターンごとにトークン使用データを保存することで、詳細な使用状況分析を提供します。**これは各 エージェント 実行後に `store_run_usage` メソッドが呼ばれることに完全に依存します。** ### 使用データの保存 @@ -137,7 +137,7 @@ turn_2_usage = await session.get_turn_usage(user_turn_number=2) ## 会話の分岐 -AdvancedSQLiteSession の主な機能の 1 つは、任意の ユーザー メッセージから会話のブランチを作成でき、代替の会話パスを探索できる点です。 +AdvancedSQLiteSession の主要機能の 1 つは、任意の ユーザー メッセージから会話ブランチを作成し、代替の会話パスを探索できることです。 ### ブランチの作成 @@ -245,17 +245,17 @@ for turn in matching_turns: ### メッセージ構造 -セッションはメッセージ構造を自動的に追跡します。内容は次のとおりです。 +このセッションは、以下を含むメッセージ構造を自動的に追跡します。 -- メッセージタイプ（user、assistant、tool_call など） -- ツール呼び出しのツール名 -- ターン番号とシーケンス番号 -- ブランチとの関連付け +- メッセージ種別（ ユーザー、assistant、tool_call など） +- ツール呼び出し時のツール名 +- ターン番号およびシーケンス番号 +- ブランチの関連付け - タイムスタンプ ## データベーススキーマ -AdvancedSQLiteSession は、基本の SQLite スキーマを拡張し、次の 2 つの追加テーブルを含みます。 +AdvancedSQLiteSession は、基本の SQLite スキーマを 2 つの追加テーブルで拡張します。 ### message_structure テーブル @@ -296,10 +296,9 @@ CREATE TABLE turn_usage ( ); ``` -## 完全な例 - -すべての機能を網羅する [完全な例](https://github.com/openai/openai-agents-python/tree/main/examples/memory/advanced_sqlite_session_example.py) をご覧ください。 +## 完全なコード例 +すべての機能を包括的に示す [完全なコード例](https://github.com/openai/openai-agents-python/tree/main/examples/memory/advanced_sqlite_session_example.py) をご覧ください。 ## API リファレンス diff --git a/docs/ja/sessions/encrypted_session.md b/docs/ja/sessions/encrypted_session.md index c6fb51e86..9e04057e9 100644 --- a/docs/ja/sessions/encrypted_session.md +++ b/docs/ja/sessions/encrypted_session.md @@ -4,18 +4,18 @@ search: --- # 暗号化セッション -`EncryptedSession` は、あらゆるセッション実装に対して透過的な暗号化を提供し、古い項目の自動有効期限切れにより会話データを保護します。 +`EncryptedSession` は任意のセッション実装に透過的な暗号化を提供し、会話データを保護しつつ、古い項目を自動的に期限切れにします。 ## 機能 -- **透過的な暗号化**: どのセッションでも Fernet 暗号化でラップします -- **セッションごとのキー**: 一意の暗号化を行うために HKDF キー導出を使用します -- **自動有効期限**: TTL が切れた古い項目は静かにスキップされます -- **差し替え可能**: 既存の任意のセッション実装で動作します +- **透過的な暗号化**: 任意のセッションを Fernet 暗号化でラップします +- **セッションごとのキー**: HKDF 鍵導出によりセッションごとに一意の暗号化を行います +- **自動失効**: TTL が失効した古い項目は静かにスキップされます +- **ドロップイン置換**: 既存のあらゆるセッション実装で機能します ## インストール -暗号化セッションには `encrypt` エクストラが必要です: +暗号化セッションには `encrypt` 追加コンポーネントが必要です: ```bash pip install openai-agents[encrypt] @@ -57,7 +57,7 @@ if __name__ == "__main__": ### 暗号化キー -暗号化キーは Fernet キーまたは任意の文字列を使用できます: +暗号化キーは Fernet キーでも、任意の文字列でも構いません: ```python from agents.extensions.memory import EncryptedSession @@ -81,7 +81,7 @@ session = EncryptedSession( ### TTL (Time To Live) -暗号化された項目が有効である期間を設定します: +暗号化された項目の有効期間を設定します: ```python # Items expire after 1 hour @@ -101,7 +101,7 @@ session = EncryptedSession( ) ``` -## さまざまなセッションタイプでの使用 +## 異なるセッション種別での使用 ### SQLite セッションでの使用 @@ -140,30 +140,30 @@ session = EncryptedSession( !!! warning "高度なセッション機能" - `EncryptedSession` を `AdvancedSQLiteSession` のような高度なセッション実装と併用する場合、次の点に注意してください: + `EncryptedSession` を `AdvancedSQLiteSession` のような高度なセッション実装と併用する場合は、次の点に注意してください。 - - メッセージ内容が暗号化されるため、`find_turns_by_content()` のようなメソッドは効果的に動作しません - - コンテンツベースの検索は暗号化データに対して行われるため、その有効性が制限されます + - メッセージ内容が暗号化されるため、`find_turns_by_content()` のようなメソッドは効果的に機能しません + - 内容に基づく検索は暗号化データに対して行われるため、効果が制限されます -## キー導出 +## 鍵導出 -EncryptedSession は HKDF (HMAC-based Key Derivation Function) を使用して、セッションごとに一意の暗号化キーを導出します: +EncryptedSession は HKDF ( HMAC-based Key Derivation Function ) を用いて、セッションごとに一意の暗号化キーを導出します。 -- **マスターキー**: 提供された暗号化キー +- **マスターキー**: 提供した暗号化キー - **セッションソルト**: セッション ID -- **Info string**: `"agents.session-store.hkdf.v1"` -- **出力**: 32 バイト Fernet キー +- **情報文字列**: `"agents.session-store.hkdf.v1"` +- **出力**: 32 バイトの Fernet キー -これにより次のことが保証されます: -- 各セッションには一意の暗号化キーがあります -- マスターキーがなければキーを導出できません -- 異なるセッション間でセッションデータを復号できません +これにより、次が保証されます: +- 各セッションに一意の暗号化キーがあること +- マスターキーなしでは鍵を導出できないこと +- セッションデータは異なるセッション間で復号できないこと -## 自動有効期限 +## 自動失効 -項目が TTL を超えた場合、取得時に自動的にスキップされます: +項目が TTL を超えた場合、取得時に自動的にスキップされます: ```python # Items older than TTL are silently ignored diff --git a/docs/ja/sessions/index.md b/docs/ja/sessions/index.md index 7708cf52f..ab7131772 100644 --- a/docs/ja/sessions/index.md +++ b/docs/ja/sessions/index.md @@ -4,9 +4,9 @@ search: --- # セッション -Agents SDK は、複数のエージェント実行にわたって会話履歴を自動的に維持する組み込みのセッションメモリを提供し、ターン間で手動で `.to_input_list()` を扱う必要をなくします。 +Agents SDK は、エージェントの複数回の実行にわたって会話履歴を自動的に維持するための組み込みセッションメモリを提供し、ターン間で `.to_input_list()` を手動で扱う必要をなくします。 -セッションは特定のセッションの会話履歴を保存し、明示的な手動メモリ管理なしでエージェントがコンテキストを維持できるようにします。これは、エージェントに以前のやり取りを記憶させたいチャットアプリケーションやマルチターンの会話を構築する際に特に有用です。 +セッションは特定のセッションに対して会話履歴を保存し、明示的な手動メモリ管理なしにエージェントがコンテキストを維持できるようにします。これは、チャットアプリケーションや、エージェントに過去のやり取りを覚えさせたいマルチターン会話の構築に特に有用です。 ## クイックスタート @@ -51,11 +51,11 @@ print(result.final_output) # "Approximately 39 million" セッションメモリが有効な場合: -1. **各実行前**: ランナーはセッションの会話履歴を自動的に取得し、入力アイテムの先頭に付加します。 -2. **各実行後**: 実行中に生成されたすべての新しいアイテム（ユーザー入力、アシスタントの応答、ツール呼び出しなど）が自動的にセッションに保存されます。 -3. **コンテキスト保持**: 同じセッションでの後続の各実行には完全な会話履歴が含まれ、エージェントはコンテキストを維持できます。 +1. **各実行の前**: ランナー (runner) はセッションの会話履歴を自動的に取得し、入力アイテムの先頭に追加します。 +2. **各実行の後**: 実行中に生成された新しいアイテム (ユーザー入力、アシスタントの応答、ツール呼び出しなど) はすべて自動的にセッションに保存されます。 +3. **コンテキストの保存**: 同じセッションでの以降の実行は、完全な会話履歴を含むため、エージェントはコンテキストを維持できます。 -これにより、実行間で手動で `.to_input_list()` を呼び出して会話状態を管理する必要がなくなります。 +これにより、`.to_input_list()` を手動で呼び出し、実行間の会話状態を管理する必要がなくなります。 ## メモリ操作 @@ -117,13 +117,13 @@ result = await Runner.run( print(f"Agent: {result.final_output}") ``` -## セッションタイプ +## セッションの種類 -SDK は、さまざまなユースケース向けにいくつかのセッション実装を提供します: +SDK は用途に応じた複数のセッション実装を提供します: ### OpenAI Conversations API セッション -`OpenAIConversationsSession` を介して [OpenAI の Conversations API](https://platform.openai.com/docs/api-reference/conversations) を使用します。 +`OpenAIConversationsSession` を通じて [OpenAI の Conversations API](https://platform.openai.com/docs/api-reference/conversations) を使用します。 ```python from agents import Agent, Runner, OpenAIConversationsSession @@ -159,7 +159,7 @@ print(result.final_output) # "California" ### SQLite セッション -SQLite を使用したデフォルトの軽量セッション実装: +デフォルトの軽量な SQLite ベースのセッション実装です: ```python from agents import SQLiteSession @@ -180,7 +180,7 @@ result = await Runner.run( ### SQLAlchemy セッション -あらゆる SQLAlchemy 対応データベースを使用する本番対応のセッション: +SQLAlchemy がサポートする任意のデータベースを使用できる本番対応のセッションです: ```python from agents.extensions.memory import SQLAlchemySession @@ -200,9 +200,11 @@ session = SQLAlchemySession("user_123", engine=engine, create_tables=True) 詳細なドキュメントは [SQLAlchemy セッション](sqlalchemy_session.md) を参照してください。 + + ### 高度な SQLite セッション -会話の分岐、利用分析、構造化クエリを備えた強化版 SQLite セッション: +会話の分岐、利用分析、構造化クエリを備えた強化版 SQLite セッションです: ```python from agents.extensions.memory import AdvancedSQLiteSession @@ -226,7 +228,7 @@ await session.create_branch_from_turn(2) # Branch from turn 2 ### 暗号化セッション -あらゆるセッション実装向けの透過的な暗号化ラッパー: +任意のセッション実装に対する透過的な暗号化ラッパーです: ```python from agents.extensions.memory import EncryptedSession, SQLAlchemySession @@ -251,24 +253,30 @@ result = await Runner.run(agent, "Hello", session=session) 詳細なドキュメントは [暗号化セッション](encrypted_session.md) を参照してください。 +### その他のセッションタイプ + +他にもいくつかの組み込みオプションがあります。`examples/memory/` と `extensions/memory/` 配下のソースコードを参照してください。 + ## セッション管理 ### セッション ID の命名 会話を整理しやすい意味のあるセッション ID を使用します: -- ユーザー単位: `"user_12345"` -- スレッド単位: `"thread_abc123"` -- コンテキスト単位: `"support_ticket_456"` +- ユーザー単位: `"user_12345"` +- スレッド単位: `"thread_abc123"` +- コンテキスト単位: `"support_ticket_456"` -### メモリ永続化 +### メモリの永続化 -- 一時的な会話にはインメモリ SQLite（`SQLiteSession("session_id")`）を使用します -- 永続的な会話にはファイルベースの SQLite（`SQLiteSession("session_id", "path/to/db.sqlite")`）を使用します -- 既存のデータベースを SQLAlchemy がサポートする本番システムには SQLAlchemy 対応のセッション（`SQLAlchemySession("session_id", engine=engine, create_tables=True)`）を使用します -- 履歴を OpenAI Conversations API に保存したい場合は OpenAI ホストのストレージ（`OpenAIConversationsSession()`）を使用します -- あらゆるセッションを透過的な暗号化と TTL ベースの有効期限でラップするには暗号化セッション（`EncryptedSession(session_id, underlying_session, encryption_key)`）を使用します -- より高度なユースケースには、他の本番システム（Redis、Django など）向けのカスタムセッションバックエンドの実装を検討してください +- 一時的な会話にはインメモリ SQLite (`SQLiteSession("session_id")`) を使用します +- 永続的な会話にはファイルベースの SQLite (`SQLiteSession("session_id", "path/to/db.sqlite")`) を使用します +- 既存の SQLAlchemy がサポートするデータベースを用いる本番システムには SQLAlchemy ベースのセッション (`SQLAlchemySession("session_id", engine=engine, create_tables=True)`) を使用します +- クラウドネイティブな本番デプロイで、組み込みテレメトリー、トレーシング、データ分離に対応し、かつ +30+ のデータベースバックエンドをサポートする場合は Dapr ステートストアセッション (`DaprSession.from_address("session_id", state_store_name="statestore", dapr_address="localhost:50001")`) を使用します +- 履歴を OpenAI Conversations API に保存したい場合は OpenAI がホストするストレージ (`OpenAIConversationsSession()`) を使用します +- 透過的な暗号化と TTL ベースの有効期限で任意のセッションをラップするには暗号化セッション (`EncryptedSession(session_id, underlying_session, encryption_key)`) を使用します +- より高度なユースケースに向けて、他の本番システム (Redis、Django など) 向けのカスタムセッションバックエンドの実装も検討してください ### 複数セッション @@ -316,7 +324,7 @@ result2 = await Runner.run( ## 完全な例 -セッションメモリがどのように機能するかを示す完全な例です: +以下は、セッションメモリの動作を示す完全な例です: ```python import asyncio @@ -380,7 +388,7 @@ if __name__ == "__main__": ## カスタムセッション実装 -[`Session`][agents.memory.session.Session] プロトコルに従うクラスを作成することで、独自のセッションメモリを実装できます: +[`Session`][agents.memory.session.Session] プロトコルに準拠するクラスを作成することで、独自のセッションメモリを実装できます: ```python from agents.memory.session import SessionABC @@ -425,11 +433,12 @@ result = await Runner.run( ## API リファレンス -詳細な API ドキュメントは以下を参照してください: +詳細な API ドキュメントは次を参照してください: -- [`Session`][agents.memory.session.Session] - プロトコルインターフェース -- [`OpenAIConversationsSession`][agents.memory.OpenAIConversationsSession] - OpenAI Conversations API 実装 -- [`SQLiteSession`][agents.memory.sqlite_session.SQLiteSession] - 基本的な SQLite 実装 -- [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - SQLAlchemy 対応実装 -- [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 分岐と分析を備えた強化版 SQLite -- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - 任意のセッション向けの暗号化ラッパー \ No newline at end of file +- [`Session`][agents.memory.session.Session] - プロトコルインターフェース +- [`OpenAIConversationsSession`][agents.memory.OpenAIConversationsSession] - OpenAI Conversations API 実装 +- [`SQLiteSession`][agents.memory.sqlite_session.SQLiteSession] - 基本的な SQLite 実装 +- [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - SQLAlchemy ベースの実装 +- [`DaprSession`][agents.extensions.memory.dapr_session.DaprSession] - Dapr ステートストア実装 +- [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 分岐と分析を備えた強化版 SQLite +- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - 任意のセッション向け暗号化ラッパー \ No newline at end of file diff --git a/docs/ja/sessions/sqlalchemy_session.md b/docs/ja/sessions/sqlalchemy_session.md index 1844a2452..94b4b3cb6 100644 --- a/docs/ja/sessions/sqlalchemy_session.md +++ b/docs/ja/sessions/sqlalchemy_session.md @@ -4,11 +4,11 @@ search: --- # SQLAlchemy セッション -`SQLAlchemySession` は SQLAlchemy を使用して本番運用に適したセッション実装を提供し、セッションの保存先として SQLAlchemy がサポートする任意のデータベース（PostgreSQL、MySQL、SQLite など）を使用できます。 +`SQLAlchemySession` は SQLAlchemy を使用して本番運用可能なセッション実装を提供し、SQLAlchemy がサポートする任意のデータベース（PostgreSQL、MySQL、SQLite など）をセッションストレージに使用できます。 ## インストール -SQLAlchemy セッションには `sqlalchemy` の extra が必要です: +SQLAlchemy セッションには `sqlalchemy` extra が必要です: ```bash pip install openai-agents[sqlalchemy] @@ -18,7 +18,7 @@ pip install openai-agents[sqlalchemy] ### データベース URL の使用 -最も簡単な始め方です: +最も簡単な始め方: ```python import asyncio @@ -77,4 +77,4 @@ if __name__ == "__main__": ## API リファレンス - [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - メインクラス -- [`Session`][agents.memory.session.Session] - ベースセッションプロトコル \ No newline at end of file +- [`Session`][agents.memory.session.Session] - セッションのベースプロトコル \ No newline at end of file diff --git a/docs/ja/streaming.md b/docs/ja/streaming.md index 72cb5482c..fe2debaf4 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 レスポンスイベント +## Raw レスポンスイベント -[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent] は、LLM から直接渡される raw なイベントです。OpenAI Responses API フォーマットであり、各イベントには `response.created` や `response.output_text.delta` などのタイプとデータがあります。これらのイベントは、生成され次第、応答メッセージをユーザーにストリーミングしたい場合に有用です。 +[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent] は、LLM から直接渡される raw なイベントです。これは OpenAI Responses API 形式であり、各イベントはタイプ（`response.created`、`response.output_text.delta` など）とデータを持ちます。これらのイベントは、生成されしだい ユーザー にレスポンスメッセージをストリーミングしたい場合に有用です。 -例えば、次のコードは LLM が生成するテキストをトークンごとに出力します。 +例えば、次は LLM によって生成されたテキストをトークンごとに出力します。 ```python import asyncio @@ -35,11 +35,11 @@ if __name__ == "__main__": asyncio.run(main()) ``` -## Run アイテムイベントと エージェントイベント +## Run アイテムイベントと エージェント イベント -[`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 548600aef..b674b8309 100644 --- a/docs/ja/tools.md +++ b/docs/ja/tools.md @@ -4,23 +4,23 @@ search: --- # ツール -ツールは エージェント にアクションを実行させます。たとえば、データの取得、コードの実行、外部 API の呼び出し、さらにはコンピュータの使用などです。Agent SDK には次の 3 種類のツールがあります。 +ツールは エージェント にアクションを取らせます。たとえばデータの取得、コードの実行、外部 API の呼び出し、さらにはコンピュータの使用などです。Agents SDK には 3 つのツールのクラスがあります。 -- ホスト型ツール: これらは AI モデルと同じ LLM サーバー上で動作します。OpenAI は retrieval、Web 検索、コンピュータ操作 をホスト型ツールとして提供しています。 -- Function calling: 任意の Python 関数をツールとして使用できます。 -- エージェントをツールとして使用: エージェントをツールとして利用でき、ハンドオフ せずに他の エージェント を呼び出せます。 +- ホスト型ツール: これらは AI モデルと同じ LLM サーバー上で動作します。OpenAI は リトリーバル、Web 検索、コンピュータ操作 をホスト型ツールとして提供します。 +- Function calling: 任意の Python 関数をツールとして使えます。 +- ツールとしての エージェント: エージェント をツールとして使えるため、ハンドオフ なしで他の エージェント を呼び出せます。 ## ホスト型ツール -OpenAI は、[`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] を使用する際にいくつかの組み込みツールを提供しています。 +OpenAI は [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] 使用時にいくつかの組み込みツールを提供します。 -- [`WebSearchTool`][agents.tool.WebSearchTool] は エージェント に Web を検索させます。 -- [`FileSearchTool`][agents.tool.FileSearchTool] は OpenAI の ベクトルストア から情報を取得できます。 -- [`ComputerTool`][agents.tool.ComputerTool] は コンピュータ操作 の自動化を可能にします。 -- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] は LLM がサンドボックス環境でコードを実行できるようにします。 -- [`HostedMCPTool`][agents.tool.HostedMCPTool] はリモートの MCP サーバー のツールをモデルに公開します。 -- [`ImageGenerationTool`][agents.tool.ImageGenerationTool] はプロンプトから画像を生成します。 -- [`LocalShellTool`][agents.tool.LocalShellTool] はローカルマシン上でシェルコマンドを実行します。 +- [`WebSearchTool`][agents.tool.WebSearchTool]: エージェント が Web を検索できます。 +- [`FileSearchTool`][agents.tool.FileSearchTool]: OpenAI の ベクトルストア から情報を取得できます。 +- [`ComputerTool`][agents.tool.ComputerTool]: コンピュータ操作 タスクを自動化できます。 +- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool]: LLM がサンドボックス環境でコードを実行できます。 +- [`HostedMCPTool`][agents.tool.HostedMCPTool]: リモートの MCP サーバーのツールをモデルに公開します。 +- [`ImageGenerationTool`][agents.tool.ImageGenerationTool]: プロンプトから画像を生成します。 +- [`LocalShellTool`][agents.tool.LocalShellTool]: ローカル環境でシェルコマンドを実行します。 ```python from agents import Agent, FileSearchTool, Runner, WebSearchTool @@ -43,11 +43,11 @@ async def main(): ## 関数ツール -任意の Python 関数をツールとして使用できます。Agents SDK がツールの設定を自動で行います。 +任意の Python 関数をツールとして使用できます。Agents SDK がツールを自動セットアップします。 -- ツール名は Python 関数名になります（任意で名前を指定可能） -- ツールの説明は関数の docstring から取得します（任意で説明を指定可能） -- 関数入力のスキーマは、関数の引数から自動生成されます +- ツール名は Python 関数名になります（もしくは任意の名前を指定できます） +- ツールの説明は関数の docstring から取得します（もしくは説明を指定できます） +- 関数入力のスキーマは関数の引数から自動生成します - 各入力の説明は、無効化しない限り関数の docstring から取得します Python の `inspect` モジュールで関数シグネチャを抽出し、[`griffe`](https://mkdocstrings.github.io/griffe/) で docstring を解析、スキーマ作成には `pydantic` を使用します。 @@ -102,12 +102,12 @@ for tool in agent.tools: ``` -1. 関数の引数には任意の Python 型を使用でき、関数は同期/非同期どちらでも構いません。 -2. docstring があれば、ツールと引数の説明の取得に使用します。 -3. 関数は任意で `context` を受け取れます（最初の引数である必要があります）。ツール名や説明、docstring のスタイルなどのオーバーライドも設定できます。 -4. デコレートした関数をツールのリストに渡せます。 +1. 関数の引数として任意の Python 型を使用でき、関数は同期/非同期のいずれでも構いません。 +2. docstring があれば、説明および引数の説明に利用します。 +3. 関数はオプションで `context` を受け取れます（先頭の引数である必要があります）。ツール名、説明、docstring スタイルなどのオーバーライドも設定できます。 +4. デコレートされた関数を tools のリストに渡せます。 -??? note "Expand to see output" +??? note "出力を展開して表示" ``` fetch_weather @@ -177,22 +177,22 @@ for tool in agent.tools: } ``` -### 関数ツールからの画像やファイルの返却 +### 関数ツールからの画像またはファイルの返却 -テキスト出力に加えて、関数ツールの出力として 1 つまたは複数の画像やファイルを返すこともできます。次のいずれかを返せます。 +テキスト出力のほか、関数ツールの出力として 1 つまたは複数の画像やファイルを返すこともできます。次のいずれかを返せます。 - 画像: [`ToolOutputImage`][agents.tool.ToolOutputImage]（または TypedDict 版の [`ToolOutputImageDict`][agents.tool.ToolOutputImageDict]） - ファイル: [`ToolOutputFileContent`][agents.tool.ToolOutputFileContent]（または TypedDict 版の [`ToolOutputFileContentDict`][agents.tool.ToolOutputFileContentDict]） -- テキスト: 文字列または文字列化可能オブジェクト、または [`ToolOutputText`][agents.tool.ToolOutputText]（または TypedDict 版の [`ToolOutputTextDict`][agents.tool.ToolOutputTextDict]） +- テキスト: 文字列または文字列化可能なオブジェクト、または [`ToolOutputText`][agents.tool.ToolOutputText]（または TypedDict 版の [`ToolOutputTextDict`][agents.tool.ToolOutputTextDict]） ### カスタム関数ツール -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 文字列を受け取り、ツールの出力を文字列で返す非同期関数） +- `on_invoke_tool`（[`ToolContext`][agents.tool_context.ToolContext] と JSON 文字列の引数を受け取り、ツール出力の文字列を返す非同期関数） ```python from typing import Any @@ -227,16 +227,16 @@ tool = FunctionTool( ### 引数と docstring の自動解析 -前述のとおり、ツールのスキーマを抽出するために関数シグネチャを自動解析し、ツール本体と各引数の説明を抽出するために docstring を解析します。ポイントは次のとおりです。 +前述のとおり、ツールのスキーマを抽出するために関数シグネチャを自動解析し、ツールと各引数の説明を抽出するために docstring を解析します。注意点は次のとおりです。 -1. シグネチャ解析は `inspect` モジュールで行います。型アノテーションから引数の型を把握し、全体スキーマを表す Pydantic モデルを動的に構築します。Python の基本型、Pydantic モデル、TypedDict など、ほとんどの型をサポートします。 -2. docstring の解析には `griffe` を使用します。サポートする docstring 形式は `google`、`sphinx`、`numpy` です。docstring 形式は自動検出を試みますがベストエフォートのため、`function_tool` 呼び出し時に明示的に指定できます。`use_docstring_info` を `False` に設定すると docstring 解析を無効化できます。 +1. シグネチャ解析は `inspect` モジュールで行います。引数の型は型アノテーションから理解し、全体スキーマを表現する Pydantic モデルを動的に構築します。Python の基本型、Pydantic モデル、TypedDict など、ほとんどの型をサポートします。 +2. docstring の解析には `griffe` を使用します。サポートする docstring 形式は `google`、`sphinx`、`numpy` です。docstring 形式は自動検出を試みますがベストエフォートのため、`function_tool` 呼び出し時に明示的に指定できます。`use_docstring_info` を `False` に設定して docstring 解析を無効化することもできます。 スキーマ抽出のコードは [`agents.function_schema`][] にあります。 -## エージェントをツールとして使用 +## ツールとしての エージェント -一部のワークフローでは、ハンドオフ せずに中央の エージェント が専門特化した エージェント 群をオーケストレーションしたい場合があります。これは エージェント をツールとしてモデリングすることで実現できます。 +一部のワークフローでは、コントロールをハンドオフ せずに、中央の エージェント が専門 エージェント 群のネットワークをオーケストレーションしたいことがあります。エージェント をツールとしてモデリングすることでこれが可能です。 ```python from agents import Agent, Runner @@ -277,7 +277,7 @@ async def main(): ### ツール化したエージェントのカスタマイズ -`agent.as_tool` 関数は エージェント をツールに変換しやすくするための簡便メソッドです。ただし、すべての設定をサポートしているわけではありません。例えば `max_turns` は設定できません。高度なユースケースでは、ツール実装内で直接 `Runner.run` を使用してください。 +`agent.as_tool` 関数は、エージェント を簡単にツール化するためのユーティリティです。ただし、すべての設定をサポートしているわけではありません。たとえば、`max_turns` は設定できません。高度なユースケースでは、ツール実装内で直接 `Runner.run` を使用してください。 ```python @function_tool @@ -298,13 +298,13 @@ async def run_my_agent() -> str: ### カスタム出力抽出 -状況によっては、中央の エージェント に返す前にツール化した エージェント の出力を加工したいことがあります。例えば次のような場合に有用です。 +場合によっては、中央の エージェント に返す前に、ツール化した エージェント の出力を変更したいことがあります。次のような場合に有用です。 -- サブエージェントのチャット履歴から特定情報（例: JSON ペイロード）を抽出する。 +- サブエージェントのチャット履歴から特定の情報（例: JSON ペイロード）を抽出する。 - エージェント の最終回答を変換・再整形する（例: Markdown をプレーンテキストや CSV に変換）。 -- 出力を検証し、 エージェント の応答が欠落または不正な場合にフォールバック値を用意する。 +- 出力を検証し、 エージェント の応答が欠落または不正な場合にフォールバック値を提供する。 -これは `as_tool` メソッドに `custom_output_extractor` 引数を指定することで実現できます。 +これは `as_tool` メソッドに `custom_output_extractor` 引数を渡すことで実現できます。 ```python async def extract_json_payload(run_result: RunResult) -> str: @@ -325,7 +325,7 @@ json_tool = data_agent.as_tool( ### 条件付きツール有効化 -実行時に `is_enabled` パラメーター を使って エージェント ツールを条件付きで有効化/無効化できます。これにより、コンテキスト、ユーザー の嗜好、実行時条件に基づいて、LLM が利用可能なツールを動的にフィルタリングできます。 +実行時に `is_enabled` パラメーターを使って、エージェント ツールを条件付きで有効化・無効化できます。これにより、コンテキスト、ユーザー の設定、実行時の条件に基づいて、LLM に利用可能なツールを動的にフィルタリングできます。 ```python import asyncio @@ -380,26 +380,26 @@ async def main(): asyncio.run(main()) ``` -`is_enabled` パラメーター は次を受け付けます。 +`is_enabled` パラメーターは次を受け付けます。 -- **Boolean values**: `True`（常に有効）または `False`（常に無効） -- **Callable functions**: `(context, agent)` を受け取り boolean を返す関数 -- **Async functions**: 複雑な条件ロジック向けの非同期関数 +- **ブーリアン値**: `True`（常に有効）または `False`（常に無効） +- **呼び出し可能関数**: `(context, agent)` を受け取り、ブーリアンを返す関数 +- **非同期関数**: 複雑な条件ロジック向けの async 関数 -無効化されたツールは実行時に LLM から完全に隠されるため、次の用途に役立ちます。 +無効化されたツールは実行時に LLM から完全に隠されるため、次の用途に便利です。 -- ユーザー 権限に基づく機能ゲーティング -- 環境別のツール可用性（dev と prod） -- ツール構成の A/B テスト +- ユーザー 権限に基づく機能のゲーティング +- 環境別のツール可用性（開発 vs 本番） +- 異なるツール構成の A/B テスト - 実行時状態に基づく動的ツールフィルタリング ## 関数ツールでのエラー処理 -`@function_tool` で関数ツールを作成する際、`failure_error_function` を渡せます。これは、ツール呼び出しがクラッシュした場合に LLM にエラーレスポンスを提供する関数です。 +`@function_tool` で関数ツールを作成する際、`failure_error_function` を渡せます。これは、ツール呼び出しがクラッシュした場合に LLM へ返すエラー応答を提供する関数です。 -- 既定（何も渡さない場合）は、エラーが発生したことを LLM に伝える `default_tool_error_function` が実行されます。 -- 独自のエラー関数を渡した場合はそれが実行され、そのレスポンスが LLM に送信されます。 -- 明示的に `None` を渡した場合、ツール呼び出しエラーは再スローされ、呼び出し側で処理することになります。これは、モデルが不正な JSON を生成した場合の `ModelBehaviorError`、あなたのコードがクラッシュした場合の `UserError` などになり得ます。 +- 既定では（何も渡さない場合）、`default_tool_error_function` が実行され、エラーが発生したことを LLM に伝えます。 +- 独自のエラー関数を渡すと、それが代わりに実行され、その応答が LLM に送られます。 +- 明示的に `None` を渡した場合、ツール呼び出しエラーは再送出され、呼び出し側で処理する必要があります。モデルが不正な JSON を生成した場合は `ModelBehaviorError`、コードがクラッシュした場合は `UserError` などになり得ます。 ```python from agents import function_tool, RunContextWrapper diff --git a/docs/ja/tracing.md b/docs/ja/tracing.md index f3efe8609..dae15e058 100644 --- a/docs/ja/tracing.md +++ b/docs/ja/tracing.md @@ -4,52 +4,52 @@ search: --- # トレーシング -Agents SDK には組み込みのトレーシングが含まれており、エージェントの実行中に発生するイベントの包括的な記録を収集します。LLM 生成、ツール呼び出し、ハンドオフ、ガードレール、さらにはカスタムイベントまで記録します。[Traces ダッシュボード](https://platform.openai.com/traces)を使用すると、開発中および本番環境でワークフローをデバッグ、可視化、監視できます。 +Agents SDK には組み込みのトレーシングが含まれており、エージェント実行中に発生するイベントの包括的な記録（ LLM の生成、ツール呼び出し、ハンドオフ、ガードレール、さらにはカスタムイベント）を収集します。 [Traces ダッシュボード](https://platform.openai.com/traces) を使って、開発時および本番環境でワークフローをデバッグ、可視化、監視できます。 !!!note - トレーシングはデフォルトで有効です。トレーシングを無効化する方法は 2 つあります: + トレーシングはデフォルトで有効です。トレーシングを無効にする方法は 2 通りあります: 1. 環境変数 `OPENAI_AGENTS_DISABLE_TRACING=1` を設定して、トレーシングをグローバルに無効化できます - 2. 1 回の実行についてのみ、[`agents.run.RunConfig.tracing_disabled`][] を `True` に設定して無効化できます + 2. 1 回の実行に対してトレーシングを無効化するには、[`agents.run.RunConfig.tracing_disabled`][] を `True` に設定します -***OpenAI の API を使用し Zero Data Retention (ZDR) ポリシーの下で運用している組織では、トレーシングは使用できません。*** +***OpenAI の API を利用し Zero Data Retention (ZDR) ポリシーで運用している組織では、トレーシングは利用できません。*** ## トレースとスパン -- **トレース** は「ワークフロー」の単一のエンドツーエンド処理を表します。スパンで構成されます。トレースには次のプロパティがあります: - - `workflow_name`: 論理的なワークフローまたはアプリ名です。例: "Code generation" や "Customer service" - - `trace_id`: トレースの一意の ID。渡さない場合は自動生成されます。`trace_<32_alphanumeric>` の形式である必要があります - - `group_id`: 同じ会話からの複数のトレースを紐づけるための任意のグループ ID。たとえばチャットスレッド ID など - - `disabled`: True の場合、そのトレースは記録されません - - `metadata`: トレース用の任意のメタデータ -- **スパン** は開始時刻と終了時刻を持つ操作を表します。スパンには次の情報があります: - - `started_at` と `ended_at` のタイムスタンプ - - 所属するトレースを示す `trace_id` - - 親スパンを指す `parent_id`（ある場合） - - スパンに関する情報である `span_data`。たとえば、`AgentSpanData` はエージェントに関する情報、`GenerationSpanData` は LLM 生成に関する情報を含みます +- **トレース** は「ワークフロー」の単一のエンドツーエンド操作を表します。複数のスパンで構成されます。トレースには次のプロパティがあります: + - `workflow_name`: 論理的なワークフローまたはアプリです。例: "Code generation" や "Customer service" + - `trace_id`: トレースの一意な ID。渡さない場合は自動生成されます。形式は `trace_<32_alphanumeric>` である必要があります。 + - `group_id`: 同一の会話からの複数トレースをリンクするための任意のグループ ID。たとえばチャットスレッド ID を使用できます。 + - `disabled`: True の場合、このトレースは記録されません。 + - `metadata`: トレースの任意のメタデータ。 +- **スパン** は開始時刻と終了時刻を持つ操作を表します。スパンには次の情報があります: + - `started_at` と `ended_at` のタイムスタンプ + - `trace_id`（所属するトレースを表す） + - `parent_id`（このスパンの親スパンを指す。存在する場合） + - `span_data`（スパンに関する情報）。たとえば、`AgentSpanData` にはエージェントに関する情報が、`GenerationSpanData` には LLM 生成に関する情報などが含まれます。 ## デフォルトのトレーシング -デフォルトで、SDK は次をトレースします: +デフォルトでは、 SDK は以下をトレースします: -- 全体の `Runner.{run, run_sync, run_streamed}()` は `trace()` でラップされます -- エージェントが実行されるたびに、`agent_span()` でラップされます -- LLM 生成は `generation_span()` でラップされます -- 関数ツールの呼び出しはそれぞれ `function_span()` でラップされます -- ガードレールは `guardrail_span()` でラップされます -- ハンドオフは `handoff_span()` でラップされます -- 音声入力（音声認識）は `transcription_span()` でラップされます -- 音声出力（テキスト読み上げ）は `speech_span()` でラップされます -- 関連する音声スパンは `speech_group_span()` の下に親子付けされる場合があります +- 全体の `Runner.{run, run_sync, run_streamed}()` は `trace()` でラップされます。 +- エージェントが実行されるたびに `agent_span()` でラップされます +- LLM の生成は `generation_span()` でラップされます +- 関数ツール呼び出しはそれぞれ `function_span()` でラップされます +- ガードレールは `guardrail_span()` でラップされます +- ハンドオフは `handoff_span()` でラップされます +- 音声入力（音声からテキスト）は `transcription_span()` でラップされます +- 音声出力（テキストから音声）は `speech_span()` でラップされます +- 関連する音声スパンは `speech_group_span()` の下にネストされる場合があります -デフォルトでは、トレース名は "Agent workflow" です。`trace` を使用してこの名前を設定できますし、[`RunConfig`][agents.run.RunConfig] を使って名前やその他のプロパティを設定することもできます。 +デフォルトでは、トレース名は "Agent workflow" です。`trace` を使用する場合はこの名前を設定できますし、[`RunConfig`][agents.run.RunConfig] で名前やその他のプロパティを構成することもできます。 -さらに、[カスタム トレース プロセッサー](#custom-tracing-processors) を設定して、別の宛先へ（置き換え、または副次的な宛先として）トレースを送信できます。 +さらに、[カスタムトレースプロセッサー](#custom-tracing-processors) を設定して、トレースを別の宛先に送信（置き換え、またはセカンダリの宛先として）できます。 ## 上位レベルのトレース -ときどき、複数回の `run()` 呼び出しを単一のトレースに含めたいことがあります。これはコード全体を `trace()` でラップすることで実現できます。 +`run()` への複数回の呼び出しを 1 つのトレースにまとめたい場合があります。その場合は、コード全体を `trace()` でラップします。 ```python from agents import Agent, Runner, trace @@ -64,46 +64,47 @@ async def main(): print(f"Rating: {second_result.final_output}") ``` -1. `Runner.run` への 2 回の呼び出しが `with trace()` でラップされているため、個々の実行は 2 つのトレースを作成するのではなく、全体のトレースの一部になります。 +1. 2 回の `Runner.run` 呼び出しが `with trace()` でラップされているため、個々の実行は 2 つのトレースを作成するのではなく、全体のトレースの一部になります。 ## トレースの作成 -[`trace()`][agents.tracing.trace] 関数を使ってトレースを作成できます。トレースは開始と終了が必要です。方法は 2 つあります: +[`trace()`][agents.tracing.trace] 関数を使用してトレースを作成できます。トレースは開始と終了が必要です。方法は 2 つあります: -1. 推奨: トレースをコンテキストマネージャとして使用します（例: `with trace(...) as my_trace`）。これにより適切なタイミングでトレースの開始と終了が自動化されます。 +1. 推奨: トレースをコンテキストマネージャーとして使用します（例: `with trace(...) as my_trace`）。これにより、適切なタイミングで自動的に開始・終了します。 2. [`trace.start()`][agents.tracing.Trace.start] と [`trace.finish()`][agents.tracing.Trace.finish] を手動で呼び出すこともできます。 -現在のトレースは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) を通じて追跡されます。これにより自動的に並行処理で機能します。トレースを手動で開始/終了する場合、現在のトレースを更新するために `start()`/`finish()` に `mark_as_current` と `reset_current` を渡す必要があります。 +現在のトレースは Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) を介して追跡されます。これは自動的に並行処理で動作することを意味します。トレースを手動で開始・終了する場合、現在のトレースを更新するために `start()`/`finish()` に `mark_as_current` と `reset_current` を渡す必要があります。 ## スパンの作成 -さまざまな [`*_span()`][agents.tracing.create] メソッドを使ってスパンを作成できます。一般に、スパンを手動で作成する必要はありません。カスタムのスパン情報を追跡するために [`custom_span()`][agents.tracing.custom_span] 関数を使用できます。 +各種の [`*_span()`][agents.tracing.create] メソッドを使ってスパンを作成できます。一般に、スパンを手動で作成する必要はありません。カスタムスパン情報を追跡するために [`custom_span()`][agents.tracing.custom_span] 関数を利用できます。 スパンは自動的に現在のトレースの一部となり、Python の [`contextvar`](https://docs.python.org/3/library/contextvars.html) によって追跡される、最も近い現在のスパンの下にネストされます。 -## 機微なデータ +## 機微データ -一部のスパンは機微なデータを取得する可能性があります。 +一部のスパンは、機微なデータを含む可能性があります。 -`generation_span()` は LLM 生成の入力/出力を保存し、`function_span()` は関数呼び出しの入力/出力を保存します。これらには機微なデータが含まれる場合があるため、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] を使用してそのデータの取得を無効化できます。 +`generation_span()` は LLM 生成の入力/出力を保存し、`function_span()` は関数呼び出しの入力/出力を保存します。これらに機微なデータが含まれる可能性があるため、[`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] によって、そのデータの収集を無効化できます。 -同様に、音声スパンにはデフォルトで入出力音声の base64 エンコードされた PCM データが含まれます。[`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] を設定して、この音声データの取得を無効化できます。 +同様に、音声スパンはデフォルトで、入力および出力音声に対する base64 エンコード済みの PCM データを含みます。[`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] を構成して、この音声データの収集を無効化できます。 -## カスタム トレーシング プロセッサー +## カスタムトレーシングプロセッサー -トレーシングの高レベルなアーキテクチャは次のとおりです: +トレーシングのハイレベルなアーキテクチャは次のとおりです: -- 初期化時に、トレースを作成する役割を持つグローバルな [`TraceProvider`][agents.tracing.setup.TraceProvider] を作成します。 -- `TraceProvider` に [`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] を設定し、トレース/スパンをバッチで [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] に送信します。Exporter はスパンとトレースをバッチで OpenAI のバックエンドにエクスポートします。 +- 初期化時に、トレースの作成を担うグローバルな [`TraceProvider`][agents.tracing.setup.TraceProvider] を作成します。 +- `TraceProvider` を、スパン/トレースをバッチで [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] に送信する [`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] で構成します。`BackendSpanExporter` はスパンとトレースを OpenAI バックエンドにバッチでエクスポートします。 -このデフォルト設定をカスタマイズし、別のバックエンドへの送信や追加のバックエンドへの送信、あるいは Exporter の動作を変更するには、次の 2 つの方法があります: +このデフォルト構成をカスタマイズして、別のバックエンドへの送信、追加のバックエンドへの複製、またはエクスポーターの動作変更を行うには、次の 2 通りの方法があります: -1. [`add_trace_processor()`][agents.tracing.add_trace_processor] は、トレースやスパンが準備でき次第受け取る、追加のトレース プロセッサーを追加できます。これにより、OpenAI のバックエンドへの送信に加えて独自の処理を実施できます。 -2. [`set_trace_processors()`][agents.tracing.set_trace_processors] は、デフォルトのプロセッサーを独自のトレース プロセッサーに置き換えることができます。つまり、OpenAI のバックエンドにトレースが送信されるのは、送信を行う `TracingProcessor` を含めた場合に限られます。 +1. [`add_trace_processor()`][agents.tracing.add_trace_processor] は、スパン/トレースが準備でき次第受け取る、**追加の** トレースプロセッサーを追加できます。これにより、 OpenAI のバックエンドへの送信に加えて、独自の処理を実行できます。 +2. [`set_trace_processors()`][agents.tracing.set_trace_processors] は、デフォルトのプロセッサーを独自のトレースプロセッサーで**置き換え**られます。これは、 OpenAI バックエンドに送信する `TracingProcessor` を含めない限り、トレースが OpenAI バックエンドへ送られないことを意味します。 -## OpenAI 以外のモデルでのトレーシング -OpenAI の API キーを、OpenAI 以外のモデルとともに使用して、トレーシングを無効化することなく OpenAI Traces ダッシュボードで無料のトレーシングを有効にできます。 +## OpenAI 以外のモデルとのトレーシング + +OpenAI の API キーを、 OpenAI 以外のモデルと併用しても、トレーシングを無効化する必要なく、 OpenAI Traces ダッシュボードで無料のトレーシングを有効にできます。 ```python import os @@ -124,28 +125,29 @@ agent = Agent( ) ``` -## 注意 -- 無料のトレースは OpenAI Traces ダッシュボードで表示できます。 - -## 外部トレーシング プロセッサー一覧 - -- [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) -- [Agenta](https://docs.agenta.ai/observability/integrations/openai-agents) \ No newline at end of file +## メモ +- 無料のトレースは OpenAI Traces ダッシュボードで確認できます。 + + +## 外部トレーシングプロセッサー一覧 + +- [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) +- [Agenta](https://docs.agenta.ai/observability/integrations/openai-agents) \ No newline at end of file diff --git a/docs/ja/usage.md b/docs/ja/usage.md index fc36165e0..21d0ea862 100644 --- a/docs/ja/usage.md +++ b/docs/ja/usage.md @@ -4,21 +4,22 @@ search: --- # 使用状況 -Agents SDK は、すべての run の token 使用状況を自動的に追跡します。run コンテキストからアクセスでき、コストの監視、制限の適用、分析の記録に利用できます。 +Agents SDK は各実行ごとにトークン使用状況を自動的に追跡します。実行コンテキストから参照でき、コストの監視、制限の適用、分析の記録に利用できます。 ## 追跡対象 -- **requests**: 実行された LLM API 呼び出し数 -- **input_tokens**: 送信された入力 token の合計 -- **output_tokens**: 受信した出力 token の合計 +- **requests**: LLM API 呼び出し数 +- **input_tokens**: 送信された入力トークン合計 +- **output_tokens**: 受信した出力トークン合計 - **total_tokens**: 入力 + 出力 +- **request_usage_entries**: リクエストごとの使用状況の内訳リスト - **details**: - `input_tokens_details.cached_tokens` - `output_tokens_details.reasoning_tokens` -## 実行からの使用状況の取得 +## 実行からの使用状況へのアクセス -`Runner.run(...)` の後、`result.context_wrapper.usage` から使用状況にアクセスします。 +`Runner.run(...)` の後、 `result.context_wrapper.usage` から使用状況にアクセスします。 ```python result = await Runner.run(agent, "What's the weather in Tokyo?") @@ -30,11 +31,11 @@ print("Output tokens:", usage.output_tokens) print("Total tokens:", usage.total_tokens) ``` -使用状況は、実行中のすべてのモデル呼び出し（ツール呼び出しや handoffs を含む）にわたって集計されます。 +使用状況は、実行中のすべてのモデル呼び出し（ツール呼び出しやハンドオフを含む）にわたって集計されます。 ### LiteLLM モデルでの使用状況の有効化 -LiteLLM プロバイダーは、デフォルトでは使用状況メトリクスを報告しません。[`LitellmModel`](models/litellm.md) を使用する場合は、`ModelSettings(include_usage=True)` をエージェントに渡して、LiteLLM のレスポンスが `result.context_wrapper.usage` を埋めるようにします。 +LiteLLM プロバイダーはデフォルトで使用メトリクスを報告しません。[`LitellmModel`](models/litellm.md) を使用する場合は、エージェントに `ModelSettings(include_usage=True)` を渡して、LiteLLM のレスポンスが `result.context_wrapper.usage` に反映されるようにします。 ```python from agents import Agent, ModelSettings, Runner @@ -50,9 +51,20 @@ result = await Runner.run(agent, "What's the weather in Tokyo?") print(result.context_wrapper.usage.total_tokens) ``` -## セッションでの使用状況の取得 +## リクエスト単位の使用状況トラッキング -`Session`（例: `SQLiteSession`）を使用する場合、`Runner.run(...)` の各呼び出しは、その実行に固有の使用状況を返します。セッションはコンテキスト用に会話履歴を保持しますが、各実行の使用状況は独立しています。 +SDK は各 API リクエストの使用状況を `request_usage_entries` に自動追跡します。詳細なコスト計算やコンテキストウィンドウ消費の監視に便利です。 + +```python +result = await Runner.run(agent, "What's the weather in Tokyo?") + +for request in enumerate(result.context_wrapper.usage.request_usage_entries): + print(f"Request {i + 1}: {request.input_tokens} in, {request.output_tokens} out") +``` + +## セッションでの使用状況へのアクセス + +`Session`（例: `SQLiteSession`）を使用する場合、`Runner.run(...)` の各呼び出しはその実行に固有の使用状況を返します。セッションはコンテキスト用に会話履歴を保持しますが、各実行の使用状況は独立しています。 ```python session = SQLiteSession("my_conversation") @@ -64,11 +76,11 @@ second = await Runner.run(agent, "Can you elaborate?", session=session) print(second.context_wrapper.usage.total_tokens) # Usage for second run ``` -セッションは実行間で会話コンテキストを保持しますが、各 `Runner.run()` 呼び出しで返される使用状況メトリクスは、その実行のみを表します。セッションでは、前のメッセージが各実行に入力として再供給される場合があり、その結果、次のターンの入力 token 数に影響します。 +セッションは実行間で会話コンテキストを保持しますが、各 `Runner.run()` 呼び出しで返される使用メトリクスはその実行結果にのみ対応します。セッションでは、前のメッセージが各実行に入力として再投入される場合があり、その結果、後続のターンで入力トークン数に影響します。 ## フックでの使用状況の利用 -`RunHooks` を使用している場合、各フックに渡される `context` オブジェクトには `usage` が含まれます。これにより、重要なライフサイクルのタイミングで使用状況を記録できます。 +`RunHooks` を使用している場合、各フックに渡される `context` オブジェクトには `usage` が含まれます。これにより、重要なライフサイクル時点で使用状況を記録できます。 ```python class MyHooks(RunHooks): @@ -79,8 +91,9 @@ class MyHooks(RunHooks): ## API リファレンス -詳細な API ドキュメントは次を参照してください: +詳細な API ドキュメントは以下をご参照ください。 -- [`Usage`][agents.usage.Usage] - 使用状況の追跡データ構造 -- [`RunContextWrapper`][agents.run.RunContextWrapper] - 実行コンテキストから使用状況にアクセス -- [`RunHooks`][agents.run.RunHooks] - 使用状況トラッキングのライフサイクルにフック \ No newline at end of file +- [`Usage`][agents.usage.Usage] - 使用状況トラッキングのデータ構造 +- [`RequestUsage`][agents.usage.RequestUsage] - リクエストごとの使用状況の詳細 +- [`RunContextWrapper`][agents.run.RunContextWrapper] - 実行コンテキストから使用状況へアクセス +- [`RunHooks`][agents.run.RunHooks] - 使用状況トラッキングのライフサイクルにフック \ No newline at end of file diff --git a/docs/ja/visualization.md b/docs/ja/visualization.md index cc466b47f..30469a980 100644 --- a/docs/ja/visualization.md +++ b/docs/ja/visualization.md @@ -4,7 +4,7 @@ search: --- # エージェントの可視化 -エージェントの可視化では、 **Graphviz** を使用してエージェントとその関係の構造化されたグラフィカル表現を生成できます。これは、アプリケーション内でエージェント、ツール、ハンドオフがどのように相互作用するかを理解するのに役立ちます。 +エージェントの可視化では、 **Graphviz** を使用してエージェントとその関係の構造化されたグラフィカル表現を生成できます。これは、アプリケーション内でエージェント、ツール、ハンドオフがどのように連携するかを理解するのに役立ちます。 ## インストール @@ -18,10 +18,10 @@ pip install "openai-agents[viz]" `draw_graph` 関数を使用してエージェントの可視化を生成できます。この関数は次のような有向グラフを作成します: -- **エージェント** は黄色のボックスで表されます。 -- **MCP サーバー** は灰色のボックスで表されます。 -- **ツール** は緑色の楕円で表されます。 -- **ハンドオフ** はあるエージェントから別のエージェントへの有向エッジで表されます。 +- **エージェント** は黄色のボックスで表現されます。 +- **MCP サーバー** は灰色のボックスで表現されます。 +- **ツール** は緑の楕円で表現されます。 +- **ハンドオフ** はあるエージェントから別のエージェントへの有向エッジです。 ### 使用例 @@ -67,32 +67,32 @@ triage_agent = Agent( draw_graph(triage_agent) ``` -![エージェントのグラフ](../assets/images/graph.png) +![Agent Graph](../assets/images/graph.png) -これは、 **triage agent** の構造と、サブエージェントやツールへの接続を視覚的に表すグラフを生成します。 +これは、 **トリアージ エージェント** の構造と、そのサブエージェントやツールとの接続を視覚的に表現するグラフを生成します。 ## 可視化の理解 -生成されたグラフには以下が含まれます: +生成されるグラフには次が含まれます: - エントリーポイントを示す **開始ノード** (`__start__`)。 -- 黄色で塗りつぶされた **長方形** で表されるエージェント。 -- 緑で塗りつぶされた **楕円** で表されるツール。 -- 灰色で塗りつぶされた **長方形** で表される MCP サーバー。 +- 黄色で塗りつぶされた **長方形** で表現されるエージェント。 +- 緑で塗りつぶされた **楕円** で表現されるツール。 +- 灰色で塗りつぶされた **長方形** で表現される MCP サーバー。 - 相互作用を示す有向エッジ: - - エージェント間のハンドオフには **実線矢印**。 - - ツール呼び出しには **点線矢印**。 - - MCP サーバー呼び出しには **破線矢印**。 -- 実行の終了地点を示す **終了ノード** (`__end__`)。 + - エージェント間のハンドオフを表す **実線の矢印**。 + - ツール呼び出しを表す **点線の矢印**。 + - MCP サーバー呼び出しを表す **破線の矢印**。 +- 実行が終了する箇所を示す **終了ノード** (`__end__`)。 **注:** MCP サーバーは最近のバージョンの -`agents` パッケージ（ **v0.2.8** で確認済み）でレンダリングされます。可視化に MCP のボックスが表示されない場合は、最新リリースにアップグレードしてください。 +`agents` パッケージでレンダリングされます (検証済み: **v0.2.8** )。可視化に MCP のボックスが表示されない場合は、最新リリースにアップグレードしてください。 ## グラフのカスタマイズ ### グラフの表示 -デフォルトでは、`draw_graph` はグラフをインライン表示します。別ウィンドウで表示するには次のようにします: +デフォルトでは、`draw_graph` はグラフをインライン表示します。別ウィンドウで表示するには、次のように記述します: ```python draw_graph(triage_agent).view() diff --git a/docs/ja/voice/pipeline.md b/docs/ja/voice/pipeline.md index dc71d8ae9..576a518da 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,28 +34,28 @@ graph LR ## パイプラインの設定 -パイプライン作成時には、次の項目を設定できます。 +パイプラインを作成するとき、次の項目を設定できます。 1. 新しい音声が文字起こしされるたびに実行されるコードである [`workflow`][agents.voice.workflow.VoiceWorkflowBase] 2. 使用する [`speech-to-text`][agents.voice.model.STTModel] と [`text-to-speech`][agents.voice.model.TTSModel] のモデル -3. 次のような設定を可能にする [`config`][agents.voice.pipeline_config.VoicePipelineConfig] +3. 次のような設定を行える [`config`][agents.voice.pipeline_config.VoicePipelineConfig] - モデル名をモデルにマッピングできるモデルプロバイダー - - トレーシング（トレーシングの無効化可否、音声ファイルのアップロード可否、ワークフロー名、trace 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] は、ユーザーの発話終了を検出する必要がある場合に使用します。検出された音声チャンクをプッシュでき、音声パイプラインは「アクティビティ検出」と呼ばれる処理によって、適切なタイミングで自動的にエージェントのワークフローを実行します。 +1. [`AudioInput`][agents.voice.input.AudioInput] は、完全な音声の書き起こしがあり、その結果だけを生成したい場合に使います。これは、話者が話し終えたタイミングの検出が不要なケース、たとえば事前録音の音声や、ユーザーの発話終了が明確なプッシュ・トゥ・トーク アプリで有用です。 +2. [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput] は、ユーザーの発話終了の検出が必要な場合に使います。検出された音声チャンクを順次プッシュでき、ボイスパイプラインが「アクティビティ検出 (activity detection)」と呼ばれるプロセスにより、適切なタイミングで自動的にエージェントのワークフローを実行します。 ## 結果 -音声パイプライン実行の結果は [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult] です。これは、発生したイベントをストリーミングできるオブジェクトです。いくつかの種類の [`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] があり、次を含みます。 +ボイスパイプライン実行の結果は [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult] です。これは、発生したイベントをストリーミングで受け取れるオブジェクトです。いくつかの種類の [`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] があり、次を含みます。 1. 音声チャンクを含む [`VoiceStreamEventAudio`][agents.voice.events.VoiceStreamEventAudio] -2. ターンの開始や終了といったライフサイクルイベントを通知する [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle] +2. ターンの開始や終了などのライフサイクルイベントを知らせる [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle] 3. エラーイベントである [`VoiceStreamEventError`][agents.voice.events.VoiceStreamEventError] ```python @@ -76,4 +76,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 44d6bd42a..de67b84e0 100644 --- a/docs/ja/voice/quickstart.md +++ b/docs/ja/voice/quickstart.md @@ -6,7 +6,7 @@ search: ## 前提条件 -ベースの [クイックスタート手順](../quickstart.md)（ Agents SDK 用）に従い、仮想環境をセットアップしてください。次に、 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. 音声をテキストに変換するために音声認識モデルを実行します。 +2. 通常はエージェント的なワークフローであるあなたのコードを実行して、結果を生成します。 +3. 結果のテキストを音声に戻すために音声合成モデルを実行します。 ```mermaid graph LR @@ -48,7 +48,7 @@ graph LR ## エージェント -まず、いくつかのエージェントをセットアップします。これは、この SDK でエージェントを作成したことがある場合は馴染みがあるはずです。今回は複数のエージェント、ハンドオフ、そして 1 つのツールを用意します。 +まず、いくつかのエージェントを設定します。これは、この SDK でエージェントを作成したことがあれば馴染みのあるはずです。ここでは、複数のエージェント、ハンドオフ、そして 1 つのツールを用意します。 ```python import asyncio @@ -92,7 +92,7 @@ agent = Agent( ## 音声パイプライン -[`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow] をワークフローとして使用し、シンプルな音声パイプラインをセットアップします。 +ワークフローとして [`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow] を使って、簡単な音声パイプラインを設定します。 ```python from agents.voice import SingleAgentVoiceWorkflow, VoicePipeline @@ -124,7 +124,7 @@ async for event in result.stream(): ``` -## まとめて実行 +## 統合 ```python import asyncio @@ -195,4 +195,4 @@ if __name__ == "__main__": asyncio.run(main()) ``` -このサンプルを実行すると、エージェントがあなたに話しかけます。自分でエージェントと会話できるデモは [examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static) をご覧ください。 \ No newline at end of file +この例を実行すると、エージェントがあなたに話しかけます。[examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static) の例を確認して、実際に自分でエージェントに話しかけられるデモをご覧ください。 \ No newline at end of file diff --git a/docs/ja/voice/tracing.md b/docs/ja/voice/tracing.md index 9d74081f3..c16aff5a7 100644 --- a/docs/ja/voice/tracing.md +++ b/docs/ja/voice/tracing.md @@ -4,15 +4,15 @@ search: --- # トレーシング -[エージェントのトレーシング](../tracing.md) と同様に、音声パイプラインも自動的にトレーシングされます。 +[エージェントがトレースされる方法](../tracing.md) と同様に、音声パイプラインも自動的にトレースされます。 -基本的なトレーシング情報については上記のドキュメントをご確認ください。加えて、[`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig] を使ってパイプラインのトレーシングを設定できます。 +基本的なトレーシング情報は上記のトレーシングのドキュメントをご参照ください。加えて、[`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig] でパイプラインのトレーシングを構成できます。 -トレーシングに関係する主なフィールドは次のとおりです。 +トレーシング関連の主なフィールドは次のとおりです: -- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: トレーシングを無効化するかを制御します。デフォルトではトレーシングは有効です。 -- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: 音声書き起こしなど、機密となり得るデータをトレースに含めるかを制御します。これは音声パイプライン専用で、ワークフロー内部で行われることには適用されません。 -- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]: 音声データをトレースに含めるかを制御します。 +- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: トレーシングを無効化するかどうかを制御します。デフォルトではトレーシングは有効です。 +- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: トレースに音声書き起こしなどの機微なデータを含めるかどうかを制御します。これは特に音声パイプライン向けの設定であり、ワークフロー内部で行われる処理には適用されません。 +- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]: トレースに音声データを含めるかどうかを制御します。 - [`workflow_name`][agents.voice.pipeline_config.VoicePipelineConfig.workflow_name]: トレースのワークフロー名です。 -- [`group_id`][agents.voice.pipeline_config.VoicePipelineConfig.group_id]: 複数のトレースをリンクできる、トレースの `group_id` です。 +- [`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 diff --git a/docs/ko/agents.md b/docs/ko/agents.md index 6f5f124d3..69f89a766 100644 --- a/docs/ko/agents.md +++ b/docs/ko/agents.md @@ -4,16 +4,16 @@ search: --- # 에이전트 -에이전트는 앱의 핵심 구성 요소입니다. 에이전트는 instructions와 tools로 구성된 대규모 언어 모델(LLM)입니다. +에이전트는 앱의 핵심 빌딩 블록입니다. 에이전트는 instructions 와 tools 로 구성된 대규모 언어 모델(LLM)입니다. ## 기본 구성 -에이전트에서 가장 자주 설정하는 속성은 다음과 같습니다: +에이전트를 구성할 때 가장 자주 사용하는 속성은 다음과 같습니다: - `name`: 에이전트를 식별하는 필수 문자열 -- `instructions`: developer message 또는 시스템 프롬프트로도 알려져 있음 -- `model`: 사용할 LLM과 temperature, top_p 등 모델 튜닝 매개변수를 설정하는 선택적 `model_settings` -- `tools`: 에이전트가 작업을 수행할 때 사용할 도구 +- `instructions`: developer message 또는 system prompt 라고도 함 +- `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 @@ -50,9 +50,9 @@ agent = Agent[UserContext]( ) ``` -## 출력 타입 +## 출력 유형 -기본적으로 에이전트는 일반 텍스트(예: `str`) 출력을 생성합니다. 특정 타입의 출력을 원한다면 `output_type` 매개변수를 사용할 수 있습니다. 일반적인 선택은 [Pydantic](https://docs.pydantic.dev/) 객체이지만, Pydantic [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/)로 래핑할 수 있는 모든 타입을 지원합니다. 예: dataclasses, lists, TypedDict 등 +기본적으로 에이전트는 일반 텍스트(즉, `str`) 출력을 생성합니다. 특정 유형의 출력을 원한다면 `output_type` 매개변수를 사용할 수 있습니다. 일반적으로는 [Pydantic](https://docs.pydantic.dev/) 객체를 많이 사용하지만, Pydantic [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) 로 래핑할 수 있는 모든 타입 — dataclass, list, TypedDict 등 — 을 지원합니다. ```python from pydantic import BaseModel @@ -73,20 +73,20 @@ agent = Agent( !!! note - `output_type`을 전달하면, 모델이 일반 텍스트 응답 대신 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs)을 사용하도록 지시합니다. + `output_type`을 전달하면, 모델은 일반 텍스트 응답 대신 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs)을 사용하게 됩니다. -## 멀티 에이전트 시스템 디자인 패턴 +## 멀티 에이전트 시스템 설계 패턴 멀티 에이전트 시스템을 설계하는 방법은 다양하지만, 일반적으로 다음 두 가지 패턴이 널리 적용됩니다: -1. 매니저(도구로서의 에이전트): 중앙 매니저/오케스트레이터가 특화된 하위 에이전트를 도구처럼 호출하며 대화의 주도권을 유지 -2. 핸드오프: 동등한 에이전트 간에 대화를 특화된 에이전트로 넘겨, 해당 에이전트가 대화를 이어받는 분산형 패턴 +1. 매니저(에이전트를 도구로 사용): 중앙 매니저/오케스트레이터가 전문화된 하위 에이전트를 도구처럼 호출하며 대화를 계속 주도 +2. 핸드오프: 동등한 에이전트 간에 제어권을 전문 에이전트로 넘겨 대화를 이어감. 분산형 패턴 -자세한 내용은 [에이전트 구축 실용 가이드](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf)를 참고하세요. +자세한 내용은 [에이전트 구축을 위한 실용 가이드](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf)를 참고하세요. -### 매니저(도구로서의 에이전트) +### 매니저(에이전트를 도구로 사용) -`customer_facing_agent`가 모든 사용자 상호작용을 처리하고, 도구로 노출된 특화 하위 에이전트를 호출합니다. 자세한 내용은 [도구](tools.md#agents-as-tools) 문서를 참고하세요. +`customer_facing_agent`는 모든 사용자 상호작용을 처리하고 도구로 노출된 전문 하위 에이전트를 호출합니다. 자세한 내용은 [tools](tools.md#agents-as-tools) 문서를 참고하세요. ```python from agents import Agent @@ -115,7 +115,7 @@ customer_facing_agent = Agent( ### 핸드오프 -핸드오프는 에이전트가 위임할 수 있는 하위 에이전트입니다. 핸드오프가 발생하면 위임받은 에이전트가 대화 기록을 넘겨받아 대화를 이어받습니다. 이 패턴은 단일 작업에 뛰어난 모듈식 특화 에이전트를 가능하게 합니다. 자세한 내용은 [핸드오프](handoffs.md) 문서를 참고하세요. +핸드오프는 에이전트가 위임할 수 있는 하위 에이전트입니다. 핸드오프가 발생하면 위임받은 에이전트가 대화 이력을 받아 대화를 이어갑니다. 이 패턴은 단일 작업에 특화된 모듈식, 전문형 에이전트를 가능하게 합니다. 자세한 내용은 [handoffs](handoffs.md) 문서를 참고하세요. ```python from agents import Agent @@ -136,7 +136,7 @@ triage_agent = Agent( ## 동적 instructions -대부분의 경우 에이전트를 생성할 때 instructions를 제공할 수 있습니다. 하지만 함수로 동적 instructions를 제공할 수도 있습니다. 이 함수는 에이전트와 컨텍스트를 인자로 받고 프롬프트를 반환해야 합니다. 일반 함수와 `async` 함수 모두 허용됩니다. +대부분의 경우 에이전트를 생성할 때 instructions 를 제공하면 됩니다. 그러나 함수로 동적 instructions 를 제공할 수도 있습니다. 이 함수는 에이전트와 컨텍스트를 입력으로 받아 프롬프트를 반환해야 합니다. 일반 함수와 `async` 함수 모두 허용됩니다. ```python def dynamic_instructions( @@ -151,17 +151,17 @@ agent = Agent[UserContext]( ) ``` -## 라이프사이클 이벤트(훅) +## 라이프사이클 이벤트(hooks) -때로는 에이전트의 라이프사이클을 관찰하고 싶을 수 있습니다. 예를 들어, 이벤트를 로깅하거나 특정 이벤트 발생 시 데이터를 미리 가져오고 싶을 수 있습니다. `hooks` 속성으로 에이전트 라이프사이클에 훅을 연결할 수 있습니다. [`AgentHooks`][agents.lifecycle.AgentHooks] 클래스를 서브클래싱하고, 관심 있는 메서드를 오버라이드하세요. +때로는 에이전트의 라이프사이클을 관찰하고 싶을 수 있습니다. 예를 들어 이벤트를 로깅하거나 특정 이벤트 발생 시 데이터를 미리 가져올 수 있습니다. `hooks` 속성을 사용해 에이전트 라이프사이클에 훅을 걸 수 있습니다. [`AgentHooks`][agents.lifecycle.AgentHooks] 클래스를 상속하고, 관심 있는 메서드를 오버라이드하세요. ## 가드레일 -가드레일은 에이전트가 실행되는 동안 사용자 입력에 대한 검사/검증을 병렬로 수행하고, 에이전트 출력이 생성된 후 해당 출력에 대해서도 검사/검증을 수행할 수 있게 합니다. 예를 들어, 사용자 입력과 에이전트 출력을 관련성 기준으로 스크리닝할 수 있습니다. 자세한 내용은 [가드레일](guardrails.md) 문서를 참고하세요. +가드레일을 사용하면 에이전트 실행과 병렬로 사용자 입력에 대한 검사/검증을 수행하고, 에이전트 출력이 생성된 후에도 검사할 수 있습니다. 예를 들어, 사용자 입력과 에이전트 출력을 관련성 기준으로 스크리닝할 수 있습니다. 자세한 내용은 [guardrails](guardrails.md) 문서를 참고하세요. ## 에이전트 복제/복사 -에이전트에서 `clone()` 메서드를 사용하면 에이전트를 복제하고, 필요한 속성을 선택적으로 변경할 수 있습니다. +에이전트의 `clone()` 메서드를 사용하면 에이전트를 복제하고, 원하는 속성을 선택적으로 변경할 수 있습니다. ```python pirate_agent = Agent( @@ -178,12 +178,12 @@ robot_agent = pirate_agent.clone( ## 도구 사용 강제 -도구 목록을 제공해도 LLM이 항상 도구를 사용하는 것은 아닙니다. [`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice]를 설정하여 도구 사용을 강제할 수 있습니다. 유효한 값은 다음과 같습니다: +도구 목록을 제공해도 LLM 이 항상 도구를 사용하는 것은 아닙니다. [`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice]를 설정하여 도구 사용을 강제할 수 있습니다. 유효한 값은 다음과 같습니다: -1. `auto`: LLM이 도구 사용 여부를 결정 -2. `required`: LLM이 반드시 도구를 사용해야 함(단, 어떤 도구를 사용할지는 지능적으로 선택) -3. `none`: LLM이 도구를 사용하지 않도록 요구 -4. 특정 문자열 설정(예: `my_tool`): 해당 특정 도구 사용을 요구 +1. `auto`: LLM 이 도구 사용 여부를 스스로 결정 +2. `required`: LLM 이 도구를 반드시 사용하도록 강제(어떤 도구를 사용할지는 지능적으로 결정) +3. `none`: LLM 이 도구를 사용하지 않도록 강제 +4. 특정 문자열(예: `my_tool`)을 설정해 해당 특정 도구 사용을 강제 ```python from agents import Agent, Runner, function_tool, ModelSettings @@ -205,8 +205,8 @@ agent = Agent( `Agent` 구성의 `tool_use_behavior` 매개변수는 도구 출력 처리 방식을 제어합니다: -- "run_llm_again": 기본값. 도구를 실행한 뒤, LLM이 결과를 처리해 최종 응답을 생성 -- "stop_on_first_tool": 첫 번째 도구 호출의 출력을 추가 LLM 처리 없이 최종 응답으로 사용 +- `"run_llm_again"`: 기본값. 도구를 실행하고, LLM 이 결과를 처리해 최종 응답을 생성 +- `"stop_on_first_tool"`: 첫 번째 도구 호출의 출력을 추가 LLM 처리 없이 최종 응답으로 사용 ```python from agents import Agent, Runner, function_tool, ModelSettings @@ -224,7 +224,7 @@ agent = Agent( ) ``` -- `StopAtTools(stop_at_tool_names=[...])`: 지정된 도구가 호출되면 중지하고, 해당 출력을 최종 응답으로 사용 +- `StopAtTools(stop_at_tool_names=[...])`: 지정된 도구 중 하나가 호출되면 중지하고, 해당 출력물을 최종 응답으로 사용 ```python from agents import Agent, Runner, function_tool @@ -248,7 +248,7 @@ agent = Agent( ) ``` -- `ToolsToFinalOutputFunction`: 도구 결과를 처리하고 중지 또는 LLM 계속 진행 여부를 결정하는 커스텀 함수 +- `ToolsToFinalOutputFunction`: 도구 결과를 처리하고 중지할지 LLM 을 계속 사용할지 결정하는 사용자 정의 함수 ```python from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper @@ -286,4 +286,4 @@ agent = Agent( !!! note - 무한 루프를 방지하기 위해 프레임워크는 도구 호출 후 `tool_choice`를 자동으로 "auto"로 재설정합니다. 이 동작은 [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice]로 구성할 수 있습니다. 무한 루프의 원인은 도구 결과가 LLM으로 전달되고, `tool_choice` 때문에 LLM이 다시 도구 호출을 생성하는 과정이 반복되기 때문입니다. \ No newline at end of file + 무한 루프를 방지하기 위해, 프레임워크는 도구 호출 후 `tool_choice`를 자동으로 "auto"로 리셋합니다. 이 동작은 [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice]로 구성할 수 있습니다. 무한 루프는 도구 결과가 LLM 으로 다시 전달되고, `tool_choice` 때문에 LLM 이 또 다른 도구 호출을 생성하는 일이 반복되기 때문에 발생합니다. \ No newline at end of file diff --git a/docs/ko/config.md b/docs/ko/config.md index a02e3e155..9737bd574 100644 --- a/docs/ko/config.md +++ b/docs/ko/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 키(즉, 환경 변수 또는 설정한 기본 키)를 사용합니다. 트레이싱에 사용할 API 키를 별도로 지정하려면 [`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 함수를 사용하세요. +트레이싱은 기본적으로 활성화되어 있습니다. 기본적으로 위 섹션의 OpenAI API 키(즉, 환경 변수 또는 설정한 기본 키)를 사용합니다. [`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 함수를 사용해 트레이싱에 사용할 API 키를 별도로 설정할 수 있습니다. ```python from agents import set_tracing_export_api_key @@ -52,7 +52,7 @@ set_tracing_disabled(True) ## 디버그 로깅 -SDK에는 핸들러가 설정되지 않은 두 개의 Python 로거가 있습니다. 기본적으로 이는 경고와 오류가 `stdout`으로 전송되고, 다른 로그는 억제됨을 의미합니다. +SDK에는 핸들러가 설정되지 않은 두 개의 Python 로거가 있습니다. 기본적으로 이는 경고와 오류는 `stdout`으로 전송되지만, 다른 로그들은 억제됨을 의미합니다. 자세한 로깅을 활성화하려면 [`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 함수를 사용하세요. @@ -62,7 +62,7 @@ from agents import enable_verbose_stdout_logging enable_verbose_stdout_logging() ``` -또는 핸들러, 필터, 포매터 등을 추가하여 로그를 커스터마이즈할 수 있습니다. 자세한 내용은 [Python 로깅 가이드](https://docs.python.org/3/howto/logging.html)를 참조하세요. +또는 핸들러, 필터, 포매터 등을 추가하여 로그를 사용자 지정할 수 있습니다. 자세한 내용은 [Python logging 가이드](https://docs.python.org/3/howto/logging.html)를 참고하세요. ```python import logging @@ -83,15 +83,15 @@ logger.addHandler(logging.StreamHandler()) ### 로그의 민감한 데이터 -일부 로그에는 민감한 데이터(예: 사용자 데이터)가 포함될 수 있습니다. 이러한 데이터의 로깅을 비활성화하려면 다음 환경 변수를 설정하세요. +일부 로그에는 민감한 데이터(예: 사용자 데이터)가 포함될 수 있습니다. 이러한 데이터가 기록되지 않도록 하려면 다음 환경 변수를 설정하세요. -LLM 입력 및 출력을 로깅하지 않으려면: +LLM 입력과 출력을 로깅하지 않으려면: ```bash export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1 ``` -도구 입력 및 출력을 로깅하지 않으려면: +도구 입력과 출력을 로깅하지 않으려면: ```bash export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1 diff --git a/docs/ko/context.md b/docs/ko/context.md index 3e9a9fd7a..32e0c2cb1 100644 --- a/docs/ko/context.md +++ b/docs/ko/context.md @@ -4,30 +4,30 @@ search: --- # 컨텍스트 관리 -컨텍스트는 과부하된 용어입니다. 관심을 가질 수 있는 컨텍스트는 크게 두 가지 범주가 있습니다: +컨텍스트는 여러 의미로 쓰입니다. 여기서 중요한 컨텍스트는 크게 두 가지입니다: -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. 해당 객체를 다양한 실행 메서드에 전달합니다(예: `Runner.run(..., **context=whatever**)`) -3. 모든 도구 호출, 라이프사이클 훅 등에는 래퍼 객체 `RunContextWrapper[T]`가 전달되며, 여기서 `T`는 컨텍스트 객체 타입을 나타내며 `wrapper.context`로 접근할 수 있습니다 +1. 원하는 어떤 Python 객체든 만듭니다. 일반적으로 dataclass 또는 Pydantic 객체를 사용합니다. +2. 그 객체를 다양한 실행 메서드에 전달합니다(예: `Runner.run(..., **context=whatever**)`). +3. 모든 도구 호출, 라이프사이클 훅 등에는 `RunContextWrapper[T]` 래퍼 객체가 전달됩니다. 여기서 `T`는 컨텍스트 객체 타입을 의미하며 `wrapper.context`를 통해 접근할 수 있습니다. -가장 중요한 점: 특정 에이전트 실행에 참여하는 모든 에이전트, 도구 함수, 라이프사이클 등은 동일한 컨텍스트의 _타입_ 을 사용해야 합니다. +가장 중요한 점: 특정 에이전트 실행에 포함되는 모든 에이전트, 도구 함수, 라이프사이클 등은 동일한 컨텍스트의 타입을 사용해야 합니다. 컨텍스트는 다음과 같은 용도로 사용할 수 있습니다: -- 실행을 위한 컨텍스트 데이터(예: 사용자 이름/uid 같은 정보 또는 그 외 사용자와 관련된 정보) -- 의존성(예: 로거 객체, 데이터 페처 등) -- 헬퍼 함수 +- 실행에 필요한 컨텍스트 데이터(예: 사용자 이름/uid 등 사용자에 대한 정보) +- 의존성(예: 로거 객체, 데이터 페처 등) +- 헬퍼 함수 !!! danger "주의" - 컨텍스트 객체는 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. 에이전트는 도구를 올바르게 호출하고 나이를 가져옵니다. --- ### 고급: `ToolContext` -일부 경우에는 실행 중인 도구에 대한 추가 메타데이터(예: 이름, 호출 ID, 원문 인수 문자열)에 접근하고 싶을 수 있습니다. +경우에 따라 실행 중인 도구에 대한 추가 메타데이터(이름, 호출 ID, 원문 인자 문자열 등)에 접근하고 싶을 수 있습니다. 이를 위해 `RunContextWrapper`를 확장한 [`ToolContext`][agents.tool_context.ToolContext] 클래스를 사용할 수 있습니다. ```python @@ -110,7 +110,7 @@ agent = Agent( - `tool_name` – 호출 중인 도구의 이름 - `tool_call_id` – 이 도구 호출의 고유 식별자 -- `tool_arguments` – 도구에 전달된 원문 인수 문자열 +- `tool_arguments` – 도구에 전달된 원문 인자 문자열 실행 중 도구 수준 메타데이터가 필요할 때 `ToolContext`를 사용하세요. 에이전트와 도구 간 일반적인 컨텍스트 공유에는 `RunContextWrapper`만으로 충분합니다. @@ -119,9 +119,9 @@ agent = Agent( ## 에이전트/LLM 컨텍스트 -LLM이 호출될 때 볼 수 있는 데이터는 대화 기록뿐입니다. 즉, LLM이 새로운 데이터를 볼 수 있게 하려면 해당 데이터가 그 기록에 포함되도록 해야 합니다. 이를 위한 방법은 다음과 같습니다: +LLM이 호출될 때 볼 수 있는 데이터는 대화 기록뿐입니다. 따라서 LLM에 새로운 데이터를 제공하려면, 해당 데이터가 대화 기록에 포함되도록 만들어야 합니다. 방법은 다음과 같습니다: -1. 에이전트의 `instructions`에 추가합니다. 이는 "시스템 프롬프트" 또는 "developer message"로도 알려져 있습니다. 시스템 프롬프트는 정적인 문자열일 수도 있고, 컨텍스트를 받아 문자열을 출력하는 동적 함수일 수도 있습니다. 항상 유용한 정보(예: 사용자 이름이나 현재 날짜)에는 일반적인 방식입니다 -2. `Runner.run` 함수를 호출할 때 `input`에 추가합니다. 이는 `instructions` 전략과 유사하지만, [chain of command](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command) 상에서 더 낮은 메시지를 가질 수 있습니다 -3. 함수 도구를 통해 노출합니다. 이는 온디맨드 컨텍스트에 유용합니다. LLM이 데이터가 필요할 때 판단하여, 해당 데이터를 가져오기 위해 도구를 호출할 수 있습니다 -4. 리트리벌 또는 웹 검색을 사용합니다. 이는 파일이나 데이터베이스(리트리벌) 또는 웹(웹 검색)에서 관련 데이터를 가져올 수 있는 특수한 도구입니다. 이는 응답을 관련 컨텍스트 데이터에 기반하도록 하는 데 유용합니다 \ No newline at end of file +1. 에이전트의 `instructions`에 추가합니다. 이는 "system prompt" 또는 "developer message"라고도 합니다. 시스템 프롬프트는 정적 문자열일 수도 있고, 컨텍스트를 받아 문자열을 출력하는 동적 함수일 수도 있습니다. 사용자 이름이나 현재 날짜처럼 항상 유용한 정보를 전달하는 일반적인 방법입니다. +2. `Runner.run` 함수를 호출할 때 `input`에 추가합니다. 이는 `instructions`와 유사하지만, [명령 체계](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command)에서 더 낮은 위치의 메시지를 사용할 수 있습니다. +3. 함수 도구를 통해 노출합니다. 이는 온디맨드 컨텍스트에 유용합니다. LLM이 필요할 때 해당 데이터를 가져오기 위해 도구를 호출할 수 있습니다. +4. 리트리벌 또는 웹 검색을 사용합니다. 이는 파일이나 데이터베이스에서 관련 데이터를 가져올 수 있는 특수 도구(리트리벌) 또는 웹에서 데이터를 가져오는 도구(웹 검색)입니다. 관련 컨텍스트 데이터로 응답을 근거(grounding) 있게 만드는 데 유용합니다. \ No newline at end of file diff --git a/docs/ko/examples.md b/docs/ko/examples.md index 25f8d9b8f..330d19e88 100644 --- a/docs/ko/examples.md +++ b/docs/ko/examples.md @@ -4,12 +4,12 @@ search: --- # 코드 예제 -[repo](https://github.com/openai/openai-agents-python/tree/main/examples)의 examples 섹션에서 SDK의 다양한 샘플 구현을 확인하세요. 예제는 다양한 패턴과 기능을 보여 주는 여러 카테고리로 구성되어 있습니다. +[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):** - 이 카테고리의 코드 예제는 다음과 같은 일반적인 에이전트 설계 패턴을 보여 줍니다 + 이 카테고리의 예제는 다음과 같은 일반적인 에이전트 설계 패턴을 보여줍니다 - 결정적 워크플로 - 도구로서의 에이전트 @@ -21,14 +21,14 @@ search: - 스트리밍 가드레일 - **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** - 이 코드 예제들은 SDK의 기본 기능을 보여 줍니다 + 이 예제들은 다음과 같은 SDK의 기초 기능을 보여줍니다 - - Hello World 예제 (기본 모델, GPT-5, open-weight 모델) - - 에이전트 라이프사이클 관리 + - Hello World 코드 예제 (기본 모델, GPT-5, 오픈 웨이트 모델) + - 에이전트 수명 주기 관리 - 동적 시스템 프롬프트 - - 스트리밍 출력 (텍스트, 항목, 함수 호출 인자) + - 스트리밍 출력 (텍스트, 아이템, 함수 호출 인자) - 프롬프트 템플릿 - - 파일 처리 (로컬 및 원격, 이미지 및 PDF) + - 파일 처리 (로컬과 원격, 이미지 및 PDF) - 사용량 추적 - 비엄격 출력 타입 - 이전 응답 ID 사용 @@ -37,25 +37,25 @@ search: 항공사를 위한 고객 서비스 시스템 예제 - **[financial_research_agent](https://github.com/openai/openai-agents-python/tree/main/examples/financial_research_agent):** - 금융 데이터 분석을 위해 에이전트와 도구로 구조화된 리서치 워크플로를 시연하는 금융 리서치 에이전트 + 재무 데이터 분석을 위한 에이전트와 도구로 구조화된 리서치 워크플로를 보여주는 재무 리서치 에이전트 - **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** - 메시지 필터링과 함께 에이전트 핸드오프의 실용적 코드 예제를 확인하세요 + 메시지 필터링과 함께 에이전트 핸드오프의 실용적인 예제 - **[hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp):** - 호스티드 MCP (Model Context Protocol) 커넥터와 승인 사용 방법을 보여 주는 코드 예제 + 호스티드 MCP (Model Context Protocol) 커넥터와 승인을 사용하는 방법을 보여주는 예제 - **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** - MCP (Model Context Protocol)로 에이전트를 만드는 방법을 배워 보세요. 다음을 포함합니다 + MCP (Model Context Protocol)로 에이전트를 구축하는 방법을 배웁니다. 예: - - 파일시스템 예제 + - 파일 시스템 예제 - Git 예제 - - MCP 프롬프트 서버 예제 - - SSE (Server-Sent Events) 예제 - - 스트리밍 가능한 HTTP 예제 + - MCP 프롬프트 서버 코드 예제 + - SSE (Server-Sent Events) 코드 예제 + - 스트리밍 가능한 HTTP 코드 예제 - **[memory](https://github.com/openai/openai-agents-python/tree/main/examples/memory):** - 에이전트를 위한 다양한 메모리 구현 코드 예제, 다음을 포함 + 에이전트를 위한 다양한 메모리 구현 예제 - SQLite 세션 스토리지 - 고급 SQLite 세션 스토리지 @@ -65,29 +65,29 @@ search: - OpenAI 세션 스토리지 - **[model_providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** - 사용자 지정 프로바이더와 LiteLLM 통합을 포함하여 SDK로 OpenAI 외 모델을 사용하는 방법 알아보기 + 커스텀 프로바이더와 LiteLLM 통합을 포함하여 OpenAI 이외의 모델을 SDK에서 사용하는 방법을 살펴보세요 - **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** - SDK를 사용하여 실시간 경험을 구축하는 방법을 보여 주는 코드 예제, 다음을 포함 + SDK를 사용해 실시간 경험을 구축하는 방법을 보여주는 예제 - 웹 애플리케이션 - 커맨드라인 인터페이스 - Twilio 통합 - **[reasoning_content](https://github.com/openai/openai-agents-python/tree/main/examples/reasoning_content):** - 추론 콘텐츠 및 structured outputs를 다루는 방법을 보여 주는 코드 예제 + reasoning 콘텐츠와 structured outputs를 다루는 방법을 보여주는 예제 - **[research_bot](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):** - 복잡한 멀티 에이전트 리서치 워크플로를 시연하는 간단한 딥 리서치 클론 + 복잡한 멀티 에이전트 리서치 워크플로를 보여주는 간단한 딥 리서치 클론 - **[tools](https://github.com/openai/openai-agents-python/tree/main/examples/tools):** - 다음과 같은 OpenAI 호스트하는 도구를 구현하는 방법을 배워 보세요 + 다음과 같은 OpenAI 호스트하는 도구를 구현하는 방법을 배웁니다 - - 웹 검색 및 필터가 있는 웹 검색 + - 웹 검색 및 필터를 사용한 웹 검색 - 파일 검색 - Code Interpreter - 컴퓨터 사용 - 이미지 생성 - **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** - TTS 및 STT 모델을 사용하는 음성 에이전트 코드 예제를 확인하세요. 스트리밍 음성 예제 포함 \ No newline at end of file + TTS 및 STT 모델을 사용하는 음성 에이전트 예제, 스트리밍 음성 코드 예제를 포함합니다 \ No newline at end of file diff --git a/docs/ko/guardrails.md b/docs/ko/guardrails.md index 8e5b6d4bc..dd45c5e8d 100644 --- a/docs/ko/guardrails.md +++ b/docs/ko/guardrails.md @@ -4,44 +4,44 @@ search: --- # 가드레일 -가드레일은 에이전트와 _병렬로_ 실행되며, 사용자 입력에 대한 점검과 검증을 수행할 수 있게 합니다. 예를 들어, 고객 요청을 돕기 위해 매우 똑똑한(따라서 느리고 비싼) 모델을 사용하는 에이전트를 상상해 보세요. 악의적인 사용자가 수학 숙제를 도와달라고 모델에 요청하는 것은 원치 않을 것입니다. 이때 빠르고 저렴한 모델로 가드레일을 실행할 수 있습니다. 가드레일이 악의적 사용을 감지하면 즉시 오류를 발생시켜, 비용이 많이 드는 모델 실행을 중단하고 시간과 비용을 절약할 수 있습니다. +가드레일은 에이전트와 함께 병렬로 실행되어 사용자 입력에 대한 점검과 검증을 수행합니다. 예를 들어, 고객 요청을 처리하기 위해 매우 똑똑한(따라서 느리고/비싼) 모델을 사용하는 에이전트가 있다고 가정해 보겠습니다. 악의적인 사용자가 수학 숙제를 도와 달라고 모델에 요청하는 것을 원치 않을 것입니다. 이때 빠르고/저렴한 모델로 가드레일을 실행할 수 있습니다. 가드레일이 악의적 사용을 감지하면 즉시 오류를 발생시켜 비싼 모델의 실행을 중단하고 시간/비용을 절약합니다. 가드레일에는 두 가지 종류가 있습니다: -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] 예외가 발생하며, 이에 적절히 사용자에게 응답하거나 예외를 처리할 수 있습니다 +1. 먼저, 가드레일은 에이전트에 전달된 것과 동일한 입력을 받습니다. +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] 예외가 발생하며, 이에 적절히 사용자에게 응답하거나 예외를 처리할 수 있습니다 +1. 먼저, 가드레일은 에이전트가 생성한 출력을 받습니다. +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 @@ -94,10 +94,10 @@ async def main(): print("Math homework guardrail tripped") ``` -1. 이 에이전트를 가드레일 함수에서 사용합니다 -2. 이는 에이전트의 입력/컨텍스트를 받아 결과를 반환하는 가드레일 함수입니다 -3. 가드레일 결과에 추가 정보를 포함할 수 있습니다 -4. 워크플로를 정의하는 실제 에이전트입니다 +1. 이 에이전트를 가드레일 함수에서 사용합니다. +2. 이것은 에이전트의 입력/컨텍스트를 받아 결과를 반환하는 가드레일 함수입니다. +3. 가드레일 결과에 추가 정보를 포함할 수 있습니다. +4. 이것이 워크플로를 정의하는 실제 에이전트입니다. 출력 가드레일도 유사합니다. @@ -152,7 +152,7 @@ async def main(): print("Math output guardrail tripped") ``` -1. 실제 에이전트의 출력 타입입니다 -2. 가드레일의 출력 타입입니다 -3. 에이전트의 출력을 받아 결과를 반환하는 가드레일 함수입니다 -4. 워크플로를 정의하는 실제 에이전트입니다 \ No newline at end of file +1. 이것이 실제 에이전트의 출력 타입입니다. +2. 이것이 가드레일의 출력 타입입니다. +3. 이것은 에이전트의 출력을 받아 결과를 반환하는 가드레일 함수입니다. +4. 이것이 워크플로를 정의하는 실제 에이전트입니다. \ No newline at end of file diff --git a/docs/ko/handoffs.md b/docs/ko/handoffs.md index e1d87737c..909d962e5 100644 --- a/docs/ko/handoffs.md +++ b/docs/ko/handoffs.md @@ -4,19 +4,19 @@ search: --- # 핸드오프 -핸드오프는 한 에이전트가 다른 에이전트에게 작업을 위임하도록 합니다. 이는 서로 다른 영역에 특화된 에이전트가 있는 시나리오에서 특히 유용합니다. 예를 들어, 고객 지원 앱에는 주문 상태, 환불, FAQ 등과 같은 작업을 각각 전담하는 에이전트가 있을 수 있습니다. +핸드오프는 한 에이전트가 다른 에이전트에게 작업을 위임할 수 있게 합니다. 이는 서로 다른 영역에 특화된 에이전트들이 있는 시나리오에서 특히 유용합니다. 예를 들어, 고객 지원 앱은 주문 상태, 환불, FAQ 등과 같은 작업을 각각 전담하는 에이전트를 가질 수 있습니다. -핸드오프는 LLM 에게 도구로 표현됩니다. 따라서 `Refund Agent`라는 에이전트로의 핸드오프가 있다면, 도구 이름은 `transfer_to_refund_agent`가 됩니다. +핸드오프는 LLM에게 도구로 표현됩니다. 예를 들어 `Refund Agent`라는 에이전트로의 핸드오프가 있다면, 도구 이름은 `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,19 +28,19 @@ refund_agent = Agent(name="Refund agent") triage_agent = Agent(name="Triage agent", handoffs=[billing_agent, handoff(refund_agent)]) ``` -1. 에이전트를 직접 사용할 수 있으며(예: `billing_agent`), 또는 `handoff()` 함수를 사용할 수 있습니다 +1. `billing_agent`처럼 에이전트를 직접 사용할 수도 있고, `handoff()` 함수를 사용할 수도 있습니다. -### `handoff()` 함수로 핸드오프 사용자 지정 +### `handoff()` 함수로 핸드오프 커스터마이즈 -[`handoff()`][agents.handoffs.handoff] 함수는 다양한 사용자 지정을 지원합니다. +[`handoff()`][agents.handoffs.handoff] 함수로 다양한 설정을 커스터마이즈할 수 있습니다. - `agent`: 작업을 넘길 대상 에이전트 -- `tool_name_override`: 기본적으로 `Handoff.default_tool_name()` 함수가 사용되며, 이는 `transfer_to_`로 결정됨. 이를 오버라이드할 수 있음 +- `tool_name_override`: 기본적으로 `Handoff.default_tool_name()` 함수가 사용되며, 이는 `transfer_to_`으로 결정됩니다. 이를 오버라이드할 수 있습니다. - `tool_description_override`: `Handoff.default_tool_description()`의 기본 도구 설명을 오버라이드 -- `on_handoff`: 핸드오프가 호출될 때 실행되는 콜백 함수. 핸드오프가 호출됨을 알게 되는 즉시 데이터 페칭을 시작하는 등의 용도에 유용함. 이 함수는 에이전트 컨텍스트를 받고, 선택적으로 LLM 이 생성한 입력도 받을 수 있음. 입력 데이터는 `input_type` 매개변수로 제어됨 -- `input_type`: 핸드오프가 기대하는 입력의 타입(선택 사항) -- `input_filter`: 다음 에이전트가 받는 입력을 필터링할 수 있음. 아래 참고 -- `is_enabled`: 핸드오프 활성화 여부. 불리언 또는 불리언을 반환하는 함수가 될 수 있어, 런타임에 동적으로 활성화/비활성화 가능 +- `on_handoff`: 핸드오프가 호출될 때 실행되는 콜백 함수. 핸드오프가 호출되는 즉시 일부 데이터 페칭을 시작하는 등의 작업에 유용합니다. 이 함수는 에이전트 컨텍스트를 받고, 선택적으로 LLM이 생성한 입력도 받을 수 있습니다. 입력 데이터는 `input_type` 매개변수로 제어됩니다. +- `input_type`: 핸드오프에서 기대하는 입력 타입(선택 사항) +- `input_filter`: 다음 에이전트가 받는 입력을 필터링합니다. 아래 설명을 참고하세요. +- `is_enabled`: 핸드오프 활성화 여부. 불리언이거나 불리언을 반환하는 함수가 될 수 있어, 런타임에 동적으로 활성/비활성화할 수 있습니다. ```python from agents import Agent, handoff, RunContextWrapper @@ -60,7 +60,7 @@ handoff_obj = handoff( ## 핸드오프 입력 -특정 상황에서는, 핸드오프를 호출할 때 LLM 이 일부 데이터를 제공하길 원할 수 있습니다. 예를 들어, "에스컬레이션 에이전트"로의 핸드오프를 상상해 보세요. 기록을 위해 사유를 제공받고자 할 수 있습니다. +특정 상황에서는 핸드오프를 호출할 때 LLM이 일부 데이터를 제공하길 원할 수 있습니다. 예를 들어, "Escalation agent"로의 핸드오프를 상상해보세요. 그 이유를 기록할 수 있도록 사유가 제공되길 원할 수 있습니다. ```python from pydantic import BaseModel @@ -84,9 +84,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`를 반환해야 하는 함수입니다. -일부 일반적인 패턴(예: 히스토리에서 모든 도구 호출 제거)은 [`agents.extensions.handoff_filters`][]에 이미 구현되어 있습니다 +일부 공통 패턴(예: 기록에서 모든 도구 호출 제거)은 [`agents.extensions.handoff_filters`][]에 미리 구현되어 있습니다. ```python from agents import Agent, handoff @@ -100,11 +100,11 @@ handoff_obj = handoff( ) ``` -1. 이것은 `FAQ agent`가 호출될 때 자동으로 히스토리에서 모든 도구를 제거합니다 +1. 이는 `FAQ agent`가 호출될 때 기록에서 모든 도구를 자동으로 제거합니다. ## 권장 프롬프트 -LLM 이 핸드오프를 올바르게 이해하도록 하려면, 에이전트에 핸드오프 관련 정보를 포함하는 것을 권장합니다. [`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX`][]의 권장 프리픽스를 사용하거나, [`agents.extensions.handoff_prompt.prompt_with_handoff_instructions`][]를 호출하여 프롬프트에 권장 데이터를 자동으로 추가할 수 있습니다. +LLM이 핸드오프를 올바르게 이해하도록 하려면, 에이전트에 핸드오프 관련 정보를 포함하는 것을 권장합니다. [`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX`][]의 권장 접두사를 사용하거나, [`agents.extensions.handoff_prompt.prompt_with_handoff_instructions`][]를 호출해 권장 데이터를 프롬프트에 자동으로 추가할 수 있습니다. ```python from agents import Agent diff --git a/docs/ko/index.md b/docs/ko/index.md index fb6c1fad8..35c9bfc6a 100644 --- a/docs/ko/index.md +++ b/docs/ko/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과 결합하면, 이러한 기본 컴포넌트만으로도 도구와 에이전트 간의 복잡한 관계를 표현하고, 가파른 학습 곡선 없이 실제 애플리케이션을 구축할 수 있습니다. 또한 SDK에는 에이전트 플로우를 시각화하고 디버깅하며, 평가하고 심지어 애플리케이션용 모델을 파인튜닝할 수 있게 해 주는 기본 제공 **트레이싱**이 포함되어 있습니다. +Python과 결합하면, 이 기본 구성 요소만으로도 도구와 에이전트 간의 복잡한 관계를 표현할 수 있으며, 가파른 학습 곡선 없이 실제 애플리케이션을 만들 수 있습니다. 또한 SDK에는 에이전트 플로우를 시각화하고 디버그하며, 평가하고 심지어 애플리케이션에 맞게 모델을 파인튜닝할 수 있게 해주는 내장 **트레이싱**이 포함되어 있습니다. -## Agents SDK 사용 이유 +## Agents SDK를 사용하는 이유 -SDK는 두 가지 설계 원칙을 따릅니다: +SDK는 두 가지 핵심 설계 원칙을 따릅니다: -1. 사용할 가치가 있을 만큼 충분한 기능을 제공하되, 빠르게 배울 수 있도록 기본 컴포넌트 수는 최소화합니다. -2. 기본 설정만으로도 잘 동작하지만, 원하는 동작을 정확히 커스터마이즈할 수 있습니다. +1. 사용할 가치가 있을 만큼 충분한 기능을 제공하되, 빠르게 익힐 수 있도록 기본 구성 요소는 최소화합니다 +2. 기본 설정만으로도 잘 동작하지만, 동작을 정확히 원하는 대로 커스터마이즈할 수 있습니다 SDK의 주요 기능은 다음과 같습니다: -- 에이전트 루프: 도구 호출, 결과를 LLM에 전달, LLM이 완료될 때까지 반복을 처리하는 기본 제공 에이전트 루프 -- 파이썬 우선: 새로운 추상화를 배우지 않고도, 언어의 기본 기능만으로 에이전트를 오케스트레이션하고 체인 구성 -- 핸드오프: 여러 에이전트 간 조정과 위임을 가능하게 하는 강력한 기능 -- 가드레일: 에이전트와 병렬로 입력 검증과 체크를 수행하고, 실패 시 빠르게 중단 -- 세션: 에이전트 실행 전체에서 대화 이력을 자동으로 관리하여 수동 상태 관리를 제거 -- 함수 도구: 어떤 Python 함수든 자동 스키마 생성과 Pydantic 기반 검증으로 도구로 전환 -- 트레이싱: 워크플로를 시각화, 디버그, 모니터링할 수 있게 해 주는 기본 제공 트레이싱과 함께, OpenAI의 평가, 파인튜닝, 지식 증류 도구도 활용 가능 +- 에이전트 루프: tools 호출, 결과를 LLM에 전달, LLM이 완료될 때까지 루프를 수행하는 내장 에이전트 루프 +- 파이썬 우선: 새로운 추상화를 배울 필요 없이 언어의 내장 기능을 사용해 에이전트를 오케스트레이션하고 체이닝 +- 핸드오프: 여러 에이전트 간의 조율과 위임을 가능하게 하는 강력한 기능 +- 가드레일: 에이전트와 병렬로 입력 검증과 체크를 실행하고, 실패 시 조기에 중단 +- 세션: 에이전트 실행 전반에 걸친 대화 히스토리 자동 관리로 수동 상태 관리 제거 +- 함수 도구: 어떤 Python 함수든 도구로 변환하고, 스키마 자동 생성과 Pydantic 기반 검증 제공 +- 트레이싱: 워크플로우를 시각화, 디버그, 모니터링하고 OpenAI 평가, 파인튜닝, 증류 도구 제품군을 사용할 수 있게 해주는 내장 트레이싱 ## 설치 @@ -36,7 +36,7 @@ SDK의 주요 기능은 다음과 같습니다: pip install openai-agents ``` -## Hello World 예시 +## Hello world 예제 ```python from agents import Agent, Runner @@ -51,7 +51,7 @@ print(result.final_output) # Infinite loop's dance. ``` -(_실행할 경우 `OPENAI_API_KEY` 환경 변수를 설정하세요_) +(_실행하는 경우 `OPENAI_API_KEY` 환경 변수를 설정했는지 확인하세요_) ```bash export OPENAI_API_KEY=sk-... diff --git a/docs/ko/mcp.md b/docs/ko/mcp.md index 7cbf88ec2..ef37281b3 100644 --- a/docs/ko/mcp.md +++ b/docs/ko/mcp.md @@ -4,32 +4,32 @@ search: --- # Model context protocol (MCP) -[Model context protocol](https://modelcontextprotocol.io/introduction) (MCP)은 애플리케이션이 도구와 컨텍스트를 언어 모델에 노출하는 방식을 표준화합니다. 공식 문서에서 발췌: +[Model context protocol](https://modelcontextprotocol.io/introduction) (MCP)은 애플리케이션이 도구와 컨텍스트를 언어 모델에 노출하는 방식을 표준화합니다. 공식 문서에서: -> MCP는 애플리케이션이 LLM에 컨텍스트를 제공하는 방식을 표준화하는 오픈 프로토콜입니다. MCP를 AI 애플리케이션을 위한 USB-C 포트로 생각해 보세요. USB-C가 다양한 주변기기와 액세서리에 기기를 연결하는 표준화된 방식을 제공하듯, MCP는 AI 모델을 다양한 데이터 소스와 도구에 연결하는 표준화된 방식을 제공합니다. +> MCP는 애플리케이션이 LLMs에 컨텍스트를 제공하는 방식을 표준화하는 오픈 프로토콜입니다. MCP를 AI 애플리케이션을 위한 USB-C 포트라고 생각해 보세요. USB-C가 다양한 주변기기와 액세서리를 기기에 연결하는 표준화된 방법을 제공하듯, MCP는 AI 모델을 다양한 데이터 소스와 도구에 연결하는 표준화된 방법을 제공합니다. -Agents Python SDK는 여러 MCP 트랜스포트를 이해합니다. 이를 통해 기존 MCP 서버를 재사용하거나 직접 구축하여 파일 시스템, HTTP, 또는 커넥터를 기반으로 한 도구를 에이전트에 노출할 수 있습니다. +Agents Python SDK는 여러 MCP 전송 방식을 이해합니다. 이를 통해 기존 MCP 서버를 재사용하거나 직접 구축하여 파일 시스템, HTTP 또는 커넥터 기반 도구를 에이전트에 노출할 수 있습니다. -## MCP 통합 선택 +## Choosing an MCP integration -MCP 서버를 에이전트에 연결하기 전에 도구 호출을 어디에서 실행할지와 도달 가능한 트랜스포트를 결정하세요. 아래 매트릭스는 Python SDK가 지원하는 옵션을 요약합니다. +에이전트에 MCP 서버를 연결하기 전에 도구 호출이 어디에서 실행되어야 하는지, 그리고 어떤 전송 방식을 사용할 수 있는지 결정하세요. 아래 매트릭스는 Python SDK가 지원하는 옵션을 요약합니다. -| 필요한 사항 | 권장 옵션 | +| 필요한 것 | 권장 옵션 | | ------------------------------------------------------------------------------------ | ----------------------------------------------------- | -| OpenAI의 Responses API가 모델을 대신하여 공용으로 접근 가능한 MCP 서버를 호출하도록 함 | **호스티드 MCP 서버 도구** via [`HostedMCPTool`][agents.tool.HostedMCPTool] | -| 로컬 또는 원격에서 실행 중인 Streamable HTTP 서버에 연결 | **Streamable HTTP MCP 서버** via [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] | +| 모델을 대신해 OpenAI의 Responses API가 공개적으로 접근 가능한 MCP 서버를 호출하도록 설정 | **호스티드 MCP 서버 도구** via [`HostedMCPTool`][agents.tool.HostedMCPTool] | +| 로컬 또는 원격에서 실행하는 Streamable HTTP 서버에 연결 | **Streamable HTTP MCP 서버** via [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] | | Server-Sent Events를 사용하는 HTTP를 구현한 서버와 통신 | **HTTP with SSE MCP 서버** via [`MCPServerSse`][agents.mcp.server.MCPServerSse] | | 로컬 프로세스를 실행하고 stdin/stdout을 통해 통신 | **stdio MCP 서버** via [`MCPServerStdio`][agents.mcp.server.MCPServerStdio] | -아래 섹션에서는 각 옵션을 설정하는 방법과, 어떤 상황에서 특정 트랜스포트를 선호해야 하는지 안내합니다. +아래 섹션에서는 각 옵션, 구성 방법, 그리고 언제 어떤 전송 방식을 선호해야 하는지 설명합니다. ## 1. Hosted MCP server tools -호스티드 툴은 전체 도구 왕복을 OpenAI 인프라로 넘깁니다. 코드에서 도구를 나열하고 호출하는 대신 [`HostedMCPTool`][agents.tool.HostedMCPTool]이 서버 레이블(및 선택적 커넥터 메타데이터)을 Responses API로 전달합니다. 모델은 원격 서버의 도구를 나열하고, Python 프로세스로의 추가 콜백 없이 이를 호출합니다. 호스티드 툴은 현재 Responses API의 호스티드 MCP 통합을 지원하는 OpenAI 모델에서 동작합니다. +호스티드 툴은 전체 도구 왕복 호출을 OpenAI 인프라로 이동합니다. 사용자의 코드가 도구를 나열하고 호출하는 대신, [`HostedMCPTool`][agents.tool.HostedMCPTool]이 서버 레이블(및 선택적 커넥터 메타데이터)을 Responses API로 전달합니다. 모델은 원격 서버의 도구를 나열하고 추가적인 Python 프로세스 콜백 없이 이를 호출합니다. 호스티드 툴은 현재 Responses API의 호스티드 MCP 연동을 지원하는 OpenAI 모델과 함께 작동합니다. -### 기본 호스티드 MCP 도구 +### Basic hosted MCP tool -에이전트의 `tools` 목록에 [`HostedMCPTool`][agents.tool.HostedMCPTool]을 추가하여 호스티드 도구를 생성하세요. `tool_config` 딕셔너리는 REST API에 전송할 JSON을 반영합니다: +에이전트의 `tools` 목록에 [`HostedMCPTool`][agents.tool.HostedMCPTool]을 추가하여 호스티드 툴을 생성합니다. `tool_config` 딕셔너리는 REST API에 보낼 JSON과 동일합니다: ```python import asyncio @@ -59,9 +59,9 @@ asyncio.run(main()) 호스티드 서버는 도구를 자동으로 노출합니다. `mcp_servers`에 추가할 필요가 없습니다. -### 호스티드 MCP 결과 스트리밍 +### Streaming hosted MCP results -호스티드 툴은 함수 도구와 정확히 동일한 방식으로 스트리밍을 지원합니다. `Runner.run_streamed`에 `stream=True`를 전달하여 모델이 실행 중일 때도 증분 MCP 출력을 소비하세요: +호스티드 툴은 함수 도구와 정확히 동일한 방식으로 스트리밍을 지원합니다. 모델이 여전히 작업 중일 때 점진적인 MCP 출력을 소비하려면 `Runner.run_streamed`에 `stream=True`를 전달하세요: ```python result = Runner.run_streamed(agent, "Summarise this repository's top languages") @@ -71,9 +71,9 @@ async for event in result.stream_events(): print(result.final_output) ``` -### 선택적 승인 플로우 +### Optional approval flows -서버가 민감한 작업을 수행할 수 있는 경우, 각 도구 실행 전에 사람 또는 프로그램의 승인을 요구할 수 있습니다. `tool_config`의 `require_approval`을 단일 정책(`"always"`, `"never"`) 또는 도구 이름별 정책 매핑 딕셔너리로 설정하세요. 파이썬 내부에서 결정을 내리려면 `on_approval_request` 콜백을 제공하세요. +서버가 민감한 작업을 수행할 수 있는 경우 각 도구 실행 전에 사람 또는 프로그램의 승인을 요구할 수 있습니다. `tool_config`의 `require_approval`을 단일 정책(`"always"`, `"never"`) 또는 도구 이름을 정책에 매핑한 딕셔너리로 구성하세요. Python 내부에서 결정을 내리려면 `on_approval_request` 콜백을 제공하세요. ```python from agents import MCPToolApprovalFunctionResult, MCPToolApprovalRequest @@ -101,11 +101,11 @@ agent = Agent( ) ``` -콜백은 동기 또는 비동기로 작성할 수 있으며, 모델이 계속 실행하는 데 필요한 승인 데이터가 필요할 때마다 호출됩니다. +콜백은 동기식 또는 비동기식일 수 있으며, 모델이 계속 실행되기 위해 승인 데이터가 필요할 때마다 호출됩니다. -### 커넥터 기반 호스티드 서버 +### Connector-backed hosted servers -호스티드 MCP는 OpenAI 커넥터도 지원합니다. `server_url` 대신 `connector_id`와 액세스 토큰을 제공하세요. Responses API가 인증을 처리하며, 호스티드 서버가 커넥터의 도구를 노출합니다. +호스티드 MCP는 OpenAI 커넥터도 지원합니다. `server_url`을 지정하는 대신 `connector_id`와 액세스 토큰을 제공하세요. Responses API가 인증을 처리하고 호스티드 서버는 커넥터의 도구를 노출합니다. ```python import os @@ -121,12 +121,11 @@ HostedMCPTool( ) ``` -스트리밍, 승인, 커넥터를 포함한 완전한 호스티드 툴 샘플은 -[`examples/hosted_mcp`](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp)에 있습니다. +스트리밍, 승인, 커넥터를 포함한 완전한 호스티드 툴 샘플은 [`examples/hosted_mcp`](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp)에 있습니다. -## 2. Streamable HTTP MCP 서버 +## 2. Streamable HTTP MCP servers -네트워크 연결을 직접 관리하려면 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp]를 사용하세요. Streamable HTTP 서버는 트랜스포트를 직접 제어하거나, 지연 시간을 낮게 유지하면서 서버를 자체 인프라 내에서 실행하고자 할 때 이상적입니다. +네트워크 연결을 직접 관리하려면 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp]를 사용하세요. Streamable HTTP 서버는 전송을 직접 제어하거나 지연 시간을 낮게 유지하면서 자체 인프라 내에서 서버를 실행하고자 할 때 이상적입니다. ```python import asyncio @@ -161,16 +160,16 @@ async def main() -> None: asyncio.run(main()) ``` -생성자는 다음 추가 옵션을 받습니다: +생성자는 다음 추가 옵션을 허용합니다: - `client_session_timeout_seconds`는 HTTP 읽기 타임아웃을 제어합니다 -- `use_structured_content`는 `tool_result.structured_content`를 텍스트 출력보다 우선할지 여부를 전환합니다 -- `max_retry_attempts` 및 `retry_backoff_seconds_base`는 `list_tools()`와 `call_tool()`에 대한 자동 재시도를 추가합니다 -- `tool_filter`를 사용하면 도구의 부분집합만 노출할 수 있습니다([도구 필터링](#tool-filtering) 참고) +- `use_structured_content`는 `tool_result.structured_content`를 텍스트 출력보다 선호할지 여부를 전환합니다 +- `max_retry_attempts`와 `retry_backoff_seconds_base`는 `list_tools()`와 `call_tool()`에 자동 재시도를 추가합니다 +- `tool_filter`는 노출할 도구의 하위 집합만 선택적으로 노출하게 해줍니다 ([도구 필터링](#tool-filtering) 참조) -## 3. HTTP with SSE MCP 서버 +## 3. HTTP with SSE MCP servers -MCP 서버가 HTTP with SSE 트랜스포트를 구현하는 경우, [`MCPServerSse`][agents.mcp.server.MCPServerSse]를 인스턴스화하세요. 트랜스포트를 제외하면 API는 Streamable HTTP 서버와 동일합니다. +MCP 서버가 HTTP with SSE 전송을 구현한다면 [`MCPServerSse`][agents.mcp.server.MCPServerSse]를 인스턴스화하세요. 전송 방식을 제외하면 API는 Streamable HTTP 서버와 동일합니다. ```python @@ -197,9 +196,9 @@ async with MCPServerSse( print(result.final_output) ``` -## 4. stdio MCP 서버 +## 4. stdio MCP servers -로컬 하위 프로세스로 실행되는 MCP 서버에는 [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]를 사용하세요. SDK가 프로세스를 생성하고, 파이프를 열어두며, 컨텍스트 매니저가 종료될 때 자동으로 닫습니다. 이 옵션은 빠른 개념 증명이나 서버가 커맨드라인 엔트리 포인트만 노출하는 경우에 유용합니다. +로컬 하위 프로세스로 실행되는 MCP 서버의 경우 [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]를 사용하세요. SDK는 프로세스를 생성하고 파이프를 열어 두며 컨텍스트 관리자가 종료될 때 자동으로 닫습니다. 이 옵션은 빠른 개념 증명이나 서버가 커맨드라인 엔트리 포인트만 노출하는 경우에 유용합니다. ```python from pathlib import Path @@ -225,13 +224,13 @@ async with MCPServerStdio( print(result.final_output) ``` -## 도구 필터링 +## Tool filtering -각 MCP 서버는 에이전트에 필요한 함수만 노출할 수 있도록 도구 필터를 지원합니다. 필터링은 생성 시점 또는 실행별로 동적으로 수행할 수 있습니다. +각 MCP 서버는 에이전트에 필요한 기능만 노출할 수 있도록 도구 필터를 지원합니다. 필터링은 생성 시점 또는 실행별로 동적으로 수행할 수 있습니다. -### 정적 도구 필터링 +### Static tool filtering -[`create_static_tool_filter`][agents.mcp.create_static_tool_filter]를 사용하여 간단한 허용/차단 리스트를 구성하세요: +[`create_static_tool_filter`][agents.mcp.create_static_tool_filter]를 사용해 간단한 허용/차단 목록을 구성하세요: ```python from pathlib import Path @@ -249,11 +248,11 @@ filesystem_server = MCPServerStdio( ) ``` -`allowed_tool_names`와 `blocked_tool_names`가 모두 제공되는 경우, SDK는 허용 리스트를 먼저 적용한 뒤 남은 집합에서 차단된 도구를 제거합니다. +`allowed_tool_names`와 `blocked_tool_names`가 모두 제공된 경우 SDK는 먼저 허용 목록을 적용한 뒤 남은 집합에서 차단된 도구를 제거합니다. -### 동적 도구 필터링 +### Dynamic tool filtering -더 정교한 로직이 필요하다면 [`ToolFilterContext`][agents.mcp.ToolFilterContext]를 받는 호출 가능 객체를 전달하세요. 이 호출 가능 객체는 동기 또는 비동기로 작성할 수 있으며, 도구를 노출해야 할 때 `True`를 반환합니다. +더 정교한 로직이 필요하다면 [`ToolFilterContext`][agents.mcp.ToolFilterContext]를 받는 호출 가능 객체를 전달하세요. 이 호출 가능 객체는 동기식 또는 비동기식일 수 있으며 도구를 노출해야 할 때 `True`를 반환합니다. ```python from pathlib import Path @@ -279,12 +278,12 @@ async with MCPServerStdio( 필터 컨텍스트는 활성 `run_context`, 도구를 요청하는 `agent`, 그리고 `server_name`을 제공합니다. -## 프롬프트 +## Prompts MCP 서버는 에이전트 instructions를 동적으로 생성하는 프롬프트도 제공할 수 있습니다. 프롬프트를 지원하는 서버는 두 가지 메서드를 노출합니다: -- `list_prompts()`는 사용 가능한 프롬프트 템플릿을 나열합니다 -- `get_prompt(name, arguments)`는 선택적 매개변수와 함께 구체적인 프롬프트를 가져옵니다 +- `list_prompts()`는 사용 가능한 프롬프트 템플릿을 열거합니다 +- `get_prompt(name, arguments)`는 선택적으로 매개변수와 함께 구체적인 프롬프트를 가져옵니다 ```python from agents import Agent @@ -302,21 +301,21 @@ agent = Agent( ) ``` -## 캐싱 +## Caching -모든 에이전트 실행은 각 MCP 서버에 대해 `list_tools()`를 호출합니다. 원격 서버는 눈에 띄는 지연을 유발할 수 있으므로, 모든 MCP 서버 클래스는 `cache_tools_list` 옵션을 노출합니다. 도구 정의가 자주 변경되지 않는다고 확신하는 경우에만 `True`로 설정하세요. 이후 새 목록을 강제로 가져오려면 서버 인스턴스에서 `invalidate_tools_cache()`를 호출하세요. +모든 에이전트 실행은 각 MCP 서버에서 `list_tools()`를 호출합니다. 원격 서버는 눈에 띄는 지연을 유발할 수 있으므로 모든 MCP 서버 클래스는 `cache_tools_list` 옵션을 노출합니다. 도구 정의가 자주 변경되지 않는다고 확신할 때에만 이를 `True`로 설정하세요. 나중에 새 목록을 강제로 가져오려면 서버 인스턴스에서 `invalidate_tools_cache()`를 호출하세요. -## 트레이싱 +## Tracing -[트레이싱](./tracing.md)은 MCP 활동을 자동으로 캡처합니다. 포함되는 항목: +[트레이싱](./tracing.md)은 MCP 활동을 자동으로 캡처합니다. 포함 내용: -1. 도구를 나열하기 위한 MCP 서버 호출 -2. 도구 호출과 관련된 MCP 정보 +1. 도구 목록을 가져오기 위한 MCP 서버 호출 +2. 도구 호출에 대한 MCP 관련 정보 ![MCP 트레이싱 스크린샷](../assets/images/mcp-tracing.jpg) -## 추가 자료 +## Further reading - [Model Context Protocol](https://modelcontextprotocol.io/) – 명세와 설계 가이드 - [examples/mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp) – 실행 가능한 stdio, SSE, Streamable HTTP 샘플 -- [examples/hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp) – 승인 및 커넥터를 포함한 완전한 호스티드 MCP 데모 \ No newline at end of file +- [examples/hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp) – 승인과 커넥터를 포함한 완전한 호스티드 MCP 데모 \ No newline at end of file diff --git a/docs/ko/models/index.md b/docs/ko/models/index.md index a47d10a9f..636c2b1d1 100644 --- a/docs/ko/models/index.md +++ b/docs/ko/models/index.md @@ -4,20 +4,20 @@ search: --- # 모델 -Agents SDK 는 OpenAI 모델을 다음 두 가지 방식으로 기본 지원합니다: +Agents SDK 는 두 가지 방식으로 OpenAI 모델을 즉시 사용할 수 있도록 지원합니다: - **권장**: 새로운 [Responses API](https://platform.openai.com/docs/api-reference/responses)를 사용해 OpenAI API 를 호출하는 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] - [Chat Completions API](https://platform.openai.com/docs/api-reference/chat)를 사용해 OpenAI API 를 호출하는 [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] ## OpenAI 모델 -`Agent` 초기화 시 모델을 지정하지 않으면 기본 모델이 사용됩니다. 현재 기본값은 [`gpt-4.1`](https://platform.openai.com/docs/models/gpt-4.1)로, 에이전트형 워크플로에 대한 예측 가능성과 낮은 지연 시간의 균형이 뛰어납니다. +`Agent` 를 초기화할 때 모델을 지정하지 않으면 기본 모델이 사용됩니다. 현재 기본값은 [`gpt-4.1`](https://platform.openai.com/docs/models/gpt-4.1)이며, 에이전트 중심 워크플로를 위한 예측 가능성과 낮은 지연 시간의 균형이 뛰어납니다. [`gpt-5`](https://platform.openai.com/docs/models/gpt-5) 같은 다른 모델로 전환하려면 다음 섹션의 단계를 따르세요. ### 기본 OpenAI 모델 -사용자 지정 모델을 설정하지 않은 모든 에이전트에서 일관되게 특정 모델을 사용하려면, 에이전트를 실행하기 전에 `OPENAI_DEFAULT_MODEL` 환경 변수를 설정하세요. +사용자 지정 모델을 설정하지 않은 모든 에이전트에 대해 일관되게 특정 모델을 사용하려면, 에이전트를 실행하기 전에 `OPENAI_DEFAULT_MODEL` 환경 변수를 설정하세요. ```bash export OPENAI_DEFAULT_MODEL=gpt-5 @@ -26,9 +26,9 @@ python3 my_awesome_agent.py #### GPT-5 모델 -GPT-5 의 reasoning 모델들([`gpt-5`](https://platform.openai.com/docs/models/gpt-5), [`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini), [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano))을 이렇게 사용할 경우, SDK 는 기본적으로 합리적인 `ModelSettings` 를 적용합니다. 구체적으로, `reasoning.effort` 와 `verbosity` 를 모두 `"low"` 로 설정합니다. 이러한 설정을 직접 만들고 싶다면 `agents.models.get_default_model_settings("gpt-5")` 를 호출하세요. +이 방식으로 GPT-5 의 reasoning 모델들([`gpt-5`](https://platform.openai.com/docs/models/gpt-5), [`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini), [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano))을 사용할 때, SDK 는 기본적으로 합리적인 `ModelSettings` 를 적용합니다. 구체적으로 `reasoning.effort` 와 `verbosity` 를 모두 `"low"` 로 설정합니다. 이러한 설정을 직접 구성하려면 `agents.models.get_default_model_settings("gpt-5")` 를 호출하세요. -더 낮은 지연 시간이나 특정 요구사항이 있다면 다른 모델과 설정을 선택할 수 있습니다. 기본 모델의 reasoning effort 를 조정하려면 사용자 정의 `ModelSettings` 를 전달하세요: +지연 시간을 더 낮추거나 특정 요구사항이 있는 경우, 다른 모델과 설정을 선택할 수 있습니다. 기본 모델의 reasoning effort 를 조정하려면 사용자 정의 `ModelSettings` 를 전달하세요: ```python from openai.types.shared import Reasoning @@ -44,21 +44,21 @@ my_agent = Agent( ) ``` -특히 낮은 지연 시간이 필요하다면, [`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) 또는 [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano) 모델을 `reasoning.effort="minimal"` 로 사용하는 것이 기본 설정보다 더 빠르게 응답하는 경우가 많습니다. 다만 Responses API 의 일부 내장 도구(예: 파일 검색과 이미지 생성)는 `"minimal"` reasoning effort 를 지원하지 않으므로, 본 Agents SDK 는 기본값을 `"low"` 로 설정합니다. +특히 지연 시간을 낮추기 위해 [`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) 또는 [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano) 모델을 `reasoning.effort="minimal"` 과 함께 사용하면 기본 설정보다 더 빠르게 응답을 반환하는 경우가 많습니다. 다만 Responses API 의 일부 내장 도구(예: 파일 검색 및 이미지 생성)는 `"minimal"` reasoning effort 를 지원하지 않으므로, Agents SDK 의 기본값은 `"low"` 입니다. #### 비 GPT-5 모델 사용자 지정 `model_settings` 없이 비 GPT-5 모델 이름을 전달하면, SDK 는 어떤 모델과도 호환되는 일반적인 `ModelSettings` 로 되돌립니다. -## 비 OpenAI 모델 +## OpenAI 이외의 모델 -대부분의 다른 비 OpenAI 모델은 [LiteLLM 통합](./litellm.md)을 통해 사용할 수 있습니다. 먼저 litellm 의 의존성 그룹을 설치하세요: +대부분의 비 OpenAI 모델은 [LiteLLM 통합](../litellm.md)을 통해 사용할 수 있습니다. 먼저, litellm 의 종속성 그룹을 설치하세요: ```bash pip install "openai-agents[litellm]" ``` -그런 다음, `litellm/` 접두사를 사용하여 [지원되는 모델](https://docs.litellm.ai/docs/providers) 중 아무거나 사용하세요: +그런 다음, `litellm/` 접두사를 사용해 [지원되는 모델](https://docs.litellm.ai/docs/providers) 중 아무 것이나 사용하세요: ```python claude_agent = Agent(model="litellm/anthropic/claude-3-5-sonnet-20240620", ...) @@ -67,29 +67,29 @@ gemini_agent = Agent(model="litellm/gemini/gemini-2.5-flash-preview-04-17", ...) ### 비 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/)에 있음): -1. [`set_default_openai_client`][agents.set_default_openai_client] 는 LLM 클라이언트로 `AsyncOpenAI` 인스턴스를 전역적으로 사용하려는 경우에 유용합니다. 이는 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) 를 참고하세요. -3. [`Agent.model`][agents.agent.Agent.model] 을 사용하면 특정 Agent 인스턴스에 모델을 지정할 수 있습니다. 이를 통해 에이전트마다 다른 제공업체를 혼합해 사용할 수 있습니다. 설정 가능한 예시는 [examples/model_providers/custom_example_agent.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_agent.py) 를 참고하세요. 대부분의 사용 가능한 모델을 간편하게 사용하려면 [LiteLLM 통합](./litellm.md) 을 활용하세요. +1. [`set_default_openai_client`][agents.set_default_openai_client] 는 전역적으로 `AsyncOpenAI` 인스턴스를 LLM 클라이언트로 사용하려는 경우에 유용합니다. 이는 LLM 공급자가 OpenAI 호환 API 엔드포인트를 제공하며 `base_url` 과 `api_key` 를 설정할 수 있는 경우입니다. 구성 가능한 예시는 [examples/model_providers/custom_example_global.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_global.py) 를 참조하세요. +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) 를 참조하세요. +3. [`Agent.model`][agents.agent.Agent.model] 은 특정 Agent 인스턴스에 대해 모델을 지정할 수 있게 합니다. 이를 통해 서로 다른 에이전트에 대해 서로 다른 공급자를 혼합하여 사용할 수 있습니다. 구성 가능한 예시는 [examples/model_providers/custom_example_agent.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_agent.py) 를 참조하세요. 대부분의 사용 가능한 모델을 쉽게 사용하는 방법은 [LiteLLM 통합](../litellm.md)을 통한 것입니다. -`platform.openai.com` 의 API 키가 없는 경우, `set_tracing_disabled()` 로 트레이싱을 비활성화하거나, [다른 트레이싱 프로세서](../tracing.md) 를 설정하는 것을 권장합니다. +`platform.openai.com` 의 API 키가 없는 경우, `set_tracing_disabled()` 로 트레이싱을 비활성화하거나, [다른 트레이싱 프로세서](../tracing.md)를 설정하는 것을 권장합니다. !!! note - 이 예제들에서는 대부분의 LLM 제공업체가 아직 Responses API 를 지원하지 않기 때문에 Chat Completions API/모델을 사용합니다. LLM 제공업체가 Responses API 를 지원한다면 Responses 사용을 권장합니다. + 이 예시들에서는 대부분의 LLM 공급자가 아직 Responses API 를 지원하지 않기 때문에 Chat Completions API/모델을 사용합니다. 사용 중인 LLM 공급자가 지원한다면 Responses 사용을 권장합니다. ## 모델 혼합 사용 -단일 워크플로 내에서 에이전트마다 다른 모델을 사용하고 싶을 수 있습니다. 예를 들어, 분류(트리아지)에는 더 작고 빠른 모델을, 복잡한 작업에는 더 크고 강력한 모델을 사용할 수 있습니다. [`Agent`][agents.Agent] 를 구성할 때 다음 중 하나로 특정 모델을 선택할 수 있습니다: +단일 워크플로 내에서 에이전트마다 서로 다른 모델을 사용하고 싶을 수 있습니다. 예를 들어 분류에는 더 작고 빠른 모델을, 복잡한 작업에는 더 크고 강력한 모델을 사용할 수 있습니다. [`Agent`][agents.Agent] 를 구성할 때 다음 중 하나로 특정 모델을 선택할 수 있습니다: 1. 모델 이름을 전달 -2. 임의의 모델 이름 + 해당 이름을 Model 인스턴스로 매핑할 수 있는 [`ModelProvider`][agents.models.interface.ModelProvider] 를 전달 -3. [`Model`][agents.models.interface.Model] 구현체를 직접 제공 +2. 임의의 모델 이름 + 해당 이름을 Model 인스턴스로 매핑할 수 있는 [`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] 두 가지 형태를 모두 지원하지만, 두 형태가 지원하는 기능과 도구가 서로 다르므로 각 워크플로에는 하나의 모델 형태만 사용할 것을 권장합니다. 워크플로가 모델 형태의 혼합을 요구한다면, 사용하는 모든 기능이 두 형태 모두에서 제공되는지 확인하세요. + SDK 는 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] 과 [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] 두 형태를 모두 지원하지만, 두 형태가 지원하는 기능과 도구가 다르므로 각 워크플로에는 하나의 모델 형태만 사용하는 것을 권장합니다. 워크플로에서 모델 형태를 혼합해야 한다면, 사용하는 모든 기능이 두 형태 모두에서 사용 가능한지 확인하세요. ```python from agents import Agent, Runner, AsyncOpenAI, OpenAIChatCompletionsModel @@ -122,10 +122,10 @@ async def main(): print(result.final_output) ``` -1. OpenAI 모델 이름을 직접 설정 -2. [`Model`][agents.models.interface.Model] 구현체를 제공 +1. OpenAI 모델의 이름을 직접 설정합니다 +2. [`Model`][agents.models.interface.Model] 구현을 제공합니다 -에이전트에 사용되는 모델을 추가로 구성하려면, `temperature` 같은 선택적 모델 구성 매개변수를 제공하는 [`ModelSettings`][agents.models.interface.ModelSettings] 를 전달할 수 있습니다. +에이전트에 사용되는 모델을 추가로 구성하려는 경우, temperature 같은 선택적 모델 구성 매개변수를 제공하는 [`ModelSettings`][agents.models.interface.ModelSettings] 를 전달할 수 있습니다. ```python from agents import Agent, ModelSettings @@ -138,7 +138,7 @@ english_agent = Agent( ) ``` -또한 OpenAI 의 Responses API 를 사용할 때 [몇 가지 다른 선택적 매개변수](https://platform.openai.com/docs/api-reference/responses/create) (예: `user`, `service_tier` 등)가 있습니다. 이들이 최상위에 없으면 `extra_args` 를 사용해 함께 전달할 수 있습니다. +또한 OpenAI 의 Responses API 를 사용할 때 [몇 가지 다른 선택적 매개변수](https://platform.openai.com/docs/api-reference/responses/create)(예: `user`, `service_tier` 등)가 있습니다. 이들이 최상위에 없으면 `extra_args` 를 사용해 함께 전달할 수 있습니다. ```python from agents import Agent, ModelSettings @@ -154,26 +154,26 @@ english_agent = Agent( ) ``` -## 다른 LLM 제공업체 사용 시 일반적인 문제 +## 다른 LLM 공급자 사용 시 흔한 문제 -### Tracing 클라이언트 오류 401 +### 트레이싱 클라이언트 오류 401 -트레이싱 관련 오류가 발생한다면, 이는 트레이스가 OpenAI 서버로 업로드되는데 OpenAI API 키가 없기 때문입니다. 해결 방법은 다음 세 가지 중 하나입니다: +트레이싱 관련 오류가 발생하는 경우, 트레이스가 OpenAI 서버로 업로드되지만 OpenAI API 키가 없기 때문입니다. 해결 방법은 다음 세 가지입니다: -1. 트레이싱 완전 비활성화: [`set_tracing_disabled(True)`][agents.set_tracing_disabled] -2. 트레이싱용 OpenAI 키 설정: [`set_tracing_export_api_key(...)`][agents.set_tracing_export_api_key]. 이 API 키는 트레이스 업로드에만 사용되며, 반드시 [platform.openai.com](https://platform.openai.com/) 의 키여야 합니다. -3. 비 OpenAI 트레이스 프로세서 사용. [tracing 문서](../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 트레이스 프로세서를 사용. [tracing 문서](../tracing.md#custom-tracing-processors) 참고 ### Responses API 지원 -SDK 는 기본적으로 Responses API 를 사용하지만, 대부분의 다른 LLM 제공업체는 아직 이를 지원하지 않습니다. 그 결과 404 같은 문제가 발생할 수 있습니다. 해결 방법은 두 가지입니다: +SDK 는 기본적으로 Responses API 를 사용하지만, 대부분의 다른 LLM 공급자는 아직 지원하지 않습니다. 이로 인해 404 등의 문제가 발생할 수 있습니다. 해결 방법은 다음 두 가지입니다: -1. [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api] 를 호출하세요. 환경 변수로 `OPENAI_API_KEY` 와 `OPENAI_BASE_URL` 을 설정하는 경우에 동작합니다. -2. [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] 을 사용하세요. 예시는 [여기](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/) 에 있습니다. +1. [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api] 를 호출하세요. 환경 변수로 `OPENAI_API_KEY` 와 `OPENAI_BASE_URL` 을 설정한 경우에 동작합니다 +2. [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] 을 사용하세요. 예시는 [여기](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)에 있습니다 -### Structured outputs 지원 +### structured outputs 지원 -일부 모델 제공업체는 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) 를 지원하지 않습니다. 이로 인해 다음과 같은 오류가 발생할 수 있습니다: +일부 모델 공급자는 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs)을 지원하지 않습니다. 이로 인해 다음과 유사한 오류가 발생할 수 있습니다: ``` @@ -181,12 +181,12 @@ BadRequestError: Error code: 400 - {'error': {'message': "'response_format.type' ``` -이는 일부 모델 제공업체의 한계로, JSON 출력을 지원하지만 출력에 사용할 `json_schema` 를 지정할 수 없습니다. 이에 대한 해결책을 마련 중이지만, JSON schema 출력을 지원하는 제공업체를 사용하는 것을 권장합니다. 그렇지 않으면 잘못된 JSON 때문에 앱이 자주 실패할 수 있습니다. +이는 일부 모델 공급자의 한계로, JSON 출력을 지원하더라도 출력에 사용할 `json_schema` 를 지정할 수 없습니다. 이에 대한 해결책을 마련 중이지만, 그렇지 않으면 잘못된 JSON 때문에 앱이 자주 깨질 수 있으므로 JSON schema 출력을 지원하는 공급자에 의존할 것을 권장합니다. -## 제공업체 간 모델 혼합 +## 공급자 간 모델 혼합 사용 -모델 제공업체 간 기능 차이를 인지하지 못하면 오류가 발생할 수 있습니다. 예를 들어, OpenAI 는 structured outputs, 멀티모달 입력, 호스티드 파일 검색 및 웹 검색을 지원하지만, 다른 많은 제공업체는 이러한 기능을 지원하지 않습니다. 다음 제약을 유의하세요: +모델 공급자 간 기능 차이를 인지하지 못하면 오류가 발생할 수 있습니다. 예를 들어 OpenAI 는 structured outputs, 멀티모달 입력, 호스티드 파일 검색 및 웹 검색을 지원하지만, 다른 많은 공급자는 이러한 기능을 지원하지 않습니다. 다음 제한 사항을 유의하세요: -- 지원하지 않는 `tools` 를 이해하지 못하는 제공업체로 보내지 않기 -- 텍스트 전용 모델을 호출하기 전에 멀티모달 입력을 필터링 -- structured JSON outputs 를 지원하지 않는 제공업체는 때때로 잘못된 JSON 을 생성할 수 있음 \ No newline at end of file +- 지원하지 않는 공급자에게는 이해하지 못하는 `tools` 를 보내지 말 것 +- 텍스트 전용 모델을 호출하기 전에 멀티모달 입력을 필터링할 것 +- structured JSON 출력을 지원하지 않는 공급자는 때때로 잘못된 JSON 을 생성할 수 있음을 유의할 것 \ No newline at end of file diff --git a/docs/ko/models/litellm.md b/docs/ko/models/litellm.md index 3836f16b7..c7258b409 100644 --- a/docs/ko/models/litellm.md +++ b/docs/ko/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/)은 단일 인터페이스로 100개 이상의 모델을 사용할 수 있게 해주는 라이브러리입니다. 우리는 Agents SDK에서 어떤 AI 모델이든 사용할 수 있도록 LiteLLM 통합을 추가했습니다. ## 설정 -`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` 를 모델로, OpenAI API 키 -- `anthropic/claude-3-5-sonnet-20240620` 를 모델로, Anthropic API 키 -- 등 +- 모델에는 `openai/gpt-4.1`, 그리고 OpenAI API 키 +- 모델에는 `anthropic/claude-3-5-sonnet-20240620`, 그리고 Anthropic API 키 +- 등 -LiteLLM 이 지원하는 전체 모델 목록은 [litellm providers docs](https://docs.litellm.ai/docs/providers) 를 참고하세요. +LiteLLM이 지원하는 전체 모델 목록은 [litellm providers docs](https://docs.litellm.ai/docs/providers)를 참고하세요. ```python from __future__ import annotations @@ -78,7 +78,7 @@ if __name__ == "__main__": ## 사용량 데이터 추적 -LiteLLM 응답으로 Agents SDK 사용량 메트릭을 채우고 싶다면, 에이전트를 생성할 때 `ModelSettings(include_usage=True)` 를 전달하세요. +LiteLLM 응답을 Agents SDK 사용량 지표에 반영하려면 에이전트를 생성할 때 `ModelSettings(include_usage=True)`를 전달하세요. ```python from agents import Agent, ModelSettings @@ -91,4 +91,4 @@ agent = Agent( ) ``` -`include_usage=True` 를 사용하면, LiteLLM 요청은 기본 제공 OpenAI 모델과 마찬가지로 `result.context_wrapper.usage` 를 통해 토큰 및 요청 수를 보고합니다. \ No newline at end of file +`include_usage=True`가 설정되면 LiteLLM 요청은 기본 제공 OpenAI 모델과 마찬가지로 `result.context_wrapper.usage`를 통해 토큰 및 요청 수를 보고합니다. \ No newline at end of file diff --git a/docs/ko/multi_agent.md b/docs/ko/multi_agent.md index f00a80c3b..0efe75d7f 100644 --- a/docs/ko/multi_agent.md +++ b/docs/ko/multi_agent.md @@ -4,38 +4,38 @@ search: --- # 멀티 에이전트 오케스트레이션 -오케스트레이션은 앱에서 에이전트가 흐르는 방식, 즉 어떤 에이전트가 어떤 순서로 실행되고 다음에 무엇을 할지 어떻게 결정하는지를 의미합니다. 에이전트를 오케스트레이션하는 방법은 두 가지가 있습니다: +오케스트레이션은 앱에서 에이전트가 흐르는 방식을 뜻합니다. 어떤 에이전트를 어떤 순서로 실행할지, 그리고 다음에 무엇을 할지 어떻게 결정할지입니다. 에이전트를 오케스트레이션하는 방법은 크게 두 가지가 있습니다: -1. LLM이 결정을 내리도록 허용: LLM의 지능을 활용해 계획하고 추론하며 그에 따라 수행할 단계를 결정합니다. -2. 코드로 오케스트레이션: 코드로 에이전트의 흐름을 결정합니다. +1. LLM이 결정하게 하기: LLM의 지능을 활용해 계획하고 추론하며 그에 따라 수행할 단계를 결정합니다 +2. 코드로 오케스트레이션하기: 코드로 에이전트의 흐름을 결정합니다 -이 패턴들은 혼합해서 사용할 수 있습니다. 각 방식에는 아래에 설명된 트레이드오프가 있습니다. +이 패턴들은 혼합하여 사용할 수 있습니다. 각각의 트레이드오프는 아래에 설명합니다. -## LLM 기반 오케스트레이션 +## LLM을 통한 오케스트레이션 -에이전트는 instructions, tools, 핸드오프를 갖춘 LLM입니다. 즉, 개방형 과제가 주어지면 LLM이 도구를 사용해 행동을 취하고 데이터를 획득하며, 핸드오프를 통해 하위 에이전트에 작업을 위임하는 방식으로 과제를 수행할 계획을 자율적으로 세울 수 있습니다. 예를 들어, 리서치 에이전트는 다음과 같은 도구를 갖출 수 있습니다: +에이전트는 instructions, tools, 핸드오프를 갖춘 LLM입니다. 이는 개방형 작업이 주어졌을 때, LLM이 작업을 처리할 계획을 자율적으로 세우고, 도구를 사용해 행동하고 데이터를 획득하며, 핸드오프를 통해 하위 에이전트에 작업을 위임할 수 있음을 의미합니다. 예를 들어, 리서치 에이전트에 다음과 같은 도구를 장착할 수 있습니다: -- 웹 검색을 통한 온라인 정보 탐색 -- 파일 검색 및 검색을 통한 사내 데이터와 연결 탐색 -- 컴퓨터 사용을 통한 컴퓨터 상의 행동 수행 -- 코드 실행을 통한 데이터 분석 -- 계획 수립, 보고서 작성 등에 특화된 에이전트로의 핸드오프 +- 온라인에서 정보를 찾기 위한 웹 검색 +- 사내 데이터와 연결 전반을 탐색하기 위한 파일 검색 및 가져오기 +- 컴퓨터에서 작업을 수행하기 위한 컴퓨터 사용 +- 데이터 분석을 위한 코드 실행 +- 기획, 보고서 작성 등 특정 작업에 특화된 에이전트로의 핸드오프 -이 패턴은 과제가 개방형이고 LLM의 지능에 의존하고 싶을 때 적합합니다. 여기서 가장 중요한 전술은 다음과 같습니다: +이 패턴은 작업이 개방형이고 LLM의 지능에 의존하고 싶을 때 유용합니다. 여기서 가장 중요한 전술은 다음과 같습니다: -1. 좋은 프롬프트에 투자하세요. 사용 가능한 도구, 사용 방법, 그리고 운영해야 할 매개변수를 명확히 하세요. -2. 앱을 모니터링하고 개선을 반복하세요. 문제가 생기는 지점을 확인하고 프롬프트를 반복적으로 개선하세요. -3. 에이전트가 자기 성찰을 통해 개선하도록 하세요. 예를 들어, 루프에서 실행하며 스스로를 비판하게 하거나, 오류 메시지를 제공해 개선하도록 하세요. -4. 모든 일을 잘하는 범용 에이전트 대신 하나의 작업에 특화된 에이전트를 두세요. -5. [evals](https://platform.openai.com/docs/guides/evals)에 투자하세요. 이를 통해 에이전트가 학습하고 과제 수행 능력을 향상시킬 수 있습니다. +1. 좋은 프롬프트에 투자하세요. 사용 가능한 도구, 사용 방법, 그리고 준수해야 할 매개변수를 명확히 하세요. +2. 앱을 모니터링하고 반복 개선하세요. 어디서 문제가 생기는지 확인하고 프롬프트를 개선하세요. +3. 에이전트가 자기 성찰을 통해 개선하도록 하세요. 예를 들어 루프에서 실행해 스스로 비평하게 하거나, 오류 메시지를 제공해 개선하도록 하세요. +4. 모든 것을 잘하는 범용 에이전트 대신 한 가지 작업에 뛰어난 특화 에이전트를 두세요. +5. [평가(evals)](https://platform.openai.com/docs/guides/evals)에 투자하세요. 이를 통해 에이전트를 학습시켜 성능을 개선할 수 있습니다. ## 코드 기반 오케스트레이션 -LLM 기반 오케스트레이션은 강력하지만, 코드 기반 오케스트레이션은 속도, 비용, 성능 측면에서 작업을 더 결정론적이고 예측 가능하게 만듭니다. 일반적인 패턴은 다음과 같습니다: +LLM을 통한 오케스트레이션이 강력하긴 하지만, 코드 기반 오케스트레이션은 속도, 비용, 성능 측면에서 작업을 더 결정적이고 예측 가능하게 만듭니다. 일반적인 패턴은 다음과 같습니다: -- [structured outputs](https://platform.openai.com/docs/guides/structured-outputs)를 사용해 코드로 검사할 수 있는 적절한 형식의 데이터를 생성. 예: 에이전트에게 작업을 몇 개의 카테고리로 분류하도록 요청한 뒤, 해당 카테고리에 따라 다음 에이전트를 선택 -- 한 에이전트의 출력을 다음 에이전트의 입력으로 변환하여 여러 에이전트를 체이닝. 예: 블로그 글 작성을 리서치 → 개요 작성 → 본문 작성 → 비평 → 개선의 일련의 단계로 분해 -- 평가와 피드백을 제공하는 에이전트와 실제 작업을 수행하는 에이전트를 `while` 루프로 함께 실행하고, 평가자가 출력이 특정 기준을 통과했다고 판단할 때까지 반복 -- `asyncio.gather` 같은 파이썬 기본 구성 요소를 사용하여 여러 에이전트를 병렬 실행. 서로 의존하지 않는 여러 작업을 더 빨리 처리할 때 유용 +- [structured outputs](https://platform.openai.com/docs/guides/structured-outputs)를 사용해 코드로 검사할 수 있는 적절한 형식의 데이터를 생성합니다. 예를 들어 에이전트에게 작업을 몇 가지 카테고리로 분류하도록 요청한 뒤, 해당 카테고리에 따라 다음 에이전트를 선택할 수 있습니다. +- 한 에이전트의 출력을 다음 에이전트의 입력으로 변환하여 여러 에이전트를 체이닝합니다. 블로그 글 작성 같은 작업을 일련의 단계로 분해할 수 있습니다 - 리서치 수행, 아웃라인 작성, 본문 작성, 비평, 그리고 개선 +- 작업을 수행하는 에이전트와 평가 및 피드백을 제공하는 에이전트를 `while` 루프로 실행하고, 평가자가 출력이 특정 기준을 통과한다고 할 때까지 반복합니다. +- `asyncio.gather` 같은 Python 기본 구성 요소를 통해 여러 에이전트를 병렬로 실행합니다. 서로 독립적인 여러 작업이 있을 때 속도 향상에 유용합니다. -[`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/ko/quickstart.md b/docs/ko/quickstart.md index 83422d08e..be06085dc 100644 --- a/docs/ko/quickstart.md +++ b/docs/ko/quickstart.md @@ -4,9 +4,9 @@ search: --- # 빠른 시작 -## 프로젝트와 가상 환경 생성 +## 프로젝트 및 가상 환경 생성 -한 번만 하면 됩니다. +한 번만 수행하면 됩니다. ```bash mkdir my_project @@ -16,7 +16,7 @@ python -m venv .venv ### 가상 환경 활성화 -새 터미널 세션을 시작할 때마다 실행하세요. +새 터미널 세션을 시작할 때마다 수행하세요. ```bash source .venv/bin/activate @@ -30,7 +30,7 @@ pip install openai-agents # or `uv add openai-agents`, etc ### OpenAI API 키 설정 -없다면 OpenAI API 키를 만들기 위해 [이 지침](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key)을 따르세요. +아직 없다면 OpenAI API 키를 생성하려면 [이 안내](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key)를 따르세요. ```bash export OPENAI_API_KEY=sk-... @@ -38,7 +38,7 @@ export OPENAI_API_KEY=sk-... ## 첫 에이전트 생성 -에이전트는 instructions, 이름, 그리고 선택적 구성(예: `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 @@ -71,7 +71,7 @@ math_tutor_agent = Agent( ## 핸드오프 정의 -각 에이전트에서, 작업을 진행하는 방법을 결정할 때 선택할 수 있는 아웃바운드 핸드오프 옵션 목록을 정의할 수 있습니다. +각 에이전트에서, 작업을 진행하는 방법을 결정하기 위해 에이전트가 선택할 수 있는 아웃바운드 핸드오프 옵션 목록을 정의할 수 있습니다. ```python triage_agent = Agent( @@ -83,7 +83,7 @@ triage_agent = Agent( ## 에이전트 오케스트레이션 실행 -워크플로가 실행되고 트리아지 에이전트가 두 전문 에이전트 간에 올바르게 라우팅하는지 확인해 봅시다. +워크플로가 실행되고 분류 에이전트가 두 전문 에이전트 사이를 올바르게 라우팅하는지 확인해 봅시다. ```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 @@ -192,12 +192,12 @@ if __name__ == "__main__": ## 트레이스 보기 -에이전트 실행 중에 어떤 일이 있었는지 검토하려면 [OpenAI 대시보드의 Trace 뷰어](https://platform.openai.com/traces)에서 실행 트레이스를 확인하세요. +에이전트 실행 중에 어떤 일이 있었는지 검토하려면 [OpenAI 대시보드의 Trace viewer](https://platform.openai.com/traces)로 이동해 실행 트레이스를 확인하세요. ## 다음 단계 -더 복잡한 에이전트 플로우를 만드는 방법을 알아보세요: +더 복잡한 에이전트 기반 플로우를 만드는 방법을 알아보세요: -- [Agents](agents.md) 구성 방법 알아보기 -- [에이전트 실행](running_agents.md) 알아보기 -- [tools](tools.md), [guardrails](guardrails.md), [models](models/index.md) 알아보기 \ No newline at end of file +- Learn about how to configure [에이전트](agents.md). +- Learn about [running agents](running_agents.md). +- Learn about [도구](tools.md), [가드레일](guardrails.md) and [모델](models/index.md). \ No newline at end of file diff --git a/docs/ko/realtime/guide.md b/docs/ko/realtime/guide.md index 08ba4bab8..f04878614 100644 --- a/docs/ko/realtime/guide.md +++ b/docs/ko/realtime/guide.md @@ -4,59 +4,59 @@ search: --- # 가이드 -이 가이드는 OpenAI Agents SDK의 실시간 기능을 활용해 음성 지원 AI 에이전트를 구축하는 방법을 자세히 설명합니다. +이 가이드는 OpenAI Agents SDK의 실시간 기능을 사용해 음성 기능이 포함된 AI 에이전트를 구축하는 방법을 자세히 설명합니다. -!!! warning "베타 기능" +!!! warning "Beta feature" 실시간 에이전트는 베타 단계입니다. 구현을 개선하는 과정에서 호환성 깨짐이 발생할 수 있습니다. ## 개요 -실시간 에이전트는 오디오와 텍스트 입력을 실시간으로 처리하고 실시간 오디오로 응답하는 대화 흐름을 제공합니다. OpenAI의 Realtime API와 지속적으로 연결되어 낮은 지연으로 자연스러운 음성 대화를 지원하며 인터럽션(중단 처리)을 우아하게 처리합니다. +실시간 에이전트는 실시간으로 오디오와 텍스트 입력을 처리하고 실시간 오디오로 응답하는 대화형 플로우를 제공합니다. OpenAI의 Realtime API와 지속적인 연결을 유지하여, 낮은 지연으로 자연스러운 음성 대화를 가능하게 하고 인터럽션(중단 처리)도 원활히 처리합니다. ## 아키텍처 ### 핵심 구성 요소 -실시간 시스템은 다음과 같은 주요 구성 요소로 이루어집니다: +실시간 시스템은 다음과 같은 핵심 구성 요소로 이루어집니다: -- **RealtimeAgent**: instructions, tools, 핸드오프로 구성된 에이전트 -- **RealtimeRunner**: 구성을 관리합니다. `runner.run()`을 호출해 세션을 얻을 수 있습니다 -- **RealtimeSession**: 단일 상호작용 세션입니다. 보통 사용자가 대화를 시작할 때 하나를 만들고 대화가 끝날 때까지 유지합니다 +- **RealtimeAgent**: instructions, tools 및 핸드오프로 구성된 에이전트 +- **RealtimeRunner**: 구성을 관리합니다. `runner.run()`을 호출해 세션을 가져올 수 있습니다. +- **RealtimeSession**: 단일 상호작용 세션입니다. 보통 사용자가 대화를 시작할 때 하나를 만들고, 대화가 끝날 때까지 유지합니다. - **RealtimeModel**: 기본 모델 인터페이스(일반적으로 OpenAI의 WebSocket 구현) ### 세션 흐름 일반적인 실시간 세션은 다음 흐름을 따릅니다: -1. instructions, tools, 핸드오프로 **RealtimeAgent를 생성**합니다 -2. 에이전트와 구성 옵션으로 **RealtimeRunner를 설정**합니다 -3. `await runner.run()`으로 **세션을 시작**하고 RealtimeSession을 받습니다 -4. `send_audio()` 또는 `send_message()`를 사용해 **오디오 또는 텍스트 메시지를 전송**합니다 -5. 세션을 순회(iterate)하며 **이벤트를 수신**합니다 - 오디오 출력, 전사, 도구 호출, 핸드오프, 오류 등이 포함됩니다 -6. 사용자가 에이전트 말 위로 말할 때 **인터럽션(중단 처리)**을 처리합니다. 현재 오디오 생성을 자동으로 중지합니다 +1. **RealtimeAgent**를 instructions, tools 및 핸드오프로 구성합니다 +2. **RealtimeRunner 설정**을 에이전트와 구성 옵션으로 설정합니다 +3. `await runner.run()`으로 **세션 시작** 후 RealtimeSession을 받습니다 +4. `send_audio()` 또는 `send_message()`로 **오디오 또는 텍스트 메시지 전송**합니다 +5. 세션을 반복(iterate)하여 **이벤트 수신**을 처리합니다. 이벤트에는 오디오 출력, 전사, 도구 호출, 핸드오프, 오류가 포함됩니다 +6. 사용자가 에이전트 말 중에 말할 때 발생하는 **인터럽션(중단 처리)**을 처리합니다. 이 경우 현재 오디오 생성이 자동으로 중지됩니다 세션은 대화 기록을 유지하고 실시간 모델과의 지속 연결을 관리합니다. ## 에이전트 구성 -RealtimeAgent는 일반 Agent 클래스와 유사하지만 몇 가지 중요한 차이가 있습니다. 전체 API 세부 정보는 [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API 레퍼런스를 참조하세요. +RealtimeAgent는 일반 Agent 클래스와 유사하게 동작하지만 몇 가지 중요한 차이점이 있습니다. 전체 API는 [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API 레퍼런스를 참고하세요. 일반 에이전트와의 주요 차이점: -- 모델 선택은 에이전트 수준이 아닌 세션 수준에서 구성합니다 -- structured output 지원이 없습니다(`outputType` 미지원) -- 보이스는 에이전트별로 구성할 수 있으나 첫 번째 에이전트가 말한 후에는 변경할 수 없습니다 -- tools, 핸드오프, instructions 등 다른 기능은 동일하게 동작합니다 +- 모델 선택은 에이전트 레벨이 아닌 세션 레벨에서 구성합니다 +- structured output 지원이 없습니다(`outputType`은 지원되지 않음) +- 보이스는 에이전트별로 설정할 수 있지만 첫 번째 에이전트가 말을 시작한 이후에는 변경할 수 없습니다 +- tools, 핸드오프, instructions 같은 다른 기능은 동일하게 작동합니다 ## 세션 구성 ### 모델 설정 -세션 구성으로 기본 실시간 모델의 동작을 제어할 수 있습니다. 모델 이름(예: `gpt-realtime`), 보이스 선택(alloy, echo, fable, onyx, nova, shimmer), 지원 모달리티(텍스트 및/또는 오디오)를 설정할 수 있습니다. 오디오 형식은 입력과 출력 모두에 대해 설정할 수 있으며 기본값은 PCM16입니다. +세션 구성으로 기본 실시간 모델 동작을 제어할 수 있습니다. 모델 이름(예: `gpt-realtime`), 보이스 선택(alloy, echo, fable, onyx, nova, shimmer), 지원 모달리티(텍스트 및/또는 오디오)를 구성할 수 있습니다. 오디오 형식은 입력과 출력 모두에 대해 설정할 수 있으며 기본값은 PCM16입니다. ### 오디오 구성 -오디오 설정은 세션이 음성 입력과 출력을 처리하는 방식을 제어합니다. Whisper 같은 모델을 사용해 입력 오디오 전사를 구성하고, 언어 설정을 지정하며, 도메인 특화 용어의 정확도를 높이기 위한 전사 프롬프트를 제공할 수 있습니다. 턴 감지 설정으로 에이전트가 언제 응답을 시작하고 멈춰야 하는지 제어하며, 음성 활동 감지 임계값, 무음 지속 시간, 감지된 음성 주변 패딩 옵션을 제공합니다. +오디오 설정은 세션이 음성 입력 및 출력을 처리하는 방식을 제어합니다. Whisper 같은 모델을 사용한 입력 오디오 전사, 언어 선호도 설정, 도메인 특화 용어의 정확도를 향상시키기 위한 전사 프롬프트를 구성할 수 있습니다. 턴 감지 설정은 에이전트가 언제 응답을 시작하고 종료해야 하는지 제어하며, 음성 활동 감지 임계값, 무음 지속 시간, 감지된 음성의 패딩 옵션을 제공합니다. ## 도구와 함수 @@ -90,7 +90,7 @@ agent = RealtimeAgent( ### 핸드오프 생성 -핸드오프를 통해 특화된 에이전트 간에 대화를 전환할 수 있습니다. +핸드오프를 통해 전문화된 에이전트 간에 대화를 전달할 수 있습니다. ```python from agents.realtime import realtime_handoff @@ -119,20 +119,20 @@ main_agent = RealtimeAgent( ## 이벤트 처리 -세션은 세션 객체를 순회하며 수신할 수 있는 이벤트를 스트리밍합니다. 이벤트에는 오디오 출력 청크, 전사 결과, 도구 실행 시작/종료, 에이전트 핸드오프, 오류가 포함됩니다. 처리해야 할 주요 이벤트는 다음과 같습니다: +세션은 세션 객체를 순회(iterate)하여 수신할 수 있는 이벤트를 스트리밍합니다. 이벤트에는 오디오 출력 청크, 전사 결과, 도구 실행 시작/종료, 에이전트 핸드오프, 오류가 포함됩니다. 다음 핵심 이벤트를 처리하세요: -- **audio**: 에이전트 응답의 원시 오디오 데이터 +- **audio**: 원문 오디오 데이터(에이전트 응답) - **audio_end**: 에이전트가 말하기를 완료함 -- **audio_interrupted**: 사용자가 에이전트를 가로막음 +- **audio_interrupted**: 사용자가 에이전트를 인터럽션(중단 처리)함 - **tool_start/tool_end**: 도구 실행 라이프사이클 - **handoff**: 에이전트 핸드오프 발생 - **error**: 처리 중 오류 발생 -완전한 이벤트 세부 정보는 [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent]를 참고하세요. +전체 이벤트 세부 정보는 [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent]를 참조하세요. ## 가드레일 -실시간 에이전트에는 출력 가드레일만 지원됩니다. 성능 문제를 피하기 위해 모든 단어마다가 아니라 디바운스되어 주기적으로 실행됩니다. 기본 디바운스 길이는 100자이며 구성 가능합니다. +실시간 에이전트는 출력 가드레일만 지원합니다. 성능 문제를 방지하기 위해 실시간 생성 중 매 단어마다 실행하지 않고 디바운싱되어 주기적으로 실행됩니다. 기본 디바운스 길이는 100자이며, 설정 가능합니다. 가드레일은 `RealtimeAgent`에 직접 연결하거나 세션의 `run_config`를 통해 제공할 수 있습니다. 두 소스의 가드레일은 함께 실행됩니다. @@ -152,25 +152,54 @@ agent = RealtimeAgent( ) ``` -가드레일이 트리거되면 `guardrail_tripped` 이벤트를 생성하고 에이전트의 현재 응답을 인터럽트할 수 있습니다. 디바운스 동작은 안전성과 실시간 성능 요구 사항 간의 균형을 맞추는 데 도움이 됩니다. 텍스트 에이전트와 달리, 실시간 에이전트는 가드레일이 작동해도 Exception을 발생시키지 **않습니다**. +가드레일이 트리거되면 `guardrail_tripped` 이벤트가 생성되며, 에이전트의 현재 응답을 인터럽션할 수 있습니다. 디바운스 동작은 안전성과 실시간 성능 요구 사항의 균형을 맞추는 데 도움이 됩니다. 텍스트 에이전트와 달리, 실시간 에이전트는 가드레일이 트립되더라도 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` 이벤트를 반드시 수신하세요. -## 모델 직접 액세스 +## SIP 통합 -기본 모델에 접근해 커스텀 리스너를 추가하거나 고급 작업을 수행할 수 있습니다: +[Realtime Calls API](https://platform.openai.com/docs/guides/realtime-sip)로 수신되는 전화에 실시간 에이전트를 연결할 수 있습니다. SDK는 SIP를 통해 미디어를 협상하면서 동일한 에이전트 플로우를 재사용하는 [`OpenAIRealtimeSIPModel`][agents.realtime.openai_realtime.OpenAIRealtimeSIPModel]을 제공합니다. + +사용하려면 모델 인스턴스를 러너에 전달하고 세션 시작 시 SIP `call_id`를 제공하세요. 호출 ID는 수신 전화를 알리는 웹훅으로 전달됩니다. + +```python +from agents.realtime import RealtimeAgent, RealtimeRunner +from agents.realtime.openai_realtime import OpenAIRealtimeSIPModel + +runner = RealtimeRunner( + starting_agent=agent, + model=OpenAIRealtimeSIPModel(), +) + +async with await runner.run( + model_config={ + "call_id": call_id_from_webhook, + "initial_model_settings": { + "turn_detection": {"type": "semantic_vad", "interrupt_response": True}, + }, + }, +) as session: + async for event in session: + ... +``` + +발신자가 전화를 끊으면 SIP 세션이 종료되고 실시간 연결이 자동으로 닫힙니다. 전체 전화 예시는 [`examples/realtime/twilio_sip`](https://github.com/openai/openai-agents-python/tree/main/examples/realtime/twilio_sip)를 참고하세요. + +## 직접 모델 액세스 + +기본 모델에 접근하여 커스텀 리스너를 추가하거나 고급 작업을 수행할 수 있습니다: ```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] 인터페이스에 직접 접근할 수 있습니다. -## code examples +## 코드 예제 -완전한 동작 code examples는 [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/ko/realtime/quickstart.md b/docs/ko/realtime/quickstart.md index 1d24a0bc1..851a7a0a5 100644 --- a/docs/ko/realtime/quickstart.md +++ b/docs/ko/realtime/quickstart.md @@ -4,16 +4,16 @@ search: --- # 빠른 시작 -실시간 에이전트는 OpenAI의 Realtime API를 사용하여 AI 에이전트와의 음성 대화를 가능하게 합니다. 이 가이드는 첫 실시간 음성 에이전트를 만드는 방법을 안내합니다. +실시간 에이전트는 OpenAI의 Realtime API를 사용하여 AI 에이전트와 음성 대화를 가능하게 합니다. 이 가이드는 첫 실시간 음성 에이전트를 만드는 과정을 안내합니다. !!! warning "베타 기능" -실시간 에이전트는 베타 단계입니다. 구현을 개선하는 동안 호환성 깨짐이 있을 수 있습니다. +실시간 에이전트는 베타입니다. 구현을 개선하는 과정에서 호환성에 영향을 주는 변경이 발생할 수 있습니다. -## 사전 준비 사항 +## 사전 준비 - Python 3.9 이상 - OpenAI API 키 -- OpenAI Agents SDK에 대한 기본적인 이해 +- OpenAI Agents SDK에 대한 기본 이해 ## 설치 @@ -25,7 +25,7 @@ pip install openai-agents ## 첫 실시간 에이전트 만들기 -### 1. 필요한 구성 요소 임포트 +### 1. 필수 컴포넌트 가져오기 ```python import asyncio @@ -111,7 +111,7 @@ def _truncate_str(s: str, max_length: int) -> str: ## 전체 예제 -다음은 완전한 동작 예제입니다: +다음은 완전히 동작하는 예제입니다: ```python import asyncio @@ -200,19 +200,19 @@ if __name__ == "__main__": - `input_audio_format`: 입력 오디오 형식 (`pcm16`, `g711_ulaw`, `g711_alaw`) - `output_audio_format`: 출력 오디오 형식 -- `input_audio_transcription`: 음성 인식 구성 +- `input_audio_transcription`: 전사 구성 ### 턴 감지 - `type`: 감지 방식 (`server_vad`, `semantic_vad`) -- `threshold`: 음성 활동 임계값 (0.0-1.0) -- `silence_duration_ms`: 턴 종료를 감지할 무음 지속시간 +- `threshold`: 음성 활동 기준치 (0.0-1.0) +- `silence_duration_ms`: 턴 종료를 감지할 무음 지속 시간 - `prefix_padding_ms`: 발화 전 오디오 패딩 ## 다음 단계 -- [실시간 에이전트 자세히 알아보기](guide.md) -- [examples/realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) 폴더의 동작하는 code examples 확인 +- [실시간 에이전트에 대해 더 알아보기](guide.md) +- [examples/realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) 폴더에서 동작하는 code examples 확인 - 에이전트에 도구 추가 - 에이전트 간 핸드오프 구현 - 안전을 위한 가드레일 설정 @@ -225,7 +225,7 @@ if __name__ == "__main__": export OPENAI_API_KEY="your-api-key-here" ``` -또는 세션을 생성할 때 직접 전달하세요: +또는 세션을 생성할 때 직접 전달할 수도 있습니다: ```python session = await runner.run(model_config={"api_key": "your-api-key"}) diff --git a/docs/ko/release.md b/docs/ko/release.md index 26d583508..8d1505966 100644 --- a/docs/ko/release.md +++ b/docs/ko/release.md @@ -4,37 +4,44 @@ search: --- # 릴리스 프로세스/변경 로그 -이 프로젝트는 `0.Y.Z` 형식의 약간 수정된 시맨틱 버전 관리를 따릅니다. 선행 `0`은 SDK가 여전히 빠르게 발전 중임을 의미합니다. 각 구성 요소는 다음과 같이 증가시킵니다: +이 프로젝트는 `0.Y.Z` 형식의 약간 수정된 시맨틱 버전 관리를 따릅니다. 선행 `0`은 SDK가 아직 빠르게 발전 중임을 의미합니다. 구성 요소는 다음과 같이 증가합니다: ## 마이너(`Y`) 버전 -베타로 표시되지 않은 모든 퍼블릭 인터페이스에 대한 **호환성 파괴 변경**이 있을 때 마이너 버전 `Y`를 올립니다. 예를 들어 `0.0.x`에서 `0.1.x`로 올라갈 때 호환성 파괴 변경이 포함될 수 있습니다. +베타로 표시되지 않은 공개 인터페이스에 **호환 중단 변경**이 있을 때 마이너 버전 `Y`를 올립니다. 예를 들어, `0.0.x`에서 `0.1.x`로 올라갈 때 호환 중단 변경이 포함될 수 있습니다. -호환성 파괴 변경을 원하지 않으시면, 프로젝트에서 `0.0.x` 버전으로 고정할 것을 권장합니다. +호환 중단 변경을 원하지 않으시면, 프로젝트에서 `0.0.x` 버전으로 고정하는 것을 권장합니다. ## 패치(`Z`) 버전 -호환성 파괴가 없는 변경에 대해 `Z`를 증가시킵니다: +호환 중단이 없는 변경에 대해 `Z`를 증가시킵니다: - 버그 수정 -- 새 기능 +- 새로운 기능 - 비공개 인터페이스 변경 - 베타 기능 업데이트 -## 호환성 파괴 변경 로그 +## 호환 중단 변경 로그 + +### 0.5.0 + +이 버전은 눈에 띄는 호환 중단 변경을 도입하지 않지만, 새로운 기능과 내부의 몇 가지 중요한 업데이트가 포함되어 있습니다: + +- `RealtimeRunner`가 [SIP 프로토콜 연결](https://platform.openai.com/docs/guides/realtime-sip)을 처리하도록 지원 추가 +- Python 3.14 호환성을 위해 `Runner#run_sync`의 내부 로직을 대폭 개정 ### 0.4.0 -이 버전에서는 [openai](https://pypi.org/project/openai/) 패키지 v1.x 버전이 더 이상 지원되지 않습니다. 이 SDK와 함께 openai v2.x를 사용하세요. +이 버전부터 [openai](https://pypi.org/project/openai/) 패키지 v1.x 버전은 더 이상 지원되지 않습니다. 이 SDK와 함께 openai v2.x를 사용해 주세요. ### 0.3.0 -이 버전에서는 Realtime API 지원이 gpt-realtime 모델 및 해당 API 인터페이스(GA 버전)로 마이그레이션됩니다. +이 버전에서 Realtime API 지원이 gpt-realtime 모델과 해당 API 인터페이스(GA 버전)로 마이그레이션되었습니다. ### 0.2.0 -이 버전에서는 기존에 `Agent`를 인수로 받던 일부 위치가 이제 `AgentBase`를 인수로 받습니다. 예: MCP 서버의 `list_tools()` 호출. 이는 순수하게 타입과 관련된 변경이며, 여전히 `Agent` 객체를 받게 됩니다. 업데이트하려면 `Agent`를 `AgentBase`로 바꿔 타입 오류를 해결하면 됩니다. +이 버전에서는 이전에 `Agent`를 인자로 받던 일부 위치가 이제 `AgentBase`를 인자로 받습니다. 예: MCP 서버의 `list_tools()` 호출. 이는 타입과 관련된 변경일 뿐이며, 여전히 `Agent` 객체를 받게 됩니다. 업데이트하려면 `Agent`를 `AgentBase`로 바꿔 타입 오류만 수정하면 됩니다. ### 0.1.0 -이 버전에서는 [`MCPServer.list_tools()`][agents.mcp.server.MCPServer]에 `run_context`와 `agent`라는 새 매개변수가 두 개 추가되었습니다. `MCPServer`를 서브클래싱하는 모든 클래스에 이 매개변수들을 추가해야 합니다. \ No newline at end of file +이 버전에서 [`MCPServer.list_tools()`][agents.mcp.server.MCPServer]에 `run_context`와 `agent`라는 두 개의 새로운 매개변수가 추가되었습니다. `MCPServer`를 서브클래싱하는 모든 클래스에 이 매개변수를 추가해야 합니다. \ No newline at end of file diff --git a/docs/ko/repl.md b/docs/ko/repl.md index 097c10369..32e4b10ae 100644 --- a/docs/ko/repl.md +++ b/docs/ko/repl.md @@ -4,7 +4,8 @@ search: --- # REPL 유틸리티 -SDK는 터미널에서 에이전트의 동작을 빠르고 대화형으로 테스트할 수 있도록 `run_demo_loop`를 제공합니다. +SDK는 터미널에서 에이전트 동작을 빠르게 인터랙티브하게 테스트할 수 있도록 `run_demo_loop`를 제공합니다. + ```python import asyncio @@ -18,6 +19,6 @@ if __name__ == "__main__": asyncio.run(main()) ``` -`run_demo_loop`는 반복 루프에서 사용자 입력을 요청하고, 턴 사이의 대화 기록을 유지합니다. 기본적으로 생성되는 대로 모델 출력을 스트리밍합니다. 위 예제를 실행하면, run_demo_loop가 대화형 채팅 세션을 시작합니다. 계속해서 사용자 입력을 요청하고, 턴 사이의 전체 대화 기록을 기억하여(에이전트가 어떤 내용이 논의되었는지 알 수 있도록) 응답을 생성하는 즉시 실시간으로 에이전트의 응답을 자동 스트리밍합니다. +`run_demo_loop`는 루프에서 사용자 입력을 요청하며, 턴 사이의 대화 기록을 유지합니다. 기본적으로 생성되는 대로 모델 출력을 스트리밍합니다. 위의 예제를 실행하면, run_demo_loop가 인터랙티브 채팅 세션을 시작합니다. 사용자 입력을 계속 요청하고, 턴 사이의 전체 대화 기록을 기억하며(따라서 에이전트가 어떤 대화가 오갔는지 알 수 있음), 에이전트의 응답을 생성되는 즉시 실시간으로 자동 스트리밍합니다. -이 채팅 세션을 종료하려면 `quit` 또는 `exit`를 입력하고 Enter 키를 누르거나 `Ctrl-D` 키보드 단축키를 사용하세요. \ No newline at end of file +채팅 세션을 종료하려면 `quit` 또는 `exit`를 입력(Enter 키)하거나 `Ctrl-D` 키보드 단축키를 사용하세요. \ No newline at end of file diff --git a/docs/ko/results.md b/docs/ko/results.md index 6cb8c0189..b0ec0ed4b 100644 --- a/docs/ko/results.md +++ b/docs/ko/results.md @@ -6,51 +6,51 @@ search: `Runner.run` 메서드를 호출하면 다음 중 하나를 받습니다: -- [`RunResult`][agents.result.RunResult] (`run` 또는 `run_sync` 호출 시) -- [`RunResultStreaming`][agents.result.RunResultStreaming] (`run_streamed` 호출 시) +- `run` 또는 `run_sync`를 호출한 경우 [`RunResult`][agents.result.RunResult] +- `run_streamed`를 호출한 경우 [`RunResultStreaming`][agents.result.RunResultStreaming] -둘 다 [`RunResultBase`][agents.result.RunResultBase]를 상속하며, 대부분의 유용한 정보가 여기에 있습니다. +두 결과 모두 대부분의 유용한 정보가 담긴 [`RunResultBase`][agents.result.RunResultBase]를 상속합니다. ## 최종 출력 -[`final_output`][agents.result.RunResultBase.final_output] 속성에는 마지막으로 실행된 에이전트의 최종 출력이 들어 있습니다. 이는 다음 중 하나입니다: +[`final_output`][agents.result.RunResultBase.final_output] 프로퍼티에는 마지막으로 실행된 에이전트의 최종 출력이 담깁니다. 이는 다음 중 하나입니다: -- 마지막 에이전트에 `output_type`이 정의되지 않은 경우 `str` -- 에이전트에 출력 타입이 정의된 경우 `last_agent.output_type` 타입의 객체 +- 마지막 에이전트에 `output_type`이 정의되지 않은 경우 `str` +- 에이전트에 출력 타입이 정의된 경우 `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]입니다. 실행 항목은 LLM 이 생성한 원문 항목을 래핑합니다. +[`new_items`][agents.result.RunResultBase.new_items] 프로퍼티에는 실행 중 생성된 신규 항목이 담깁니다. 항목은 [`RunItem`][agents.items.RunItem]들입니다. 실행 항목은 LLM이 생성한 원문 항목을 래핑합니다. -- [`MessageOutputItem`][agents.items.MessageOutputItem]: LLM 의 메시지를 나타냄. 원문 항목은 생성된 메시지 -- [`HandoffCallItem`][agents.items.HandoffCallItem]: LLM 이 핸드오프 도구를 호출했음을 나타냄. 원문 항목은 LLM 의 도구 호출 항목 -- [`HandoffOutputItem`][agents.items.HandoffOutputItem]: 핸드오프가 발생했음을 나타냄. 원문 항목은 핸드오프 도구 호출에 대한 도구 응답. 항목에서 소스/타깃 에이전트에도 접근 가능 -- [`ToolCallItem`][agents.items.ToolCallItem]: LLM 이 도구를 호출했음을 나타냄 -- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem]: 도구가 호출되었음을 나타냄. 원문 항목은 도구 응답. 항목에서 도구 출력에도 접근 가능 -- [`ReasoningItem`][agents.items.ReasoningItem]: LLM 의 추론 항목을 나타냄. 원문 항목은 생성된 추론 +- [`MessageOutputItem`][agents.items.MessageOutputItem]은 LLM의 메시지를 나타냅니다. 원문 항목은 생성된 메시지입니다. +- [`HandoffCallItem`][agents.items.HandoffCallItem]은 LLM이 핸드오프 도구를 호출했음을 나타냅니다. 원문 항목은 LLM의 도구 호출 항목입니다. +- [`HandoffOutputItem`][agents.items.HandoffOutputItem]은 핸드오프가 발생했음을 나타냅니다. 원문 항목은 핸드오프 도구 호출에 대한 도구 응답입니다. 항목에서 소스/타깃 에이전트에도 접근할 수 있습니다. +- [`ToolCallItem`][agents.items.ToolCallItem]은 LLM이 도구를 호출했음을 나타냅니다. +- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem]은 도구가 호출되었음을 나타냅니다. 원문 항목은 도구 응답입니다. 항목에서 도구 출력에도 접근할 수 있습니다. +- [`ReasoningItem`][agents.items.ReasoningItem]은 LLM의 추론 항목을 나타냅니다. 원문 항목은 생성된 추론입니다. ## 기타 정보 ### 가드레일 결과 -[`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_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/ko/running_agents.md b/docs/ko/running_agents.md index 2c28c37ee..6bdc14c92 100644 --- a/docs/ko/running_agents.md +++ b/docs/ko/running_agents.md @@ -6,9 +6,9 @@ search: 에이전트는 [`Runner`][agents.run.Runner] 클래스를 통해 실행할 수 있습니다. 선택지는 3가지입니다: -1. [`Runner.run()`][agents.run.Runner.run]: 비동기로 실행되며 [`RunResult`][agents.result.RunResult] 를 반환 -2. [`Runner.run_sync()`][agents.run.Runner.run_sync]: 동기 메서드로, 내부적으로 `.run()` 을 실행 -3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed]: 비동기로 실행되며 [`RunResultStreaming`][agents.result.RunResultStreaming] 를 반환. LLM 을 스트리밍 모드로 호출하며, 수신되는 대로 이벤트를 스트리밍 +1. [`Runner.run()`][agents.run.Runner.run]: 비동기로 실행되며 [`RunResult`][agents.result.RunResult] 를 반환합니다. +2. [`Runner.run_sync()`][agents.run.Runner.run_sync]: 동기 메서드이며 내부적으로 `.run()` 을 실행합니다. +3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed]: 비동기로 실행되며 [`RunResultStreaming`][agents.result.RunResultStreaming] 를 반환합니다. LLM 을 스트리밍 모드로 호출하고, 수신되는 대로 이벤트를 스트리밍합니다. ```python from agents import Agent, Runner @@ -29,49 +29,49 @@ async def main(): `Runner` 의 run 메서드를 사용할 때 시작 에이전트와 입력을 전달합니다. 입력은 문자열(사용자 메시지로 간주) 또는 OpenAI Responses API 의 입력 항목 리스트일 수 있습니다. -그 후 러너는 다음 루프를 실행합니다: +Runner 는 다음과 같은 루프를 실행합니다: -1. 현재 에이전트와 현재 입력으로 LLM 을 호출 -2. LLM 이 출력을 생성 - 1. LLM 이 `final_output` 을 반환하면 루프가 종료되고 결과를 반환 - 2. LLM 이 핸드오프를 수행하면 현재 에이전트와 입력을 업데이트하고 루프를 재실행 - 3. LLM 이 도구 호출을 생성하면 해당 도구 호출을 실행하고 결과를 덧붙인 뒤 루프를 재실행 -3. 전달된 `max_turns` 를 초과하면 [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 예외를 발생 +1. 현재 에이전트와 현재 입력으로 LLM 을 호출합니다. +2. LLM 이 출력을 생성합니다. + 1. LLM 이 `final_output` 을 반환하면 루프가 종료되고 결과를 반환합니다. + 2. LLM 이 핸드오프를 수행하면 현재 에이전트와 입력을 갱신하고 루프를 재실행합니다. + 3. LLM 이 도구 호출을 생성하면 해당 도구 호출을 실행하고 결과를 추가한 뒤 루프를 재실행합니다. +3. 전달된 `max_turns` 를 초과하면 [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 예외를 발생시킵니다. !!! note - LLM 출력이 "최종 출력" 으로 간주되는 규칙은, 원하는 타입의 텍스트 출력을 생성하고 도구 호출이 없는 경우입니다. + LLM 출력이 "최종 출력"으로 간주되는 규칙은, 원하는 타입의 텍스트 출력을 생성하고 도구 호출이 없을 때입니다. ## 스트리밍 -스트리밍을 사용하면 LLM 이 실행되는 동안 추가로 스트리밍 이벤트를 수신할 수 있습니다. 스트림이 완료되면 [`RunResultStreaming`][agents.result.RunResultStreaming] 에는 실행에 대한 전체 정보와 새로 생성된 모든 출력이 포함됩니다. 스트리밍 이벤트는 `.stream_events()` 를 호출해 받을 수 있습니다. 자세한 내용은 [스트리밍 가이드](streaming.md)에서 확인하세요. +스트리밍을 사용하면 LLM 이 실행되는 동안 스트리밍 이벤트를 추가로 수신할 수 있습니다. 스트림이 완료되면 [`RunResultStreaming`][agents.result.RunResultStreaming] 에는 실행에 대한 전체 정보(생성된 모든 신규 출력 포함)가 담깁니다. 스트리밍 이벤트는 `.stream_events()` 를 호출해 받을 수 있습니다. 자세한 내용은 [스트리밍 가이드](streaming.md)를 참고하세요. ## 실행 구성 -`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` 설정을 권장. 그룹 ID 는 여러 실행에 걸쳐 트레이스를 연결할 수 있는 선택 필드 -- [`trace_metadata`][agents.run.RunConfig.trace_metadata]: 모든 트레이스에 포함할 메타데이터 +- [`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` 설정을 권장합니다. 그룹 ID 는 선택 필드로, 여러 실행에 걸친 트레이스를 연결할 수 있게 합니다. +- [`trace_metadata`][agents.run.RunConfig.trace_metadata]: 모든 트레이스에 포함할 메타데이터입니다. ## 대화/채팅 스레드 -어느 run 메서드를 호출하든 하나 이상의 에이전트 실행(따라서 하나 이상의 LLM 호출)로 이어질 수 있지만, 이는 채팅 대화의 단일 논리 턴을 나타냅니다. 예: +어떤 run 메서드를 호출하든 하나 이상의 에이전트가 실행될 수 있습니다(즉, 하나 이상의 LLM 호출), 하지만 논리적으로는 채팅 대화의 단일 턴을 나타냅니다. 예: 1. 사용자 턴: 사용자가 텍스트 입력 -2. 러너 실행: 첫 번째 에이전트가 LLM 을 호출하고 도구를 실행하고 두 번째 에이전트로 핸드오프, 두 번째 에이전트가 추가 도구를 실행한 뒤 출력을 생성 +2. Runner 실행: 첫 번째 에이전트가 LLM 을 호출하고 도구를 실행한 뒤 두 번째 에이전트로 핸드오프, 두 번째 에이전트가 더 많은 도구를 실행한 뒤 출력을 생성 -에이전트 실행이 끝나면 사용자에게 무엇을 보여줄지 선택할 수 있습니다. 예를 들어, 에이전트가 생성한 모든 새 항목을 보여주거나 최종 출력만 보여줄 수 있습니다. 어느 쪽이든 사용자가 후속 질문을 할 수 있으며, 이때 run 메서드를 다시 호출하면 됩니다. +에이전트 실행이 끝나면 사용자에게 무엇을 보여줄지 선택할 수 있습니다. 예를 들어, 에이전트가 생성한 모든 신규 항목을 보여주거나 최종 출력만 보여줄 수 있습니다. 어느 쪽이든, 사용자가 후속 질문을 할 수 있으며, 그 경우 run 메서드를 다시 호출하면 됩니다. ### 수동 대화 관리 -[`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] 메서드를 사용해 다음 턴의 입력을 받아 대화 기록을 수동으로 관리할 수 있습니다: +다음 턴의 입력을 얻기 위해 [`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] 메서드를 사용하여 대화 이력을 수동으로 관리할 수 있습니다: ```python async def main(): @@ -91,9 +91,9 @@ async def main(): # California ``` -### Sessions 를 통한 자동 대화 관리 +### Sessions 기반 자동 대화 관리 -더 간단한 접근 방식으로, [Sessions](sessions/index.md) 를 사용하면 `.to_input_list()` 를 수동으로 호출하지 않고도 대화 기록을 자동으로 처리할 수 있습니다: +더 간단한 접근 방식으로, [Sessions](sessions/index.md) 를 사용하면 `.to_input_list()` 를 수동으로 호출하지 않고도 대화 이력을 자동으로 처리할 수 있습니다: ```python from agents import Agent, Runner, SQLiteSession @@ -117,24 +117,24 @@ async def main(): # California ``` -Sessions 는 자동으로 다음을 수행합니다: +Sessions 는 다음을 자동으로 수행합니다: -- 각 실행 전 대화 기록을 가져옴 -- 각 실행 후 새 메시지를 저장 -- 서로 다른 세션 ID 별로 대화를 분리 관리 +- 각 실행 전 대화 이력 가져오기 +- 각 실행 후 새 메시지 저장 +- 서로 다른 세션 ID 에 대해 별도의 대화 유지 -자세한 내용은 [Sessions 문서](sessions/index.md)를 참조하세요. +자세한 내용은 [Sessions 문서](sessions/index.md)에서 확인하세요. ### 서버 관리 대화 -`to_input_list()` 또는 `Sessions` 로 로컬에서 처리하는 대신, OpenAI conversation state 기능에 서버 측 대화 상태 관리를 맡길 수도 있습니다. 이를 통해 과거 메시지를 모두 수동으로 재전송하지 않고도 대화 기록을 보존할 수 있습니다. 자세한 내용은 [OpenAI Conversation state 가이드](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses)에서 확인하세요. +로컬에서 `to_input_list()` 또는 `Sessions` 로 처리하는 대신, OpenAI 대화 상태 기능에 서버 측 대화 상태 관리를 맡길 수도 있습니다. 이를 통해 과거 모든 메시지를 수동으로 다시 보내지 않고도 대화 이력을 보존할 수 있습니다. 자세한 내용은 [OpenAI Conversation state 가이드](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses)를 참고하세요. -OpenAI 는 턴 간 상태를 추적하는 두 가지 방법을 제공합니다: +OpenAI 는 턴에 걸쳐 상태를 추적하는 두 가지 방법을 제공합니다: #### 1. `conversation_id` 사용 -먼저 OpenAI Conversations API 를 사용해 대화를 생성한 뒤, 이후 모든 호출에서 해당 ID 를 재사용합니다: +먼저 OpenAI Conversations API 를 사용해 대화를 생성한 다음, 이후 모든 호출에서 해당 ID 를 재사용합니다: ```python from agents import Agent, Runner @@ -166,7 +166,7 @@ async def main(): #### 2. `previous_response_id` 사용 -다른 옵션은 **response chaining** 으로, 각 턴이 이전 턴의 response ID 에 명시적으로 연결됩니다. +또 다른 옵션은 **응답 체이닝**으로, 각 턴이 이전 턴의 response ID 에 명시적으로 연결됩니다. ```python from agents import Agent, Runner @@ -192,16 +192,16 @@ async def main(): ## 장기 실행 에이전트 및 휴먼인더루프 (HITL) -Agents SDK 의 [Temporal](https://temporal.io/) 통합을 사용하여 내구성이 있는 장기 실행 워크플로, 휴먼인더루프 작업을 포함해 실행할 수 있습니다. Temporal 과 Agents SDK 가 장기 실행 작업을 완료하는 데 함께 동작하는 데모는 [이 영상](https://www.youtube.com/watch?v=fFBZqzT4DD8)에서 볼 수 있으며, [문서는 여기](https://github.com/temporalio/sdk-python/tree/main/temporalio/contrib/openai_agents)에서 확인하세요. +Agents SDK 의 [Temporal](https://temporal.io/) 통합을 사용하면 내구성이 있는 장기 실행 워크플로(휴먼인더루프 작업 포함)를 실행할 수 있습니다. 장기 작업을 완료하기 위해 Temporal 과 Agents SDK 가 함께 동작하는 데모는 [이 영상](https://www.youtube.com/watch?v=fFBZqzT4DD8)에서 확인하고, [문서는 여기](https://github.com/temporalio/sdk-python/tree/main/temporalio/contrib/openai_agents)에서 확인하세요. ## 예외 -SDK 는 특정 상황에서 예외를 발생시킵니다. 전체 목록은 [`agents.exceptions`][] 에 있습니다. 개요는 다음과 같습니다: +SDK 는 특정 경우 예외를 발생시킵니다. 전체 목록은 [`agents.exceptions`][] 에 있습니다. 개요는 다음과 같습니다: -- [`AgentsException`][agents.exceptions.AgentsException]: SDK 내에서 발생하는 모든 예외의 기본 클래스. 다른 모든 구체적 예외의 상위 타입으로 사용 -- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded]: 에이전트 실행이 `Runner.run`, `Runner.run_sync`, `Runner.run_streamed` 메서드에 전달된 `max_turns` 한도를 초과했을 때 발생. 에이전트가 지정된 상호작용 턴 수 내에 작업을 완료하지 못했음을 의미 -- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError]: 기반 모델(LLM) 이 예상치 못했거나 잘못된 출력을 생성했을 때 발생. 예를 들면: - - 형식이 잘못된 JSON: 도구 호출 또는 직접 출력에서 잘못된 JSON 구조를 제공하는 경우, 특히 특정 `output_type` 이 정의된 경우 - - 예상치 못한 도구 관련 실패: 모델이 도구를 예상된 방식으로 사용하지 못한 경우 -- [`UserError`][agents.exceptions.UserError]: SDK 를 사용하는 개발자(코드를 작성하는 사람) 가 SDK 사용 중 오류를 일으켰을 때 발생. 보통 잘못된 코드 구현, 유효하지 않은 구성, SDK API 오사용에서 기인 -- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered], [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]: 각각 입력 가드레일 또는 출력 가드레일의 조건이 충족될 때 발생. 입력 가드레일은 처리 전에 수신 메시지를 검사하고, 출력 가드레일은 에이전트의 최종 응답을 전달하기 전에 검사 \ No newline at end of file +- [`AgentsException`][agents.exceptions.AgentsException]: SDK 내에서 발생하는 모든 예외의 기본 클래스입니다. 다른 모든 구체적 예외가 파생되는 일반 타입으로 사용됩니다. +- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded]: 에이전트 실행이 `max_turns` 한도를 초과했을 때 `Runner.run`, `Runner.run_sync`, 또는 `Runner.run_streamed` 메서드에서 발생합니다. 이는 에이전트가 지정된 상호작용 턴 수 내에 작업을 완료하지 못했음을 나타냅니다. +- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError]: 기본 모델(LLM) 이 예상치 못했거나 유효하지 않은 출력을 생성할 때 발생합니다. 다음을 포함할 수 있습니다: + - 잘못된 JSON: 특히 특정 `output_type` 이 정의된 경우, 도구 호출이나 직접 출력에 대해 모델이 잘못된 JSON 구조를 제공하는 경우 + - 예기치 않은 도구 관련 실패: 모델이 예상된 방식으로 도구를 사용하지 못하는 경우 +- [`UserError`][agents.exceptions.UserError]: SDK 를 사용하는 코드 작성자인 당신이 SDK 사용 중 오류를 발생시켰을 때 발생합니다. 보통 잘못된 코드 구현, 유효하지 않은 구성, SDK API 오용으로 인해 발생합니다. +- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered], [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]: 각각 입력 가드레일 또는 출력 가드레일의 조건이 충족될 때 발생합니다. 입력 가드레일은 처리 전에 수신 메시지를 검사하고, 출력 가드레일은 전달 전 에이전트의 최종 응답을 검사합니다. \ No newline at end of file diff --git a/docs/ko/sessions/advanced_sqlite_session.md b/docs/ko/sessions/advanced_sqlite_session.md index 7084b4a9e..cd6388f2d 100644 --- a/docs/ko/sessions/advanced_sqlite_session.md +++ b/docs/ko/sessions/advanced_sqlite_session.md @@ -9,9 +9,9 @@ search: ## 기능 - **대화 분기**: 임의의 사용자 메시지에서 대체 대화 경로 생성 -- **사용량 추적**: 각 턴별 상세 토큰 사용량 분석과 전체 JSON 분해 제공 -- **구조화된 쿼리**: 턴 기준 대화 조회, 도구 사용 통계 등 -- **분기 관리**: 독립적인 분기 전환 및 관리 +- **사용량 추적**: 각 턴별 토큰 사용량에 대한 상세 분석과 전체 JSON 분해 +- **구조화된 쿼리**: 턴 단위 대화 조회, 도구 사용 통계 등 다양한 조회 +- **브랜치 관리**: 독립적인 브랜치 전환 및 관리 - **메시지 구조 메타데이터**: 메시지 유형, 도구 사용, 대화 흐름 추적 ## 빠른 시작 @@ -85,13 +85,13 @@ session = AdvancedSQLiteSession( ### 매개변수 - `session_id` (str): 대화 세션의 고유 식별자 -- `db_path` (str | Path): SQLite 데이터베이스 파일 경로. 인메모리 저장을 위해 기본값은 `:memory:` +- `db_path` (str | Path): SQLite 데이터베이스 파일 경로. 인메모리 저장소의 기본값은 `:memory:` - `create_tables` (bool): 고급 테이블을 자동으로 생성할지 여부. 기본값은 `False` - `logger` (logging.Logger | None): 세션에 사용할 커스텀 로거. 기본값은 모듈 로거 ## 사용량 추적 -AdvancedSQLiteSession은 대화의 각 턴마다 토큰 사용 데이터를 저장하여 상세한 사용량 분석을 제공합니다. **이는 각 에이전트 실행 후 `store_run_usage` 메서드를 호출하는 것에 전적으로 의존합니다.** +AdvancedSQLiteSession은 대화의 각 턴별 토큰 사용 데이터를 저장하여 상세한 사용량 분석을 제공합니다. **이는 각 에이전트 실행 후 `store_run_usage` 메서드가 호출되는 것에 전적으로 의존합니다.** ### 사용 데이터 저장 @@ -137,9 +137,9 @@ turn_2_usage = await session.get_turn_usage(user_turn_number=2) ## 대화 분기 -AdvancedSQLiteSession의 핵심 기능 중 하나는 임의의 사용자 메시지에서 대화 분기를 생성해 대체 대화 경로를 탐색할 수 있는 능력입니다. +AdvancedSQLiteSession의 핵심 기능 중 하나는 임의의 사용자 메시지에서 대화 브랜치를 생성하여 대체 대화 경로를 탐색할 수 있는 능력입니다. -### 분기 생성 +### 브랜치 생성 ```python # Get available turns for branching @@ -165,7 +165,7 @@ branch_id = await session.create_branch_from_content( ) ``` -### 분기 관리 +### 브랜치 관리 ```python # List all branches @@ -182,7 +182,7 @@ await session.switch_to_branch(branch_id) await session.delete_branch(branch_id, force=True) # force=True allows deleting current branch ``` -### 분기 워크플로 예시 +### 브랜치 워크플로 예시 ```python # Original conversation @@ -245,17 +245,17 @@ for turn in matching_turns: ### 메시지 구조 -세션은 다음을 포함한 메시지 구조를 자동으로 추적합니다: +세션은 다음을 포함하여 메시지 구조를 자동으로 추적합니다: -- 메시지 유형(user, assistant, tool_call 등) -- 도구 호출의 도구 이름 +- 메시지 유형 (user, assistant, tool_call 등) +- 도구 호출 시 도구 이름 - 턴 번호와 시퀀스 번호 -- 분기 연관성 +- 브랜치 연관 관계 - 타임스탬프 ## 데이터베이스 스키마 -AdvancedSQLiteSession은 기본 SQLite 스키마를 두 개의 추가 테이블로 확장합니다: +AdvancedSQLiteSession은 기본 SQLite 스키마를 확장하여 두 개의 추가 테이블을 제공합니다: ### message_structure 테이블 @@ -298,10 +298,10 @@ CREATE TABLE turn_usage ( ## 전체 예제 -모든 기능을 종합적으로 보여주는 [완전한 예제](https://github.com/openai/openai-agents-python/tree/main/examples/memory/advanced_sqlite_session_example.py)를 확인하세요. +모든 기능을 포괄적으로 보여주는 [전체 예제](https://github.com/openai/openai-agents-python/tree/main/examples/memory/advanced_sqlite_session_example.py)를 확인하세요. -## API 레퍼런스 +## API 참고 - [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 메인 클래스 - [`Session`][agents.memory.session.Session] - 기본 세션 프로토콜 \ No newline at end of file diff --git a/docs/ko/sessions/encrypted_session.md b/docs/ko/sessions/encrypted_session.md index 2ea020ac1..caff3eca9 100644 --- a/docs/ko/sessions/encrypted_session.md +++ b/docs/ko/sessions/encrypted_session.md @@ -4,18 +4,18 @@ search: --- # 암호화된 세션 -`EncryptedSession`은 모든 세션 구현에 투명한 암호화를 제공하며, 대화 데이터를 보호하고 오래된 항목을 자동으로 만료합니다. +`EncryptedSession`은 어떤 세션 구현에도 투명한 암호화를 제공하여, 자동 만료와 함께 대화 데이터를 안전하게 보호합니다. -## 기능 +## 특징 -- **투명한 암호화**: 어떤 세션이든 Fernet 암호화로 감쌉니다 -- **세션별 키**: HKDF 키 파생을 사용해 세션마다 고유한 암호화를 적용합니다 -- **자동 만료**: TTL이 만료되면 오래된 항목은 자동으로 건너뜁니다 -- **대체 가능**: 기존의 어떤 세션 구현과도 함께 동작합니다 +- **투명한 암호화**: 모든 세션을 Fernet 암호화로 래핑 +- **세션별 키**: 세션마다 고유한 암호화를 위해 HKDF 키 유도 사용 +- **자동 만료**: TTL이 만료된 항목은 조용히 건너뜀 +- **대체 가능**: 기존 세션 구현과 호환 ## 설치 -암호화된 세션을 사용하려면 `encrypt` extra가 필요합니다: +암호화 세션을 사용하려면 `encrypt` extra가 필요합니다: ```bash pip install openai-agents[encrypt] @@ -101,9 +101,9 @@ session = EncryptedSession( ) ``` -## 다양한 세션 유형과의 사용 +## 다양한 세션 타입과의 사용 -### SQLite 세션 사용 +### SQLite 세션과 함께 사용 ```python from agents import SQLiteSession @@ -119,7 +119,7 @@ session = EncryptedSession( ) ``` -### SQLAlchemy 세션 사용 +### SQLAlchemy 세션과 함께 사용 ```python from agents.extensions.memory import EncryptedSession, SQLAlchemySession @@ -140,30 +140,30 @@ session = EncryptedSession( !!! warning "고급 세션 기능" - `EncryptedSession`을 `AdvancedSQLiteSession` 같은 고급 세션 구현과 함께 사용할 때 다음 사항에 유의하세요: + `AdvancedSQLiteSession`과 같은 고급 세션 구현에서 `EncryptedSession`을 사용할 때, 다음 사항에 유의하세요: - - 메시지 내용이 암호화되므로 `find_turns_by_content()` 같은 메서드는 효과적으로 동작하지 않습니다 - - 내용 기반 검색은 암호화된 데이터에서 수행되어 효율이 제한됩니다 + - 메시지 콘텐츠가 암호화되므로 `find_turns_by_content()` 같은 메서드는 효과적으로 동작하지 않습니다 + - 콘텐츠 기반 검색은 암호화된 데이터에서 수행되어 효율이 제한됩니다 -## 키 파생 +## 키 유도 -EncryptedSession은 HKDF(HMAC 기반 키 파생 함수)를 사용하여 세션마다 고유한 암호화 키를 파생합니다: +EncryptedSession은 세션별로 고유한 암호화 키를 유도하기 위해 HKDF(HMAC 기반 Key Derivation Function)를 사용합니다: -- **마스터 키**: 제공한 암호화 키 +- **마스터 키**: 사용자가 제공한 암호화 키 - **세션 솔트**: 세션 ID - **Info 문자열**: `"agents.session-store.hkdf.v1"` - **출력**: 32바이트 Fernet 키 -이는 다음을 보장합니다: -- 각 세션은 고유한 암호화 키를 가집니다 -- 마스터 키 없이는 키를 파생할 수 없습니다 -- 서로 다른 세션 간에는 세션 데이터를 복호화할 수 없습니다 +이를 통해 다음이 보장됩니다: +- 각 세션은 고유한 암호화 키를 가짐 +- 마스터 키 없이는 키를 유도할 수 없음 +- 서로 다른 세션 간에는 세션 데이터를 복호화할 수 없음 ## 자동 만료 -항목이 TTL을 초과하면 검색 중에 자동으로 건너뜁니다: +항목이 TTL을 초과하면, 조회 시 자동으로 건너뜁니다: ```python # Items older than TTL are silently ignored @@ -175,5 +175,5 @@ result = await Runner.run(agent, "Continue conversation", session=session) ## API 레퍼런스 -- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - 기본 클래스 +- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - 메인 클래스 - [`Session`][agents.memory.session.Session] - 기본 세션 프로토콜 \ No newline at end of file diff --git a/docs/ko/sessions/index.md b/docs/ko/sessions/index.md index 47e536fd2..908c0e626 100644 --- a/docs/ko/sessions/index.md +++ b/docs/ko/sessions/index.md @@ -4,9 +4,9 @@ search: --- # 세션 -Agents SDK 는 여러 에이전트 실행에 걸쳐 대화 이력을 자동으로 유지하는 내장 세션 메모리를 제공합니다. 이를 통해 턴 사이에 `.to_input_list()`를 수동으로 처리할 필요가 없습니다. +Agents SDK 는 여러 에이전트 실행 간에 대화 기록을 자동으로 유지하는 내장 세션 메모리를 제공합니다. 이를 통해 턴 사이에 `.to_input_list()`를 수동으로 처리할 필요가 없습니다. -세션은 특정 세션에 대한 대화 이력을 저장하여, 에이전트가 명시적인 수동 메모리 관리 없이도 컨텍스트를 유지할 수 있도록 합니다. 이는 에이전트가 이전 상호작용을 기억하기를 원하는 채팅 애플리케이션이나 멀티 턴 대화를 구축할 때 특히 유용합니다. +세션은 특정 세션의 대화 기록을 저장하여, 명시적인 수동 메모리 관리 없이도 에이전트가 컨텍스트를 유지할 수 있게 합니다. 이는 에이전트가 이전 상호작용을 기억해야 하는 채팅 애플리케이션이나 멀티턴 대화를 구축할 때 특히 유용합니다. ## 빠른 시작 @@ -51,17 +51,17 @@ print(result.final_output) # "Approximately 39 million" 세션 메모리가 활성화되면: -1. **각 실행 전**: 러너가 세션의 대화 이력을 자동으로 가져와 입력 항목 앞에 추가합니다 -2. **각 실행 후**: 실행 중에 생성된 모든 새 항목(사용자 입력, 어시스턴트 응답, 도구 호출 등)이 세션에 자동으로 저장됩니다 -3. **컨텍스트 유지**: 동일한 세션으로 후속 실행을 수행하면 전체 대화 이력이 포함되어 에이전트가 컨텍스트를 유지할 수 있습니다 +1. **각 실행 전**: 러너가 자동으로 해당 세션의 대화 기록을 가져와 입력 아이템 앞에 추가합니다 +2. **각 실행 후**: 실행 중 생성된 모든 새 아이템(사용자 입력, 어시스턴트 응답, 도구 호출 등)이 자동으로 세션에 저장됩니다 +3. **컨텍스트 유지**: 동일한 세션으로 수행되는 이후 실행에는 전체 대화 기록이 포함되어, 에이전트가 컨텍스트를 유지할 수 있습니다 -이로써 `.to_input_list()`를 수동으로 호출하고 실행 간 대화 상태를 관리할 필요가 없어집니다. +이로써 `.to_input_list()`를 수동으로 호출하고 실행 간 대화 상태를 관리할 필요가 없습니다. ## 메모리 작업 ### 기본 작업 -세션은 대화 이력을 관리하기 위한 여러 작업을 지원합니다: +세션은 대화 기록을 관리하기 위한 여러 작업을 지원합니다: ```python from agents import SQLiteSession @@ -88,7 +88,7 @@ await session.clear_session() ### 수정용 pop_item 사용 -`pop_item` 메서드는 대화에서 마지막 항목을 되돌리거나 수정하려는 경우에 특히 유용합니다: +대화에서 마지막 아이템을 되돌리거나 수정하려는 경우 `pop_item` 메서드가 특히 유용합니다: ```python from agents import Agent, Runner, SQLiteSession @@ -159,7 +159,7 @@ print(result.final_output) # "California" ### SQLite 세션 -기본 제공되는 경량의 SQLite 기반 세션 구현: +기본 제공되는 경량 SQLite 기반 세션 구현: ```python from agents import SQLiteSession @@ -198,11 +198,13 @@ engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/db") session = SQLAlchemySession("user_123", engine=engine, create_tables=True) ``` -자세한 문서는 [SQLAlchemy 세션](sqlalchemy_session.md)을 참조하세요. +자세한 문서는 [SQLAlchemy Sessions](sqlalchemy_session.md)를 참고하세요. + + ### 고급 SQLite 세션 -대화 분기, 사용량 분석, 구조화된 쿼리를 제공하는 향상된 SQLite 세션: +대화 분기, 사용량 분석, 구조화된 쿼리가 가능한 향상된 SQLite 세션: ```python from agents.extensions.memory import AdvancedSQLiteSession @@ -222,11 +224,11 @@ await session.store_run_usage(result) # Track token usage await session.create_branch_from_turn(2) # Branch from turn 2 ``` -자세한 문서는 [고급 SQLite 세션](advanced_sqlite_session.md)을 참조하세요. +자세한 문서는 [Advanced SQLite Sessions](advanced_sqlite_session.md)를 참고하세요. ### 암호화 세션 -모든 세션 구현에 사용할 수 있는 투명한 암호화 래퍼: +모든 세션 구현을 위한 투명한 암호화 래퍼: ```python from agents.extensions.memory import EncryptedSession, SQLAlchemySession @@ -249,13 +251,17 @@ session = EncryptedSession( result = await Runner.run(agent, "Hello", session=session) ``` -자세한 문서는 [암호화 세션](encrypted_session.md)을 참조하세요. +자세한 문서는 [Encrypted Sessions](encrypted_session.md)를 참고하세요. + +### 기타 세션 유형 + +몇 가지 더 내장 옵션이 있습니다. `examples/memory/` 및 `extensions/memory/` 아래의 소스 코드를 참고하세요. ## 세션 관리 ### 세션 ID 네이밍 -대화를 구성하는 데 도움이 되는 의미 있는 세션 ID 를 사용하세요: +대화를 체계적으로 구성하는 데 도움이 되는 의미 있는 세션 ID 를 사용하세요: - User 기반: `"user_12345"` - 스레드 기반: `"thread_abc123"` @@ -263,12 +269,14 @@ result = await Runner.run(agent, "Hello", session=session) ### 메모리 지속성 -- 임시 대화에는 인메모리 SQLite(`SQLiteSession("session_id")`) 사용 -- 지속형 대화에는 파일 기반 SQLite(`SQLiteSession("session_id", "path/to/db.sqlite")`) 사용 -- SQLAlchemy 가 지원하는 기존 데이터베이스가 있는 프로덕션 시스템에는 SQLAlchemy 기반 세션(`SQLAlchemySession("session_id", engine=engine, create_tables=True)`) 사용 -- 이력을 OpenAI Conversations API 에 저장하길 원할 때는 OpenAI 호스트하는 스토리지(`OpenAIConversationsSession()`) 사용 -- 투명한 암호화와 TTL 기반 만료를 위해 암호화 세션(`EncryptedSession(session_id, underlying_session, encryption_key)`)으로 어떤 세션이든 래핑 -- 더 고급 사용 사례를 위해 다른 프로덕션 시스템(Redis, Django 등)에 대한 커스텀 세션 백엔드 구현 고려 +- 임시 대화에는 인메모리 SQLite (`SQLiteSession("session_id")`) 사용 +- 지속형 대화에는 파일 기반 SQLite (`SQLiteSession("session_id", "path/to/db.sqlite")`) 사용 +- SQLAlchemy 가 지원하는 기존 데이터베이스가 있는 프로덕션 시스템에는 SQLAlchemy 기반 세션 (`SQLAlchemySession("session_id", engine=engine, create_tables=True)`) 사용 +- 프로덕션 클라우드 네이티브 배포에는 Dapr 상태 저장소 세션 (`DaprSession.from_address("session_id", state_store_name="statestore", dapr_address="localhost:50001")`) 사용. +30+ 데이터베이스 백엔드, 내장 텔레메트리, 트레이싱, 데이터 분리를 지원 +- 기록을 OpenAI Conversations API 에 저장하길 원한다면 OpenAI 호스트하는 스토리지 (`OpenAIConversationsSession()`) 사용 +- 모든 세션을 투명한 암호화 및 TTL 기반 만료로 감싸려면 암호화 세션 (`EncryptedSession(session_id, underlying_session, encryption_key)`) 사용 +- 더 고급 사용 사례를 위해 다른 프로덕션 시스템(Redis, Django 등)에 대한 커스텀 세션 백엔드 구현을 고려 ### 다중 세션 @@ -316,7 +324,7 @@ result2 = await Runner.run( ## 전체 예시 -다음은 세션 메모리가 동작하는 완전한 예시입니다: +다음은 세션 메모리가 실제로 동작하는 전체 예시입니다: ```python import asyncio @@ -423,13 +431,14 @@ result = await Runner.run( ) ``` -## API Reference +## API 레퍼런스 -자세한 API 문서는 다음을 참조하세요: +자세한 API 문서는 다음을 참고하세요: - [`Session`][agents.memory.session.Session] - 프로토콜 인터페이스 - [`OpenAIConversationsSession`][agents.memory.OpenAIConversationsSession] - OpenAI Conversations API 구현 - [`SQLiteSession`][agents.memory.sqlite_session.SQLiteSession] - 기본 SQLite 구현 - [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - SQLAlchemy 기반 구현 -- [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 분기와 분석을 지원하는 향상된 SQLite +- [`DaprSession`][agents.extensions.memory.dapr_session.DaprSession] - Dapr 상태 저장소 구현 +- [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 분기 및 분석이 가능한 향상된 SQLite - [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - 모든 세션용 암호화 래퍼 \ No newline at end of file diff --git a/docs/ko/sessions/sqlalchemy_session.md b/docs/ko/sessions/sqlalchemy_session.md index bf2a171be..371fdc05a 100644 --- a/docs/ko/sessions/sqlalchemy_session.md +++ b/docs/ko/sessions/sqlalchemy_session.md @@ -4,7 +4,7 @@ search: --- # SQLAlchemy 세션 -`SQLAlchemySession`은 SQLAlchemy를 사용해 프로덕션급 세션 구현을 제공합니다. 이를 통해 세션 저장소로 SQLAlchemy가 지원하는 모든 데이터베이스(PostgreSQL, MySQL, SQLite 등)를 사용할 수 있습니다. +`SQLAlchemySession`은 SQLAlchemy를 사용해 프로덕션용 세션 구현을 제공하며, 세션 저장소로 SQLAlchemy가 지원하는 모든 데이터베이스(PostgreSQL, MySQL, SQLite 등)를 사용할 수 있습니다. ## 설치 @@ -74,7 +74,7 @@ if __name__ == "__main__": ``` -## API 참고 +## API 참조 -- [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - 기본 클래스 -- [`Session`][agents.memory.session.Session] - 베이스 세션 프로토콜 \ No newline at end of file +- [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - 주요 클래스 +- [`Session`][agents.memory.session.Session] - 기본 세션 프로토콜 \ No newline at end of file diff --git a/docs/ko/streaming.md b/docs/ko/streaming.md index e9ab2dd70..05138bc59 100644 --- a/docs/ko/streaming.md +++ b/docs/ko/streaming.md @@ -4,13 +4,13 @@ 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] 객체의 비동기 스트림을 얻습니다. ## 원문 응답 이벤트 -[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent]는 LLM에서 직접 전달되는 원문 이벤트입니다. OpenAI Responses API 형식이며, 각 이벤트에는 타입(예: `response.created`, `response.output_text.delta` 등)과 데이터가 있습니다. 생성되는 즉시 사용자에게 응답 메시지를 스트리밍하려는 경우 유용합니다. +[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent]는 LLM에서 직접 전달되는 원문 이벤트입니다. OpenAI Responses API 형식이며, 각 이벤트에는 타입(`response.created`, `response.output_text.delta` 등)과 데이터가 있습니다. 이러한 이벤트는 생성되는 즉시 사용자에게 응답 메시지를 스트리밍하고 싶을 때 유용합니다. 예를 들어, 다음은 LLM이 생성한 텍스트를 토큰 단위로 출력합니다. @@ -35,9 +35,9 @@ if __name__ == "__main__": asyncio.run(main()) ``` -## 실행 항목 이벤트와 에이전트 이벤트 +## 실행 항목 이벤트 및 에이전트 이벤트 -[`RunItemStreamEvent`][agents.stream_events.RunItemStreamEvent]는 더 높은 수준의 이벤트입니다. 항목이 완전히 생성되었을 때 알려줍니다. 이를 통해 각 토큰이 아닌 "메시지 생성됨", "도구 실행됨" 등의 수준에서 진행 상태를 전달할 수 있습니다. 유사하게, [`AgentUpdatedStreamEvent`][agents.stream_events.AgentUpdatedStreamEvent]는 현재 에이전트가 변경될 때 업데이트를 제공합니다(예: 핸드오프의 결과로). +[`RunItemStreamEvent`][agents.stream_events.RunItemStreamEvent]는 더 높은 수준의 이벤트입니다. 항목이 완전히 생성되었을 때를 알려줍니다. 이를 통해 각 토큰이 아닌 "메시지 생성 완료", "도구 실행 완료" 등의 수준에서 진행 상황을 전달할 수 있습니다. 마찬가지로, [`AgentUpdatedStreamEvent`][agents.stream_events.AgentUpdatedStreamEvent]는 현재 에이전트가 변경될 때(예: 핸드오프의 결과로) 업데이트를 제공합니다. 예를 들어, 다음은 원문 이벤트를 무시하고 사용자에게 업데이트를 스트리밍합니다. diff --git a/docs/ko/tools.md b/docs/ko/tools.md index 9a04a2105..89d31bde5 100644 --- a/docs/ko/tools.md +++ b/docs/ko/tools.md @@ -4,23 +4,23 @@ search: --- # 도구 -도구는 에이전트가 데이터를 가져오고, 코드를 실행하고, 외부 API 를 호출하고, 심지어 컴퓨터를 사용하는 등 행동을 취할 수 있게 합니다. Agent SDK 에는 세 가지 종류의 도구가 있습니다: +도구는 에이전트가 작업을 수행하도록 합니다. 예: 데이터 가져오기, 코드 실행, 외부 API 호출, 심지어 컴퓨터 사용까지. Agents SDK에는 세 가지 종류의 도구가 있습니다: -- 호스티드 툴: AI 모델과 함께 LLM 서버에서 실행됩니다. OpenAI 는 retrieval, 웹 검색 및 컴퓨터 사용을 호스티드 툴로 제공합니다 -- 함수 호출: 임의의 Python 함수를 도구로 사용할 수 있게 합니다 -- 도구로서의 에이전트: 에이전트를 도구로 사용하여, 핸드오프 없이 에이전트가 다른 에이전트를 호출할 수 있게 합니다 +- 호스티드 툴: 이는 AI 모델과 함께 LLM 서버에서 실행됩니다. OpenAI는 retrieval, 웹 검색 및 컴퓨터 사용을 호스티드 툴로 제공합니다 +- 함수 호출: 임의의 Python 함수를 도구로 사용할 수 있습니다 +- 도구로서의 에이전트: 에이전트를 도구로 사용하여, 핸드오프 없이 에이전트가 다른 에이전트를 호출할 수 있습니다 ## 호스티드 툴 -OpenAI 는 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] 사용 시 몇 가지 기본 제공 도구를 제공합니다: +OpenAI는 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel]을 사용할 때 몇 가지 기본 제공 도구를 제공합니다: -- [`WebSearchTool`][agents.tool.WebSearchTool] 은 에이전트가 웹을 검색할 수 있게 합니다 -- [`FileSearchTool`][agents.tool.FileSearchTool] 은 OpenAI 벡터 스토어에서 정보를 검색할 수 있게 합니다 -- [`ComputerTool`][agents.tool.ComputerTool] 은 컴퓨터 사용 작업을 자동화할 수 있게 합니다 -- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] 은 LLM 이 샌드박스 환경에서 코드를 실행할 수 있게 합니다 -- [`HostedMCPTool`][agents.tool.HostedMCPTool] 은 원격 MCP 서버의 도구를 모델에 노출합니다 -- [`ImageGenerationTool`][agents.tool.ImageGenerationTool] 은 프롬프트로부터 이미지를 생성합니다 -- [`LocalShellTool`][agents.tool.LocalShellTool] 은 로컬 머신에서 셸 명령을 실행합니다 +- [`WebSearchTool`][agents.tool.WebSearchTool]은 에이전트가 웹을 검색할 수 있게 합니다 +- [`FileSearchTool`][agents.tool.FileSearchTool]은 OpenAI 벡터 스토어에서 정보를 검색할 수 있게 합니다 +- [`ComputerTool`][agents.tool.ComputerTool]은 컴퓨터 사용 작업을 자동화할 수 있게 합니다 +- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool]은 LLM이 샌드박스 환경에서 코드를 실행할 수 있게 합니다 +- [`HostedMCPTool`][agents.tool.HostedMCPTool]은 원격 MCP 서버의 도구를 모델에 노출합니다 +- [`ImageGenerationTool`][agents.tool.ImageGenerationTool]은 프롬프트로부터 이미지를 생성합니다 +- [`LocalShellTool`][agents.tool.LocalShellTool]은 로컬 머신에서 셸 명령을 실행합니다 ```python from agents import Agent, FileSearchTool, Runner, WebSearchTool @@ -43,14 +43,14 @@ async def main(): ## 함수 도구 -임의의 Python 함수를 도구로 사용할 수 있습니다. Agents SDK 가 도구를 자동으로 설정합니다: +임의의 Python 함수를 도구로 사용할 수 있습니다. Agents SDK가 도구를 자동으로 설정합니다: -- 도구 이름은 Python 함수 이름이 됩니다(또는 이름을 직접 지정할 수 있음) -- 도구 설명은 함수의 docstring 에서 가져옵니다(또는 설명을 직접 지정할 수 있음) -- 함수 입력에 대한 스키마는 함수의 인자에서 자동으로 생성됨 -- 각 입력에 대한 설명은 비활성화하지 않는 한 함수의 docstring 에서 가져옴 +- 도구 이름은 Python 함수 이름이 됩니다(또는 이름을 제공할 수 있음) +- 도구 설명은 함수의 독스트링에서 가져옵니다(또는 설명을 제공할 수 있음) +- 함수 입력에 대한 스키마는 함수의 인자에서 자동으로 생성됩니다 +- 각 입력의 설명은 비활성화하지 않는 한 함수의 독스트링에서 가져옵니다 -Python 의 `inspect` 모듈을 사용해 함수 시그니처를 추출하고, [`griffe`](https://mkdocstrings.github.io/griffe/) 로 docstring 을 파싱하며 스키마 생성에는 `pydantic` 을 사용합니다. +Python의 `inspect` 모듈로 함수 시그니처를 추출하고, [`griffe`](https://mkdocstrings.github.io/griffe/)로 독스트링을 파싱하며, 스키마 생성에는 `pydantic`을 사용합니다. ```python import json @@ -102,12 +102,12 @@ for tool in agent.tools: ``` -1. 함수 인자로는 어떤 Python 타입이든 사용할 수 있으며, 함수는 동기 또는 비동기일 수 있습니다 -2. docstring 이 있으면 설명과 인자 설명을 추출하는 데 사용합니다 -3. 선택적으로 `context` 를 받을 수 있습니다(첫 번째 인자여야 함). 도구 이름, 설명, 사용할 docstring 스타일 등도 오버라이드할 수 있습니다 +1. 함수 인자로는 어떤 Python 타입이든 사용할 수 있으며, 함수는 sync 또는 async 모두 가능합니다 +2. 독스트링이 있으면 설명과 인자 설명을 캡처하는 데 사용합니다 +3. 함수는 선택적으로 `context`를 받을 수 있습니다(첫 번째 인자여야 함). 도구 이름, 설명, 사용할 독스트링 스타일 등 override를 설정할 수도 있습니다 4. 데코레이터가 적용된 함수를 도구 목록에 전달하면 됩니다 -??? note "Expand to see output" +??? note "출력을 보려면 확장" ``` fetch_weather @@ -179,20 +179,20 @@ for tool in agent.tools: ### 함수 도구에서 이미지 또는 파일 반환 -텍스트 출력과 더불어, 함수 도구의 출력으로 하나 이상의 이미지 또는 파일을 반환할 수 있습니다. 이를 위해 다음 중 아무 것이나 반환할 수 있습니다: +텍스트 출력 외에도, 함수 도구의 출력으로 하나 이상의 이미지 또는 파일을 반환할 수 있습니다. 이를 위해 다음 중 하나를 반환할 수 있습니다: -- 이미지: [`ToolOutputImage`][agents.tool.ToolOutputImage] (TypedDict 버전: [`ToolOutputImageDict`][agents.tool.ToolOutputImageDict]) -- 파일: [`ToolOutputFileContent`][agents.tool.ToolOutputFileContent] (TypedDict 버전: [`ToolOutputFileContentDict`][agents.tool.ToolOutputFileContentDict]) -- 텍스트: 문자열 또는 문자열로 변환 가능한 객체, 혹은 [`ToolOutputText`][agents.tool.ToolOutputText] (TypedDict 버전: [`ToolOutputTextDict`][agents.tool.ToolOutputTextDict]) +- 이미지: [`ToolOutputImage`][agents.tool.ToolOutputImage] (또는 TypedDict 버전, [`ToolOutputImageDict`][agents.tool.ToolOutputImageDict]) +- 파일: [`ToolOutputFileContent`][agents.tool.ToolOutputFileContent] (또는 TypedDict 버전, [`ToolOutputFileContentDict`][agents.tool.ToolOutputFileContentDict]) +- 텍스트: 문자열 또는 문자열로 변환 가능한 객체, 또는 [`ToolOutputText`][agents.tool.ToolOutputText] (또는 TypedDict 버전, [`ToolOutputTextDict`][agents.tool.ToolOutputTextDict]) -### 사용자 지정 함수 도구 +### 사용자 정의 함수 도구 -때로는 Python 함수를 도구로 사용하고 싶지 않을 수 있습니다. 이 경우 [`FunctionTool`][agents.tool.FunctionTool] 을 직접 생성할 수 있습니다. 다음을 제공해야 합니다: +때로는 Python 함수를 도구로 사용하고 싶지 않을 때가 있습니다. 이 경우, 직접 [`FunctionTool`][agents.tool.FunctionTool]을 생성할 수 있습니다. 다음을 제공해야 합니다: - `name` - `description` -- `params_json_schema` (인자를 위한 JSON 스키마) -- `on_invoke_tool` (async 함수로, [`ToolContext`][agents.tool_context.ToolContext] 와 JSON 문자열 형태의 인자를 받아야 하며, 도구 출력을 문자열로 반환해야 함) +- `params_json_schema` (인자에 대한 JSON 스키마) +- `on_invoke_tool` ([`ToolContext`][agents.tool_context.ToolContext]와 인자를 JSON 문자열로 받아 비동기로 실행되며, 도구 출력을 문자열로 반환해야 하는 함수) ```python from typing import Any @@ -225,18 +225,18 @@ tool = FunctionTool( ) ``` -### 인자 및 docstring 자동 파싱 +### 인자 및 독스트링 자동 파싱 -앞서 언급했듯이, 도구의 스키마를 추출하기 위해 함수 시그니처를 자동으로 파싱하고, 도구 및 개별 인자에 대한 설명을 추출하기 위해 docstring 을 파싱합니다. 이에 대한 몇 가지 참고 사항: +앞서 언급했듯이, 도구의 스키마를 추출하기 위해 함수 시그니처를 자동으로 파싱하고, 도구 및 개별 인자에 대한 설명을 추출하기 위해 독스트링을 파싱합니다. 이에 대한 참고 사항: -1. 시그니처 파싱은 `inspect` 모듈로 수행합니다. 타입 힌트를 사용해 인자 타입을 파악하고, 전체 스키마를 나타내는 Pydantic 모델을 동적으로 빌드합니다. Python 기본형, Pydantic 모델, TypedDict 등 대부분의 타입을 지원합니다 -2. docstring 파싱에는 `griffe` 를 사용합니다. 지원하는 docstring 포맷은 `google`, `sphinx`, `numpy` 입니다. 포맷을 자동 감지하려고 시도하지만 최선의 노력일 뿐이므로, `function_tool` 호출 시 명시적으로 설정할 수 있습니다. `use_docstring_info` 를 `False` 로 설정해 docstring 파싱을 비활성화할 수도 있습니다 +1. 시그니처 파싱은 `inspect` 모듈을 통해 수행합니다. 타입 힌트를 사용해 인자 타입을 파악하고, 전체 스키마를 나타내는 Pydantic 모델을 동적으로 빌드합니다. Python 기본형, Pydantic 모델, TypedDict 등 대부분의 타입을 지원합니다 +2. 독스트링 파싱에는 `griffe`를 사용합니다. 지원하는 독스트링 형식은 `google`, `sphinx`, `numpy`입니다. 독스트링 형식을 자동으로 감지하려 시도하지만, 최선의 노력일 뿐이므로 `function_tool` 호출 시 명시적으로 설정할 수 있습니다. `use_docstring_info`를 `False`로 설정하여 독스트링 파싱을 비활성화할 수도 있습니다 -스키마 추출 코드는 [`agents.function_schema`][] 에 있습니다. +스키마 추출을 위한 코드는 [`agents.function_schema`][]에 있습니다. ## 도구로서의 에이전트 -일부 워크플로에서는 제어를 넘기지 않고 중앙 에이전트가 특화된 에이전트들의 네트워크를 오케스트레이션하기를 원할 수 있습니다. 에이전트를 도구로 모델링하여 이를 수행할 수 있습니다. +일부 워크플로우에서는 제어를 핸드오프하지 않고, 중앙 에이전트가 특화된 에이전트 네트워크를 오케스트레이션하기를 원할 수 있습니다. 에이전트를 도구로 모델링하면 이를 실현할 수 있습니다. ```python from agents import Agent, Runner @@ -275,9 +275,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 @@ -296,15 +296,15 @@ async def run_my_agent() -> str: return str(result.final_output) ``` -### 사용자 지정 출력 추출 +### 사용자 정의 출력 추출 -특정 경우, 중앙 에이전트로 반환하기 전에 도구형 에이전트의 출력을 수정하고 싶을 수 있습니다. 이는 다음과 같은 경우에 유용합니다: +일부 경우, 중앙 에이전트에 반환하기 전에 툴-에이전트의 출력을 수정하고 싶을 수 있습니다. 다음과 같은 경우에 유용합니다: -- 하위 에이전트의 대화 기록에서 특정 정보(예: JSON 페이로드)만 추출 -- 에이전트의 최종 답변을 변환 또는 재포맷(예: Markdown 을 일반 텍스트나 CSV 로 변환) -- 에이전트의 응답이 없거나 형식이 잘못된 경우 출력을 검증하거나 대체 값을 제공 +- 하위 에이전트의 대화 히스토리에서 특정 정보(예: JSON 페이로드)를 추출 +- 에이전트의 최종 답변을 변환 또는 재포맷(예: Markdown을 일반 텍스트 또는 CSV로 변환) +- 에이전트의 응답이 없거나 잘못된 경우 출력을 검증하거나 대체 값을 제공 -이를 위해 `as_tool` 메서드에 `custom_output_extractor` 매개변수를 제공하면 됩니다: +이를 위해 `as_tool` 메서드에 `custom_output_extractor` 인자를 제공할 수 있습니다: ```python async def extract_json_payload(run_result: RunResult) -> str: @@ -323,9 +323,9 @@ json_tool = data_agent.as_tool( ) ``` -### 조건부 도구 활성화 +### 도구 조건부 활성화 -런타임에 `is_enabled` 매개변수를 사용해 에이전트 도구를 조건부로 활성화하거나 비활성화할 수 있습니다. 이를 통해 컨텍스트, 사용자 선호도, 런타임 조건에 따라 LLM 에 제공되는 도구를 동적으로 필터링할 수 있습니다. +런타임에 `is_enabled` 매개변수를 사용하여 에이전트 도구를 조건부로 활성화 또는 비활성화할 수 있습니다. 이를 통해 컨텍스트, 사용자 선호도, 런타임 조건에 따라 LLM에 제공되는 도구를 동적으로 필터링할 수 있습니다. ```python import asyncio @@ -382,24 +382,24 @@ asyncio.run(main()) `is_enabled` 매개변수는 다음을 허용합니다: -- **Boolean values**: `True` (항상 활성) 또는 `False` (항상 비활성) -- **Callable functions**: `(context, agent)` 를 받아 불리언을 반환하는 함수 -- **Async functions**: 더 복잡한 조건부 로직을 위한 비동기 함수 +- **Boolean 값**: `True`(항상 활성화) 또는 `False`(항상 비활성화) +- **호출 가능한 함수**: `(context, agent)`를 받아 boolean을 반환하는 함수 +- **Async 함수**: 복잡한 조건부 로직을 위한 비동기 함수 -비활성화된 도구는 런타임에 LLM 에 완전히 숨겨지므로 다음에 유용합니다: +비활성화된 도구는 런타임에 LLM에서 완전히 숨겨지므로 다음과 같은 경우에 유용합니다: -- 사용자 권한 기반 기능 게이팅 -- 환경별 도구 가용성 설정(개발/프로덕션) -- 서로 다른 도구 구성을 A/B 테스트 +- 사용자 권한에 따른 기능 게이팅 +- 환경별 도구 가용성(dev vs prod) +- 서로 다른 도구 구성에 대한 A/B 테스트 - 런타임 상태에 따른 동적 도구 필터링 -## 함수 도구 오류 처리 +## 함수 도구의 오류 처리 -`@function_tool` 로 함수 도구를 만들 때 `failure_error_function` 을 전달할 수 있습니다. 이는 도구 호출이 크래시한 경우 LLM 에 오류 응답을 제공하는 함수입니다. +`@function_tool`로 함수 도구를 만들 때 `failure_error_function`을 전달할 수 있습니다. 이는 도구 호출이 크래시했을 때 LLM에 오류 응답을 제공하는 함수입니다. -- 기본값(즉, 아무것도 전달하지 않은 경우)으로, 오류가 발생했음을 LLM 에 알리는 `default_tool_error_function` 이 실행됩니다 -- 사용자 정의 오류 함수를 전달하면 해당 함수가 대신 실행되어 그 응답이 LLM 에 전송됩니다 -- 명시적으로 `None` 을 전달하면, 도구 호출 오류가 다시 발생(raise)하여 직접 처리해야 합니다. 모델이 잘못된 JSON 을 생성한 경우 `ModelBehaviorError`, 코드가 크래시한 경우 `UserError` 등이 될 수 있습니다 +- 기본값(아무것도 전달하지 않은 경우)으로는 오류가 발생했음을 LLM에 알리는 `default_tool_error_function`이 실행됩니다 +- 자체 오류 함수를 전달하면 그것이 대신 실행되어, 그 응답이 LLM으로 전송됩니다 +- 명시적으로 `None`을 전달하면, 모든 도구 호출 오류가 다시 발생(re-raise)하므로 직접 처리해야 합니다. 모델이 잘못된 JSON을 생성한 경우 `ModelBehaviorError`, 코드가 크래시한 경우 `UserError` 등이 될 수 있습니다 ```python from agents import function_tool, RunContextWrapper @@ -422,4 +422,4 @@ def get_user_profile(user_id: str) -> str: ``` -`FunctionTool` 객체를 수동으로 생성하는 경우, `on_invoke_tool` 함수 내부에서 오류를 직접 처리해야 합니다. \ No newline at end of file +`FunctionTool` 객체를 수동으로 생성하는 경우, `on_invoke_tool` 함수 내부에서 오류를 처리해야 합니다. \ No newline at end of file diff --git a/docs/ko/tracing.md b/docs/ko/tracing.md index a18fe9d5b..c36649420 100644 --- a/docs/ko/tracing.md +++ b/docs/ko/tracing.md @@ -4,52 +4,52 @@ search: --- # 트레이싱 -Agents SDK에는 기본 제공 트레이싱이 포함되어 있어 에이전트 실행 중 발생하는 이벤트의 포괄적인 기록을 수집합니다: LLM 생성, 도구 호출, 핸드오프, 가드레일, 그리고 사용자 정의 이벤트까지. [Traces 대시보드](https://platform.openai.com/traces)를 사용하여 개발 중과 프로덕션 환경에서 워크플로를 디버깅, 시각화, 모니터링할 수 있습니다. +Agents SDK 는 에이전트 실행 중 발생하는 이벤트의 포괄적인 기록을 수집하는 내장 트레이싱을 포함합니다: LLM 생성, 도구 호출, 핸드오프, 가드레일, 그리고 커스텀 이벤트까지. [Traces 대시보드](https://platform.openai.com/traces)를 사용해 개발 중과 프로덕션에서 워크플로를 디버그, 시각화, 모니터링할 수 있습니다. !!!note 트레이싱은 기본적으로 활성화되어 있습니다. 트레이싱을 비활성화하는 방법은 두 가지입니다: - 1. 환경 변수 `OPENAI_AGENTS_DISABLE_TRACING=1` 를 설정하여 전역적으로 트레이싱을 비활성화할 수 있습니다 - 2. 단일 실행에 대해서는 [`agents.run.RunConfig.tracing_disabled`][] 를 `True` 로 설정하여 트레이싱을 비활성화할 수 있습니다 + 1. 환경 변수 `OPENAI_AGENTS_DISABLE_TRACING=1` 을 설정해 전역적으로 비활성화할 수 있습니다 + 2. 단일 실행에 대해 [`agents.run.RunConfig.tracing_disabled`][] 를 `True` 로 설정하여 비활성화할 수 있습니다 -***OpenAI의 API를 사용하는 Zero Data Retention (ZDR) 정책 하의 조직에서는 트레이싱을 사용할 수 없습니다.*** +***OpenAI 의 API 를 사용하는 Zero Data Retention (ZDR) 정책 하에 운영되는 조직의 경우, 트레이싱을 사용할 수 없습니다.*** ## 트레이스와 스팬 -- **트레이스(Traces)** 는 "워크플로"의 단일 엔드투엔드 동작을 나타냅니다. 스팬으로 구성됩니다. 트레이스에는 다음 속성이 있습니다: - - `workflow_name`: 논리적 워크플로 또는 앱입니다. 예: "Code generation" 또는 "Customer service" - - `trace_id`: 트레이스의 고유 ID입니다. 전달하지 않으면 자동으로 생성됩니다. 형식은 `trace_<32_alphanumeric>` 이어야 합니다 - - `group_id`: 선택적 그룹 ID로, 동일한 대화의 여러 트레이스를 연결합니다. 예를 들어 채팅 스레드 ID를 사용할 수 있습니다 +- **트레이스(Traces)** 는 하나의 "워크플로"에 대한 단일 엔드 투 엔드 작업을 나타냅니다. 스팬으로 구성됩니다. 트레이스에는 다음 속성이 있습니다: + - `workflow_name`: 논리적 워크플로 또는 앱 이름입니다. 예: "Code generation" 또는 "Customer service" + - `trace_id`: 트레이스의 고유 ID 입니다. 전달하지 않으면 자동 생성됩니다. 형식은 `trace_<32_alphanumeric>` 여야 합니다 + - `group_id`: 선택적 그룹 ID 로, 동일한 대화에서 발생한 여러 트레이스를 연결합니다. 예: 채팅 스레드 ID 를 사용할 수 있습니다 - `disabled`: True 인 경우 트레이스가 기록되지 않습니다 - - `metadata`: 트레이스의 선택적 메타데이터 -- **스팬(Spans)** 은 시작 및 종료 시간이 있는 작업을 나타냅니다. 스팬에는 다음이 포함됩니다: + - `metadata`: 트레이스에 대한 선택적 메타데이터 +- **스팬(Spans)** 은 시작과 종료 시간이 있는 작업을 나타냅니다. 스팬에는 다음이 있습니다: - `started_at` 및 `ended_at` 타임스탬프 - 속한 트레이스를 나타내는 `trace_id` - - 이 스팬의 상위 스팬(있는 경우)을 가리키는 `parent_id` - - 스팬에 대한 정보인 `span_data`. 예를 들어, `AgentSpanData` 는 에이전트 정보, `GenerationSpanData` 는 LLM 생성 정보를 포함합니다 + - 이 스팬의 부모 스팬(있는 경우)을 가리키는 `parent_id` + - 스팬에 대한 정보인 `span_data`. 예를 들어, `AgentSpanData` 는 에이전트 정보를, `GenerationSpanData` 는 LLM 생성 정보를 포함합니다 ## 기본 트레이싱 -기본적으로 SDK는 다음을 트레이싱합니다: +기본적으로 SDK 는 다음을 트레이싱합니다: -- 전체 `Runner.{run, run_sync, run_streamed}()` 가 `trace()` 로 감싸집니다 -- 에이전트가 실행될 때마다 `agent_span()` 으로 감싸집니다 -- LLM 생성은 `generation_span()` 으로 감싸집니다 -- 함수 도구 호출은 각각 `function_span()` 으로 감싸집니다 -- 가드레일은 `guardrail_span()` 으로 감싸집니다 -- 핸드오프는 `handoff_span()` 으로 감싸집니다 -- 오디오 입력(음성-텍스트)은 `transcription_span()` 으로 감싸집니다 -- 오디오 출력(텍스트-음성)은 `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()` 호출을 단일 트레이스의 일부로 만들고 싶을 수 있습니다. 이때 전체 코드를 `trace()` 로 감싸면 됩니다. +때때로, 여러 번의 `run()` 호출을 하나의 트레이스에 포함하고 싶을 수 있습니다. 전체 코드를 `trace()` 로 래핑하면 가능합니다. ```python from agents import Agent, Runner, trace @@ -64,46 +64,46 @@ async def main(): print(f"Rating: {second_result.final_output}") ``` -1. `Runner.run` 에 대한 두 호출이 `with trace()` 로 감싸져 있으므로, 개별 실행은 두 개의 트레이스를 생성하는 대신 전체 트레이스의 일부가 됩니다. +1. `Runner.run` 에 대한 두 번의 호출이 `with trace()` 로 래핑되어 있으므로, 개별 실행이 두 개의 트레이스를 생성하는 대신 전체 트레이스의 일부가 됩니다. ## 트레이스 생성 -[`trace()`][agents.tracing.trace] 함수를 사용하여 트레이스를 생성할 수 있습니다. 트레이스는 시작과 종료가 필요합니다. 이를 수행하는 방법은 두 가지입니다: +[`trace()`][agents.tracing.trace] 함수를 사용해 트레이스를 생성할 수 있습니다. 트레이스는 시작과 종료가 필요합니다. 방법은 두 가지입니다: -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()` 은 함수 호출의 입력/출력을 저장합니다. 여기에는 민감한 데이터가 포함될 수 있으므로, [`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] 를 통해 해당 데이터 캡처를 비활성화할 수 있습니다. +`generation_span()` 은 LLM 생성의 입력/출력을 저장하고, `function_span()` 은 함수 호출의 입력/출력을 저장합니다. 민감한 데이터를 포함할 수 있으므로, [`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] 를 통해 해당 데이터 캡처를 비활성화할 수 있습니다. -마찬가지로, 오디오 스팬은 기본적으로 입력 및 출력 오디오에 대해 base64 로 인코딩된 PCM 데이터를 포함합니다. [`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] 를 구성하여 이 오디오 데이터 캡처를 비활성화할 수 있습니다. +유사하게, 오디오 스팬은 기본적으로 입력 및 출력 오디오에 대해 base64 로 인코딩된 PCM 데이터를 포함합니다. [`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] 를 구성하여 이 오디오 데이터 캡처를 비활성화할 수 있습니다. ## 사용자 정의 트레이싱 프로세서 트레이싱의 상위 수준 아키텍처는 다음과 같습니다: -- 초기화 시, 트레이스를 생성하는 역할을 하는 전역 [`TraceProvider`][agents.tracing.setup.TraceProvider] 를 생성합니다 -- 트레이스/스팬을 배치로 [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] 에 보내는 [`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] 로 `TraceProvider` 를 구성합니다. 이는 스팬과 트레이스를 배치로 OpenAI 백엔드에 내보냅니다 +- 초기화 시, 트레이스를 생성하는 역할의 전역 [`TraceProvider`][agents.tracing.setup.TraceProvider] 를 생성합니다 +- `TraceProvider` 를 [`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor] 로 구성하고, 이 프로세서는 트레이스/스팬을 배치로 [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter] 에 전송하며, Exporter 는 스팬과 트레이스를 배치로 OpenAI 백엔드에 내보냅니다 -기본 설정을 사용자 정의하여 대체 또는 추가 백엔드로 트레이스를 전송하거나 내보내기 동작을 변경하려면 두 가지 옵션이 있습니다: +기본 설정을 사용자 정의하여, 다른 백엔드로 전송하거나 추가 백엔드로 전송하거나 Exporter 동작을 수정하려면 두 가지 옵션이 있습니다: -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` 를 포함해야 합니다 -## 비 OpenAI 모델과의 트레이싱 +## 비 OpenAI 모델과 트레이싱 -트레이싱을 비활성화할 필요 없이 OpenAI API 키를 비 OpenAI 모델과 함께 사용하여 OpenAI Traces 대시보드에서 무료 트레이싱을 활성화할 수 있습니다. +트레이싱을 비활성화할 필요 없이 OpenAI Traces 대시보드에서 무료 트레이싱을 활성화하기 위해 OpenAI API 키를 비 OpenAI 모델과 함께 사용할 수 있습니다. ```python import os @@ -125,7 +125,7 @@ agent = Agent( ``` ## 참고 -- OpenAI Traces 대시보드에서 무료 트레이스를 확인하세요 +- OpenAI Traces 대시보드에서 무료 트레이스를 확인하세요. ## 외부 트레이싱 프로세서 목록 diff --git a/docs/ko/usage.md b/docs/ko/usage.md index a5546494f..28c2c4473 100644 --- a/docs/ko/usage.md +++ b/docs/ko/usage.md @@ -4,21 +4,22 @@ search: --- # 사용량 -Agents SDK는 실행마다 토큰 사용량을 자동으로 추적합니다. 실행 컨텍스트에서 접근하여 비용 모니터링, 한도 적용, 분석 기록에 사용할 수 있습니다. +Agents SDK는 모든 실행에 대한 토큰 사용량을 자동으로 추적합니다. 실행 컨텍스트에서 이를 확인하여 비용을 모니터링하고, 한도를 강제하거나, 분석을 기록할 수 있습니다. ## 추적 항목 - **requests**: 수행된 LLM API 호출 수 - **input_tokens**: 전송된 입력 토큰 총합 - **output_tokens**: 수신된 출력 토큰 총합 -- **total_tokens**: input + output +- **total_tokens**: 입력 + 출력 +- **request_usage_entries**: 요청별 사용량 분해 목록 - **details**: - `input_tokens_details.cached_tokens` - `output_tokens_details.reasoning_tokens` ## 실행에서 사용량 접근 -`Runner.run(...)` 이후, `result.context_wrapper.usage`를 통해 사용량에 접근합니다. +`Runner.run(...)` 이후에는 `result.context_wrapper.usage`를 통해 사용량에 접근합니다. ```python result = await Runner.run(agent, "What's the weather in Tokyo?") @@ -30,11 +31,11 @@ print("Output tokens:", usage.output_tokens) print("Total tokens:", usage.total_tokens) ``` -사용량은 실행 중 이루어진 모든 모델 호출 전반에 걸쳐 집계됩니다(도구 호출과 핸드오프 포함). +사용량은 실행 중의 모든 모델 호출(도구 호출과 handoffs 포함)에 걸쳐 집계됩니다. ### LiteLLM 모델에서 사용량 활성화 -LiteLLM 제공자는 기본적으로 사용량 지표를 보고하지 않습니다. [`LitellmModel`](models/litellm.md)을 사용할 때, 에이전트에 `ModelSettings(include_usage=True)`를 전달하면 LiteLLM 응답이 `result.context_wrapper.usage`를 채웁니다. +LiteLLM 공급자는 기본적으로 사용량 지표를 보고하지 않습니다. [`LitellmModel`](models/litellm.md)을 사용할 때, 에이전트에 `ModelSettings(include_usage=True)`를 전달하면 LiteLLM 응답이 `result.context_wrapper.usage`에 채워집니다. ```python from agents import Agent, ModelSettings, Runner @@ -50,9 +51,20 @@ result = await Runner.run(agent, "What's the weather in Tokyo?") print(result.context_wrapper.usage.total_tokens) ``` +## 요청별 사용량 추적 + +SDK는 `request_usage_entries`에서 각 API 요청의 사용량을 자동으로 추적하므로, 세부적인 비용 계산과 컨텍스트 윈도우 소비 모니터링에 유용합니다. + +```python +result = await Runner.run(agent, "What's the weather in Tokyo?") + +for request in enumerate(result.context_wrapper.usage.request_usage_entries): + print(f"Request {i + 1}: {request.input_tokens} in, {request.output_tokens} out") +``` + ## 세션에서 사용량 접근 -`Session`(예: `SQLiteSession`)을 사용할 때는 `Runner.run(...)` 호출마다 해당 실행에 대한 사용량이 반환됩니다. 세션은 컨텍스트를 위한 대화 기록을 유지하지만, 각 실행의 사용량은 독립적입니다. +`Session`(예: `SQLiteSession`)을 사용할 때, `Runner.run(...)`에 대한 각 호출은 해당 실행의 사용량을 반환합니다. 세션은 컨텍스트를 위한 대화 기록을 유지하지만, 각 실행의 사용량은 독립적입니다. ```python session = SQLiteSession("my_conversation") @@ -64,11 +76,11 @@ second = await Runner.run(agent, "Can you elaborate?", session=session) print(second.context_wrapper.usage.total_tokens) # Usage for second run ``` -세션은 실행 간 대화 컨텍스트를 보존하지만, 각 `Runner.run()` 호출이 반환하는 사용량 지표는 해당 실행만을 나타냅니다. 세션에서는 이전 메시지가 각 실행의 입력으로 다시 제공될 수 있으며, 이는 이후 턴의 입력 토큰 수에 영향을 줍니다. +세션은 실행 간 대화 컨텍스트를 보존하지만, 각 `Runner.run()` 호출에서 반환되는 사용량 지표는 해당 실행만을 나타냅니다. 세션에서는 이전 메시지가 각 실행의 입력으로 다시 투입될 수 있으며, 이는 이후 턴의 입력 토큰 수에 영향을 줍니다. ## 훅에서 사용량 활용 -`RunHooks`를 사용하는 경우, 각 훅에 전달되는 `context` 객체에 `usage`가 포함됩니다. 이를 통해 수명 주기의 주요 시점에서 사용량을 로깅할 수 있습니다. +`RunHooks`를 사용하는 경우, 각 훅에 전달되는 `context` 객체에는 `usage`가 포함됩니다. 이를 통해 수명 주기의 핵심 시점에서 사용량을 로깅할 수 있습니다. ```python class MyHooks(RunHooks): @@ -77,10 +89,11 @@ class MyHooks(RunHooks): print(f"{agent.name} → {u.requests} requests, {u.total_tokens} total tokens") ``` -## API 참고 +## API 레퍼런스 -자세한 API 문서는 다음을 참조하세요: +자세한 API 문서는 다음을 참고하세요: - [`Usage`][agents.usage.Usage] - 사용량 추적 데이터 구조 +- [`RequestUsage`][agents.usage.RequestUsage] - 요청별 사용량 세부 정보 - [`RunContextWrapper`][agents.run.RunContextWrapper] - 실행 컨텍스트에서 사용량 접근 -- [`RunHooks`][agents.run.RunHooks] - 사용량 트래킹 수명 주기에 훅 연결 \ No newline at end of file +- [`RunHooks`][agents.run.RunHooks] - 사용량 추적 수명 주기에 훅 연결 \ No newline at end of file diff --git a/docs/ko/visualization.md b/docs/ko/visualization.md index 85d6a7423..a76130f07 100644 --- a/docs/ko/visualization.md +++ b/docs/ko/visualization.md @@ -4,7 +4,7 @@ search: --- # 에이전트 시각화 -에이전트 시각화는 **Graphviz**를 사용하여 에이전트와 그 관계를 구조화된 그래픽으로 생성할 수 있게 합니다. 이는 애플리케이션 내에서 에이전트, 도구, 핸드오프가 어떻게 상호작용하는지 이해하는 데 유용합니다. +에이전트 시각화는 **Graphviz**를 사용해 에이전트와 그 관계의 구조적 그래프 표현을 생성합니다. 이는 애플리케이션 내에서 에이전트, 도구, 핸드오프가 어떻게 상호작용하는지 이해하는 데 유용합니다. ## 설치 @@ -16,12 +16,12 @@ pip install "openai-agents[viz]" ## 그래프 생성 -`draw_graph` 함수를 사용하여 에이전트 시각화를 생성할 수 있습니다. 이 함수는 다음과 같은 유향 그래프를 생성합니다: +`draw_graph` 함수를 사용해 에이전트 시각화를 생성할 수 있습니다. 이 함수는 다음과 같은 구성의 방향 그래프를 만듭니다: -- **에이전트**는 노란색 상자로 표시됩니다 -- **MCP 서버**는 회색 상자로 표시됩니다 -- **도구**는 녹색 타원으로 표시됩니다 -- **핸드오프**는 한 에이전트에서 다른 에이전트로 향하는 방향 간선으로 표시됩니다 +- **에이전트**는 노란색 상자로 표시됨 +- **MCP 서버**는 회색 상자로 표시됨 +- **도구**는 초록색 타원으로 표시됨 +- **핸드오프**는 한 에이전트에서 다른 에이전트로 향하는 방향 간선으로 표시됨 ### 사용 예시 @@ -67,30 +67,31 @@ triage_agent = Agent( draw_graph(triage_agent) ``` -![Agent Graph](../assets/images/graph.png) +![에이전트 그래프](../assets/images/graph.png) -이는 **트리아지 에이전트**와 하위 에이전트 및 도구와의 연결 구조를 시 بص각적으로 나타내는 그래프를 생성합니다. +이는 **트리아지 에이전트**와 하위 에이전트 및 도구와의 연결 구조를 시각적으로 표현하는 그래프를 생성합니다. ## 시각화 이해 -생성된 그래프는 다음을 포함합니다: +생성된 그래프에는 다음이 포함됩니다: -- 진입점을 나타내는 **시작 노드**(`__start__`) -- 노란색 채우기의 **직사각형**으로 표시된 에이전트 -- 녹색 채우기의 **타원**으로 표시된 도구 -- 회색 채우기의 **직사각형**으로 표시된 MCP 서버 +- 진입점을 나타내는 **시작 노드** (`__start__`) +- 노란색 채우기의 **사각형**으로 표시된 에이전트 +- 초록색 채우기의 **타원**으로 표시된 도구 +- 회색 채우기의 **사각형**으로 표시된 MCP 서버 - 상호작용을 나타내는 방향 간선: - 에이전트 간 핸드오프는 **실선 화살표** - 도구 호출은 **점선 화살표** - MCP 서버 호출은 **파선 화살표** -- 실행 종료 지점을 나타내는 **종료 노드**(`__end__`) +- 실행 종료 지점을 나타내는 **끝 노드** (`__end__`) -**참고:** MCP 서버는 최신 버전의 `agents` 패키지에서 렌더링됩니다( **v0.2.8** 에서 확인됨). 시각화에 MCP 상자가 보이지 않으면 최신 릴리스로 업그레이드하세요. +**참고:** MCP 서버는 최신 버전의 +`agents` 패키지에서 렌더링됩니다 (**v0.2.8**에서 확인됨). 시각화에 MCP 상자가 보이지 않는다면 최신 릴리스로 업그레이드하세요. ## 그래프 사용자 지정 ### 그래프 표시 -기본적으로 `draw_graph`는 그래프를 인라인으로 표시합니다. 그래프를 별도 창에서 표시하려면 다음을 작성하세요: +기본적으로 `draw_graph`는 그래프를 인라인으로 표시합니다. 그래프를 별도 창에 표시하려면 다음을 작성하세요: ```python draw_graph(triage_agent).view() @@ -103,4 +104,4 @@ draw_graph(triage_agent).view() draw_graph(triage_agent, filename="agent_graph") ``` -이렇게 하면 작업 디렉터리에 `agent_graph.png`가 생성됩니다. \ No newline at end of file +그러면 작업 디렉토리에 `agent_graph.png`가 생성됩니다. \ No newline at end of file diff --git a/docs/ko/voice/pipeline.md b/docs/ko/voice/pipeline.md index d1790b569..39e313c6b 100644 --- a/docs/ko/voice/pipeline.md +++ b/docs/ko/voice/pipeline.md @@ -4,7 +4,7 @@ search: --- # 파이프라인과 워크플로우 -[`VoicePipeline`][agents.voice.pipeline.VoicePipeline] 클래스는 에이전트형 워크플로우를 손쉽게 음성 앱으로 전환할 수 있게 해줍니다. 실행할 워크플로우를 전달하면, 파이프라인이 입력 오디오의 음성 인식, 오디오 종료 감지, 적절한 타이밍에 워크플로우 호출, 워크플로우 출력의 오디오 변환까지 처리합니다. +[`VoicePipeline`][agents.voice.pipeline.VoicePipeline] 클래스는 에이전트형 워크플로우를 손쉽게 보이스 앱으로 전환할 수 있게 해줍니다. 실행할 워크플로우를 전달하면, 파이프라인이 입력 오디오의 전사, 오디오 종료 감지, 적절한 타이밍에 워크플로우 호출, 워크플로우 출력을 다시 오디오로 변환하는 작업을 처리합니다. ```mermaid graph LR @@ -36,27 +36,27 @@ graph LR 파이프라인을 생성할 때 다음을 설정할 수 있습니다: -1. [`workflow`][agents.voice.workflow.VoiceWorkflowBase] — 새 오디오가 전사될 때마다 실행되는 코드 -2. 사용하는 [`speech-to-text`][agents.voice.model.STTModel] 및 [`text-to-speech`][agents.voice.model.TTSModel] 모델 -3. [`config`][agents.voice.pipeline_config.VoicePipelineConfig] — 다음과 같은 항목을 구성 가능: - - 모델 제공자(모델 이름을 실제 모델로 매핑) - - 트레이싱 설정(트레이싱 비활성화 여부, 오디오 파일 업로드 여부, 워크플로우 이름, 트레이스 ID 등) - - TTS/STT 모델의 설정(프롬프트, 언어, 사용되는 데이터 타입 등) +1. 새 오디오가 전사될 때마다 실행되는 코드인 [`workflow`][agents.voice.workflow.VoiceWorkflowBase] +2. 사용되는 [`speech-to-text`][agents.voice.model.STTModel] 및 [`text-to-speech`][agents.voice.model.TTSModel] 모델 +3. 다음과 같은 항목을 구성할 수 있는 [`config`][agents.voice.pipeline_config.VoicePipelineConfig] + - 모델 제공자: 모델 이름을 실제 모델로 매핑 + - 트레이싱: 트레이싱 비활성화 여부, 오디오 파일 업로드 여부, 워크플로우 이름, 트레이스 ID 등 + - TTS 및 STT 모델의 설정: 프롬프트, 언어, 사용되는 데이터 타입 등 ## 파이프라인 실행 -파이프라인은 [`run()`][agents.voice.pipeline.VoicePipeline.run] 메서드로 실행하며, 두 가지 형태로 오디오 입력을 전달할 수 있습니다: +파이프라인은 [`run()`][agents.voice.pipeline.VoicePipeline.run] 메서드를 통해 실행할 수 있으며, 두 가지 형태로 오디오 입력을 전달할 수 있습니다: -1. [`AudioInput`][agents.voice.input.AudioInput] — 전체 오디오 전사가 있고 그에 대한 결과만 생성하면 되는 경우 사용합니다. 예를 들어, 사전 녹음된 오디오나 사용자가 말하기를 마치는 시점이 명확한 푸시투토크 앱처럼 발화 종료 감지가 필요 없는 경우에 유용합니다 -2. [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput] — 사용자의 발화 종료 감지가 필요할 수 있는 경우에 사용합니다. 감지된 대로 오디오 청크를 푸시할 수 있으며, 음성 파이프라인은 "activity detection(활동 감지)"이라는 프로세스를 통해 적절한 시점에 에이전트 워크플로우를 자동으로 실행합니다 +1. 전체 오디오 전사가 있을 때 결과만 생성하고자 하는 경우 [`AudioInput`][agents.voice.input.AudioInput] 를 사용합니다. 사전 녹음된 오디오이거나, 사용자가 언제 말하기를 멈췄는지 명확한 푸시투토크 앱처럼 화자의 발화 종료를 감지할 필요가 없는 경우에 유용합니다 +2. 사용자가 언제 말을 마쳤는지 감지해야 할 수 있는 경우 [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput] 를 사용합니다. 감지되는 즉시 오디오 청크를 푸시할 수 있고, 보이스 파이프라인은 "activity detection"이라 불리는 프로세스를 통해 적절한 시점에 에이전트 워크플로우를 자동으로 실행합니다 ## 결과 -음성 파이프라인 실행 결과는 [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult] 입니다. 이는 발생하는 이벤트를 스트리밍할 수 있는 객체입니다. 다음과 같은 여러 종류의 [`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] 가 있습니다: +보이스 파이프라인 실행의 결과는 [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult] 입니다. 이는 발생하는 이벤트를 스트리밍할 수 있는 객체입니다. 다음과 같은 여러 종류의 [`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] 가 있습니다: -1. [`VoiceStreamEventAudio`][agents.voice.events.VoiceStreamEventAudio] — 오디오 청크를 포함 -2. [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle] — 턴 시작/종료와 같은 라이프사이클 이벤트 알림 -3. [`VoiceStreamEventError`][agents.voice.events.VoiceStreamEventError] — 오류 이벤트 +1. 오디오 청크를 포함하는 [`VoiceStreamEventAudio`][agents.voice.events.VoiceStreamEventAudio] +2. 턴 시작/종료와 같은 라이프사이클 이벤트를 알려주는 [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle] +3. 오류 이벤트인 [`VoiceStreamEventError`][agents.voice.events.VoiceStreamEventError] ```python @@ -76,4 +76,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/ko/voice/quickstart.md b/docs/ko/voice/quickstart.md index d33b1a881..6aad24683 100644 --- a/docs/ko/voice/quickstart.md +++ b/docs/ko/voice/quickstart.md @@ -4,9 +4,9 @@ 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. 음성을 텍스트로 변환하기 위해 음성-텍스트 모델을 실행 -2. 결과를 생성하기 위해 보통 에이전트형 워크플로인 코드를 실행 -3. 결과 텍스트를 다시 오디오로 변환하기 위해 텍스트-음성 모델을 실행 +1. 음성을 텍스트로 변환하기 위해 음성 인식 모델을 실행합니다 +2. 결과를 생성하기 위해 보통 에이전트 기반 워크플로인 코드를 실행합니다 +3. 결과 텍스트를 다시 오디오로 변환하기 위해 음성 합성 모델을 실행합니다 ```mermaid graph LR @@ -48,7 +48,7 @@ graph LR ## 에이전트 -먼저 에이전트를 몇 개 설정해 봅시다. 이 SDK로 에이전트를 만들어 본 적이 있다면 익숙하게 느껴질 것입니다. 에이전트 몇 개와 핸드오프, 그리고 하나의 도구를 사용합니다. +먼저 에이전트를 몇 개 설정해 봅시다. 이 SDK로 에이전트를 만들어 본 적이 있다면 익숙하게 느껴질 것입니다. 에이전트 두 개와 하나의 핸드오프, 그리고 하나의 도구를 사용하겠습니다. ```python import asyncio @@ -92,7 +92,7 @@ agent = Agent( ## 음성 파이프라인 -워크플로로 [`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow]를 사용해 간단한 음성 파이프라인을 설정합니다. +워크플로로 [`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow]를 사용하여 간단한 음성 파이프라인을 설정하겠습니다. ```python from agents.voice import SingleAgentVoiceWorkflow, VoicePipeline @@ -124,7 +124,7 @@ async for event in result.stream(): ``` -## 통합 +## 모두 연결하기 ```python import asyncio @@ -195,4 +195,4 @@ if __name__ == "__main__": asyncio.run(main()) ``` -이 예제를 실행하면 에이전트가 직접 말을 겁니다! 직접 에이전트와 대화할 수 있는 데모는 [examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static)에서 확인하세요. \ No newline at end of file +이 예제를 실행하면 에이전트가 말하기 시작합니다! 직접 에이전트와 대화해 볼 수 있는 데모는 [examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static)에서 확인하세요. \ No newline at end of file diff --git a/docs/ko/voice/tracing.md b/docs/ko/voice/tracing.md index 2546302f0..080354b5e 100644 --- a/docs/ko/voice/tracing.md +++ b/docs/ko/voice/tracing.md @@ -4,15 +4,15 @@ search: --- # 트레이싱 -[에이전트가 트레이싱되는 방식](../tracing.md)과 마찬가지로, 음성 파이프라인도 자동으로 트레이싱됩니다. +[에이전트 트레이싱](../tracing.md)과 마찬가지로 음성 파이프라인도 자동으로 트레이싱됩니다. -기본적인 트레이싱 정보는 위의 문서를 참고하시면 되며, 추가로 [`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig]를 통해 파이프라인의 트레이싱을 구성할 수 있습니다. +기본적인 트레이싱 정보는 위 문서를 참고하시고, 추가로 [`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig]를 통해 파이프라인의 트레이싱을 구성할 수 있습니다. 주요 트레이싱 관련 필드는 다음과 같습니다: -- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: 트레이싱 비활성화 여부를 제어합니다. 기본값은 활성화입니다. -- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: 오디오 전사본과 같은 잠재적으로 민감한 데이터를 트레이스에 포함할지 제어합니다. 이는 음성 파이프라인에만 적용되며, 워크플로 내부에서 발생하는 작업에는 적용되지 않습니다. -- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]: 트레이스에 오디오 데이터를 포함할지 제어합니다. -- [`workflow_name`][agents.voice.pipeline_config.VoicePipelineConfig.workflow_name]: 트레이스 워크플로 이름 -- [`group_id`][agents.voice.pipeline_config.VoicePipelineConfig.group_id]: 트레이스의 `group_id`로, 여러 트레이스를 연결할 수 있습니다. -- [`trace_metadata`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: 트레이스에 포함할 추가 메타데이터 \ No newline at end of file +- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: 트레이싱 비활성화 여부를 제어합니다. 기본값은 트레이싱 활성화입니다. +- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: 오디오 전사본과 같은 잠재적으로 민감한 데이터를 트레이스에 포함할지 제어합니다. 이는 음성 파이프라인에만 해당하며, 워크플로(Workflow) 내부에서 수행되는 작업에는 적용되지 않습니다. +- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]: 오디오 데이터를 트레이스에 포함할지 제어합니다. +- [`workflow_name`][agents.voice.pipeline_config.VoicePipelineConfig.workflow_name]: 트레이스 워크플로의 이름입니다. +- [`group_id`][agents.voice.pipeline_config.VoicePipelineConfig.group_id]: 여러 트레이스를 연결할 수 있게 해주는 트레이스의 `group_id`입니다. +- [`trace_metadata`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: 트레이스에 포함할 추가 메타데이터입니다. \ No newline at end of file diff --git a/docs/zh/agents.md b/docs/zh/agents.md index 93b40cae2..dcb69085f 100644 --- a/docs/zh/agents.md +++ b/docs/zh/agents.md @@ -4,16 +4,16 @@ search: --- # 智能体 -智能体是你应用中的核心构建块。一个智能体是一个大型语言模型（LLM），并通过 instructions 和工具进行配置。 +智能体是你应用中的核心构建块。一个智能体是一个大型语言模型（LLM），通过 instructions 和 tools 进行配置。 -## 基础配置 +## 基本配置 -你最常配置的智能体属性包括： +你将为智能体配置的最常见属性包括： -- `name`: 标识你的智能体的必填字符串。 -- `instructions`: 也称为开发者消息或 system prompt。 -- `model`: 使用哪个 LLM，以及可选的 `model_settings` 来配置如 temperature、top_p 等模型调优参数。 -- `tools`: 智能体可用于完成任务的工具。 +- `name`: 标识你的智能体的必填字符串。 +- `instructions`: 也称为开发者消息或系统提示词。 +- `model`: 使用哪个 LLM，以及可选的 `model_settings` 用于配置模型调参，比如 temperature、top_p 等。 +- `tools`: 智能体可用于完成任务的工具。 ```python from agents import Agent, ModelSettings, function_tool @@ -33,7 +33,7 @@ agent = Agent( ## 上下文 -智能体在其 `context` 类型上是通用的。上下文是一个依赖注入工具：它是你创建并传递给 `Runner.run()` 的对象，会传递给每个智能体、工具、任务转移等，并作为一次智能体运行所需依赖与状态的集合。你可以提供任意 Python 对象作为上下文。 +智能体在其 `context` 类型上是泛型的。Context 是一种依赖注入工具：这是你创建并传递给 `Runner.run()` 的对象，会传递给每个智能体、工具、handoff 等，作为一次智能体运行的依赖与状态集合。你可以提供任意 Python 对象作为 context。 ```python @dataclass @@ -52,7 +52,7 @@ agent = Agent[UserContext]( ## 输出类型 -默认情况下，智能体输出纯文本（即 `str`）。如果你希望智能体产出特定类型的输出，可以使用 `output_type` 参数。一个常见选择是使用 [Pydantic](https://docs.pydantic.dev/) 对象，但我们支持任何可以被 Pydantic [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) 包装的类型——dataclasses、lists、TypedDict 等。 +默认情况下，智能体产生纯文本（即 `str`）输出。如果你希望智能体产生特定类型的输出，你可以使用 `output_type` 参数。一个常见的选择是使用 [Pydantic](https://docs.pydantic.dev/) 对象，但我们支持任何可以被 Pydantic [TypeAdapter](https://docs.pydantic.dev/latest/api/type_adapter/) 包装的类型——dataclasses、lists、TypedDict 等。 ```python from pydantic import BaseModel @@ -73,20 +73,20 @@ agent = Agent( !!! note - 当你传入 `output_type` 时，这会告知模型使用 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) 而不是常规的纯文本响应。 + 当你传入 `output_type` 时，这会指示模型使用 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) 而不是常规的纯文本响应。 ## 多智能体系统设计模式 -设计多智能体系统的方式很多，但我们常见到两种广泛适用的模式： +设计多智能体系统的方法很多，但我们通常看到两种广泛适用的模式： -1. 管理器（智能体作为工具）：一个中心管理/编排器以工具的形式调用专业子智能体，并始终控制对话。 -2. 任务转移：对等智能体将控制权移交给一个专业智能体，由其接管对话。这是去中心化的。 +1. 管理器（智能体作为工具）：一个中心的管理器/编排器将专用子智能体作为工具调用，并保持对话的控制权。 +2. Handoffs：对等智能体将控制权移交给专用智能体，由其接管对话。这是去中心化的。 -更多详情参见[构建智能体的实用指南](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf)。 +详见[我们的智能体构建实用指南](https://cdn.openai.com/business-guides-and-resources/a-practical-guide-to-building-agents.pdf)。 ### 管理器（智能体作为工具） -`customer_facing_agent` 处理所有用户交互，并调用以工具形式暴露的专业子智能体。阅读[工具](tools.md#agents-as-tools)文档以了解更多。 +`customer_facing_agent` 处理所有用户交互，并调用作为工具暴露的专用子智能体。更多内容见[工具](tools.md#agents-as-tools)文档。 ```python from agents import Agent @@ -113,9 +113,9 @@ customer_facing_agent = Agent( ) ``` -### 任务转移 +### Handoffs -任务转移是智能体可委托的子智能体。当发生任务转移时，被委托的智能体会接收对话历史并接管对话。该模式支持模块化、专精的智能体，在单一任务上表现卓越。更多内容参见[任务转移](handoffs.md)文档。 +Handoffs 是智能体可以委派给的子智能体。当发生 handoff 时，被委派的智能体会接收对话历史并接管对话。这种模式支持模块化、专精于单一任务的智能体。更多内容见[handoffs](handoffs.md)文档。 ```python from agents import Agent @@ -136,7 +136,7 @@ triage_agent = Agent( ## 动态 instructions -在大多数情况下，你可以在创建智能体时提供 instructions。不过，你也可以通过函数提供动态 instructions。该函数会接收智能体和上下文，并且必须返回提示词。常规和 `async` 函数均可接受。 +在大多数情况下，你可以在创建智能体时提供 instructions。不过，你也可以通过函数提供动态 instructions。该函数会接收智能体和 context，并且必须返回提示词。支持普通函数和 `async` 函数。 ```python def dynamic_instructions( @@ -151,17 +151,17 @@ agent = Agent[UserContext]( ) ``` -## 生命周期事件（hooks） +## 生命周期事件（钩子） -有时，你可能希望观察一个智能体的生命周期。例如，你可能希望记录事件，或在特定事件发生时预取数据。你可以通过 `hooks` 属性挂接到智能体生命周期。继承 [`AgentHooks`][agents.lifecycle.AgentHooks] 类，并重写你感兴趣的方法。 +有时你会希望观察智能体的生命周期。例如，你可能希望记录事件，或在特定事件发生时预取数据。你可以通过 `hooks` 属性接入智能体生命周期。子类化 [`AgentHooks`][agents.lifecycle.AgentHooks] 并重写你感兴趣的方法。 ## 安全防护措施 -安全防护措施允许你在智能体运行的同时对用户输入进行检查/校验，并在智能体产生输出后对其进行检查。例如，你可以对用户输入和智能体输出进行相关性筛查。更多内容参见[安全防护措施](guardrails.md)文档。 +安全防护措施允许你在智能体运行的同时并行对用户输入进行检查/校验，并在智能体产出结果后对其输出进行检查。例如，你可以筛查用户输入和智能体输出的相关性。更多内容见[guardrails](guardrails.md)文档。 ## 克隆/复制智能体 -通过在智能体上使用 `clone()` 方法，你可以复制一个智能体，并可选地修改任何你想更改的属性。 +通过在智能体上使用 `clone()` 方法，你可以复制一个智能体，并可选地更改任意属性。 ```python pirate_agent = Agent( @@ -178,12 +178,12 @@ robot_agent = pirate_agent.clone( ## 强制使用工具 -提供工具列表并不总意味着 LLM 一定会使用某个工具。你可以通过设置 [`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] 来强制使用工具。可选值为： +提供工具列表并不总是意味着 LLM 会使用某个工具。你可以通过设置 [`ModelSettings.tool_choice`][agents.model_settings.ModelSettings.tool_choice] 来强制使用工具。有效值包括： -1. `auto`：允许 LLM 自行决定是否使用工具。 -2. `required`：要求 LLM 使用某个工具（但它可以智能选择哪个工具）。 -3. `none`：要求 LLM 不使用工具。 -4. 设置某个特定字符串，例如 `my_tool`，要求 LLM 使用该特定工具。 +1. `auto`，允许 LLM 决定是否使用工具。 +2. `required`，要求 LLM 必须使用某个工具（但它可以智能地决定使用哪个工具）。 +3. `none`，要求 LLM 不使用工具。 +4. 设置特定字符串，例如 `my_tool`，要求 LLM 使用该特定工具。 ```python from agents import Agent, Runner, function_tool, ModelSettings @@ -203,10 +203,10 @@ agent = Agent( ## 工具使用行为 -`Agent` 配置中的 `tool_use_behavior` 参数控制工具输出的处理方式： +`Agent` 配置中的 `tool_use_behavior` 参数控制如何处理工具输出： -- `"run_llm_again"`：默认值。先运行工具，再由 LLM 处理结果以生成最终响应。 -- `"stop_on_first_tool"`：第一次工具调用的输出将作为最终响应，不再经由 LLM 进一步处理。 +- `"run_llm_again"`：默认值。运行工具后，LLM 处理结果以生成最终响应。 +- `"stop_on_first_tool"`：第一次工具调用的输出会被用作最终响应，不再进行后续的 LLM 处理。 ```python from agents import Agent, Runner, function_tool, ModelSettings @@ -224,7 +224,7 @@ agent = Agent( ) ``` -- `StopAtTools(stop_at_tool_names=[...])`：如果调用了任一指定工具则停止，并使用其输出作为最终响应。 +- `StopAtTools(stop_at_tool_names=[...])`：如果调用了任一指定工具则停止，使用其输出作为最终响应。 ```python from agents import Agent, Runner, function_tool @@ -248,7 +248,7 @@ agent = Agent( ) ``` -- `ToolsToFinalOutputFunction`：自定义函数，用于处理工具结果并决定是停止还是继续交给 LLM。 +- `ToolsToFinalOutputFunction`：一个自定义函数，用于处理工具结果并决定是停止还是继续由 LLM 处理。 ```python from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper @@ -286,4 +286,4 @@ agent = Agent( !!! note - 为防止无限循环，框架会在一次工具调用后自动将 `tool_choice` 重置为 "auto"。此行为可通过 [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] 配置。产生无限循环的原因在于工具结果会被发送给 LLM，而由于设置了 `tool_choice`，LLM 会再次生成工具调用，如此往复。 \ No newline at end of file + 为防止无限循环，框架会在一次工具调用后自动将 `tool_choice` 重置为 "auto"。可通过 [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] 配置此行为。出现无限循环的原因是工具结果会被发送给 LLM，而由于 `tool_choice` 的设置，LLM 会再次生成工具调用，如此往复。 \ No newline at end of file diff --git a/docs/zh/config.md b/docs/zh/config.md index 4baee4d11..d41bbd79d 100644 --- a/docs/zh/config.md +++ b/docs/zh/config.md @@ -4,9 +4,9 @@ search: --- # 配置 SDK -## API 密钥与客户端 +## API 密钥和客户端 -默认情况下，SDK 在被导入后会立即查找用于 LLM 请求和追踪的 `OPENAI_API_KEY` 环境变量。如果无法在应用启动前设置该环境变量，可以使用 [set_default_openai_key()][agents.set_default_openai_key] 函数来设置密钥。 +默认情况下，SDK 在导入后会立刻从环境变量 `OPENAI_API_KEY` 中读取用于 LLM 请求和追踪的密钥。如果你无法在应用启动前设置该环境变量，可以使用 [set_default_openai_key()][agents.set_default_openai_key] 函数来设置密钥。 ```python from agents import set_default_openai_key @@ -14,7 +14,7 @@ from agents import set_default_openai_key set_default_openai_key("sk-...") ``` -或者，你也可以配置要使用的 OpenAI 客户端。默认情况下，SDK 会创建一个 `AsyncOpenAI` 实例，使用来自环境变量的 API 密钥或上面设置的默认密钥。你可以使用 [set_default_openai_client()][agents.set_default_openai_client] 函数进行更改。 +或者，你也可以配置一个要使用的 OpenAI 客户端。默认情况下，SDK 会基于上述环境变量或默认密钥创建一个 `AsyncOpenAI` 实例。你可以通过 [set_default_openai_client()][agents.set_default_openai_client] 函数进行修改。 ```python from openai import AsyncOpenAI @@ -24,7 +24,7 @@ custom_client = AsyncOpenAI(base_url="...", api_key="...") set_default_openai_client(custom_client) ``` -最后，你还可以自定义要使用的 OpenAI API。默认情况下，我们使用 OpenAI Responses API。你可以使用 [set_default_openai_api()][agents.set_default_openai_api] 函数将其改为使用 Chat Completions API。 +最后，你还可以自定义所使用的 OpenAI API。默认我们使用 OpenAI Responses API。你可以通过 [set_default_openai_api()][agents.set_default_openai_api] 函数改为使用 Chat Completions API。 ```python from agents import set_default_openai_api @@ -34,7 +34,7 @@ set_default_openai_api("chat_completions") ## 追踪 -追踪默认启用。它默认使用上述部分中的 OpenAI API 密钥（即环境变量或你设置的默认密钥）。你可以使用 [`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 @@ -52,7 +52,7 @@ set_tracing_disabled(True) ## 调试日志 -SDK 有两个未设置任何处理器的 Python 日志记录器。默认情况下，这意味着警告和错误将发送到 `stdout`，但其他日志会被抑制。 +该 SDK 提供两个未设置任何处理器的 Python 日志记录器。默认情况下，这意味着警告和错误会发送到 `stdout`，其他日志会被抑制。 要启用详细日志，使用 [`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 函数。 @@ -62,7 +62,7 @@ from agents import enable_verbose_stdout_logging enable_verbose_stdout_logging() ``` -或者，你可以通过添加处理器、过滤器、格式化器等来自定义日志。更多信息请参见 [Python logging guide](https://docs.python.org/3/howto/logging.html)。 +或者，你可以通过添加处理器、过滤器、格式化器等自定义日志。更多内容参见 [Python logging 指南](https://docs.python.org/3/howto/logging.html)。 ```python import logging @@ -83,15 +83,15 @@ logger.addHandler(logging.StreamHandler()) ### 日志中的敏感数据 -某些日志可能包含敏感数据（例如，用户数据）。如果你想禁用这些数据的记录，请设置以下环境变量。 +某些日志可能包含敏感数据（例如用户数据）。如果你希望禁止记录这些数据，请设置以下环境变量。 -要禁用记录 LLM 的输入与输出： +要禁用记录 LLM 的输入和输出： ```bash export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1 ``` -要禁用记录工具的输入与输出： +要禁用记录工具的输入和输出： ```bash export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1 diff --git a/docs/zh/context.md b/docs/zh/context.md index 222de068e..9c6543ce2 100644 --- a/docs/zh/context.md +++ b/docs/zh/context.md @@ -4,30 +4,30 @@ search: --- # 上下文管理 -上下文是一个语义较多的术语。你可能关心的上下文主要有两类： +“上下文”一词常被多重使用。你可能关心的上下文主要有两大类： -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. 将该对象传给各种运行方法（例如 `Runner.run(..., **context=whatever**)`）。 -3. 所有工具调用、生命周期钩子等都会接收到一个包装对象 `RunContextWrapper[T]`，其中 `T` 表示你的上下文对象类型，你可以通过 `wrapper.context` 访问它。 +1. 你创建任意 Python 对象即可。常见模式是使用 dataclass 或 Pydantic 对象。 +2. 将该对象传给各类运行方法（例如 `Runner.run(..., **context=whatever**)`）。 +3. 所有工具调用、生命周期钩子等都会接收一个包装对象 `RunContextWrapper[T]`，其中 `T` 代表你的上下文对象类型，你可以通过 `wrapper.context` 访问。 -需要注意的最重要一点：对于一次给定的智能体运行，所有智能体、工具函数、生命周期等必须使用相同类型的上下文。 +需要注意的**最重要**一点：对某次智能体运行而言，所有智能体、工具函数、生命周期等必须使用相同的上下文_类型_。 -你可以将上下文用于以下场景： +你可以将上下文用于如下用途： - 运行时的上下文数据（例如用户名/uid 或关于用户的其他信息） -- 依赖（例如日志器对象、数据获取器等） -- 辅助函数 +- 依赖（例如 logger 对象、数据获取器等） +- 帮助函数 -!!! danger "Note" +!!! danger "注意" - 上下文对象**不会**被发送给 LLM。它是纯本地对象，你可以读取、写入并调用其方法。 + 上下文对象**不会**被发送给 LLM。它纯粹是一个本地对象，你可以读取、写入并在其上调用方法。 ```python import asyncio @@ -66,18 +66,18 @@ if __name__ == "__main__": asyncio.run(main()) ``` -1. 这是上下文对象。这里我们使用了 dataclass，但你也可以使用任意类型。 -2. 这是一个工具。你可以看到它接收 `RunContextWrapper[UserInfo]`。工具实现会从上下文中读取数据。 -3. 我们用泛型 `UserInfo` 标注智能体，以便类型检查器能捕获错误（例如我们尝试传入使用不同上下文类型的工具时）。 -4. 上下文被传递给 `run` 函数。 +1. 这是上下文对象。我们这里使用了 dataclass，但你可以使用任意类型。 +2. 这是一个工具。你可以看到它接收 `RunContextWrapper[UserInfo]`。工具实现会从上下文中读取。 +3. 我们用泛型 `UserInfo` 标注智能体，以便类型检查器能捕获错误（例如，如果我们尝试传入一个接收不同上下文类型的工具）。 +4. 通过 `run` 函数传入上下文。 5. 智能体正确调用工具并获得年龄。 --- -### 进阶：`ToolContext` +### 高级用法：`ToolContext` -在某些情况下，你可能希望访问关于正在执行的工具的额外元数据——例如其名称、调用 ID 或原始参数字符串。 -为此，你可以使用继承自 `RunContextWrapper` 的 [`ToolContext`][agents.tool_context.ToolContext] 类。 +在某些情况下，你可能希望访问正在执行的工具的额外元数据——例如其名称、调用 ID 或原始参数字符串。 +为此，你可以使用扩展自 `RunContextWrapper` 的 [`ToolContext`][agents.tool_context.ToolContext] 类。 ```python from typing import Annotated @@ -106,22 +106,22 @@ agent = Agent( ``` `ToolContext` 提供与 `RunContextWrapper` 相同的 `.context` 属性， -另含当前工具调用特有的字段： +并额外提供当前工具调用特有的字段： - `tool_name` – 被调用工具的名称 - `tool_call_id` – 此次工具调用的唯一标识符 -- `tool_arguments` – 传递给工具的原始参数字符串 +- `tool_arguments` – 传给工具的原始参数字符串 当你在执行期间需要工具级元数据时，请使用 `ToolContext`。 -对于智能体与工具之间的一般性上下文共享，`RunContextWrapper` 已经足够。 +对于智能体与工具之间的一般上下文共享，`RunContextWrapper` 已经足够。 --- ## 智能体/LLM 上下文 -当调用 LLM 时，它能看到的**唯一**数据来自对话历史。这意味着如果你想让某些新数据对 LLM 可见，必须以让其出现在对话历史中的方式提供。可选方式包括： +当调用 LLM 时，它能看到的**唯一**数据来自对话历史。这意味着，如果你想让一些新数据对 LLM 可见，你必须以使其可出现在历史记录中的方式提供。常见方法包括： -1. 将其添加到智能体的 `instructions`。这也被称为“系统提示词”（system prompt）或“开发者消息”。系统提示词可以是静态字符串，也可以是接收上下文并输出字符串的动态函数。这常用于始终有用的信息（例如用户名或当前日期）。 -2. 在调用 `Runner.run` 函数时，将其添加到 `input`。这与 `instructions` 的做法类似，但允许你提供在[指令链](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command)中更靠后的消息。 -3. 通过工具调用（function tools）暴露。这适用于按需（on-demand）的上下文——LLM 决定何时需要某些数据，并可调用工具来获取该数据。 -4. 使用检索或网络检索（web search）。这些是能够从文件或数据库（检索）或网络（网络检索）中获取相关数据的特殊工具。这有助于用相关的上下文数据来“支撑”（ground）回复。 \ No newline at end of file +1. 将其添加到智能体的 `instructions` 中。这也被称为“system prompt（系统提示词）”或“开发者消息”。system prompt 可以是静态字符串，也可以是接收上下文并输出字符串的动态函数。这通常用于总是有用的信息（例如用户名或当前日期）。 +2. 在调用 `Runner.run` 函数时，将其添加到 `input` 中。这与 `instructions` 策略类似，但允许你将消息放在[指令链层级](https://cdn.openai.com/spec/model-spec-2024-05-08.html#follow-the-chain-of-command)更靠下的位置。 +3. 通过工具调用暴露它。这对_按需_上下文很有用——LLM 会在需要某些数据时自行决定，并可调用工具来获取该数据。 +4. 使用检索或网络检索。这些是能够从文件或数据库（检索）或从网络（网络检索）获取相关数据的特殊工具。这有助于用相关的上下文数据对回复进行“落地”。 \ No newline at end of file diff --git a/docs/zh/examples.md b/docs/zh/examples.md index 3d5136bba..2388233d4 100644 --- a/docs/zh/examples.md +++ b/docs/zh/examples.md @@ -4,7 +4,7 @@ search: --- # 代码示例 -在[repo](https://github.com/openai/openai-agents-python/tree/main/examples) 的 examples 目录中查看该 SDK 的多种示例实现。这些代码示例按多个目录组织，展示不同的模式与能力。 +在[仓库](https://github.com/openai/openai-agents-python/tree/main/examples)的 examples 目录中查看多种 SDK 示例实现。这些示例按多个目录组织，展示不同的模式与能力。 ## 目录 @@ -12,32 +12,32 @@ search: 本目录中的示例展示常见的智能体设计模式，例如： - 确定性工作流 - - 将智能体作为工具 + - 智能体作为工具 - 智能体并行执行 - - 有条件的工具使用 + - 条件性工具使用 - 输入/输出安全防护措施 - - 将 LLM 作为裁判 + - LLM 作为评审 - 路由 - 流式传输安全防护措施 - **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):** 这些示例展示 SDK 的基础能力，例如： - - Hello World 代码示例（默认模型、GPT-5、开放权重模型） + - Hello World 示例（默认模型、GPT-5、开放权重模型） - 智能体生命周期管理 - 动态系统提示词 - 流式传输输出（文本、条目、函数调用参数） - - 提示词模板 + - 提示模板 - 文件处理（本地与远程、图像与 PDF） - - 使用跟踪 + - 用量跟踪 - 非严格输出类型 - 先前响应 ID 的使用 - **[customer_service](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service):** - 航空公司的示例客服系统。 + 航空公司的客服系统示例。 - **[financial_research_agent](https://github.com/openai/openai-agents-python/tree/main/examples/financial_research_agent):** - 一个金融研究智能体，演示使用智能体和工具进行金融数据分析的结构化研究工作流。 + 展示使用智能体与工具进行金融数据分析的结构化研究工作流的金融研究智能体。 - **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):** 查看带消息过滤的智能体任务转移的实用示例。 @@ -48,14 +48,14 @@ search: - **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):** 学习如何使用 MCP (Model Context Protocol) 构建智能体，包括： - - 文件系统代码示例 - - Git 代码示例 - - MCP 提示词服务代码示例 - - SSE（Server-Sent Events）代码示例 - - 可流式传输的 HTTP 代码示例 + - 文件系统示例 + - Git 示例 + - MCP 提示服务示例 + - SSE（服务器发送事件）示例 + - 可流式传输的 HTTP 示例 - **[memory](https://github.com/openai/openai-agents-python/tree/main/examples/memory):** - 智能体的不同内存实现示例，包括： + 展示用于智能体的不同内存实现，包括： - SQLite 会话存储 - 高级 SQLite 会话存储 @@ -65,10 +65,10 @@ search: - OpenAI 会话存储 - **[model_providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):** - 了解如何在该 SDK 中使用非 OpenAI 模型，包括自定义提供方与 LiteLLM 集成。 + 了解如何在 SDK 中使用非 OpenAI 模型，包括自定义提供方与 LiteLLM 集成。 - **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):** - 展示如何使用该 SDK 构建实时体验的示例，包括： + 展示如何使用 SDK 构建实时体验的示例，包括： - Web 应用 - 命令行界面 @@ -90,4 +90,4 @@ search: - 图像生成 - **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):** - 查看语音智能体示例，使用我们的 TTS 和 STT 模型，包括流式语音示例。 \ No newline at end of file + 查看语音智能体示例，使用我们的 TTS 和 STT 模型，包括流式传输语音示例。 \ No newline at end of file diff --git a/docs/zh/guardrails.md b/docs/zh/guardrails.md index 31acfdbcd..18f74b445 100644 --- a/docs/zh/guardrails.md +++ b/docs/zh/guardrails.md @@ -4,7 +4,7 @@ search: --- # 安全防护措施 -安全防护措施与您的智能体并行运行，使您能够对用户输入进行检查和验证。举例来说，假设您有一个使用非常智能（因此也较慢/昂贵）的模型来处理客户请求的智能体。您不希望恶意用户让该模型帮助他们完成数学作业。因此，您可以使用一个快速/低成本的模型运行安全防护措施。如果安全防护措施检测到恶意使用，它可以立即抛出错误，从而阻止昂贵模型的运行，为您节省时间/金钱。 +安全防护措施与智能体并行运行，使你能够对用户输入进行检查和验证。比如，想象你有一个使用非常智能（因此也更慢/更昂贵）模型来处理客户请求的智能体。你不希望恶意用户让模型帮他们做数学作业。因此，你可以用一个快速/廉价的模型运行安全防护措施。如果安全防护措施检测到恶意使用，它可以立即抛出错误，从而阻止昂贵模型运行并为你节省时间/金钱。 安全防护措施有两种类型： @@ -13,35 +13,35 @@ search: ## 输入安全防护措施 -输入安全防护措施分三步运行： +输入安全防护措施分 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]异常，以便您对用户做出恰当响应或处理该异常。 +1. 首先，安全防护措施接收传递给智能体的同一份输入。 +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 步运行： -1. 首先，安全防护措施接收由智能体产生的输出。 -2. 接着，安全防护措施函数运行以生成一个[`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput]，随后被包装成[`OutputGuardrailResult`][agents.guardrail.OutputGuardrailResult] -3. 最后，我们检查[`.tripwire_triggered`][agents.guardrail.GuardrailFunctionOutput.tripwire_triggered]是否为 true。若为 true，则会抛出[`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]异常，以便您对用户做出恰当响应或处理该异常。 +1. 首先，安全防护措施接收由智能体生成的输出。 +2. 接着，安全防护函数运行以生成 [`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput]，随后将其包装为 [`OutputGuardrailResult`][agents.guardrail.OutputGuardrailResult] +3. 最后，我们检查 [`.tripwire_triggered`][agents.guardrail.GuardrailFunctionOutput.tripwire_triggered] 是否为 true。若为 true，将抛出 [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered] 异常，以便你适当回应用户或处理异常。 -!!! Note +!!! 注意 - 输出安全防护措施旨在运行于最终的智能体输出上，因此只有当某个智能体是*最后一个*智能体时，它的安全防护措施才会运行。与输入安全防护措施类似，我们这样设计是因为安全防护措施通常与具体的智能体相关——不同的智能体会运行不同的安全防护措施，因此将代码就近放置更有利于可读性。 + 输出安全防护措施旨在作用于智能体的最终输出，因此只有当该智能体是最后一个智能体时，其安全防护措施才会运行。与输入安全防护措施类似，我们这样做是因为安全防护措施通常与具体智能体强相关——你会为不同智能体运行不同的安全防护措施，因此将代码就近放置有助于可读性。 -## 触发线 +## 触发线（Tripwires） -如果输入或输出未通过安全防护措施，安全防护措施可以通过触发线来发出信号。一旦我们发现某个安全防护措施触发了触发线，就会立即抛出 `{Input,Output}GuardrailTripwireTriggered` 异常并停止智能体执行。 +如果输入或输出未通过安全防护措施检查，安全防护措施可以通过触发线（tripwire）发出信号。一旦我们发现某个安全防护措施触发了触发线，我们会立即抛出 `{Input,Output}GuardrailTripwireTriggered` 异常并停止智能体执行。 -## 实现安全防护措施 +## 安全防护措施实现 -您需要提供一个接收输入并返回[`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput]的函数。此示例中，我们将通过在底层运行一个智能体来实现。 +你需要提供一个接收输入并返回 [`GuardrailFunctionOutput`][agents.guardrail.GuardrailFunctionOutput] 的函数。在此示例中，我们将通过在底层运行一个智能体来实现。 ```python from pydantic import BaseModel @@ -94,12 +94,12 @@ async def main(): print("Math homework guardrail tripped") ``` -1. 我们将在安全防护措施函数中使用此智能体。 -2. 这是接收智能体输入/上下文并返回结果的安全防护措施函数。 -3. 我们可以在安全防护措施结果中包含额外信息。 +1. 我们会在安全防护函数中使用这个智能体。 +2. 这是接收智能体输入/上下文并返回结果的安全防护函数。 +3. 我们可以在安全防护结果中包含额外信息。 4. 这是定义工作流的实际智能体。 -输出安全防护措施与之类似。 +输出安全防护措施与此类似。 ```python from pydantic import BaseModel @@ -154,5 +154,5 @@ async def main(): 1. 这是实际智能体的输出类型。 2. 这是安全防护措施的输出类型。 -3. 这是接收智能体输出并返回结果的安全防护措施函数。 +3. 这是接收智能体输出并返回结果的安全防护函数。 4. 这是定义工作流的实际智能体。 \ No newline at end of file diff --git a/docs/zh/handoffs.md b/docs/zh/handoffs.md index f81e0202d..7facc1546 100644 --- a/docs/zh/handoffs.md +++ b/docs/zh/handoffs.md @@ -4,19 +4,19 @@ search: --- # 任务转移 -任务转移允许一个智能体将任务委派给另一个智能体。这在不同智能体各自专精不同领域的场景中特别有用。例如，一个客户支持应用可能有各自专门处理订单状态、退款、常见问题（FAQ）等任务的智能体。 +任务转移允许一个智能体将任务委派给另一个智能体。这在不同智能体各自专长不同领域的场景中尤为有用。例如，一个客服应用可能有分别处理订单状态、退款、常见问题等任务的智能体。 -对 LLM 而言，任务转移被表示为工具。因此，如果要将任务转移给名为 `Refund Agent` 的智能体，则该工具会被命名为 `transfer_to_refund_agent`。 +在 LLM 看来，任务转移以工具的形式呈现。因此，如果要将任务转移给名为 `Refund Agent` 的智能体，那么该工具会被命名为 `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 @@ -32,14 +32,14 @@ triage_agent = Agent(name="Triage agent", handoffs=[billing_agent, handoff(refun ### 通过 `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()` 提供的默认工具描述。 -- `on_handoff`: 当任务转移被调用时执行的回调函数。这对于在你知道将要进行任务转移时立即启动某些数据获取等操作很有用。该函数接收智能体上下文，并且可选地接收 LLM 生成的输入。输入数据由 `input_type` 参数控制。 +- `agent`: 要将任务转移到的智能体。 +- `tool_name_override`: 默认使用 `Handoff.default_tool_name()`，解析为 `transfer_to_`。你可以覆盖它。 +- `tool_description_override`: 覆盖来自 `Handoff.default_tool_description()` 的默认工具描述。 +- `on_handoff`: 任务转移被调用时执行的回调函数。这对于在你知道发生任务转移的第一时间触发数据获取等操作很有用。该函数会接收智能体上下文，并可选地接收由 LLM 生成的输入。输入数据由 `input_type` 参数控制。 - `input_type`: 任务转移期望的输入类型（可选）。 -- `input_filter`: 允许你过滤下一个智能体接收的输入。详见下文。 +- `input_filter`: 允许你过滤传递给下一个智能体的输入。详见下文。 - `is_enabled`: 是否启用该任务转移。可以是布尔值或返回布尔值的函数，从而允许你在运行时动态启用或禁用任务转移。 ```python @@ -60,7 +60,7 @@ handoff_obj = handoff( ## 任务转移输入 -在某些情况下，你希望 LLM 在调用任务转移时提供一些数据。例如，设想将任务转移给“升级处理（Escalation）智能体”。你可能希望提供一个原因，以便进行日志记录。 +在某些情况下，你希望 LLM 在调用任务转移时提供一些数据。例如，设想转移到一个“升级处理智能体”（Escalation agent）。你可能希望提供一个原因，便于记录。 ```python from pydantic import BaseModel @@ -84,9 +84,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`。 -有一些常见模式（例如从历史记录中移除所有工具调用），它们已在 [`agents.extensions.handoff_filters`][] 中为你实现。 +有一些常见模式（例如从历史中移除所有工具调用），已在 [`agents.extensions.handoff_filters`][] 中为你实现。 ```python from agents import Agent, handoff @@ -100,11 +100,11 @@ handoff_obj = handoff( ) ``` -1. 当调用 `FAQ agent` 时，这将自动从历史记录中移除所有工具。 +1. 当调用 `FAQ agent` 时，这将自动从历史中移除所有工具。 ## 推荐提示词 -为确保 LLM 正确理解任务转移，我们建议在你的智能体中包含有关任务转移的信息。我们在 [`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX`][] 中提供了建议的前缀，或者你也可以调用 [`agents.extensions.handoff_prompt.prompt_with_handoff_instructions`][] 将推荐数据自动添加到你的提示词中。 +为确保 LLM 正确理解任务转移，我们建议在你的智能体中包含有关任务转移的信息。我们在 [`agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX`][] 中提供了建议的前缀，或者你可以调用 [`agents.extensions.handoff_prompt.prompt_with_handoff_instructions`][] 将推荐内容自动添加到你的提示词中。 ```python from agents import Agent diff --git a/docs/zh/index.md b/docs/zh/index.md index c3b94648b..1e1110565 100644 --- a/docs/zh/index.md +++ b/docs/zh/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 仅包含一小组基本组件： -- **智能体（Agents）**：配备了 instructions 和 tools 的 LLM -- **任务转移（Handoffs）**：允许智能体将特定任务委派给其他智能体 -- **安全防护措施（Guardrails）**：支持对智能体输入与输出进行校验 -- **会话（Sessions）**：在多次运行中自动维护对话历史 +- **智能体**：配备 instructions 和 tools 的 LLM +- **任务转移**：允许智能体将特定任务委派给其他智能体 +- **安全防护措施**：支持对智能体的输入与输出进行校验 +- **会话**：在多次运行智能体时自动维护对话历史 -结合 Python，这些基本组件足以表达工具与智能体之间的复杂关系，让你无需陡峭的学习曲线即可构建真实应用。此外，SDK 自带 **追踪（tracing）**，可用于可视化和调试你的智能体流程，亦可进行评估，甚至为你的应用微调模型。 +结合 Python，这些基本组件足以表达工具与智能体之间的复杂关系，让你无需陡峭的学习曲线就能构建真实世界的应用。此外，SDK 内置了 **追踪**，帮助你可视化与调试智能体流程，并支持评估，甚至为你的应用微调模型。 ## 使用 Agents SDK 的理由 -该 SDK 的两条核心设计原则： +该 SDK 的设计原则有两点： -1. 功能足够有用，但基本组件足够少，便于快速上手。 -2. 开箱即用，同时你可以精确自定义行为。 +1. 功能足够丰富以值得使用，但基本组件足够少以便快速上手。 +2. 开箱即用且表现出色，同时你可以精确自定义实际行为。 -主要特性包括： +SDK 的主要特性如下： -- 智能体循环：内置循环负责调用 tools、将结果反馈给 LLM，并在 LLM 完成前自动迭代。 -- Python 优先：使用语言自带能力编排与串联智能体，无需学习新的抽象。 -- 任务转移：强大的多智能体协作与委派能力。 -- 安全防护措施：与智能体并行执行输入校验与检查，失败即提前终止。 -- 会话：跨多次运行自动管理对话历史，免去手动状态处理。 -- 工具调用：将任意 Python 函数变为工具，自动生成 schema，并通过 Pydantic 驱动的校验。 -- 追踪：内置追踪用于可视化、调试与监控流程，并可使用 OpenAI 的评估、微调与蒸馏工具套件。 +- 智能体循环：内置循环，负责调用工具、将结果发送给 LLM，并循环直至 LLM 完成。 +- Python 优先：使用内置语言特性编排与串联智能体，无需学习新的抽象。 +- 任务转移：在多个智能体之间进行协调与委派的强大能力。 +- 安全防护措施：与智能体并行运行输入校验与检查，失败时可提前中断。 +- 会话：在多次运行智能体间自动管理对话历史，免除手动状态处理。 +- 工具调用：将任意 Python 函数变为工具，自动生成模式并使用 Pydantic 进行校验。 +- 追踪：内置追踪用于可视化、调试与监控工作流，并可使用 OpenAI 的评估、微调与蒸馏工具集。 ## 安装 @@ -36,7 +36,7 @@ search: pip install openai-agents ``` -## Hello World 示例 +## Hello world 示例 ```python from agents import Agent, Runner @@ -51,7 +51,7 @@ print(result.final_output) # Infinite loop's dance. ``` -（运行时，请确保已设置环境变量 `OPENAI_API_KEY`） +（_如需运行，请确保设置 `OPENAI_API_KEY` 环境变量_） ```bash export OPENAI_API_KEY=sk-... diff --git a/docs/zh/mcp.md b/docs/zh/mcp.md index 622133a40..9edd25000 100644 --- a/docs/zh/mcp.md +++ b/docs/zh/mcp.md @@ -4,34 +4,32 @@ search: --- # Model context protocol (MCP) -[Model context protocol](https://modelcontextprotocol.io/introduction)（MCP）标准化了应用如何向语言模型暴露工具和上下文。来自官方文档： +[Model context protocol](https://modelcontextprotocol.io/introduction)（MCP）标准化了应用向语言模型公开工具和上下文的方式。官方文档描述： -> MCP is an open protocol that standardizes how applications provide context to LLMs. Think of MCP like a USB-C port for AI -> applications. Just as USB-C provides a standardized way to connect your devices to various peripherals and accessories, MCP -> provides a standardized way to connect AI models to different data sources and tools. +> MCP 是一个开放协议，用于标准化应用向 LLM 提供上下文的方式。可以把 MCP 想象成 AI 应用的 USB‑C 接口。就像 USB‑C 为你的设备连接各种外设和配件提供了标准化方式，MCP 为 AI 模型连接不同数据源和工具提供了标准化方式。 -Agents Python SDK 支持多种 MCP 传输方式。这让你可以复用现有的 MCP 服务，或自行构建以向智能体暴露文件系统、HTTP 或连接器支持的工具。 +Agents Python SDK 支持多种 MCP 传输方式。这让你可以复用现有的 MCP 服务，或构建自己的服务，将文件系统、HTTP 或基于连接器的工具暴露给智能体。 ## Choosing an MCP integration -在将 MCP 服务接入智能体之前，先决定工具调用应在何处执行，以及你能使用哪些传输方式。下表总结了 Python SDK 支持的选项。 +在把 MCP 服务接入智能体之前，请先确定工具调用应在何处执行，以及你能访问哪些传输方式。下表总结了 Python SDK 支持的选项。 | 你的需求 | 推荐选项 | | ------------------------------------------------------------------------------------ | ----------------------------------------------------- | -| 让 OpenAI 的 Responses API 代表模型调用一个可公开访问的 MCP 服务 | **Hosted MCP server tools**，通过 [`HostedMCPTool`][agents.tool.HostedMCPTool] | -| 连接你本地或远程运行的可流式 HTTP 服务 | **Streamable HTTP MCP servers**，通过 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] | -| 与实现了带 Server-Sent Events 的 HTTP 的服务通信 | **HTTP with SSE MCP servers**，通过 [`MCPServerSse`][agents.mcp.server.MCPServerSse] | +| 让 OpenAI 的 Responses API 代表模型调用可公网访问的 MCP 服务 | **Hosted MCP server tools**，通过 [`HostedMCPTool`][agents.tool.HostedMCPTool] | +| 连接你本地或远程运行的 Streamable HTTP 服务 | **Streamable HTTP MCP servers**，通过 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp] | +| 与实现了基于 SSE 的 HTTP 的服务通信 | **HTTP with SSE MCP servers**，通过 [`MCPServerSse`][agents.mcp.server.MCPServerSse] | | 启动本地进程并通过 stdin/stdout 通信 | **stdio MCP servers**，通过 [`MCPServerStdio`][agents.mcp.server.MCPServerStdio] | -下文将依次介绍每个选项、如何配置，以及在何种情况下更倾向于使用哪种传输方式。 +下文将依次介绍每个选项、如何配置、以及在何种情况下更适合使用对应的传输方式。 ## 1. Hosted MCP server tools -托管工具将整个工具的往返调用放到 OpenAI 的基础设施中。你的代码不再列出和调用工具，[`HostedMCPTool`][agents.tool.HostedMCPTool] 会将服务标签（以及可选的连接器元数据）转发给 Responses API。模型会列出远程服务的工具并直接调用它们，而无需回调到你的 Python 进程。托管工具目前适用于支持 Responses API 托管 MCP 集成的 OpenAI 模型。 +托管工具将整个工具调用往返过程交由 OpenAI 的基础设施处理。你的代码无需列出并调用工具，[`HostedMCPTool`][agents.tool.HostedMCPTool] 会把服务标识（以及可选的连接器元数据）转发给 Responses API。模型会列出远程服务的工具并直接调用，无需回调到你的 Python 进程。托管工具目前适用于支持 Responses API 托管 MCP 集成的 OpenAI 模型。 ### Basic hosted MCP tool -在智能体的 `tools` 列表中添加一个 [`HostedMCPTool`][agents.tool.HostedMCPTool] 即可创建托管工具。`tool_config` 字典与发送到 REST API 的 JSON 相对应： +通过在智能体的 `tools` 列表中添加 [`HostedMCPTool`][agents.tool.HostedMCPTool] 来创建托管工具。`tool_config` 字典与通过 REST API 发送的 JSON 对应： ```python import asyncio @@ -59,11 +57,11 @@ async def main() -> None: asyncio.run(main()) ``` -托管服务会自动暴露其工具；无需将其加入 `mcp_servers`。 +托管服务会自动暴露其工具；你无需将其添加到 `mcp_servers`。 ### Streaming hosted MCP results -托管工具以与工具调用完全相同的方式支持流式传输。向 `Runner.run_streamed` 传入 `stream=True`，即可在模型仍在运行时消费增量的 MCP 输出： +托管工具以与 工具调用 相同的方式支持流式传输结果。向 `Runner.run_streamed` 传入 `stream=True`，即可在模型仍在处理时消费增量的 MCP 输出： ```python result = Runner.run_streamed(agent, "Summarise this repository's top languages") @@ -75,7 +73,7 @@ print(result.final_output) ### Optional approval flows -如果某个服务可以执行敏感操作，你可以在每次工具执行前要求人工或程序化审批。在 `tool_config` 中配置 `require_approval`，可传入单一策略（`"always"`、`"never"`）或一个将工具名称映射到策略的字典。若要在 Python 内做出决策，提供一个 `on_approval_request` 回调即可。 +如果某个服务可能执行敏感操作，你可以在每次工具执行前要求人工或程序化审批。在 `tool_config` 中配置 `require_approval`，可指定单一策略（`"always"`、`"never"`）或按工具名映射到策略的字典。若需在 Python 内做决策，提供 `on_approval_request` 回调即可。 ```python from agents import MCPToolApprovalFunctionResult, MCPToolApprovalRequest @@ -103,11 +101,11 @@ agent = Agent( ) ``` -回调可以是同步或异步的，并会在模型需要审批数据以继续运行时被调用。 +该回调可以是同步或异步的；每当模型需要审批数据以继续运行时都会被调用。 ### Connector-backed hosted servers -托管 MCP 也支持 OpenAI connectors。你可以不指定 `server_url`，而是提供 `connector_id` 和访问令牌。Responses API 负责认证，托管服务会暴露该连接器的工具。 +托管 MCP 也支持 OpenAI 连接器。无需提供 `server_url`，而是提供 `connector_id` 和访问令牌。Responses API 会处理认证，托管服务将暴露该连接器的工具。 ```python import os @@ -128,7 +126,7 @@ HostedMCPTool( ## 2. Streamable HTTP MCP servers -当你希望自行管理网络连接时，使用 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp]。当你可控传输层，或希望在自有基础设施中运行服务并保持低延迟时，可流式传输的 HTTP 服务是理想选择。 +当你希望自行管理网络连接时，使用 [`MCPServerStreamableHttp`][agents.mcp.server.MCPServerStreamableHttp]。当你可控传输层、或希望在自有基础设施中运行服务并保持低延迟时，Streamable HTTP 服务是理想选择。 ```python import asyncio @@ -163,16 +161,16 @@ async def main() -> None: asyncio.run(main()) ``` -构造函数接受以下附加选项： +构造函数支持以下额外选项： - `client_session_timeout_seconds` 控制 HTTP 读取超时。 - `use_structured_content` 切换是否优先使用 `tool_result.structured_content` 而非文本输出。 -- `max_retry_attempts` 和 `retry_backoff_seconds_base` 为 `list_tools()` 和 `call_tool()` 添加自动重试。 -- `tool_filter` 允许只暴露工具的子集（参见 [Tool filtering](#tool-filtering)）。 +- `max_retry_attempts` 和 `retry_backoff_seconds_base` 为 `list_tools()` 和 `call_tool()` 增加自动重试。 +- `tool_filter` 允许仅暴露部分工具（参见 [Tool filtering](#tool-filtering)）。 ## 3. HTTP with SSE MCP servers -如果 MCP 服务实现了带 SSE 的 HTTP 传输，实例化 [`MCPServerSse`][agents.mcp.server.MCPServerSse]。除传输方式外，其 API 与可流式 HTTP 服务完全一致。 +如果 MCP 服务实现了基于 SSE 的 HTTP 传输，请实例化 [`MCPServerSse`][agents.mcp.server.MCPServerSse]。除传输方式不同外，其 API 与 Streamable HTTP 服务完全一致。 ```python @@ -201,7 +199,7 @@ async with MCPServerSse( ## 4. stdio MCP servers -对于作为本地子进程运行的 MCP 服务，使用 [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]。SDK 会启动进程、保持管道打开，并在上下文管理器退出时自动关闭。这一选项适合快速原型验证，或当服务仅暴露命令行入口时使用。 +对于作为本地子进程运行的 MCP 服务，使用 [`MCPServerStdio`][agents.mcp.server.MCPServerStdio]。SDK 会启动该进程、保持管道打开，并在上下文管理器退出时自动关闭。此选项适用于快速原型，或当服务仅通过命令行入口暴露时。 ```python from pathlib import Path @@ -229,7 +227,7 @@ async with MCPServerStdio( ## Tool filtering -每个 MCP 服务都支持工具过滤，以便你只暴露智能体所需的函数。过滤可以在构造时进行，也可以在每次运行时动态进行。 +每个 MCP 服务均支持工具过滤，你可以只暴露智能体所需的功能。过滤可以在构造时完成，也可以在每次运行时动态应用。 ### Static tool filtering @@ -251,11 +249,11 @@ filesystem_server = MCPServerStdio( ) ``` -当同时提供 `allowed_tool_names` 和 `blocked_tool_names` 时，SDK 会先应用允许列表，然后从剩余集合中移除任何被阻止的工具。 +当同时提供 `allowed_tool_names` 与 `blocked_tool_names` 时，SDK 会先应用允许列表，然后从剩余集合中移除任何被阻止的工具。 ### Dynamic tool filtering -对于更复杂的逻辑，传入一个可调用对象，该对象接收 [`ToolFilterContext`][agents.mcp.ToolFilterContext]。该可调用对象可以是同步或异步的，返回 `True` 表示应暴露该工具。 +对于更复杂的逻辑，传入一个可调用对象，它会接收 [`ToolFilterContext`][agents.mcp.ToolFilterContext]。该可调用对象可为同步或异步，返回 `True` 时表示应暴露该工具。 ```python from pathlib import Path @@ -279,14 +277,14 @@ async with MCPServerStdio( ... ``` -过滤上下文会暴露当前的 `run_context`、请求工具的 `agent`，以及 `server_name`。 +过滤上下文提供当前的 `run_context`、请求工具的 `agent`，以及 `server_name`。 ## Prompts -MCP 服务还可以提供动态生成智能体 instructions 的提示词。支持提示词的服务会暴露两个方法： +MCP 服务还可以提供可动态生成智能体 instructions 的提示。支持提示的服务会暴露两个方法： - `list_prompts()` 枚举可用的提示模板。 -- `get_prompt(name, arguments)` 获取具体提示词，可选地携带参数。 +- `get_prompt(name, arguments)` 获取具体提示，可选传入参数。 ```python from agents import Agent @@ -306,13 +304,13 @@ agent = Agent( ## Caching -每次智能体运行都会对每个 MCP 服务调用 `list_tools()`。远程服务可能会引入明显的延迟，因此所有 MCP 服务类都暴露了 `cache_tools_list` 选项。仅当你确信工具定义不经常变化时才将其设为 `True`。如需之后强制刷新列表，调用服务实例的 `invalidate_tools_cache()`。 +每次智能体运行都会在每个 MCP 服务上调用 `list_tools()`。远程服务可能带来显著延迟，因此所有 MCP 服务类都提供 `cache_tools_list` 选项。仅当你确信工具定义不频繁变化时才将其设为 `True`。若之后需要强制刷新列表，可在服务实例上调用 `invalidate_tools_cache()`。 ## Tracing [Tracing](./tracing.md) 会自动捕获 MCP 活动，包括： -1. 调用 MCP 服务以列出工具。 +1. 调用 MCP 服务列出工具。 2. 工具调用中的 MCP 相关信息。 ![MCP Tracing Screenshot](../assets/images/mcp-tracing.jpg) @@ -320,5 +318,5 @@ agent = Agent( ## Further reading - [Model Context Protocol](https://modelcontextprotocol.io/) – 规范与设计指南。 -- [examples/mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp) – 可运行的 stdio、SSE 和可流式 HTTP 示例。 +- [examples/mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp) – 可运行的 stdio、SSE 与 Streamable HTTP 示例。 - [examples/hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp) – 完整的托管 MCP 演示，包括审批与连接器。 \ No newline at end of file diff --git a/docs/zh/models/index.md b/docs/zh/models/index.md index f97b1366c..65a7288dd 100644 --- a/docs/zh/models/index.md +++ b/docs/zh/models/index.md @@ -4,20 +4,20 @@ search: --- # 模型 -Agents SDK 开箱即用地支持两种 OpenAI 模型形态： +Agents SDK 原生支持两种 OpenAI 模型用法： -- **推荐**：[`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel]，通过新的 [Responses API](https://platform.openai.com/docs/api-reference/responses) 调用 OpenAI 接口。 -- [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel]，通过 [Chat Completions API](https://platform.openai.com/docs/api-reference/chat) 调用 OpenAI 接口。 +- **推荐**：[`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel]，使用全新的 [Responses API](https://platform.openai.com/docs/api-reference/responses) 调用 OpenAI 接口。 +- [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel]，使用 [Chat Completions API](https://platform.openai.com/docs/api-reference/chat) 调用 OpenAI 接口。 ## OpenAI 模型 -当你在初始化 `Agent` 时未指定模型，将使用默认模型。当前默认是 [`gpt-4.1`](https://platform.openai.com/docs/models/gpt-4.1)，在智能体工作流的可预测性与低延迟之间提供了良好平衡。 +当你在初始化 `Agent` 时未指定模型，将使用默认模型。当前默认是 [`gpt-4.1`](https://platform.openai.com/docs/models/gpt-4.1)，在智能体式工作流的可预测性与低延迟之间提供了良好平衡。 -如果你希望切换到其他模型，如 [`gpt-5`](https://platform.openai.com/docs/models/gpt-5)，请按照下一节的步骤操作。 +如果你想切换到其他模型，如 [`gpt-5`](https://platform.openai.com/docs/models/gpt-5)，请按照下一节的步骤操作。 ### 默认 OpenAI 模型 -如果你希望对所有未设置自定义模型的智能体始终使用某个特定模型，请在运行智能体前设置 `OPENAI_DEFAULT_MODEL` 环境变量。 +如果你希望对未自定义模型的所有智能体始终使用某个特定模型，请在运行前设置环境变量 `OPENAI_DEFAULT_MODEL`。 ```bash export OPENAI_DEFAULT_MODEL=gpt-5 @@ -26,9 +26,9 @@ python3 my_awesome_agent.py #### GPT-5 模型 -当你以这种方式使用任何 GPT-5 推理模型（[`gpt-5`](https://platform.openai.com/docs/models/gpt-5)、[`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) 或 [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano)）时，SDK 会默认应用合理的 `ModelSettings`。具体而言，它会将 `reasoning.effort` 和 `verbosity` 都设置为 `"low"`。如果你希望自行构建这些设置，请调用 `agents.models.get_default_model_settings("gpt-5")`。 +当你以这种方式使用任一 GPT-5 推理模型（[`gpt-5`](https://platform.openai.com/docs/models/gpt-5)、[`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) 或 [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano)）时，SDK 会默认应用合理的 `ModelSettings`。具体来说，它会将 `reasoning.effort` 和 `verbosity` 都设置为 `"low"`。如果你想自行构建这些设置，请调用 `agents.models.get_default_model_settings("gpt-5")`。 -如需更低延迟或满足特定需求，你可以选择不同的模型和设置。要为默认模型调整推理力度，请传入你自己的 `ModelSettings`： +若需更低延迟或满足特定需求，你可以选择不同的模型与设置。要为默认模型调整推理强度，传入你自己的 `ModelSettings`： ```python from openai.types.shared import Reasoning @@ -44,21 +44,21 @@ my_agent = Agent( ) ``` -如果专门追求更低延迟，使用 [`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) 或 [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano) 并设置 `reasoning.effort="minimal"`，通常会比默认设置更快返回结果。然而，Responses API 中的某些内置工具（例如 文件检索 与 图像生成）不支持 `"minimal"` 推理力度，这也是本 Agents SDK 默认为 `"low"` 的原因。 +如需进一步降低延迟，使用 [`gpt-5-mini`](https://platform.openai.com/docs/models/gpt-5-mini) 或 [`gpt-5-nano`](https://platform.openai.com/docs/models/gpt-5-nano) 并设置 `reasoning.effort="minimal"`，通常会比默认设置更快返回结果。然而，Responses API 中的一些内置工具（如 文件检索 和 图像生成）不支持 `"minimal"` 推理强度，这也是本 Agents SDK 默认使用 `"low"` 的原因。 #### 非 GPT-5 模型 -如果你传入非 GPT-5 的模型名称且未提供自定义 `model_settings`，SDK 会回退到对任意模型都兼容的通用 `ModelSettings`。 +如果你传入非 GPT-5 的模型名称且未提供自定义 `model_settings`，SDK 会回退到与任意模型兼容的通用 `ModelSettings`。 ## 非 OpenAI 模型 -你可以通过 [LiteLLM 集成](./litellm.md) 来使用大多数其他非 OpenAI 模型。首先，安装 litellm 依赖分组： +你可以通过 [LiteLLM 集成](./litellm.md) 使用大多数其他非 OpenAI 模型。首先安装 litellm 依赖组： ```bash pip install "openai-agents[litellm]" ``` -然后，使用带有 `litellm/` 前缀的任一[受支持模型](https://docs.litellm.ai/docs/providers)： +然后使用带有 `litellm/` 前缀的任一[受支持的模型](https://docs.litellm.ai/docs/providers)： ```python claude_agent = Agent(model="litellm/anthropic/claude-3-5-sonnet-20240620", ...) @@ -67,29 +67,29 @@ gemini_agent = Agent(model="litellm/gemini/gemini-2.5-flash-preview-04-17", ...) ### 使用非 OpenAI 模型的其他方式 -你还可以通过另外 3 种方式集成其他 LLM 提供方（示例见[此处](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)）： +你还可以通过另外 3 种方式集成其他 LLM 提供商（示例见[此处](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)）： -1. [`set_default_openai_client`][agents.set_default_openai_client] 适用于你希望在全局使用一个 `AsyncOpenAI` 实例作为 LLM 客户端的情况。适合 LLM 提供方有 OpenAI 兼容的 API 端点，且你可以设置 `base_url` 和 `api_key`。可参见可配置示例：[examples/model_providers/custom_example_global.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_global.py)。 -2. [`ModelProvider`][agents.models.interface.ModelProvider] 位于 `Runner.run` 层级。它允许你指定“在本次运行中为所有智能体使用自定义模型提供方”。可参见可配置示例：[examples/model_providers/custom_example_provider.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_provider.py)。 -3. [`Agent.model`][agents.agent.Agent.model] 允许你在特定的 Agent 实例上指定模型。这样你可以为不同的智能体混用不同的提供方。一个简单的方法是通过 [LiteLLM 集成](./litellm.md) 来使用多数可用模型。 +1. [`set_default_openai_client`][agents.set_default_openai_client] 适用于你希望在全局层面使用一个 `AsyncOpenAI` 实例作为 LLM 客户端的情况。此方式适用于 LLM 提供商具备 OpenAI 兼容的 API 端点，并且你可以设置 `base_url` 与 `api_key`。可参见 [examples/model_providers/custom_example_global.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_global.py) 中的可配置示例。 +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) 中的可配置示例。 +3. [`Agent.model`][agents.agent.Agent.model] 允许你在特定的 Agent 实例上指定模型。这使你可以为不同智能体混合搭配不同提供商。可参见 [examples/model_providers/custom_example_agent.py](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/custom_example_agent.py) 中的可配置示例。使用大多数可用模型的简便方式是通过 [LiteLLM 集成](./litellm.md)。 -在你没有来自 `platform.openai.com` 的 API Key 时，建议通过 `set_tracing_disabled()` 来禁用追踪，或设置[不同的追踪进程](../tracing.md)。 +在你没有来自 `platform.openai.com` 的 API key 时，我们建议通过 `set_tracing_disabled()` 禁用追踪，或设置[不同的追踪进程](../tracing.md)。 !!! note - 在这些示例中，我们使用 Chat Completions API/模型，因为大多数 LLM 提供方尚未支持 Responses API。如果你的 LLM 提供方支持，建议使用 Responses。 + 在这些示例中，我们使用 Chat Completions API/模型，因为大多数 LLM 提供商尚不支持 Responses API。如果你的 LLM 提供商支持，建议使用 Responses。 -## 混合与匹配模型 +## 混合与搭配模型 -在单个工作流中，你可能希望为每个智能体使用不同的模型。例如，你可以使用更小更快的模型进行初步分诊，而在复杂任务上使用更大更强的模型。在配置 [`Agent`][agents.Agent] 时，你可以通过以下方式选择特定模型： +在单个工作流中，你可能希望为每个智能体使用不同的模型。例如，你可以使用更小更快的模型进行分诊，而用更大更强的模型处理复杂任务。在配置 [`Agent`][agents.Agent] 时，你可以通过以下方式选择特定模型： -1. 直接传入模型名称。 +1. 传入模型名称。 2. 传入任意模型名称 + 一个可以将该名称映射到 Model 实例的 [`ModelProvider`][agents.models.interface.ModelProvider]。 -3. 直接提供一个 [`Model`][agents.models.interface.Model] 的实现。 +3. 直接提供一个 [`Model`][agents.models.interface.Model] 实现。 !!!note - 虽然我们的 SDK 同时支持 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] 和 [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] 两种形态，但我们建议在每个工作流中使用单一模型形态，因为这两种形态支持的功能和工具集不同。如果你的工作流确实需要混用不同的模型形态，请确保你使用的所有功能在两者上都可用。 + 尽管我们的 SDK 同时支持 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] 和 [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel] 两种形态，但我们建议每个工作流使用单一模型形态，因为两者支持的功能与工具集合不同。如果你的工作流需要混合使用不同模型形态，请确保你所用的所有功能在两者上都可用。 ```python from agents import Agent, Runner, AsyncOpenAI, OpenAIChatCompletionsModel @@ -122,10 +122,10 @@ async def main(): print(result.final_output) ``` -1. 直接设置 OpenAI 模型的名称。 -2. 提供一个 [`Model`][agents.models.interface.Model] 的实现。 +1. 直接设置一个 OpenAI 模型的名称。 +2. 提供一个 [`Model`][agents.models.interface.Model] 实现。 -当你需要进一步配置某个智能体所用的模型时，你可以传入 [`ModelSettings`][agents.models.interface.ModelSettings]，它提供诸如 temperature 等可选的模型配置参数。 +当你希望对智能体使用的模型进行进一步配置时，你可以传入 [`ModelSettings`][agents.models.interface.ModelSettings]，用于提供可选的模型配置参数，例如 temperature。 ```python from agents import Agent, ModelSettings @@ -138,7 +138,7 @@ english_agent = Agent( ) ``` -此外，在使用 OpenAI 的 Responses API 时，[还有一些其他可选参数](https://platform.openai.com/docs/api-reference/responses/create)（例如 `user`、`service_tier` 等）。如果这些参数并未在顶层提供，你也可以通过 `extra_args` 传入。 +此外，在使用 OpenAI 的 Responses API 时，[还有一些其他可选参数](https://platform.openai.com/docs/api-reference/responses/create)（例如 `user`、`service_tier` 等）。如果这些参数在顶层不可用，你可以通过 `extra_args` 传入。 ```python from agents import Agent, ModelSettings @@ -154,26 +154,26 @@ english_agent = Agent( ) ``` -## 使用其他 LLM 提供方的常见问题 +## 使用其他 LLM 提供商的常见问题 -### 追踪客户端报错 401 +### 追踪客户端错误 401 -如果你遇到与追踪相关的错误，这是因为追踪数据会被上传到 OpenAI 服务，而你没有 OpenAI 的 API Key。你有三种解决方案： +如果你遇到与追踪相关的错误，这是因为追踪数据会上传到 OpenAI 服务，而你没有 OpenAI API key。你有三种方案可以解决： 1. 完全禁用追踪：[`set_tracing_disabled(True)`][agents.set_tracing_disabled]。 -2. 设置用于追踪的 OpenAI Key：[`set_tracing_export_api_key(...)`][agents.set_tracing_export_api_key]。此 API Key 仅用于上传追踪数据，并且必须来自 [platform.openai.com](https://platform.openai.com/)。 +2. 为追踪设置一个 OpenAI key：[`set_tracing_export_api_key(...)`][agents.set_tracing_export_api_key]。该 API key 仅用于上传追踪数据，且必须来自 [platform.openai.com](https://platform.openai.com/)。 3. 使用非 OpenAI 的追踪进程。参见[追踪文档](../tracing.md#custom-tracing-processors)。 ### Responses API 支持 -SDK 默认使用 Responses API，但多数其他 LLM 提供方尚未支持。因此你可能会看到 404 或类似问题。为解决此问题，你有两种选择： +SDK 默认使用 Responses API，但大多数其他 LLM 提供商尚不支持。因此你可能会看到 404 或类似问题。解决方法有两种： -1. 调用 [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api]。当你通过环境变量设置了 `OPENAI_API_KEY` 和 `OPENAI_BASE_URL` 时适用。 -2. 使用 [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel]。示例见[此处](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)。 +1. 调用 [`set_default_openai_api("chat_completions")`][agents.set_default_openai_api]。当你通过环境变量设置了 `OPENAI_API_KEY` 和 `OPENAI_BASE_URL` 时有效。 +2. 使用 [`OpenAIChatCompletionsModel`][agents.models.openai_chatcompletions.OpenAIChatCompletionsModel]。示例见[这里](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers/)。 -### structured outputs 支持 +### 结构化输出支持 -有些模型提供方不支持 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs)。这有时会导致类似如下的错误： +有些模型提供商不支持[structured outputs](https://platform.openai.com/docs/guides/structured-outputs)。这有时会导致类似如下的错误： ``` @@ -181,12 +181,12 @@ BadRequestError: Error code: 400 - {'error': {'message': "'response_format.type' ``` -这是某些模型提供方的不足之处——它们支持 JSON 输出，但不允许你指定用于输出的 `json_schema`。我们正在努力修复此问题，但建议优先使用支持 JSON schema 输出的提供方，否则你的应用可能会因为 JSON 格式错误而经常出错。 +这是部分模型提供商的不足——它们支持 JSON 输出，但不允许你为输出指定 `json_schema`。我们正在努力修复此问题，但建议优先使用支持 JSON schema 输出的提供商，否则你的应用经常会因 JSON 不符合格式良好的数据而出错。 -## 跨提供方混用模型 +## 在不同提供商间混合模型 -你需要注意不同模型提供方之间的功能差异，否则可能会遇到错误。例如，OpenAI 支持 structured outputs、多模态输入，以及由OpenAI托管的工具中的 文件检索 和 网络检索，但许多其他提供方不支持这些功能。请注意以下限制： +你需要注意不同模型提供商之间的功能差异，否则可能会遇到错误。比如，OpenAI 支持 structured outputs、多模态输入，以及托管的 文件检索 和 网络检索，但许多其他提供商并不支持这些功能。请注意以下限制： -- 不要向不支持的提供方发送其无法理解的 `tools` -- 在调用仅支持文本的模型前，过滤掉多模态输入 -- 注意不支持结构化 JSON 输出的提供方可能会偶尔产生无效 JSON \ No newline at end of file +- 不要向不理解的提供商发送不受支持的 `tools` +- 在调用仅支持文本的模型之前，先过滤掉多模态输入 +- 注意不支持结构化 JSON 输出的提供商可能会偶尔生成无效的 JSON。 \ No newline at end of file diff --git a/docs/zh/models/litellm.md b/docs/zh/models/litellm.md index 640f4186b..0665325f7 100644 --- a/docs/zh/models/litellm.md +++ b/docs/zh/models/litellm.md @@ -6,13 +6,13 @@ search: !!! note - LiteLLM 集成目前为测试版。你可能会在使用某些模型提供商时遇到问题，特别是较小的提供商。请通过 [GitHub 问题](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+ 个模型。我们已添加对 LiteLLM 的集成，以便你在 Agents SDK 中使用任意 AI 模型。 +[LiteLLM](https://docs.litellm.ai/docs/) 是一个库，可通过统一接口使用 100+ 模型。我们在 Agents SDK 中加入了 LiteLLM 集成，以便你可以使用任意 AI 模型。 ## 设置 -你需要确保可用 `litellm`。你可以通过安装可选的 `litellm` 依赖组来实现： +你需要确保可用的 `litellm`。可以通过安装可选的 `litellm` 依赖组来完成： ```bash pip install "openai-agents[litellm]" @@ -22,13 +22,13 @@ pip install "openai-agents[litellm]" ## 示例 -这是一个可直接运行的示例。运行后会提示输入模型名称和 API key。例如，你可以输入： +下面是一个可直接运行的示例。运行时会提示你输入模型名称和 API key。比如你可以输入： -- 模型使用 `openai/gpt-4.1`，并提供你的 OpenAI API key -- 模型使用 `anthropic/claude-3-5-sonnet-20240620`，并提供你的 Anthropic API key -- 等等 +- `openai/gpt-4.1` 作为模型，并提供你的 OpenAI API key +- `anthropic/claude-3-5-sonnet-20240620` 作为模型，并提供你的 Anthropic API key +- 等等 -关于 LiteLLM 支持的完整模型列表，请参见 [litellm providers 文档](https://docs.litellm.ai/docs/providers)。 +LiteLLM 支持的完整模型列表见 [litellm providers docs](https://docs.litellm.ai/docs/providers)。 ```python from __future__ import annotations @@ -76,9 +76,9 @@ if __name__ == "__main__": asyncio.run(main(model, api_key)) ``` -## 使用数据追踪 +## 用量追踪 -如果你希望 LiteLLM 的响应填充到 Agents SDK 的使用指标中，请在创建智能体时传入 `ModelSettings(include_usage=True)`。 +如果你希望将 LiteLLM 的响应填充到 Agents SDK 的用量指标中，在创建智能体时传入 `ModelSettings(include_usage=True)`。 ```python from agents import Agent, ModelSettings @@ -91,4 +91,4 @@ agent = Agent( ) ``` -启用 `include_usage=True` 后，LiteLLM 请求将通过 `result.context_wrapper.usage` 报告 token 和请求计数，与内置的 OpenAI 模型一致。 \ No newline at end of file +设置 `include_usage=True` 后，LiteLLM 请求会通过 `result.context_wrapper.usage` 报告 token 与请求计数，就像内置的 OpenAI 模型一样。 \ No newline at end of file diff --git a/docs/zh/multi_agent.md b/docs/zh/multi_agent.md index 74b918dce..7b441f11f 100644 --- a/docs/zh/multi_agent.md +++ b/docs/zh/multi_agent.md @@ -2,40 +2,40 @@ search: exclude: true --- -# 多智能体编排 +# 编排多个智能体 -编排指的是你在应用中组织智能体的流程：哪些智能体运行、以何种顺序运行、以及它们如何决定下一步。编排智能体主要有两种方式： +编排指的是应用中智能体的流转：哪些智能体运行、以何种顺序运行，以及它们如何决定接下来发生什么。编排智能体主要有两种方式： -1. 让 LLM 做决策：利用 LLM 的智能来规划、推理，并基于此决定采取的步骤。 -2. 通过代码进行编排：用你的代码决定智能体的执行流程。 +1. 让 LLM 做决策：利用 LLM 的智能来规划、推理，并据此决定采取哪些步骤。 +2. 通过代码编排：使用代码来确定智能体的流转。 -你可以混合使用这些模式。每种方式都有权衡，详见下文。 +你可以混合使用这些模式。各自的权衡如下所述。 ## 通过 LLM 编排 -一个智能体是配备了指令（instructions）、工具（tools）和任务转移（handoffs）的 LLM。这意味着对于一个开放式任务，LLM 可以自主规划解决方案，使用工具执行操作并获取数据，并通过任务转移将子任务委派给子智能体。比如，一个研究型智能体可以配备以下工具： +一个智能体是配备了 instructions、tools 和 任务转移 的 LLM。这意味着，对于一个开放式任务，LLM 可以自主规划如何完成任务，使用工具执行操作并获取数据，并通过 任务转移 将任务委派给子智能体。例如，一个研究类智能体可以配备如下工具： - 网络检索以在线查找信息 -- 文件检索和读取以搜索专有数据和连接 +- 文件检索与读取以搜索专有数据和连接 - 计算机操作以在计算机上执行动作 - 代码执行以进行数据分析 -- 向擅长规划、报告撰写等的专业智能体进行任务转移 +- 任务转移到擅长规划、写报告等的专用智能体 -当任务是开放式并希望依赖 LLM 的智能时，这种模式非常适合。这里最重要的做法包括： +当任务是开放式且你希望依赖 LLM 的智能时，这一模式非常合适。关键策略包括： -1. 投入精力编写高质量提示词。明确可用工具、使用方式，以及必须遵循的参数范围。 -2. 监控并迭代你的应用。找出问题点，并迭代提示词。 -3. 允许智能体自省和改进。例如，在循环中运行它，让其自我批判；或提供错误信息并让其改进。 -4. 建立在单一任务上表现卓越的专业智能体，而不是期望一个通用智能体在所有方面都很强。 -5. 投入到[评测](https://platform.openai.com/docs/guides/evals)。这有助于训练你的智能体，以改进并在任务上表现更好。 +1. 投入精力打磨优质提示词。明确可用的工具、如何使用它们，以及必须遵守的 参数 范围。 +2. 监控应用并持续迭代。找出出错之处，不断迭代你的提示词。 +3. 允许智能体自省与改进。例如将其置于循环中，让其自我批判；或者提供错误信息以便其改进。 +4. 使用在单一任务上表现突出的专用智能体，而不是期望一个通用智能体在所有方面都表现出色。 +5. 投入到[评测 (evals)](https://platform.openai.com/docs/guides/evals)。这能帮助训练你的智能体，在任务上不断提升。 ## 通过代码编排 -虽然通过 LLM 编排很强大，但通过代码编排能在速度、成本和性能方面使任务更具确定性与可预测性。常见模式包括： +虽然通过 LLM 编排很强大，但通过代码编排在速度、成本和性能上更具确定性与可预测性。常见模式包括： -- 使用[structured outputs](https://platform.openai.com/docs/guides/structured-outputs)生成可由你的代码检查的格式良好的数据。例如，你可以让智能体将任务分类为几个目录，然后基于该目录选择下一个智能体。 -- 将多个智能体串联，把上一个的输出转换为下一个的输入。你可以将写博客这样的任务分解为一系列步骤——先做研究、写提纲、写正文、进行批判性审阅，然后再改进。 -- 将执行任务的智能体与一个负责评估并提供反馈的智能体一起在 `while` 循环中运行，直到评估者表示输出满足某些标准为止。 -- 并行运行多个智能体，例如通过 Python 基本组件如 `asyncio.gather`。当有多个彼此不依赖的任务时，这对提升速度很有用。 +- 使用 [structured outputs](https://platform.openai.com/docs/guides/structured-outputs) 生成可由代码检查的 格式良好的数据。例如，你可以让智能体将任务分类到少数几个目录中，然后基于该目录选择下一个智能体。 +- 将多个智能体串联，把一个的输出转换为下一个的输入。你可以把“写博客文章”这样的任务分解为一系列步骤——先做研究、写大纲、写正文、批判性审阅，然后改进。 +- 将执行任务的智能体与负责评估并提供反馈的智能体一起在 `while` 循环中运行，直到评估者认为输出通过了特定标准。 +- 并行运行多个智能体，例如通过 Python 基本组件 如 `asyncio.gather`。当你有多个彼此独立的任务时，这可以提升速度。 -我们在[`examples/agent_patterns`](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns)中提供了若干代码示例。 \ No newline at end of file +我们在[`examples/agent_patterns`](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns)中提供了许多代码示例。 \ No newline at end of file diff --git a/docs/zh/quickstart.md b/docs/zh/quickstart.md index ede0f47f0..efdc4097d 100644 --- a/docs/zh/quickstart.md +++ b/docs/zh/quickstart.md @@ -4,7 +4,7 @@ search: --- # 快速开始 -## 创建项目和虚拟环境 +## 项目与虚拟环境 你只需执行一次。 @@ -14,9 +14,9 @@ cd my_project python -m venv .venv ``` -### 激活虚拟环境 +### 虚拟环境激活 -每次开启新的终端会话都要执行。 +每次开启新的终端会话时执行。 ```bash source .venv/bin/activate @@ -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 key。 +如果你还没有，请按照[这些说明](https://platform.openai.com/docs/quickstart#create-and-export-an-api-key)创建一个 OpenAI API 密钥。 ```bash export OPENAI_API_KEY=sk-... ``` -## 创建你的第一个智能体 +## 首个智能体创建 -智能体由 instructions、名称和可选配置（例如 `model_config`）定义。 +智能体由 instructions、名称以及可选配置（例如 `model_config`）定义。 ```python from agents import Agent @@ -49,7 +49,7 @@ agent = Agent( ) ``` -## 再添加几个智能体 +## 更多智能体添加 其他智能体可以用相同方式定义。`handoff_descriptions` 为确定任务转移路由提供额外上下文。 @@ -69,7 +69,7 @@ math_tutor_agent = Agent( ) ``` -## 定义你的任务转移 +## 任务转移定义 在每个智能体上，你可以定义一个外发任务转移选项清单，供智能体选择以决定如何推进其任务。 @@ -81,9 +81,9 @@ triage_agent = Agent( ) ``` -## 运行智能体编排 +## 智能体编排运行 -让我们检查工作流是否运行，以及分诊智能体是否在两个专家智能体之间正确路由。 +让我们检查工作流是否正常运行，以及分诊智能体是否能在两个专家智能体之间正确路由。 ```python from agents import Runner @@ -93,9 +93,9 @@ async def main(): print(result.final_output) ``` -## 添加安全防护措施 +## 安全防护措施添加 -你可以在输入或输出上定义自定义安全防护措施。 +你可以定义自定义的安全防护措施，运行在输入或输出上。 ```python from agents import GuardrailFunctionOutput, Agent, Runner @@ -123,7 +123,7 @@ 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 控制台中的追踪查看器](https://platform.openai.com/traces)查看你的运行追踪。 +要回顾智能体运行期间发生的事情，请前往 [OpenAI 控制台中的 Trace viewer](https://platform.openai.com/traces) 查看你的智能体运行追踪。 ## 后续步骤 了解如何构建更复杂的智能体流程： -- 了解如何配置[智能体](agents.md)。 +- 学习如何配置[智能体](agents.md)。 - 了解[运行智能体](running_agents.md)。 - 了解[工具](tools.md)、[安全防护措施](guardrails.md)和[模型](models/index.md)。 \ No newline at end of file diff --git a/docs/zh/realtime/guide.md b/docs/zh/realtime/guide.md index 3ced1edac..f51ff9ca6 100644 --- a/docs/zh/realtime/guide.md +++ b/docs/zh/realtime/guide.md @@ -4,65 +4,65 @@ search: --- # 指南 -本指南深入介绍如何使用 OpenAI Agents SDK 的实时能力构建语音交互的 AI 智能体。 +本指南深入介绍如何使用 OpenAI Agents SDK 的实时功能构建语音能力的 AI 智能体。 -!!! warning "Beta feature" -实时智能体处于 Beta 阶段。随着实现不断改进，可能会有不兼容变更。 +!!! warning "测试版功能" +Realtime 智能体处于测试阶段。随着实现的改进，可能会出现不兼容的变更。 -## 概览 +## 概述 -实时智能体支持对话式流程，可实时处理音频与文本输入，并以实时音频作出响应。它们与 OpenAI 的 Realtime API 保持长连接，实现自然、低时延的语音对话，并能优雅地处理中断。 +实时智能体支持会话式流程，能够实时处理音频和文本输入，并以实时音频进行响应。它们与 OpenAI 的 Realtime API 保持持久连接，实现低延迟的自然语音对话，并能优雅地处理打断。 ## 架构 ### 核心组件 -实时系统由以下关键组件构成： +实时系统由以下关键组件组成： -- **RealtimeAgent**: 一个智能体，配置了 instructions、tools 和 任务转移（handoffs）。 -- **RealtimeRunner**: 管理配置。可调用 `runner.run()` 获取会话。 -- **RealtimeSession**: 单次交互会话。通常在每次用户开启对话时创建，并保持存活直到对话结束。 +- **RealtimeAgent**: 一个智能体，通过 instructions、tools 和 handoffs 进行配置。 +- **RealtimeRunner**: 管理配置。你可以调用 `runner.run()` 获取一个会话。 +- **RealtimeSession**: 单次交互会话。通常在每次用户开始对话时创建一个，并在对话结束前保持存活。 - **RealtimeModel**: 底层模型接口（通常是 OpenAI 的 WebSocket 实现） ### 会话流程 -典型的实时会话遵循如下流程： +典型的实时会话遵循以下流程： -1. **创建 RealtimeAgent**，并配置 instructions、tools 和 任务转移（handoffs）。 -2. **设置 RealtimeRunner**，指定智能体和配置选项。 -3. **启动会话**，使用 `await runner.run()`，该方法返回一个 RealtimeSession。 -4. **向会话发送音频或文本消息**，使用 `send_audio()` 或 `send_message()`。 -5. **监听事件**，通过迭代会话对象来获取事件——包括音频输出、转写文本、工具调用、任务转移以及错误。 -6. **处理中断**，当用户打断智能体说话时，将自动停止当前音频生成。 +1. **创建 RealtimeAgent（一个或多个）**，并配置 instructions、tools 和 handoffs。 +2. **设置 RealtimeRunner**，传入智能体和配置选项 +3. **启动会话**，使用 `await runner.run()`，返回一个 RealtimeSession。 +4. **发送音频或文本消息** 到会话，使用 `send_audio()` 或 `send_message()` +5. **监听事件**，通过遍历会话对象来接收事件——事件包括音频输出、转写文本、工具调用、任务转移以及错误 +6. **处理打断**，当用户打断说话时，系统会自动停止当前音频生成 会话会维护对话历史，并管理与实时模型的持久连接。 ## 智能体配置 -RealtimeAgent 的工作方式与常规 Agent 类似，但存在一些关键差异。完整 API 细节请参阅 [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API 参考。 +RealtimeAgent 的工作方式与常规 Agent 类似，但有一些关键差异。完整 API 详情参见 [`RealtimeAgent`][agents.realtime.agent.RealtimeAgent] API 参考。 与常规智能体的主要差异： -- 模型选择在会话级别配置，而不是智能体级别。 -- 不支持 structured output（不支持 `outputType`）。 -- 可为每个智能体配置语音，但在第一个智能体开始说话后便不可更改。 -- 其他特性（例如 tools、任务转移和 instructions）工作方式相同。 +- 模型选择在会话级别配置，而不是在智能体级别。 +- 不支持 structured outputs（不支持 `outputType`）。 +- 可以为每个智能体配置 Voice，但在第一个智能体开始说话后就不能再更改。 +- 其他特性如 tools、handomffs 和 instructions 的工作方式相同。 ## 会话配置 ### 模型设置 -会话配置允许你控制底层实时模型的行为。你可以配置模型名称（例如 `gpt-realtime`）、语音选择（alloy、echo、fable、onyx、nova、shimmer）以及支持的模态（文本和/或音频）。音频格式可分别为输入与输出设置，默认是 PCM16。 +会话配置允许你控制底层实时模型的行为。你可以配置模型名称（例如 `gpt-realtime`）、语音选择（alloy、echo、fable、onyx、nova、shimmer），以及支持的模态（文本和/或音频）。输入和输出的音频格式都可设置，默认是 PCM16。 ### 音频配置 -音频设置控制会话如何处理语音输入与输出。你可以使用如 Whisper 的模型进行输入音频转写、设定语言偏好，并提供转写提示以提升特定领域术语的准确性。轮次检测设置控制智能体何时开始和停止响应，可配置语音活动检测阈值、静音时长，以及在检测到语音前后的填充时间。 +音频设置控制会话如何处理语音输入和输出。你可以使用如 Whisper 的模型进行输入音频转写，设置语言偏好，并提供转写提示词以提升领域词汇的准确性。说话轮次检测设置控制智能体何时开始和停止响应，可配置语音活动检测阈值、静音时长，以及在检测到的语音段前后的填充。 ## 工具与函数 ### 添加工具 -与常规智能体相同，实时智能体支持在对话中执行的 工具调用（function tools）： +与常规智能体一样，实时智能体支持在对话中执行的工具调用（function tools）： ```python from agents import function_tool @@ -90,7 +90,7 @@ agent = RealtimeAgent( ### 创建任务转移 -任务转移允许在专门化智能体之间转移对话。 +任务转移允许在专门化的智能体之间转移对话。 ```python from agents.realtime import realtime_handoff @@ -119,22 +119,22 @@ main_agent = RealtimeAgent( ## 事件处理 -会话会以流的形式发送事件，你可以通过迭代会话对象来监听。事件包括音频输出分片、转写结果、工具执行开始与结束、智能体任务转移，以及错误。需要重点处理的事件包括： +会话会流式传输事件，你可以通过遍历会话对象来监听。事件包括音频输出分片、转写结果、工具执行的开始和结束、智能体任务转移，以及错误。需要处理的关键事件包括： -- **audio**: 智能体响应的原始音频数据 -- **audio_end**: 智能体结束讲话 +- **audio**: 来自智能体响应的原始音频数据 +- **audio_end**: 智能体结束说话 - **audio_interrupted**: 用户打断了智能体 - **tool_start/tool_end**: 工具执行生命周期 - **handoff**: 发生了智能体任务转移 - **error**: 处理过程中发生错误 -完整事件详情请参阅 [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent]。 +完整事件详情参见 [`RealtimeSessionEvent`][agents.realtime.events.RealtimeSessionEvent]。 ## 安全防护措施 -实时智能体仅支持输出安全防护措施。这些防护以防抖方式周期性运行（而非每个词都运行），以避免实时生成期间的性能问题。默认防抖长度为 100 个字符，可进行配置。 +实时智能体仅支持输出安全防护措施。这些防护采用防抖策略并定期运行（不是每个词都运行），以避免实时生成中的性能问题。默认防抖长度为 100 个字符，但可配置。 -安全防护措施可以直接附加到 `RealtimeAgent`，或通过会话的 `run_config` 提供。两处配置的防护会共同生效。 +安全防护措施可以直接附加到 `RealtimeAgent`，也可以通过会话的 `run_config` 提供。两处提供的防护会同时生效。 ```python from agents.guardrail import GuardrailFunctionOutput, OutputGuardrail @@ -152,25 +152,54 @@ agent = RealtimeAgent( ) ``` -当安全防护被触发时，会生成一个 `guardrail_tripped` 事件，并可中断智能体当前的响应。防抖行为有助于在安全与实时性能需求之间取得平衡。与文本智能体不同，实时智能体在防护被触发时**不会**抛出 Exception。 +当安全防护被触发时，会生成一个 `guardrail_tripped` 事件，并可中断智能体当前的响应。防抖行为有助于在安全性与实时性能需求之间取得平衡。与文本智能体不同，实时智能体在触发安全防护措施时**不会**抛出异常。 ## 音频处理 使用 [`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` 事件，以便在用户打断智能体时立刻停止播放并清空任何已排队的音频。 -## 模型直接访问 +## SIP 集成 -你可以访问底层模型，以添加自定义监听器或执行高级操作： +你可以将实时智能体附加到通过 [Realtime Calls API](https://platform.openai.com/docs/guides/realtime-sip) 到达的电话呼入。SDK 提供了 [`OpenAIRealtimeSIPModel`][agents.realtime.openai_realtime.OpenAIRealtimeSIPModel]，在通过 SIP 协商媒体的同时复用相同的智能体流程。 + +要使用它，将该模型实例传给 runner，并在启动会话时提供 SIP 的 `call_id`。呼叫 ID 由指示来电的 webhook 传递。 + +```python +from agents.realtime import RealtimeAgent, RealtimeRunner +from agents.realtime.openai_realtime import OpenAIRealtimeSIPModel + +runner = RealtimeRunner( + starting_agent=agent, + model=OpenAIRealtimeSIPModel(), +) + +async with await runner.run( + model_config={ + "call_id": call_id_from_webhook, + "initial_model_settings": { + "turn_detection": {"type": "semantic_vad", "interrupt_response": True}, + }, + }, +) as session: + async for event in session: + ... +``` + +当呼叫方挂断时，SIP 会话结束，实时连接将自动关闭。完整电话示例参见 [`examples/realtime/twilio_sip`](https://github.com/openai/openai-agents-python/tree/main/examples/realtime/twilio_sip)。 + +## 直接访问模型 + +你可以访问底层模型以添加自定义监听器或执行高级操作： ```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 和不带 UI 的演示。 \ No newline at end of file +有关完整的可运行示例，请查看 [examples/realtime 目录](https://github.com/openai/openai-agents-python/tree/main/examples/realtime)，其中包含带 UI 和不带 UI 组件的演示。 \ No newline at end of file diff --git a/docs/zh/realtime/quickstart.md b/docs/zh/realtime/quickstart.md index d2e0fdca7..9361ef243 100644 --- a/docs/zh/realtime/quickstart.md +++ b/docs/zh/realtime/quickstart.md @@ -2,14 +2,14 @@ search: exclude: true --- -# 快速入门 +# 快速开始 -实时智能体通过 OpenAI 的 Realtime API 实现与你的 AI 智能体进行语音对话。本指南将带你创建第一个实时语音智能体。 +实时智能体允许你使用 OpenAI 的 Realtime API 为你的 AI 智能体启用语音对话。本指南将带你创建你的第一个实时语音智能体。 !!! warning "测试版功能" -Realtime 智能体目前处于测试阶段。随着我们改进实现，可能会有不兼容的变更。 +实时智能体目前为测试版。在我们改进实现的过程中，可能会有不兼容的变更。 -## 先决条件 +## 前提条件 - Python 3.9 或更高版本 - OpenAI API key @@ -17,7 +17,7 @@ Realtime 智能体目前处于测试阶段。随着我们改进实现，可能 ## 安装 -如果尚未安装，请先安装 OpenAI Agents SDK： +如果尚未安装，请安装 OpenAI Agents SDK： ```bash pip install openai-agents @@ -32,7 +32,7 @@ import asyncio from agents.realtime import RealtimeAgent, RealtimeRunner ``` -### 2. 创建实时智能体 +### 2. 创建一个实时智能体 ```python agent = RealtimeAgent( @@ -111,7 +111,7 @@ def _truncate_str(s: str, max_length: int) -> str: ## 完整示例 -下面是一个完整的可运行示例： +下面是一个可运行的完整示例： ```python import asyncio @@ -202,7 +202,7 @@ if __name__ == "__main__": - `output_audio_format`: 输出音频格式 - `input_audio_transcription`: 转写配置 -### 发言轮次检测 +### 轮次检测 - `type`: 检测方法（`server_vad`、`semantic_vad`） - `threshold`: 语音活动阈值（0.0-1.0） @@ -212,20 +212,20 @@ if __name__ == "__main__": ## 后续步骤 - [进一步了解实时智能体](guide.md) -- 查看 [examples/realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) 文件夹中的可运行的 code examples +- 在 [examples/realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime) 文件夹查看可用的示例 - 为你的智能体添加工具 -- 实现智能体之间的任务转移 -- 设置安全防护措施以确保安全 +- 在智能体之间实现任务转移 +- 设置安全防护措施以提升安全性 ## 身份验证 -请确保你的 OpenAI API key 已在环境中设置： +确保在环境中设置了你的 OpenAI API key： ```bash export OPENAI_API_KEY="your-api-key-here" ``` -或在创建会话时直接传入： +或者在创建会话时直接传入： ```python session = await runner.run(model_config={"api_key": "your-api-key"}) diff --git a/docs/zh/release.md b/docs/zh/release.md index 4566a8b68..d588111ef 100644 --- a/docs/zh/release.md +++ b/docs/zh/release.md @@ -2,39 +2,46 @@ search: exclude: true --- -# 发布流程/更新日志 +# 发布流程/变更日志 -本项目采用略经修改的语义化版本控制，形式为 `0.Y.Z`。前导的 `0` 表示该 SDK 仍在快速演进中。各部分递增规则如下： +本项目遵循经过轻微修改的语义化版本规范，采用 `0.Y.Z` 形式。前导的 `0` 表示该 SDK 仍在快速演进中。各部分递增规则如下： -## 次要（`Y`）版本 +## 次版本（`Y`） -对于未标记为 beta 的任何公共接口发生**重大变更**时，我们会提升次要版本 `Y`。例如，从 `0.0.x` 升级到 `0.1.x` 可能包含重大变更。 +对于未标注为 beta 的任何公共接口发生的**破坏性变更**，我们会提升次版本号 `Y`。例如，从 `0.0.x` 到 `0.1.x` 可能包含破坏性变更。 -如果你不希望引入重大变更，我们建议在你的项目中固定到 `0.0.x` 版本。 +如果不希望引入破坏性变更，建议在项目中将版本固定到 `0.0.x`。 -## 修订（`Z`）版本 +## 修订版本（`Z`） 对于非破坏性变更，我们会递增 `Z`： - Bug 修复 - 新功能 -- 对私有接口的更改 +- 私有接口的变更 - 对 beta 功能的更新 -## 重大变更更新日志 +## 破坏性变更日志 + +### 0.5.0 + +该版本未引入任何可见的破坏性变更，但包含新功能以及若干底层的重要更新： + +- 为 `RealtimeRunner` 增加了处理 [SIP 协议连接](https://platform.openai.com/docs/guides/realtime-sip) 的支持 +- 大幅修订了 `Runner#run_sync` 的内部逻辑，以兼容 Python 3.14 ### 0.4.0 -在该版本中，[openai](https://pypi.org/project/openai/) 包的 v1.x 版本不再受支持。请将 openai 升级到 v2.x 并与本 SDK 一起使用。 +在此版本中，不再支持 [openai](https://pypi.org/project/openai/) 包的 v1.x 版本。请与本 SDK 一起使用 openai v2.x。 ### 0.3.0 -在该版本中，Realtime API 的支持迁移到 gpt-realtime 模型及其 API 接口（GA 版本）。 +在此版本中，Realtime API 支持迁移至 gpt-realtime 模型及其 API 接口（GA 版本）。 ### 0.2.0 -在该版本中，原本接受 `Agent` 作为参数的若干位置，现在改为接受 `AgentBase` 作为参数。例如，MCP 服务中的 `list_tools()` 调用。这只是类型方面的更改，你仍将收到 `Agent` 对象。要更新的话，只需将类型中的 `Agent` 替换为 `AgentBase` 来修复类型错误。 +在此版本中，若干原先接收 `Agent` 作为参数的位置，现在改为接收 `AgentBase`。例如，MCP 服务中的 `list_tools()` 调用。这只是类型方面的变更，您仍将收到 `Agent` 对象。要更新，只需将类型错误中的 `Agent` 替换为 `AgentBase` 即可。 ### 0.1.0 -在该版本中，[`MCPServer.list_tools()`][agents.mcp.server.MCPServer] 新增了两个参数：`run_context` 和 `agent`。你需要在任何继承自 `MCPServer` 的类中添加这些参数。 \ No newline at end of file +在此版本中，[`MCPServer.list_tools()`][agents.mcp.server.MCPServer] 新增了两个参数：`run_context` 和 `agent`。您需要在任何继承自 `MCPServer` 的类中加入这些参数。 \ No newline at end of file diff --git a/docs/zh/repl.md b/docs/zh/repl.md index 79d6ed215..0a4d2c15e 100644 --- a/docs/zh/repl.md +++ b/docs/zh/repl.md @@ -2,9 +2,9 @@ search: exclude: true --- -# REPL 实用工具 +# REPL 工具 -The SDK 提供了 `run_demo_loop`，可在终端中直接对智能体行为进行快速、交互式测试。 +SDK 提供了 `run_demo_loop`，可在终端中快速、交互式地测试智能体的行为。 ```python import asyncio @@ -18,6 +18,6 @@ if __name__ == "__main__": asyncio.run(main()) ``` -`run_demo_loop` 在循环中提示用户输入，并在回合之间保留对话历史。默认情况下，它会以生成时的方式对模型输出进行流式传输。运行上面的示例后，run_demo_loop 会启动一个交互式聊天会话。它会持续请求你的输入、在各回合之间记住完整的对话历史（因此你的智能体知道已讨论的内容），并在生成的同时将智能体的响应实时流式传输给你。 +`run_demo_loop` 会在循环中提示输入用户输入，并在多轮对话间保留会话历史。默认情况下，它会以流式传输的方式输出模型生成的内容。运行上面的示例时，run_demo_loop 会启动一个交互式聊天会话。它会持续请求你的输入、在多轮对话间记住整个会话历史（因此你的智能体知道之前讨论了什么），并在生成时自动将智能体的响应实时流式传输给你。 要结束此聊天会话，只需输入 `quit` 或 `exit`（并按下回车），或使用 `Ctrl-D` 键盘快捷键。 \ No newline at end of file diff --git a/docs/zh/results.md b/docs/zh/results.md index 0366637fc..420ca99af 100644 --- a/docs/zh/results.md +++ b/docs/zh/results.md @@ -9,43 +9,43 @@ search: - [`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` 的对象，如果该智能体定义了输出类型。 +- `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]。运行条目会封装由 LLM 生成的原始条目。 +[`new_items`][agents.result.RunResultBase.new_items] 属性包含运行期间生成的新条目。条目是 [`RunItem`][agents.items.RunItem]。RunItem 包装了由 LLM 生成的原始条目。 - [`MessageOutputItem`][agents.items.MessageOutputItem] 表示来自 LLM 的消息。原始条目是生成的消息。 - [`HandoffCallItem`][agents.items.HandoffCallItem] 表示 LLM 调用了任务转移工具。原始条目是来自 LLM 的工具调用条目。 -- [`HandoffOutputItem`][agents.items.HandoffOutputItem] 表示发生了一次任务转移。原始条目是对任务转移工具调用的工具响应。你还可以从条目中访问源/目标智能体。 -- [`ToolCallItem`][agents.items.ToolCallItem] 表示 LLM 调用了一个工具。 -- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem] 表示一个工具被调用。原始条目是工具响应。你也可以从条目中访问工具输出。 -- [`ReasoningItem`][agents.items.ReasoningItem] 表示来自 LLM 的推理条目。原始条目是生成的推理。 +- [`HandoffOutputItem`][agents.items.HandoffOutputItem] 表示发生了任务转移。原始条目是对任务转移工具调用的工具响应。你也可以从该条目访问源/目标智能体。 +- [`ToolCallItem`][agents.items.ToolCallItem] 表示 LLM 调用了某个工具。 +- [`ToolCallOutputItem`][agents.items.ToolCallOutputItem] 表示某个工具被调用。原始条目是工具响应。你也可以从该条目访问工具输出。 +- [`ReasoningItem`][agents.items.ReasoningItem] 表示来自 LLM 的推理条目。原始条目是生成的推理内容。 ## 其他信息 ### 安全防护措施结果 -[`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] 属性包含安全防护措施的结果（如果有）。安全防护措施结果有时包含你希望记录或存储的有用信息，因此我们将其提供给你。 ### 原始响应 @@ -53,4 +53,4 @@ search: ### 原始输入 -[`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/zh/running_agents.md b/docs/zh/running_agents.md index 86bdc1bc6..3aa8a698d 100644 --- a/docs/zh/running_agents.md +++ b/docs/zh/running_agents.md @@ -4,11 +4,11 @@ search: --- # 运行智能体 -你可以通过 [`Runner`][agents.run.Runner] 类来运行智能体。你有 3 个选项： +你可以通过 [`Runner`][agents.run.Runner] 类来运行智能体。你有 3 种方式： 1. [`Runner.run()`][agents.run.Runner.run]：异步运行并返回一个 [`RunResult`][agents.result.RunResult]。 -2. [`Runner.run_sync()`][agents.run.Runner.run_sync]：同步方法，内部调用 `.run()`。 -3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed]：异步运行并返回一个 [`RunResultStreaming`][agents.result.RunResultStreaming]。它以流式方式调用 LLM，并在接收时将事件流式传输给你。 +2. [`Runner.run_sync()`][agents.run.Runner.run_sync]：同步方法，内部实际调用 `.run()`。 +3. [`Runner.run_streamed()`][agents.run.Runner.run_streamed]：异步运行并返回一个 [`RunResultStreaming`][agents.result.RunResultStreaming]。它以流式模式调用 LLM，并在接收事件时将其流式发送给你。 ```python from agents import Agent, Runner @@ -27,51 +27,51 @@ async def main(): ## 智能体循环 -当你在 `Runner` 中使用 run 方法时，你需要传入一个起始智能体和输入。输入可以是字符串（视为用户消息），也可以是输入项列表——这些是 OpenAI Responses API 中的项。 +当你在 `Runner` 中使用 run 方法时，你需要传入一个起始智能体和输入。输入可以是字符串（视为用户消息），也可以是输入项列表，即 OpenAI Responses API 中的条目。 -runner 随后运行一个循环： +Runner 随后会运行一个循环： -1. 我们使用当前输入，为当前智能体调用 LLM。 +1. 我们使用当前输入为当前智能体调用 LLM。 2. LLM 生成输出。 1. 如果 LLM 返回 `final_output`，循环结束并返回结果。 - 2. 如果 LLM 进行任务转移，我们会更新当前智能体和输入，并重新运行循环。 - 3. 如果 LLM 产生工具调用，我们会运行这些工具调用，追加结果，并重新运行循环。 -3. 如果超过传入的 `max_turns`，我们会抛出一个 [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 异常。 + 2. 如果 LLM 进行了任务转移，我们会更新当前智能体和输入，并重新运行循环。 + 3. 如果 LLM 生成了工具调用，我们会执行这些工具调用，追加结果，并重新运行循环。 +3. 如果超过传入的 `max_turns`，我们会抛出 [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded] 异常。 !!! note - 判断 LLM 输出是否为“最终输出”的规则是：它生成了所需类型的文本输出，且不存在工具调用。 + 判断 LLM 输出是否为“最终输出”的规则是：它生成了具有期望类型的文本输出，并且没有工具调用。 ## 流式传输 -流式传输允许你在 LLM 运行时额外接收流事件。流结束后，[`RunResultStreaming`][agents.result.RunResultStreaming] 将包含关于这次运行的完整信息，包括所有新产生的输出。你可以调用 `.stream_events()` 获取流事件。详见[流式传输指南](streaming.md)。 +流式传输允许你在 LLM 运行时额外接收流式事件。流结束后，[`RunResultStreaming`][agents.result.RunResultStreaming] 将包含关于此次运行的完整信息，包括所有新产生的输出。你可以调用 `.stream_events()` 获取流式事件。详情参见[流式传输指南](streaming.md)。 ## 运行配置 -`run_config` 参数可让你为智能体运行配置一些全局设置： +`run_config` 参数允许你为智能体运行配置一些全局设置： -- [`model`][agents.run.RunConfig.model]：允许设置一个全局的 LLM 模型使用，而不受每个 Agent 的 `model` 限制。 -- [`model_provider`][agents.run.RunConfig.model_provider]：用于查找模型名称的模型提供方，默认是 OpenAI。 -- [`model_settings`][agents.run.RunConfig.model_settings]：覆盖智能体特定设置。例如，你可以设置全局的 `temperature` 或 `top_p`。 -- [`input_guardrails`][agents.run.RunConfig.input_guardrails]、[`output_guardrails`][agents.run.RunConfig.output_guardrails]：在所有运行中包含的输入或输出安全防护措施列表。 -- [`handoff_input_filter`][agents.run.RunConfig.handoff_input_filter]：应用于所有任务转移的全局输入过滤器（如果该任务转移尚未定义）。输入过滤器允许你编辑发送给新智能体的输入。详见 [`Handoff.input_filter`][agents.handoffs.Handoff.input_filter] 的文档。 -- [`tracing_disabled`][agents.run.RunConfig.tracing_disabled]：允许你为整个运行禁用[追踪](tracing.md)。 -- [`trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data]：配置追踪中是否包含潜在敏感数据，例如 LLM 和工具调用的输入/输出。 -- [`workflow_name`][agents.run.RunConfig.workflow_name]、[`trace_id`][agents.run.RunConfig.trace_id]、[`group_id`][agents.run.RunConfig.group_id]：为本次运行设置追踪的工作流名称、追踪 ID 和追踪分组 ID。我们建议至少设置 `workflow_name`。分组 ID 是可选字段，用于在多次运行之间关联追踪。 +- [`model`][agents.run.RunConfig.model]：允许设置一个全局 LLM 模型使用，而不受各个 Agent 自身 `model` 的影响。 +- [`model_provider`][agents.run.RunConfig.model_provider]：用于查找模型名称的模型提供方，默认为 OpenAI。 +- [`model_settings`][agents.run.RunConfig.model_settings]：覆盖智能体级别的设置。例如，你可以全局设置 `temperature` 或 `top_p`。 +- [`input_guardrails`][agents.run.RunConfig.input_guardrails], [`output_guardrails`][agents.run.RunConfig.output_guardrails]：在所有运行中包含的输入或输出安全防护措施列表。 +- [`handoff_input_filter`][agents.run.RunConfig.handoff_input_filter]：一个应用于所有任务转移的全局输入过滤器（如果该转移尚未设置）。输入过滤器允许你编辑发送给新智能体的输入。更多详情参见 [`Handoff.input_filter`][agents.handoffs.Handoff.input_filter] 的文档。 +- [`tracing_disabled`][agents.run.RunConfig.tracing_disabled]：允许为整个运行禁用[追踪](tracing.md)。 +- [`trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data]：配置追踪中是否包含潜在敏感数据，例如 LLM 与工具调用的输入/输出。 +- [`workflow_name`][agents.run.RunConfig.workflow_name], [`trace_id`][agents.run.RunConfig.trace_id], [`group_id`][agents.run.RunConfig.group_id]：为此次运行设置追踪的工作流名称、追踪 ID 和追踪分组 ID。我们建议至少设置 `workflow_name`。分组 ID 是可选字段，用于在多次运行间关联追踪。 - [`trace_metadata`][agents.run.RunConfig.trace_metadata]：要包含在所有追踪中的元数据。 -## 会话/聊天线程 +## 对话/聊天线程 -调用任一运行方法可能导致一个或多个智能体运行（因此可能有一次或多次 LLM 调用），但它代表一次聊天会话中的单个逻辑轮次。例如： +调用任一运行方法都可能导致一个或多个智能体运行（因此可能进行一次或多次 LLM 调用），但这表示聊天对话中的单个逻辑轮次。例如： 1. 用户轮次：用户输入文本 -2. Runner 运行：第一个智能体调用 LLM、运行工具、进行一次任务转移到第二个智能体，第二个智能体运行更多工具，然后生成输出。 +2. Runner 运行：第一个智能体调用 LLM、运行工具、执行到第二个智能体的任务转移，第二个智能体再运行更多工具，然后生成输出。 -在智能体运行结束时，你可以选择展示给用户的内容。例如，你可以向用户展示由智能体生成的每个新条目，或仅展示最终输出。无论哪种方式，用户都可能提出后续问题，此时你可以再次调用 run 方法。 +在智能体运行结束时，你可以选择展示给用户的内容。例如，你可以向用户展示智能体生成的每个新条目，也可以只展示最终输出。无论哪种方式，用户可能随后会提出跟进问题，此时你可以再次调用运行方法。 -### 手动会话管理 +### 手动对话管理 -你可以使用 [`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] 方法手动管理会话历史，以获取下一轮的输入： +你可以使用 [`RunResultBase.to_input_list()`][agents.result.RunResultBase.to_input_list] 方法手动管理对话历史，以获取下一轮的输入： ```python async def main(): @@ -91,9 +91,9 @@ async def main(): # California ``` -### 使用 Sessions 的自动会话管理 +### 使用 Sessions 的自动对话管理 -如果需要更简单的方式，你可以使用 [Sessions](sessions/index.md) 自动处理会话历史，而无需手动调用 `.to_input_list()`： +更简单的方式是使用 [Sessions](sessions/index.md) 自动处理对话历史，而无需手动调用 `.to_input_list()`： ```python from agents import Agent, Runner, SQLiteSession @@ -119,21 +119,21 @@ async def main(): Sessions 会自动： -- 在每次运行前获取会话历史 +- 在每次运行前获取对话历史 - 在每次运行后存储新消息 -- 为不同的会话 ID 维护独立的会话 +- 为不同的会话 ID 维护独立的对话 -更多详情见[Sessions 文档](sessions/index.md)。 +更多详情参见 [Sessions 文档](sessions/index.md)。 -### 由服务端管理的会话 +### 服务端管理的对话 -你也可以让 OpenAI 的会话状态功能在服务端管理会话状态，而不是使用 `to_input_list()` 或 `Sessions` 在本地处理。这样可以在无需手动重发所有历史消息的情况下保留会话历史。更多详情见 [OpenAI Conversation state 指南](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses)。 +你也可以让 OpenAI 的会话状态功能在服务端管理对话状态，而不是通过 `to_input_list()` 或 `Sessions` 在本地处理。这样可以在无需手动重发所有历史消息的情况下保留对话历史。更多详情参见 [OpenAI Conversation state 指南](https://platform.openai.com/docs/guides/conversation-state?api-mode=responses)。 -OpenAI 提供两种跨轮次跟踪状态的方法： +OpenAI 提供两种跨轮次跟踪状态的方式： #### 1. 使用 `conversation_id` -你首先使用 OpenAI Conversations API 创建一个会话，然后在后续的每次调用中复用其 ID： +你首先使用 OpenAI Conversations API 创建一个会话，然后在每次后续调用中复用其 ID： ```python from agents import Agent, Runner @@ -165,7 +165,7 @@ async def main(): #### 2. 使用 `previous_response_id` -另一种选择是**响应链（response chaining）**，其中每一轮显式链接到上一轮的响应 ID。 +另一种方式是**响应链式（response chaining）**，每一轮显式链接到上一轮的响应 ID。 ```python from agents import Agent, Runner @@ -188,19 +188,18 @@ async def main(): # California ``` +## 长时运行智能体与人类参与回路 -## 长运行智能体与人类参与 - -你可以使用 Agents SDK 的 [Temporal](https://temporal.io/) 集成来运行持久的、长时间运行的工作流，包括人类参与的任务。观看 Temporal 与 Agents SDK 协同完成长时任务的演示[视频](https://www.youtube.com/watch?v=fFBZqzT4DD8)，并[查看文档](https://github.com/temporalio/sdk-python/tree/main/temporalio/contrib/openai_agents)。 +你可以使用 Agents SDK 与 [Temporal](https://temporal.io/) 的集成来运行持久、长时的工作流，包括人类参与回路任务。查看 Temporal 与 Agents SDK 协作完成长时任务的演示视频：[此视频](https://www.youtube.com/watch?v=fFBZqzT4DD8)，以及[此处的文档](https://github.com/temporalio/sdk-python/tree/main/temporalio/contrib/openai_agents)。 ## 异常 -SDK 在某些情况下会抛出异常。完整列表见 [`agents.exceptions`][]。概览如下： +SDK 在某些情况下会抛出异常。完整列表见 [`agents.exceptions`][]. 概览如下： -- [`AgentsException`][agents.exceptions.AgentsException]：这是 SDK 内抛出的所有异常的基类。它作为通用类型，其他特定异常都从它派生。 -- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded]：当智能体运行超过传递给 `Runner.run`、`Runner.run_sync` 或 `Runner.run_streamed` 的 `max_turns` 限制时抛出该异常。它表示智能体无法在指定的交互轮次内完成任务。 -- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError]：当底层模型（LLM）产生意外或无效输出时发生。包括： - - JSON 结构不合法：当模型为工具调用或其直接输出提供了格式错误的 JSON，特别是在定义了特定 `output_type` 时。 - - 与工具相关的意外失败：当模型未按预期方式使用工具时 -- [`UserError`][agents.exceptions.UserError]：当你（使用该 SDK 编写代码的人）在使用 SDK 时出现错误会抛出此异常。通常由代码实现不正确、配置无效或误用 SDK 的 API 导致。 -- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered]、[`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]：当输入安全防护措施或输出安全防护措施的条件被满足时分别抛出该异常。输入安全防护措施在处理前检查传入消息，而输出安全防护措施在交付前检查智能体的最终响应。 \ No newline at end of file +- [`AgentsException`][agents.exceptions.AgentsException]：SDK 内抛出的所有异常的基类。它作为通用类型，其他具体异常均从其派生。 +- [`MaxTurnsExceeded`][agents.exceptions.MaxTurnsExceeded]：当智能体运行超过传递给 `Runner.run`、`Runner.run_sync` 或 `Runner.run_streamed` 方法的 `max_turns` 限制时抛出。表示智能体未能在指定的交互轮次内完成任务。 +- [`ModelBehaviorError`][agents.exceptions.ModelBehaviorError]：当底层模型（LLM）产生了意外或无效输出时发生。这可能包括： + - JSON 格式错误：当模型为工具调用或其直接输出提供了格式错误的 JSON，尤其是在定义了特定 `output_type` 的情况下。 + - 意外的工具相关失败：当模型未能以预期方式使用工具 +- [`UserError`][agents.exceptions.UserError]：当你（使用 SDK 编写代码的人）在使用 SDK 时出现错误时抛出。通常由错误的代码实现、无效的配置或对 SDK API 的误用导致。 +- [`InputGuardrailTripwireTriggered`][agents.exceptions.InputGuardrailTripwireTriggered], [`OutputGuardrailTripwireTriggered`][agents.exceptions.OutputGuardrailTripwireTriggered]：当满足输入或输出安全防护措施的条件时分别抛出。输入安全防护措施在处理前检查传入消息，而输出安全防护措施在交付前检查智能体的最终响应。 \ No newline at end of file diff --git a/docs/zh/sessions/advanced_sqlite_session.md b/docs/zh/sessions/advanced_sqlite_session.md index be10813e6..05d09a732 100644 --- a/docs/zh/sessions/advanced_sqlite_session.md +++ b/docs/zh/sessions/advanced_sqlite_session.md @@ -4,15 +4,15 @@ search: --- # 高级 SQLite 会话 -`AdvancedSQLiteSession` 是基础 `SQLiteSession` 的增强版本，提供包括会话分支、详细用量分析和结构化会话查询在内的高级对话管理能力。 +`AdvancedSQLiteSession` 是基础 `SQLiteSession` 的增强版本，提供高级对话管理能力，包括对话分支、详细的使用分析和结构化对话查询。 ## 功能 -- **会话分支**: 可从任意用户消息创建替代的对话路径 -- **用量追踪**: 每轮详细的 token 用量分析和完整的 JSON 明细 -- **结构化查询**: 按轮次获取会话、工具使用统计等 +- **对话分支**: 从任意用户消息创建替代对话路径 +- **使用追踪**: 每轮的详细 token 使用分析，并附完整 JSON 明细 +- **结构化查询**: 按轮次获取对话、工具使用统计等 - **分支管理**: 独立的分支切换与管理 -- **消息结构元数据**: 追踪消息类型、工具使用和会话流转 +- **消息结构元数据**: 跟踪消息类型、工具使用与对话流程 ## 快速开始 @@ -84,16 +84,16 @@ session = AdvancedSQLiteSession( ### 参数 -- `session_id` (str): 会话会话的唯一标识符 -- `db_path` (str | Path): SQLite 数据库文件路径。默认使用 `:memory:` 进行内存存储 -- `create_tables` (bool): 是否自动创建高级表。默认为 `False` -- `logger` (logging.Logger | None): 会话的自定义日志记录器。默认使用模块日志记录器 +- `session_id` (str): 对话会话的唯一标识符 +- `db_path` (str | Path): SQLite 数据库文件路径。默认 `:memory:` 使用内存存储 +- `create_tables` (bool): 是否自动创建高级表。默认 `False` +- `logger` (logging.Logger | None): 会话的自定义日志器。默认使用模块日志器 -## 用量追踪 +## 使用追踪 -AdvancedSQLiteSession 通过按对话轮次存储 token 用量数据提供详细的用量分析。**这完全依赖在每次智能体运行后调用 `store_run_usage` 方法。** +AdvancedSQLiteSession 通过按对话轮次存储 token 使用数据，提供详细的使用分析。**这完全依赖在每次智能体运行后调用 `store_run_usage` 方法。** -### 存储用量数据 +### 存储使用数据 ```python # After each agent run, store the usage data @@ -107,7 +107,7 @@ await session.store_run_usage(result) # - Detailed JSON token information (if available) ``` -### 获取用量统计 +### 获取使用统计 ```python # Get session-level usage (all branches) @@ -135,9 +135,9 @@ for turn_data in turn_usage: turn_2_usage = await session.get_turn_usage(user_turn_number=2) ``` -## 会话分支 +## 对话分支 -AdvancedSQLiteSession 的关键特性之一是能够从任意用户消息创建会话分支，使你可以探索替代的对话路径。 +AdvancedSQLiteSession 的关键特性之一是能够从任意用户消息创建对话分支，让你探索替代对话路径。 ### 创建分支 @@ -217,9 +217,9 @@ await session.store_run_usage(result) ## 结构化查询 -AdvancedSQLiteSession 提供多种方法来分析会话结构与内容。 +AdvancedSQLiteSession 提供多种方法用于分析对话结构和内容。 -### 会话分析 +### 对话分析 ```python # Get conversation organized by turns @@ -245,17 +245,17 @@ for turn in matching_turns: ### 消息结构 -会话会自动追踪以下消息结构信息： +会话会自动跟踪消息结构，包括： -- 消息类型（user、assistant、tool_call 等） +- 消息类型（用户 user、助手 assistant、tool_call 等） - 工具调用的工具名称 -- 轮次编号与序列编号 +- 轮次编号与序号 - 分支关联 - 时间戳 ## 数据库模式 -AdvancedSQLiteSession 在基础的 SQLite 模式上扩展了两个附加表： +AdvancedSQLiteSession 在基础 SQLite 模式上扩展了两个附加表： ### message_structure 表 @@ -298,7 +298,7 @@ CREATE TABLE turn_usage ( ## 完整示例 -查看[完整示例](https://github.com/openai/openai-agents-python/tree/main/examples/memory/advanced_sqlite_session_example.py)，了解所有功能的综合演示。 +查看[完整示例](https://github.com/openai/openai-agents-python/tree/main/examples/memory/advanced_sqlite_session_example.py)，以全面演示所有功能。 ## API 参考 diff --git a/docs/zh/sessions/encrypted_session.md b/docs/zh/sessions/encrypted_session.md index 6774aee17..15a56647e 100644 --- a/docs/zh/sessions/encrypted_session.md +++ b/docs/zh/sessions/encrypted_session.md @@ -4,18 +4,18 @@ search: --- # 加密会话 -`EncryptedSession` 为任意会话实现提供透明加密，通过自动过期机制在 TTL 到期时跳过旧的会话项，从而保护会话数据。 +`EncryptedSession` 为任意会话实现提供透明加密，通过自动过期机制保护会话数据并清除旧条目。 ## 功能 -- **透明加密**: 使用 Fernet 加密包装任意会话 -- **每会话密钥**: 使用 HKDF 密钥派生为每个会话生成唯一加密密钥 -- **自动过期**: 当 TTL 到期时，旧项会被静默跳过 -- **可直接替换**: 可与任何现有会话实现一起使用 +- **透明加密**: 使用 Fernet 加密封装任意会话 +- **按会话独立密钥**: 使用 HKDF 密钥派生为每个会话生成唯一密钥 +- **自动过期**: 当 TTL 过期时自动跳过旧条目 +- **可直接替换**: 适配任意现有会话实现 ## 安装 -加密会话需要 `encrypt` 额外依赖： +加密会话需要安装 `encrypt` 可选依赖： ```bash pip install openai-agents[encrypt] @@ -81,7 +81,7 @@ session = EncryptedSession( ### TTL（存活时间） -设置加密项保持有效的时长： +设置加密条目的有效时长： ```python # Items expire after 1 hour @@ -101,9 +101,9 @@ session = EncryptedSession( ) ``` -## 在不同会话类型中的用法 +## 不同会话类型的用法 -### 使用 SQLite 会话 +### 配合 SQLite 会话 ```python from agents import SQLiteSession @@ -119,7 +119,7 @@ session = EncryptedSession( ) ``` -### 使用 SQLAlchemy 会话 +### 配合 SQLAlchemy 会话 ```python from agents.extensions.memory import EncryptedSession, SQLAlchemySession @@ -140,30 +140,30 @@ session = EncryptedSession( !!! warning "高级会话功能" - 当将 `EncryptedSession` 与诸如 `AdvancedSQLiteSession` 等高级会话实现一起使用时，请注意： + 当将 `EncryptedSession` 与诸如 `AdvancedSQLiteSession` 等高级会话实现配合使用时，请注意： - - 由于消息内容被加密，类似 `find_turns_by_content()` 的方法将难以有效工作 - - 基于内容的搜索会在密文上运行，效果受限 + - 由于消息内容被加密，`find_turns_by_content()` 等方法将无法有效工作 + - 基于内容的搜索会作用于加密数据，因此效果受限 ## 密钥派生 -EncryptedSession 使用 HKDF（基于 HMAC 的密钥派生函数）为每个会话派生唯一的加密密钥： +EncryptedSession 使用 HKDF（基于 HMAC 的密钥派生函数）为每个会话派生唯一加密密钥： - **主密钥**: 你提供的加密密钥 - **会话盐值**: 会话 ID -- **信息字符串**: `"agents.session-store.hkdf.v1"` +- **信息字符串**: "agents.session-store.hkdf.v1" - **输出**: 32 字节的 Fernet 密钥 这确保： - 每个会话都有唯一的加密密钥 -- 没有主密钥无法推导出各会话密钥 -- 不同会话之间的会话数据无法相互解密 +- 没有主密钥无法派生出密钥 +- 不同会话之间无法互相解密会话数据 ## 自动过期 -当项超过 TTL 时，在检索时会被自动跳过： +当条目超过 TTL 时，在检索时会被自动跳过： ```python # Items older than TTL are silently ignored diff --git a/docs/zh/sessions/index.md b/docs/zh/sessions/index.md index 85fb5879b..e5ffc7e1d 100644 --- a/docs/zh/sessions/index.md +++ b/docs/zh/sessions/index.md @@ -4,11 +4,11 @@ search: --- # 会话 -Agents SDK 提供内置会话记忆，用于在多个智能体运行之间自动维护对话历史，无需在轮次之间手动处理 `.to_input_list()`。 +Agents SDK 提供内置的会话记忆，可在多次智能体运行间自动维护对话历史，无需在轮次之间手动处理 `.to_input_list()`。 -会话为特定会话存储对话历史，使智能体无需显式的手动内存管理即可保持上下文。这对构建聊天应用或多轮对话尤为有用，能让智能体记住之前的交互。 +会话为特定会话存储对话历史，使智能体无需显式的手动内存管理即可保持上下文。这对构建聊天应用或多轮对话（需要智能体记住先前交互）尤为有用。 -## 快速开始 +## 快速上手 ```python from agents import Agent, Runner, SQLiteSession @@ -51,13 +51,13 @@ print(result.final_output) # "Approximately 39 million" 当启用会话记忆时： -1. **每次运行之前**：运行器会自动检索该会话的对话历史，并将其预置到输入项前。 -2. **每次运行之后**：在运行期间生成的所有新项（用户输入、助手回复、工具调用等）会自动存储到会话中。 -3. **上下文保留**：使用同一会话的每次后续运行都会包含完整的对话历史，使智能体能够保持上下文。 +1. **每次运行前**: 运行器会自动检索该会话的对话历史，并将其添加到输入项之前。 +2. **每次运行后**: 运行期间生成的所有新项目（用户输入、助手回复、工具调用等）都会自动存储到会话中。 +3. **上下文保留**: 使用相同会话的后续运行都会包含完整的对话历史，从而使智能体能够保持上下文。 -这免除了在轮次之间手动调用 `.to_input_list()` 并管理对话状态的需求。 +这消除了手动调用 `.to_input_list()` 并在运行之间管理对话状态的需要。 -## 内存操作 +## 记忆操作 ### 基本操作 @@ -86,9 +86,9 @@ print(last_item) # {"role": "assistant", "content": "Hi there!"} await session.clear_session() ``` -### 使用 pop_item 进行纠正 +### 使用 pop_item 进行更正 -当你希望撤销或修改对话中的最后一项时，`pop_item` 方法尤其有用： +当你想撤销或修改对话中的最后一项时，`pop_item` 方法特别有用： ```python from agents import Agent, Runner, SQLiteSession @@ -119,11 +119,11 @@ print(f"Agent: {result.final_output}") ## 会话类型 -SDK 提供多种会话实现以适应不同用例： +SDK 为不同用例提供了多种会话实现： ### OpenAI Conversations API 会话 -通过 `OpenAIConversationsSession` 使用 [OpenAI 的 Conversations API](https://platform.openai.com/docs/api-reference/conversations)。 +通过 `OpenAIConversationsSession` 使用 [OpenAI's Conversations API](https://platform.openai.com/docs/api-reference/conversations)。 ```python from agents import Agent, Runner, OpenAIConversationsSession @@ -180,7 +180,7 @@ result = await Runner.run( ### SQLAlchemy 会话 -使用任意 SQLAlchemy 支持的数据库的生产级会话： +面向生产的会话，可使用任何 SQLAlchemy 支持的数据库： ```python from agents.extensions.memory import SQLAlchemySession @@ -198,11 +198,13 @@ engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/db") session = SQLAlchemySession("user_123", engine=engine, create_tables=True) ``` -参见 [SQLAlchemy 会话](sqlalchemy_session.md) 获取详细文档。 +详见 [SQLAlchemy Sessions](sqlalchemy_session.md) 的详细文档。 + + ### 高级 SQLite 会话 -增强的 SQLite 会话，支持会话分支、使用分析和结构化查询： +增强版 SQLite 会话，支持对话分支、使用分析和结构化查询： ```python from agents.extensions.memory import AdvancedSQLiteSession @@ -222,11 +224,11 @@ await session.store_run_usage(result) # Track token usage await session.create_branch_from_turn(2) # Branch from turn 2 ``` -参见 [高级 SQLite 会话](advanced_sqlite_session.md) 获取详细文档。 +详见 [Advanced SQLite Sessions](advanced_sqlite_session.md) 的详细文档。 ### 加密会话 -针对任意会话实现的透明加密包装器： +对任意会话实现进行透明加密的封装： ```python from agents.extensions.memory import EncryptedSession, SQLAlchemySession @@ -249,26 +251,31 @@ session = EncryptedSession( result = await Runner.run(agent, "Hello", session=session) ``` -参见 [加密会话](encrypted_session.md) 获取详细文档。 +详见 [Encrypted Sessions](encrypted_session.md) 的详细文档。 + +### 其他会话类型 + +还有更多内置选项。请参阅 `examples/memory/` 和 `extensions/memory/` 下的源代码。 ## 会话管理 ### 会话 ID 命名 -使用有意义的会话 ID 来帮助组织对话： +使用有意义的会话 ID 来帮助你组织对话： -- 用户维度：`"user_12345"` -- 线程维度：`"thread_abc123"` -- 场景维度：`"support_ticket_456"` +- 用户维度: `"user_12345"` +- 线程维度: `"thread_abc123"` +- 场景维度: `"support_ticket_456"` -### 内存持久化 +### 记忆持久化 -- 使用内存型 SQLite（`SQLiteSession("session_id")`）进行临时对话 -- 使用文件型 SQLite（`SQLiteSession("session_id", "path/to/db.sqlite")`）进行持久化对话 -- 使用由 SQLAlchemy 驱动的会话（`SQLAlchemySession("session_id", engine=engine, create_tables=True)`）以在 SQLAlchemy 支持的现有数据库之上构建生产系统 -- 当你希望将历史存储在 OpenAI Conversations API 中时，使用 OpenAI 托管的存储（`OpenAIConversationsSession()`） -- 使用加密会话（`EncryptedSession(session_id, underlying_session, encryption_key)`）为任意会话提供透明加密与基于 TTL 的过期 -- 针对更高级的用例，考虑为其他生产系统（Redis、Django 等）实现自定义会话后端 +- 使用内存型 SQLite（`SQLiteSession("session_id")`）用于临时对话 +- 使用文件型 SQLite（`SQLiteSession("session_id", "path/to/db.sqlite")`）用于持久化对话 +- 使用 SQLAlchemy 驱动的会话（`SQLAlchemySession("session_id", engine=engine, create_tables=True)`）用于已有数据库的生产系统（SQLAlchemy 支持） +- 使用 Dapr 状态存储会话（`DaprSession.from_address("session_id", state_store_name="statestore", dapr_address="localhost:50001")`）用于生产级云原生部署，支持 30+ 数据库后端，并内置遥测、追踪和数据隔离 +- 当你希望将历史存储在 OpenAI Conversations API 中时，使用由 OpenAI 托管的存储（`OpenAIConversationsSession()`） +- 使用加密会话（`EncryptedSession(session_id, underlying_session, encryption_key)`）为任意会话添加透明加密和基于 TTL 的过期 +- 考虑为其他生产系统（Redis、Django 等）实现自定义会话后端，以满足更高级的用例 ### 多个会话 @@ -316,7 +323,7 @@ result2 = await Runner.run( ## 完整示例 -下面是一个展示会话记忆效果的完整示例： +以下是展示会话记忆实际效果的完整示例： ```python import asyncio @@ -380,7 +387,7 @@ if __name__ == "__main__": ## 自定义会话实现 -你可以通过创建一个遵循 [`Session`][agents.memory.session.Session] 协议的类来实现自定义会话记忆： +你可以通过创建一个遵循 [`Session`][agents.memory.session.Session] 协议的类来实现你自己的会话记忆： ```python from agents.memory.session import SessionABC @@ -425,11 +432,12 @@ result = await Runner.run( ## API 参考 -详细 API 文档请参见： +详细 API 文档参见： - [`Session`][agents.memory.session.Session] - 协议接口 - [`OpenAIConversationsSession`][agents.memory.OpenAIConversationsSession] - OpenAI Conversations API 实现 -- [`SQLiteSession`][agents.memory.sqlite_session.SQLiteSession] - 基本 SQLite 实现 -- [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - 由 SQLAlchemy 驱动的实现 -- [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 具备分支与分析的增强型 SQLite -- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - 适用于任意会话的加密包装器 \ No newline at end of file +- [`SQLiteSession`][agents.memory.sqlite_session.SQLiteSession] - 基础 SQLite 实现 +- [`SQLAlchemySession`][agents.extensions.memory.sqlalchemy_session.SQLAlchemySession] - SQLAlchemy 驱动的实现 +- [`DaprSession`][agents.extensions.memory.dapr_session.DaprSession] - Dapr 状态存储实现 +- [`AdvancedSQLiteSession`][agents.extensions.memory.advanced_sqlite_session.AdvancedSQLiteSession] - 具有分支与分析的增强版 SQLite +- [`EncryptedSession`][agents.extensions.memory.encrypt_session.EncryptedSession] - 任意会话的加密封装 \ No newline at end of file diff --git a/docs/zh/sessions/sqlalchemy_session.md b/docs/zh/sessions/sqlalchemy_session.md index bf070985c..c82d21143 100644 --- a/docs/zh/sessions/sqlalchemy_session.md +++ b/docs/zh/sessions/sqlalchemy_session.md @@ -4,21 +4,21 @@ search: --- # SQLAlchemy 会话 -`SQLAlchemySession` 使用 SQLAlchemy 提供可用于生产的会话实现，允许你将 SQLAlchemy 支持的任何数据库（PostgreSQL、MySQL、SQLite 等）用于会话存储。 +`SQLAlchemySession` 使用 SQLAlchemy 提供可用于生产环境的会话实现，允许你将 SQLAlchemy 支持的任意数据库（PostgreSQL、MySQL、SQLite 等）用于会话存储。 ## 安装 -SQLAlchemy 会话需要安装 `sqlalchemy` 扩展： +SQLAlchemy 会话需要 `sqlalchemy` 扩展： ```bash pip install openai-agents[sqlalchemy] ``` -## 快速入门 +## 快速开始 ### 使用数据库 URL -最简单的用法： +最简单的入门方式： ```python import asyncio diff --git a/docs/zh/streaming.md b/docs/zh/streaming.md index 95526de31..cffbb0719 100644 --- a/docs/zh/streaming.md +++ b/docs/zh/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] 组成的异步流，详见下文。 ## 原始响应事件 -[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent] 是直接从 LLM 传递的原始事件。它们采用 OpenAI Responses API 格式，这意味着每个事件都有一个类型（如 `response.created`、`response.output_text.delta` 等）和数据。如果你希望在消息生成时立刻将响应流式传递给用户，这些事件很有用。 +[`RawResponsesStreamEvent`][agents.stream_events.RawResponsesStreamEvent] 是直接从 LLM 传递过来的原始事件。它们采用 OpenAI Responses API 格式，这意味着每个事件都有一个类型（如 `response.created`、`response.output_text.delta` 等）以及对应的数据。如果你希望在生成过程中立即将响应消息流式传输给用户，这些事件非常有用。 -例如，下面的内容会逐 token 输出由 LLM 生成的文本。 +例如，下面的代码会逐 token 输出 LLM 生成的文本。 ```python import asyncio @@ -37,9 +37,9 @@ if __name__ == "__main__": ## 运行项事件与智能体事件 -[`RunItemStreamEvent`][agents.stream_events.RunItemStreamEvent] 属于更高层级的事件。它们会在某个项完全生成时通知你。这样你就可以在“消息已生成”“工具已运行”等层级推送进度更新，而不是在每个 token 层级。类似地，[`AgentUpdatedStreamEvent`][agents.stream_events.AgentUpdatedStreamEvent] 会在当前智能体发生变化时（例如由于一次 任务转移）为你提供更新。 +[`RunItemStreamEvent`][agents.stream_events.RunItemStreamEvent] 是更高层次的事件。它们会在某个条目完全生成时通知你。这样你可以在“消息已生成”“工具已运行”等层面推送进度更新，而不是在每个 token 层面。类似地，[`AgentUpdatedStreamEvent`][agents.stream_events.AgentUpdatedStreamEvent] 会在当前智能体发生变化时（例如由于任务转移）向你发送更新。 -例如，下面的内容会忽略原始事件，并向用户流式传输更新。 +例如，下面的代码会忽略原始事件，只向用户流式传输更新。 ```python import asyncio diff --git a/docs/zh/tools.md b/docs/zh/tools.md index f25c2dce2..2dad098e8 100644 --- a/docs/zh/tools.md +++ b/docs/zh/tools.md @@ -4,22 +4,22 @@ search: --- # 工具 -工具让智能体能够采取行动：如获取数据、运行代码、调用外部 API，甚至进行计算机操作。在 Agents SDK 中有三类工具： +工具让智能体能够执行操作：例如获取数据、运行代码、调用外部 API，甚至进行计算机操作。在 Agents SDK 中有三类工具： -- 托管工具：这些工具与 AI 模型一同运行在 LLM 服务上。OpenAI 提供检索、网络检索和计算机操作等托管工具。 -- Function Calling：它允许你将任意 Python 函数用作工具。 -- 智能体即工具：允许你将一个智能体作为工具使用，使智能体在不进行任务转移的情况下调用其他智能体。 +- 托管工具：这些工具在 LLM 服务与 AI 模型并行运行。OpenAI 提供检索、网络检索和计算机操作等托管工具。 +- Function calling：它允许你将任意 Python 函数用作工具。 +- 智能体作为工具：它允许你将一个智能体用作工具，使智能体在不进行任务转移的情况下调用其他智能体。 ## 托管工具 -在使用 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] 时，OpenAI 提供了一些内置工具： +使用 [`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] 时，OpenAI 提供一些内置工具： -- [`WebSearchTool`][agents.tool.WebSearchTool] 让智能体进行网络检索。 -- [`FileSearchTool`][agents.tool.FileSearchTool] 允许从你的 OpenAI 向量存储中检索信息。 +- [`WebSearchTool`][agents.tool.WebSearchTool] 允许智能体进行网络检索。 +- [`FileSearchTool`][agents.tool.FileSearchTool] 允许从你的 OpenAI 向量存储 中检索信息。 - [`ComputerTool`][agents.tool.ComputerTool] 允许自动化计算机操作任务。 -- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] 让 LLM 在沙箱环境中执行代码。 -- [`HostedMCPTool`][agents.tool.HostedMCPTool] 将远程 MCP 服务的工具暴露给模型。 -- [`ImageGenerationTool`][agents.tool.ImageGenerationTool] 根据提示生成图像。 +- [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] 允许 LLM 在沙箱环境中执行代码。 +- [`HostedMCPTool`][agents.tool.HostedMCPTool] 将远程 MCP 服务 的工具暴露给模型。 +- [`ImageGenerationTool`][agents.tool.ImageGenerationTool] 根据提示词生成图像。 - [`LocalShellTool`][agents.tool.LocalShellTool] 在你的机器上运行 shell 命令。 ```python @@ -41,16 +41,16 @@ async def main(): print(result.final_output) ``` -## 工具调用 +## 函数工具 -你可以将任意 Python 函数作为工具使用。Agents SDK 会自动完成工具的设置： +你可以将任意 Python 函数用作工具。Agents SDK 会自动完成工具设置： -- 工具名称将是该 Python 函数的名称（也可自定义名称） -- 工具描述将取自函数的 docstring（也可自定义描述） -- 函数输入的 schema 会根据函数参数自动创建 -- 各输入项的描述默认取自函数的 docstring（可禁用） +- 工具名将是该 Python 函数的名称（或你可以自定义名称） +- 工具描述将取自函数的 docstring（或你可以自定义描述） +- 函数输入的模式会根据函数的参数自动创建 +- 每个输入的描述会取自函数的 docstring，除非被禁用 -我们使用 Python 的 `inspect` 模块提取函数签名，配合 [`griffe`](https://mkdocstrings.github.io/griffe/) 解析 docstring，并使用 `pydantic` 创建 schema。 +我们使用 Python 的 `inspect` 模块提取函数签名，使用 [`griffe`](https://mkdocstrings.github.io/griffe/) 解析 docstring，并使用 `pydantic` 创建模式。 ```python import json @@ -102,10 +102,10 @@ for tool in agent.tools: ``` -1. 你可以使用任意 Python 类型作为函数的参数，函数可以是同步或异步。 -2. 如果存在 docstring，会用于捕获描述和参数说明。 -3. 函数可以选择性地接收 `context`（必须是第一个参数）。你也可以设置覆盖项，例如工具名称、描述、docstring 风格等。 -4. 你可以将装饰后的函数传递给工具列表。 +1. 你可以为函数参数使用任意 Python 类型，函数可以是同步或异步的。 +2. 如果存在 docstring，将用于提取工具和参数的描述。 +3. 函数可以选择性地接收 `context`（必须是第一个参数）。你还可以设置覆盖项，如工具名称、描述、docstring 风格等。 +4. 你可以将装饰后的函数传入工具列表。 ??? note "展开以查看输出" @@ -177,22 +177,22 @@ for tool in agent.tools: } ``` -### 从工具调用返回图像或文件 +### 从函数工具返回图像或文件 -除了返回文本输出，你还可以将一张或多张图像或文件作为工具调用的输出。为此，你可以返回以下任意类型： +除了返回文本输出，你还可以从函数工具返回一个或多个图像或文件。为此，你可以返回以下任意类型： -- 图像：[`ToolOutputImage`][agents.tool.ToolOutputImage]（或 TypedDict 版本，[`ToolOutputImageDict`][agents.tool.ToolOutputImageDict]） -- 文件：[`ToolOutputFileContent`][agents.tool.ToolOutputFileContent]（或 TypedDict 版本，[`ToolOutputFileContentDict`][agents.tool.ToolOutputFileContentDict]） -- 文本：字符串或可转为字符串的对象，或 [`ToolOutputText`][agents.tool.ToolOutputText]（或 TypedDict 版本，[`ToolOutputTextDict`][agents.tool.ToolOutputTextDict]） +- 图像：[`ToolOutputImage`][agents.tool.ToolOutputImage]（或其 TypedDict 版本 [`ToolOutputImageDict`][agents.tool.ToolOutputImageDict]） +- 文件：[`ToolOutputFileContent`][agents.tool.ToolOutputFileContent]（或其 TypedDict 版本 [`ToolOutputFileContentDict`][agents.tool.ToolOutputFileContentDict]） +- 文本：字符串或可转为字符串的对象，或 [`ToolOutputText`][agents.tool.ToolOutputText]（或其 TypedDict 版本 [`ToolOutputTextDict`][agents.tool.ToolOutputTextDict]） ### 自定义函数工具 -有时，你可能不想使用 Python 函数作为工具。如果需要，你可以直接创建一个 [`FunctionTool`][agents.tool.FunctionTool]。你需要提供： +有时你并不想用 Python 函数作为工具。如果你愿意，可以直接创建一个 [`FunctionTool`][agents.tool.FunctionTool]。你需要提供： - `name` - `description` - `params_json_schema`，即参数的 JSON schema -- `on_invoke_tool`，这是一个异步函数，接收 [`ToolContext`][agents.tool_context.ToolContext] 和作为 JSON 字符串的参数，并且必须返回字符串形式的工具输出。 +- `on_invoke_tool`，这是一个异步函数，接收 [`ToolContext`][agents.tool_context.ToolContext] 和作为 JSON 字符串的参数，并且必须以字符串形式返回工具输出。 ```python from typing import Any @@ -227,16 +227,16 @@ tool = FunctionTool( ### 自动参数与 docstring 解析 -如前所述，我们会自动解析函数签名以提取工具的 schema，并解析 docstring 以提取工具及各参数的描述。注意事项： +如前所述，我们会自动解析函数签名以提取工具的模式，并解析 docstring 以提取工具和各参数的描述。注意事项： -1. 使用 `inspect` 模块进行签名解析。我们使用类型注解理解参数类型，并动态构建一个 Pydantic 模型来表示整体 schema。它支持大多数类型，包括 Python 基础类型、Pydantic 模型、TypedDict 等。 -2. 我们使用 `griffe` 解析 docstring。支持的 docstring 格式有 `google`、`sphinx` 和 `numpy`。我们会尝试自动检测 docstring 格式，但这只是尽力而为，你也可以在调用 `function_tool` 时显式设置。还可以通过将 `use_docstring_info` 设为 `False` 来禁用 docstring 解析。 +1. 使用 `inspect` 模块解析签名。我们使用类型注解理解参数类型，并动态构建一个 Pydantic 模型来表示整体模式。它支持大多数类型，包括 Python 基本组件、Pydantic 模型、TypedDict 等。 +2. 我们使用 `griffe` 解析 docstring。支持的 docstring 格式包括 `google`、`sphinx` 和 `numpy`。我们会尝试自动检测 docstring 格式，但这仅是尽力而为；你可以在调用 `function_tool` 时显式设置。你也可以通过将 `use_docstring_info` 设为 `False` 来禁用 docstring 解析。 -用于 schema 提取的代码位于 [`agents.function_schema`][]。 +用于模式提取的代码位于 [`agents.function_schema`][]。 -## 智能体即工具 +## 智能体作为工具 -在某些工作流中，你可能希望由一个中心智能体编排一组专业化智能体，而不是移交控制。你可以通过将智能体建模为工具来实现这一点。 +在某些工作流中，你可能希望由一个中央智能体编排一组专业化智能体，而不是进行任务转移。你可以通过将智能体建模为工具来实现。 ```python from agents import Agent, Runner @@ -277,7 +277,7 @@ async def main(): ### 自定义工具化智能体 -`agent.as_tool` 函数是一个便捷方法，可将智能体轻松转换为工具。但它并不支持所有配置；例如，你无法设置 `max_turns`。对于高级用例，请在你的工具实现中直接使用 `Runner.run`： +`agent.as_tool` 函数是一个便捷方法，可轻松将智能体转换为工具。但它并不支持所有配置；例如，你无法设置 `max_turns`。对于高级用例，请在你的工具实现中直接使用 `Runner.run`： ```python @function_tool @@ -298,11 +298,11 @@ async def run_my_agent() -> str: ### 自定义输出提取 -在某些情况下，你可能希望在将工具化智能体的输出返回给中心智能体之前对其进行修改。如果你希望： +在某些情况下，你可能希望在将工具化智能体的输出返回给中央智能体之前对其进行修改。如果你希望： -- 从子智能体的对话历史中提取某段特定信息（例如一个 JSON 负载）。 +- 从子智能体的对话历史中提取某个特定信息（例如 JSON 负载）。 - 转换或重新格式化智能体的最终答案（例如将 Markdown 转为纯文本或 CSV）。 -- 验证输出，或在智能体响应缺失或格式不正确时提供回退值。 +- 验证输出，或在智能体响应缺失或格式错误时提供回退值。 你可以通过向 `as_tool` 方法提供 `custom_output_extractor` 参数来实现： @@ -323,7 +323,7 @@ json_tool = data_agent.as_tool( ) ``` -### 条件启用工具 +### 条件式启用工具 你可以在运行时使用 `is_enabled` 参数有条件地启用或禁用智能体工具。这允许你根据上下文、用户偏好或运行时条件动态筛选 LLM 可用的工具。 @@ -384,22 +384,22 @@ asyncio.run(main()) - **布尔值**：`True`（始终启用）或 `False`（始终禁用） - **可调用函数**：接收 `(context, agent)` 并返回布尔值的函数 -- **异步函数**：用于复杂条件逻辑的异步函数 +- **异步函数**：用于更复杂的条件逻辑 -被禁用的工具在运行时会对 LLM 完全隐藏，适用于： +被禁用的工具在运行时对 LLM 完全不可见，这在以下场景很有用： - 基于用户权限的功能门控 -- 环境特定的工具可用性（开发 vs 生产） -- 不同工具配置的 A/B 测试 +- 特定环境的工具可用性（开发环境 vs 生产环境） +- 对不同工具配置进行 A/B 测试 - 基于运行时状态的动态工具筛选 -## 在工具调用中处理错误 +## 在函数工具中处理错误 -当你通过 `@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`，等等。 ```python from agents import function_tool, RunContextWrapper @@ -422,4 +422,4 @@ def get_user_profile(user_id: str) -> str: ``` -如果你手动创建一个 `FunctionTool` 对象，那么你必须在 `on_invoke_tool` 函数内部处理错误。 \ No newline at end of file +如果你手动创建 `FunctionTool` 对象，那么必须在 `on_invoke_tool` 函数内部处理错误。 \ No newline at end of file diff --git a/docs/zh/tracing.md b/docs/zh/tracing.md index b88666ee3..24a477ec9 100644 --- a/docs/zh/tracing.md +++ b/docs/zh/tracing.md @@ -4,52 +4,52 @@ search: --- # 追踪 -Agents SDK 内置了追踪功能，会在一次智能体运行期间收集完整的事件记录：LLM 生成、工具调用、任务转移、安全防护措施，甚至自定义事件。借助 [Traces 仪表板](https://platform.openai.com/traces)，你可以在开发和生产环境中调试、可视化并监控工作流。 +Agents SDK 内置了追踪功能，可在一次智能体运行期间收集全面的事件记录：LLM 生成、工具调用、任务转移、安全防护措施，甚至自定义事件。使用 [Traces 仪表板](https://platform.openai.com/traces)，你可以在开发和生产中调试、可视化并监控工作流。 !!!note - 追踪默认启用。可以通过两种方式禁用追踪： + 追踪默认启用。有两种方式可以禁用追踪： - 1. 通过设置环境变量 `OPENAI_AGENTS_DISABLE_TRACING=1` 全局禁用追踪 - 2. 通过将 [`agents.run.RunConfig.tracing_disabled`][] 设为 `True`，仅对单次运行禁用追踪 + 1. 你可以通过设置环境变量 `OPENAI_AGENTS_DISABLE_TRACING=1` 全局禁用追踪 + 2. 你可以通过将 [`agents.run.RunConfig.tracing_disabled`][] 设为 `True`，对单次运行禁用追踪 -***对于使用 OpenAI API 并遵循 Zero Data Retention (ZDR) 策略的组织，追踪不可用。*** +***对于按照 Zero Data Retention (ZDR) 策略使用 OpenAI API 的组织，追踪不可用。*** ## 追踪与 Span -- **追踪（Traces）** 表示一次“工作流”的端到端操作。Trace 由多个 Span 组成。Trace 具有以下属性： - - `workflow_name`：逻辑上的工作流或应用。例如 “Code generation” 或 “Customer service”。 - - `trace_id`：该追踪的唯一 ID。如果未传入将自动生成。格式必须为 `trace_<32_alphanumeric>`。 - - `group_id`：可选的分组 ID，用于将同一次对话中的多个追踪关联起来。例如你可以使用聊天线程 ID。 - - `disabled`：若为 True，则不会记录该追踪。 - - `metadata`：该追踪的可选元数据。 -- **Span** 表示具有开始和结束时间的操作。Span 包含： +- **Traces（追踪）** 表示一次“工作流”的端到端操作。它由多个 Span 组成。Trace 具有以下属性： + - `workflow_name`：逻辑上的工作流或应用名称。例如 “Code generation” 或 “Customer service”。 + - `trace_id`：Trace 的唯一 ID。如果未传入，会自动生成。必须符合 `trace_<32_alphanumeric>` 格式。 + - `group_id`：可选的分组 ID，用于关联同一会话中的多个 Trace。例如，你可以使用聊天线程 ID。 + - `disabled`：若为 True，则不会记录该 Trace。 + - `metadata`：Trace 的可选元数据。 +- **Spans（Span）** 表示具有开始与结束时间的操作。Span 具有： - `started_at` 和 `ended_at` 时间戳。 - - `trace_id`，指示其所属的追踪 - - `parent_id`，指向该 Span 的父级 Span（如有） - - `span_data`，关于该 Span 的信息。例如，`AgentSpanData` 包含关于智能体的信息，`GenerationSpanData` 包含关于 LLM 生成的信息，等等。 + - `trace_id`，用于表示其所属的 Trace + - `parent_id`，指向该 Span 的父 Span（如果有） + - `span_data`，即关于该 Span 的信息。例如，`AgentSpanData` 包含关于智能体的信息，`GenerationSpanData` 包含关于 LLM 生成的信息，等等。 ## 默认追踪 默认情况下，SDK 会追踪以下内容： -- 整个 `Runner.{run, run_sync, run_streamed}()` 都包裹在 `trace()` 中。 +- 整个 `Runner.{run, run_sync, run_streamed}()` 被包裹在 `trace()` 中。 - 每次智能体运行，都会包裹在 `agent_span()` 中 -- LLM 生成会包裹在 `generation_span()` 中 -- 工具调用会分别包裹在 `function_span()` 中 -- 安全防护措施会包裹在 `guardrail_span()` 中 -- 任务转移会包裹在 `handoff_span()` 中 -- 音频输入（语音转文本）会包裹在 `transcription_span()` 中 -- 音频输出（文本转语音）会包裹在 `speech_span()` 中 -- 相关音频 span 可能会作为子级归于 `speech_group_span()` 下 +- LLM 生成被包裹在 `generation_span()` 中 +- 工具调用被分别包裹在 `function_span()` 中 +- 安全防护措施被包裹在 `guardrail_span()` 中 +- 任务转移被包裹在 `handoff_span()` 中 +- 音频输入（语音转文本）被包裹在 `transcription_span()` 中 +- 音频输出（文本转语音）被包裹在 `speech_span()` 中 +- 相关的音频 Span 可能会被作为子级挂载到 `speech_group_span()` 下 -默认情况下，追踪名称为 “Agent workflow”。如果你使用 `trace`，可以设置该名称；也可以通过 [`RunConfig`][agents.run.RunConfig] 配置名称和其他属性。 +默认情况下，Trace 名为 "Agent workflow"。如果使用 `trace`，你可以设置此名称；或者你也可以通过 [`RunConfig`][agents.run.RunConfig] 配置名称及其他属性。 -此外，你可以设置[自定义追踪进程](#custom-tracing-processors)，将追踪推送到其它目的地（作为替代或附加目的地）。 +此外，你可以设置[自定义追踪处理器](#custom-tracing-processors)，将追踪推送到其他目的地（作为替代或附加目的地）。 ## 更高层级的追踪 -有时，你可能希望多次调用 `run()` 都属于同一个追踪。你可以通过将整个代码包裹在 `trace()` 中来实现。 +有时你可能希望多次调用 `run()` 都属于同一个 Trace。可以通过把整个代码包裹在 `trace()` 中来实现。 ```python from agents import Agent, Runner, trace @@ -64,46 +64,46 @@ async def main(): print(f"Rating: {second_result.final_output}") ``` -1. 因为两次对 `Runner.run` 的调用都包裹在 `with trace()` 中，单次运行会成为整体追踪的一部分，而不是创建两个追踪。 +1. 因为两次对 `Runner.run` 的调用都包裹在 `with trace()` 中，单次运行将会成为整体 Trace 的一部分，而不是创建两个 Trace。 ## 创建追踪 -你可以使用 [`trace()`][agents.tracing.trace] 函数创建追踪。追踪需要显式开始和结束。你有两种方式： +你可以使用 [`trace()`][agents.tracing.trace] 函数创建一个 Trace。Trace 需要被启动和结束。你有两种方式： -1. 推荐：将 trace 作为上下文管理器使用，即 `with trace(...) as my_trace`。这会在合适的时机自动开始与结束追踪。 -2. 也可以手动调用 [`trace.start()`][agents.tracing.Trace.start] 和 [`trace.finish()`][agents.tracing.Trace.finish]。 +1. 推荐：将 Trace 作为上下文管理器使用，即 `with trace(...) as my_trace`。这会在合适的时机自动启动并结束 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` 来更新当前追踪。 +当前 Trace 通过 Python 的 [`contextvar`](https://docs.python.org/3/library/contextvars.html) 进行追踪。这意味着它可自动与并发配合。如果你手动启动/结束一个 Trace，需要在 `start()`/`finish()` 里传入 `mark_as_current` 和 `reset_current` 来更新当前 Trace。 -## 创建 spans +## 创建 Span -你可以使用各种 [`*_span()`][agents.tracing.create] 方法创建 span。通常无需手动创建 span。可使用 [`custom_span()`][agents.tracing.custom_span] 来追踪自定义 span 信息。 +你可以使用各类 [`*_span()`][agents.tracing.create] 方法创建 Span。通常你不需要手动创建 Span。提供了一个 [`custom_span()`][agents.tracing.custom_span] 函数用于追踪自定义 Span 信息。 -Span 会自动隶属于当前追踪，并嵌套在最近的当前 span 下，其跟踪同样通过 Python 的 [`contextvar`](https://docs.python.org/3/library/contextvars.html) 实现。 +Span 会自动成为当前 Trace 的一部分，并嵌套在最近的当前 Span 之下，该状态通过 Python 的 [`contextvar`](https://docs.python.org/3/library/contextvars.html) 进行追踪。 ## 敏感数据 -某些 span 可能会捕获潜在的敏感数据。 +某些 Span 可能会捕获潜在的敏感数据。 -`generation_span()` 会存储 LLM 生成的输入/输出，`function_span()` 会存储工具调用的输入/输出。这些可能包含敏感数据，你可以通过 [`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] 禁用这些数据的捕获。 +`generation_span()` 会存储 LLM 生成的输入/输出，`function_span()` 会存储工具调用的输入/输出。这些可能包含敏感数据，因此你可以通过 [`RunConfig.trace_include_sensitive_data`][agents.run.RunConfig.trace_include_sensitive_data] 禁用对这些数据的捕获。 -同样地，音频相关的 span 默认会包含输入与输出音频的 base64 编码 PCM 数据。你可以通过配置 [`VoicePipelineConfig.trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data] 禁用音频数据的捕获。 +同样地，音频类 Span 默认会包含输入和输出音频的 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]，它会将追踪/span 批量发送给 [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter]，后者会将 span 和追踪批量导出到 OpenAI 的后端。 +- 在初始化时，我们会创建一个全局的 [`TraceProvider`][agents.tracing.setup.TraceProvider]，负责创建 Trace。 +- 我们为 `TraceProvider` 配置一个 [`BatchTraceProcessor`][agents.tracing.processors.BatchTraceProcessor]，该处理器将 Trace/Span 批量发送到 [`BackendSpanExporter`][agents.tracing.processors.BackendSpanExporter]，由其将 Span 和 Trace 批量导出到 OpenAI 后端。 -若要自定义这一默认设置，将追踪发送到替代或附加的后端，或修改导出器行为，你有两种选择： +若要自定义此默认设置，将追踪发送到替代或附加的后端，或修改导出器行为，你有两种选择： -1. [`add_trace_processor()`][agents.tracing.add_trace_processor] 允许你添加一个额外的追踪进程，该进程会在追踪和 span 就绪时接收它们。这样你可以在将追踪发送到 OpenAI 后端之外执行自定义处理。 -2. [`set_trace_processors()`][agents.tracing.set_trace_processors] 允许你用自己的追踪进程替换默认进程。这意味着除非你包含一个将数据发送到 OpenAI 后端的 `TracingProcessor`，否则追踪将不会发送到 OpenAI 后端。 +1. [`add_trace_processor()`][agents.tracing.add_trace_processor] 允许你添加一个额外的追踪处理器，该处理器会在 Trace 和 Span 就绪时接收它们。这样你可以在将追踪发送至 OpenAI 后端之外，执行你自己的处理。 +2. [`set_trace_processors()`][agents.tracing.set_trace_processors] 允许你用你自己的追踪处理器替换默认处理器。这意味着除非你包含一个会这么做的 `TracingProcessor`，否则追踪将不会发送到 OpenAI 后端。 -## 与非 OpenAI 模型的追踪 +## 使用非 OpenAI 模型进行追踪 -你可以使用 OpenAI API key 配合非 OpenAI 模型，在无需禁用追踪的情况下，在 OpenAI Traces 仪表板中启用免费的追踪。 +你可以将 OpenAI API key 与非 OpenAI 模型一起使用，在 OpenAI Traces 仪表板中启用免费的追踪，而无需禁用追踪。 ```python import os @@ -124,16 +124,16 @@ agent = Agent( ) ``` -## 备注 +## 注意 - 在 Openai Traces 仪表板查看免费追踪。 -## 外部追踪进程列表 +## 外部追踪处理器列表 - [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) +- [MLflow（自托管/OSS）](https://mlflow.org/docs/latest/tracing/integrations/openai-agent) +- [MLflow（Databricks 托管）](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) diff --git a/docs/zh/usage.md b/docs/zh/usage.md index 7a591fe15..4cce4b025 100644 --- a/docs/zh/usage.md +++ b/docs/zh/usage.md @@ -4,21 +4,22 @@ search: --- # 用量 -Agents SDK 会自动跟踪每次运行的 token 用量。你可以从运行上下文中访问它，用于监控成本、实施限制或记录分析数据。 +Agents SDK 会为每次运行自动跟踪令牌用量。你可以从运行上下文中访问它，用于监控成本、实施限制或记录分析数据。 -## 跟踪项 +## 跟踪内容 - **requests**: 发起的 LLM API 调用次数 -- **input_tokens**: 发送的输入 token 总数 -- **output_tokens**: 接收的输出 token 总数 +- **input_tokens**: 发送的输入令牌总数 +- **output_tokens**: 接收的输出令牌总数 - **total_tokens**: 输入 + 输出 +- **request_usage_entries**: 按请求的用量明细列表 - **details**: - `input_tokens_details.cached_tokens` - `output_tokens_details.reasoning_tokens` -## 运行用量访问 +## 运行中的用量访问 -在执行 `Runner.run(...)` 后，可通过 `result.context_wrapper.usage` 访问用量数据。 +在执行 `Runner.run(...)` 之后，通过 `result.context_wrapper.usage` 访问用量。 ```python result = await Runner.run(agent, "What's the weather in Tokyo?") @@ -30,11 +31,11 @@ print("Output tokens:", usage.output_tokens) print("Total tokens:", usage.total_tokens) ``` -用量会在运行期间聚合所有模型调用（包括工具调用与任务转移）。 +用量会在本次运行期间的所有模型调用中聚合（包括工具调用和任务转移）。 -### LiteLLM 模型的用量启用 +### 在 LiteLLM 模型中启用用量统计 -LiteLLM 提供方默认不报告用量指标。使用 [`LitellmModel`](models/litellm.md) 时，向你的智能体传入 `ModelSettings(include_usage=True)`，以便 LiteLLM 的响应填充 `result.context_wrapper.usage`。 +LiteLLM 提供方默认不报告用量指标。当你使用 [`LitellmModel`](models/litellm.md) 时，向你的智能体传入 `ModelSettings(include_usage=True)`，以便 LiteLLM 响应填充 `result.context_wrapper.usage`。 ```python from agents import Agent, ModelSettings, Runner @@ -50,7 +51,18 @@ result = await Runner.run(agent, "What's the weather in Tokyo?") print(result.context_wrapper.usage.total_tokens) ``` -## 会话中的用量访问 +## 按请求的用量跟踪 + +SDK 会在 `request_usage_entries` 中自动跟踪每个 API 请求的用量，便于进行细粒度的成本计算与上下文窗口消耗监控。 + +```python +result = await Runner.run(agent, "What's the weather in Tokyo?") + +for request in enumerate(result.context_wrapper.usage.request_usage_entries): + print(f"Request {i + 1}: {request.input_tokens} in, {request.output_tokens} out") +``` + +## 通过会话访问用量 当你使用 `Session`（例如 `SQLiteSession`）时，每次调用 `Runner.run(...)` 都会返回该次运行的用量。会话会为上下文保留对话历史，但每次运行的用量彼此独立。 @@ -64,11 +76,11 @@ second = await Runner.run(agent, "Can you elaborate?", session=session) print(second.context_wrapper.usage.total_tokens) # Usage for second run ``` -请注意，尽管会话在多次运行之间保留对话上下文，但每次 `Runner.run()` 返回的用量指标仅代表该次执行。在会话中，先前消息可能会在每次运行时被重新作为输入提供，这会影响后续轮次的输入 token 计数。 +请注意，尽管会话会在运行之间保留对话上下文，但每次 `Runner.run()` 调用返回的用量指标仅代表该次执行。在会话中，先前消息可能会在每次运行时重新作为输入提供，这会影响后续轮次的输入令牌计数。 -## 钩子中的用量 +## 在钩子中使用用量 -如果你使用 `RunHooks`，传递给每个钩子的 `context` 对象包含 `usage`。这使你能够在关键生命周期时刻记录用量。 +如果你使用 `RunHooks`，传递给每个钩子的 `context` 对象包含 `usage`。这使你可以在关键生命周期时刻记录用量。 ```python class MyHooks(RunHooks): @@ -79,8 +91,9 @@ class MyHooks(RunHooks): ## API 参考 -有关详细的 API 文档，请参阅： +详细 API 文档参见： - [`Usage`][agents.usage.Usage] - 用量跟踪数据结构 +- [`RequestUsage`][agents.usage.RequestUsage] - 按请求的用量明细 - [`RunContextWrapper`][agents.run.RunContextWrapper] - 从运行上下文访问用量 -- [`RunHooks`][agents.run.RunHooks] - 接入用量跟踪生命周期 \ No newline at end of file +- [`RunHooks`][agents.run.RunHooks] - 钩入用量跟踪生命周期 \ No newline at end of file diff --git a/docs/zh/visualization.md b/docs/zh/visualization.md index 2074ea1a8..b40376f0d 100644 --- a/docs/zh/visualization.md +++ b/docs/zh/visualization.md @@ -4,7 +4,7 @@ search: --- # 智能体可视化 -智能体可视化允许你使用 **Graphviz** 生成智能体及其关系的结构化图形表示。这有助于理解在应用中智能体、工具与任务转移如何交互。 +智能体可视化允许你使用 **Graphviz** 生成智能体及其关系的结构化图形表示。这有助于理解智能体、工具和任务转移在应用中的交互方式。 ## 安装 @@ -14,16 +14,16 @@ search: pip install "openai-agents[viz]" ``` -## 生成图形 +## 生成图 你可以使用 `draw_graph` 函数生成智能体可视化。该函数会创建一个有向图，其中： - **智能体** 用黄色方框表示。 -- **MCP Servers** 用灰色方框表示。 +- **MCP 服务** 用灰色方框表示。 - **工具** 用绿色椭圆表示。 -- **任务转移** 是从一个智能体指向另一个智能体的有向边。 +- **任务转移** 用从一个智能体指向另一个智能体的有向边表示。 -### 示例用法 +### 用法示例 ```python import os @@ -69,37 +69,36 @@ draw_graph(triage_agent) ![Agent Graph](../assets/images/graph.png) -这将生成一个图形，直观展示了**分诊智能体**及其与子智能体和工具的连接结构。 +这将生成一个图，直观地表示 **分诊智能体** 的结构及其与子智能体和工具的连接。 ## 理解可视化 -生成的图形包含： +生成的图包含： -- 一个表示入口的**起始节点**（`__start__`）。 -- 用**矩形**且填充黄色表示的智能体。 -- 用**椭圆**且填充绿色表示的工具。 -- 用**矩形**且填充灰色表示的 MCP Servers。 +- 一个表示入口的 **起始节点** (`__start__`)。 +- 用黄色填充的 **矩形** 表示智能体。 +- 用绿色填充的 **椭圆** 表示工具。 +- 用灰色填充的 **矩形** 表示 MCP 服务。 - 表示交互的有向边： - - **实线箭头** 表示智能体之间的任务转移。 - - **虚线点状箭头** 表示工具调用。 + - **实线箭头** 表示智能体到智能体的任务转移。 + - **点线箭头** 表示工具调用。 - **虚线箭头** 表示 MCP 服务调用。 -- 一个表示执行终止位置的**结束节点**（`__end__`）。 +- 一个表示执行结束的 **结束节点** (`__end__`)。 -**注意：** 在较新的 -`agents` 包版本（已在 **v0.2.8** 验证）中会渲染 MCP servers。若你的可视化中未显示 MCP 方框，请升级到最新版本。 +**注意：** 最近版本的 `agents` 包会渲染 MCP 服务（已在 **v0.2.8** 验证）。如果在可视化中未看到 MCP 方框，请升级到最新版本。 -## 自定义图形 +## 自定义图 -### 显示图形 -默认情况下，`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/zh/voice/pipeline.md b/docs/zh/voice/pipeline.md index 0f45fb848..9dd832457 100644 --- a/docs/zh/voice/pipeline.md +++ b/docs/zh/voice/pipeline.md @@ -2,9 +2,9 @@ search: exclude: true --- -# 流水线与工作流 +# 管道与工作流 -[`VoicePipeline`][agents.voice.pipeline.VoicePipeline] 是一个类，可轻松将你的智能体工作流变成语音应用。你传入一个要运行的工作流，流水线会负责转写输入音频、检测音频结束时间、在正确时机调用你的工作流，并将工作流输出重新转换为音频。 +[`VoicePipeline`][agents.voice.pipeline.VoicePipeline] 是一个类，可轻松将你的智能体工作流变成语音应用。你传入要运行的工作流，管道会负责转写输入音频、检测音频结束时间、在正确的时机调用你的工作流，并将工作流输出转换回音频。 ```mermaid graph LR @@ -32,30 +32,30 @@ graph LR ``` -## 配置流水线 +## 管道配置 -创建流水线时，你可以设置以下内容： +创建管道时，你可以设置以下内容： -1. [`workflow`][agents.voice.workflow.VoiceWorkflowBase]，即每次有新音频被转写时运行的代码。 -2. 所使用的 [`speech-to-text`][agents.voice.model.STTModel] 和 [`text-to-speech`][agents.voice.model.TTSModel] 模型 -3. [`config`][agents.voice.pipeline_config.VoicePipelineConfig]，用于配置以下内容： - - 模型提供方，可将模型名称映射到具体模型 +1. [`workflow`][agents.voice.workflow.VoiceWorkflowBase]：每次转写出新音频时运行的代码。 +2. 使用的 [`speech-to-text`][agents.voice.model.STTModel] 和 [`text-to-speech`][agents.voice.model.TTSModel] 模型。 +3. [`config`][agents.voice.pipeline_config.VoicePipelineConfig]：用于配置以下内容： + - 模型提供者，可将模型名称映射到具体模型 - 追踪，包括是否禁用追踪、是否上传音频文件、工作流名称、追踪 ID 等 - - TTS 和 STT 模型的设置，例如使用的 prompt、语言和数据类型 + - TTS 与 STT 模型上的设置，如 prompt、语言和所用数据类型 -## 运行流水线 +## 运行管道 -你可以通过 [`run()`][agents.voice.pipeline.VoicePipeline.run] 方法运行流水线，并以两种形式传入音频输入： +你可以通过 [`run()`][agents.voice.pipeline.VoicePipeline.run] 方法运行管道，并以两种形式传入音频输入： -1. 当你已有完整的音频转写，只想为其生成结果时，使用 [`AudioInput`][agents.voice.input.AudioInput]。这在无需检测说话者何时结束的场景中很有用；例如，使用预录音频，或在按键说话应用中，用户结束说话的时机是明确的。 -2. 当你可能需要检测用户何时结束说话时，使用 [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput]。它允许你在检测到时持续推送音频块，语音流水线会通过称为“语音活动检测（activity detection）”的过程，在正确时机自动运行智能体工作流。 +1. 当你已有完整音频转写，只想为其生成结果时使用 [`AudioInput`][agents.voice.input.AudioInput]。这在无需检测说话者何时结束的场景很有用；例如，预录音频或在按键说话应用中，用户何时说完是明确的。 +2. 当需要检测用户何时说完时使用 [`StreamedAudioInput`][agents.voice.input.StreamedAudioInput]。它允许你在检测到时按块推送音频，语音管道会通过名为“activity detection”的流程在正确的时机自动运行智能体工作流。 ## 结果 -语音流水线运行的结果为 [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult]。该对象允许你在事件发生时进行流式接收。[`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] 有几种类型，包括： +一次语音管道运行的结果是 [`StreamedAudioResult`][agents.voice.result.StreamedAudioResult]。这是一个对象，可在事件发生时进行流式传递。包含几种 [`VoiceStreamEvent`][agents.voice.events.VoiceStreamEvent] 类型，包括： -1. [`VoiceStreamEventAudio`][agents.voice.events.VoiceStreamEventAudio]，包含一段音频片段。 -2. [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle]，用于告知诸如轮次开始或结束等生命周期事件。 +1. [`VoiceStreamEventAudio`][agents.voice.events.VoiceStreamEventAudio]，包含一段音频数据。 +2. [`VoiceStreamEventLifecycle`][agents.voice.events.VoiceStreamEventLifecycle]，用于通知诸如轮次开始或结束的生命周期事件。 3. [`VoiceStreamEventError`][agents.voice.events.VoiceStreamEventError]，表示错误事件。 ```python @@ -74,6 +74,6 @@ 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/zh/voice/quickstart.md b/docs/zh/voice/quickstart.md index 49f2d6d03..e7eac3359 100644 --- a/docs/zh/voice/quickstart.md +++ b/docs/zh/voice/quickstart.md @@ -2,11 +2,11 @@ search: exclude: true --- -# 快速入门 +# 快速开始 -## 前提条件 +## 先决条件 -请确保你已经按照 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. 运行语音转文本模型，将音频转换为文本。 2. 运行你的代码（通常是一个智能体工作流）以生成结果。 -3. 运行文本转语音模型，将结果文本转回音频。 +3. 运行文本转语音模型，将结果文本转换回音频。 ```mermaid graph LR @@ -48,7 +48,7 @@ graph LR ## 智能体 -首先，让我们设置一些智能体。如果你使用过此 SDK 构建过智能体，这应该会让你感到熟悉。我们将创建几个智能体、一个任务转移，以及一个工具。 +首先，让我们设置一些智能体。如果你之前用这个 SDK 构建过智能体，这会让你感到很熟悉。我们将有几个智能体、一次任务转移以及一个工具。 ```python import asyncio @@ -90,16 +90,16 @@ agent = Agent( ) ``` -## 语音流水线 +## 语音管线 -我们将使用 [`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow] 作为工作流，来设置一个简单的语音流水线。 +我们将设置一个简单的语音管线，使用 [`SingleAgentVoiceWorkflow`][agents.voice.workflow.SingleAgentVoiceWorkflow] 作为工作流。 ```python from agents.voice import SingleAgentVoiceWorkflow, VoicePipeline pipeline = VoicePipeline(workflow=SingleAgentVoiceWorkflow(agent)) ``` -## 运行流水线 +## 运行管线 ```python import numpy as np @@ -124,7 +124,7 @@ async for event in result.stream(): ``` -## 整合运行 +## 整体整合 ```python import asyncio @@ -195,4 +195,4 @@ if __name__ == "__main__": asyncio.run(main()) ``` -如果你运行这个示例，智能体会和你对话！前往[examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static)查看一个你可以亲自与智能体对话的演示。 \ No newline at end of file +如果你运行这个示例，智能体会对你说话！查看 [examples/voice/static](https://github.com/openai/openai-agents-python/tree/main/examples/voice/static) 中的示例，体验一个你可以直接与智能体对话的演示。 \ No newline at end of file diff --git a/docs/zh/voice/tracing.md b/docs/zh/voice/tracing.md index 3f4ff1686..facb200af 100644 --- a/docs/zh/voice/tracing.md +++ b/docs/zh/voice/tracing.md @@ -4,15 +4,15 @@ search: --- # 追踪 -与[智能体的追踪方式](../tracing.md)相同，语音流水线也会被自动追踪。 +与[智能体的追踪](../tracing.md)方式相同，语音管道也会被自动追踪。 -你可以参考上面的追踪文档了解基本信息，此外还可以通过 [`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig] 配置流水线的追踪。 +你可以阅读上面的追踪文档以了解基础信息，此外还可以通过[`VoicePipelineConfig`][agents.voice.pipeline_config.VoicePipelineConfig]对管道的追踪进行配置。 与追踪相关的关键字段包括： -- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: 控制是否禁用追踪。默认启用追踪。 -- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]: 控制追踪是否包含可能敏感的数据，例如音频转写。此设置仅适用于语音流水线，不涉及你的 Workflow 内部发生的任何内容。 -- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]: 控制追踪是否包含音频数据。 -- [`workflow_name`][agents.voice.pipeline_config.VoicePipelineConfig.workflow_name]: 追踪工作流的名称。 -- [`group_id`][agents.voice.pipeline_config.VoicePipelineConfig.group_id]: 追踪的 `group_id`，可用于关联多个追踪。 -- [`trace_metadata`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]: 随追踪一并包含的附加元数据。 \ No newline at end of file +- [`tracing_disabled`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]：控制是否禁用追踪。默认启用追踪。 +- [`trace_include_sensitive_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_data]：控制追踪中是否包含可能的敏感数据，例如音频转写文本。该配置仅作用于语音管道，不影响你的工作流（Workflow）内部的内容。 +- [`trace_include_sensitive_audio_data`][agents.voice.pipeline_config.VoicePipelineConfig.trace_include_sensitive_audio_data]：控制追踪中是否包含音频数据。 +- [`workflow_name`][agents.voice.pipeline_config.VoicePipelineConfig.workflow_name]：追踪工作流的名称。 +- [`group_id`][agents.voice.pipeline_config.VoicePipelineConfig.group_id]：追踪的`group_id`，可用于关联多个追踪。 +- [`trace_metadata`][agents.voice.pipeline_config.VoicePipelineConfig.tracing_disabled]：随追踪一同包含的附加元数据。 \ No newline at end of file