openai-agents 0.3.2__tar.gz → 0.3.3__tar.gz

{openai_agents-0.3.2 → openai_agents-0.3.3}/.github/workflows/issues.yml

@@ -15,13 +15,14 @@ jobs:
           days-before-issue-stale: 7
           days-before-issue-close: 3
           stale-issue-label: "stale"
+          exempt-issue-labels: "skip-stale"
           stale-issue-message: "This issue is stale because it has been open for 7 days with no activity."
           close-issue-message: "This issue was closed because it has been inactive for 3 days since being marked as stale."
           any-of-issue-labels: 'question,needs-more-info'
           days-before-pr-stale: 10
           days-before-pr-close: 7
           stale-pr-label: "stale"
-          exempt-issue-labels: "skip-stale"
+          exempt-pr-labels: "skip-stale"
           stale-pr-message: "This PR is stale because it has been open for 10 days with no activity."
           close-pr-message: "This PR was closed because it has been inactive for 7 days since being marked as stale."
           repo-token: ${{ secrets.GITHUB_TOKEN }}

{openai_agents-0.3.2 → openai_agents-0.3.3}/.github/workflows/update-docs.yml

@@ -5,6 +5,11 @@ name: "Update Translated Docs"
 # 2. When you add a new page to the left-hand menu, **make sure to manually update mkdocs.yml** to include the new item.
 # 3. If you switch to a different LLM (for example, from o3 to a newer model), be sure to conduct thorough testing before making the switch.
 
+# To add more languages, you will update the following:
+# 1.  Add '!docs/{lang}/**' to `on.push.paths` in this file
+# 2. Update mkdocs.yml to have the new language
+# 3. Update docs/scripts/translate_docs.py to have the new language
+
 on:
   push:
     branches:
@@ -12,6 +17,8 @@ on:
     paths:
       - 'docs/**'
       - mkdocs.yml
+      - '!docs/ja/**'
+      - '!docs/ko/**'
 
 permissions:
   contents: write

{openai_agents-0.3.2 → openai_agents-0.3.3}/.gitignore

@@ -144,3 +144,6 @@ cython_debug/
 # PyPI configuration file
 .pypirc
 .aider*
+
+# Redis database files
+dump.rdb

{openai_agents-0.3.2 → openai_agents-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openai-agents
-Version: 0.3.2
+Version: 0.3.3
 Summary: OpenAI Agents SDK
 Project-URL: Homepage, https://openai.github.io/openai-agents-python/
 Project-URL: Repository, https://github.com/openai/openai-agents-python
@@ -32,6 +32,8 @@ Provides-Extra: litellm
 Requires-Dist: litellm<2,>=1.67.4.post1; extra == 'litellm'
 Provides-Extra: realtime
 Requires-Dist: websockets<16,>=15.0; extra == 'realtime'
+Provides-Extra: redis
+Requires-Dist: redis>=6.4.0; extra == 'redis'
 Provides-Extra: sqlalchemy
 Requires-Dist: asyncpg>=0.29.0; extra == 'sqlalchemy'
 Requires-Dist: sqlalchemy>=2.0; extra == 'sqlalchemy'
@@ -75,6 +77,8 @@ pip install openai-agents
 
 For voice support, install with the optional `voice` group: `pip install 'openai-agents[voice]'`.
 
+For Redis session support, install with the optional `redis` group: `pip install 'openai-agents[redis]'`.
+
 ### uv
 
 If you're familiar with [uv](https://docs.astral.sh/uv/), using the tool would be even similar:
@@ -86,6 +90,8 @@ uv add openai-agents
 
 For voice support, install with the optional `voice` group: `uv add 'openai-agents[voice]'`.
 
+For Redis session support, install with the optional `redis` group: `uv add 'openai-agents[redis]'`.
+
 ## Hello world example
 
 ```python
@@ -255,8 +261,13 @@ print(result.final_output)  # "Approximately 39 million"
 ```python
 from agents import Agent, Runner, SQLiteSession
 
-# Custom SQLite database file
+# SQLite - file-based or in-memory database
 session = SQLiteSession("user_123", "conversations.db")
+
+# Redis - for scalable, distributed deployments
+# from agents.extensions.memory import RedisSession
+# session = RedisSession.from_url("user_123", url="redis://localhost:6379/0")
+
 agent = Agent(name="Assistant")
 
 # Different session IDs maintain separate conversation histories

{openai_agents-0.3.2 → openai_agents-0.3.3}/README.md

@@ -31,6 +31,8 @@ pip install openai-agents
 
 For voice support, install with the optional `voice` group: `pip install 'openai-agents[voice]'`.
 
+For Redis session support, install with the optional `redis` group: `pip install 'openai-agents[redis]'`.
+
 ### uv
 
 If you're familiar with [uv](https://docs.astral.sh/uv/), using the tool would be even similar:
@@ -42,6 +44,8 @@ uv add openai-agents
 
 For voice support, install with the optional `voice` group: `uv add 'openai-agents[voice]'`.
 
+For Redis session support, install with the optional `redis` group: `uv add 'openai-agents[redis]'`.
+
 ## Hello world example
 
 ```python
@@ -211,8 +215,13 @@ print(result.final_output)  # "Approximately 39 million"
 ```python
 from agents import Agent, Runner, SQLiteSession
 
-# Custom SQLite database file
+# SQLite - file-based or in-memory database
 session = SQLiteSession("user_123", "conversations.db")
+
+# Redis - for scalable, distributed deployments
+# from agents.extensions.memory import RedisSession
+# session = RedisSession.from_url("user_123", url="redis://localhost:6379/0")
+
 agent = Agent(name="Assistant")
 
 # Different session IDs maintain separate conversation histories

{openai_agents-0.3.2 → openai_agents-0.3.3}/docs/agents.md

@@ -22,7 +22,7 @@ def get_weather(city: str) -> str:
 agent = Agent(
     name="Haiku agent",
     instructions="Always respond in haiku form",
-    model="o3-mini",
+    model="gpt-5-nano",
     tools=[get_weather],
 )
 ```
@@ -163,7 +163,7 @@ By using the `clone()` method on an agent, you can duplicate an Agent, and optio
 pirate_agent = Agent(
     name="Pirate",
     instructions="Write like a pirate",
-    model="o3-mini",
+    model="gpt-4.1",
 )
 
 robot_agent = pirate_agent.clone(

openai_agents-0.3.3/docs/examples.md

@@ -0,0 +1,89 @@
+# Examples
+
+Check out a variety of sample implementations of the SDK in the examples section of the [repo](https://github.com/openai/openai-agents-python/tree/main/examples). The examples are organized into several categories that demonstrate different patterns and capabilities.
+
+## Categories
+
+-   **[agent_patterns](https://github.com/openai/openai-agents-python/tree/main/examples/agent_patterns):**
+    Examples in this category illustrate common agent design patterns, such as
+
+    -   Deterministic workflows
+    -   Agents as tools
+    -   Parallel agent execution
+    -   Conditional tool usage
+    -   Input/output guardrails
+    -   LLM as a judge
+    -   Routing
+    -   Streaming guardrails
+
+-   **[basic](https://github.com/openai/openai-agents-python/tree/main/examples/basic):**
+    These examples showcase foundational capabilities of the SDK, such as
+
+    -   Hello world examples (Default model, GPT-5, open-weight model)
+    -   Agent lifecycle management
+    -   Dynamic system prompts
+    -   Streaming outputs (text, items, function call args)
+    -   Prompt templates
+    -   File handling (local and remote, images and PDFs)
+    -   Usage tracking
+    -   Non-strict output types
+    -   Previous response ID usage
+
+-   **[customer_service](https://github.com/openai/openai-agents-python/tree/main/examples/customer_service):**
+    Example customer service system for an airline.
+
+-   **[financial_research_agent](https://github.com/openai/openai-agents-python/tree/main/examples/financial_research_agent):**
+    A financial research agent that demonstrates structured research workflows with agents and tools for financial data analysis.
+
+-   **[handoffs](https://github.com/openai/openai-agents-python/tree/main/examples/handoffs):**
+    See practical examples of agent handoffs with message filtering.
+
+-   **[hosted_mcp](https://github.com/openai/openai-agents-python/tree/main/examples/hosted_mcp):**
+    Examples demonstrating how to use hosted MCP (Model Context Protocol) connectors and approvals.
+
+-   **[mcp](https://github.com/openai/openai-agents-python/tree/main/examples/mcp):**
+    Learn how to build agents with MCP (Model Context Protocol), including:
+
+    -   Filesystem examples
+    -   Git examples
+    -   MCP prompt server examples
+    -   SSE (Server-Sent Events) examples
+    -   Streamable HTTP examples
+
+-   **[memory](https://github.com/openai/openai-agents-python/tree/main/examples/memory):**
+    Examples of different memory implementations for agents, including:
+
+    -   SQLite session storage
+    -   Advanced SQLite session storage
+    -   Redis session storage
+    -   SQLAlchemy session storage
+    -   Encrypted session storage
+    -   OpenAI session storage
+
+-   **[model_providers](https://github.com/openai/openai-agents-python/tree/main/examples/model_providers):**
+    Explore how to use non-OpenAI models with the SDK, including custom providers and LiteLLM integration.
+
+-   **[realtime](https://github.com/openai/openai-agents-python/tree/main/examples/realtime):**
+    Examples showing how to build real-time experiences using the SDK, including:
+
+    -   Web applications
+    -   Command-line interfaces
+    -   Twilio integration
+
+-   **[reasoning_content](https://github.com/openai/openai-agents-python/tree/main/examples/reasoning_content):**
+    Examples demonstrating how to work with reasoning content and structured outputs.
+
+-   **[research_bot](https://github.com/openai/openai-agents-python/tree/main/examples/research_bot):**
+    Simple deep research clone that demonstrates complex multi-agent research workflows.
+
+-   **[tools](https://github.com/openai/openai-agents-python/tree/main/examples/tools):**
+    Learn how to implement OAI hosted tools such as:
+
+    -   Web search and web search with filters
+    -   File search
+    -   Code interpreter
+    -   Computer use
+    -   Image generation
+
+-   **[voice](https://github.com/openai/openai-agents-python/tree/main/examples/voice):**
+    See examples of voice agents, using our TTS and STT models, including streamed voice examples.

{openai_agents-0.3.2 → openai_agents-0.3.3}/docs/guardrails.md

@@ -151,4 +151,4 @@ async def main():
 1. This is the actual agent's output type.
 2. This is the guardrail's output type.
 3. This is the guardrail function that receives the agent's output, and returns the result.
-4. This is the actual agent that defines the workflow.
+4. This is the actual agent that defines the workflow.

{openai_agents-0.3.2 → openai_agents-0.3.3}/docs/ja/agents.md

@@ -4,16 +4,16 @@ search:
 ---
 # エージェント
 
-エージェントはアプリの中核となる構成要素です。エージェントは、instructions とツールで構成された大規模言語モデル ( LLM ) です。
+エージェントはアプリの中核となる構成要素です。エージェントは、instructions とツールで構成された大規模言語モデル (LLM) です。
 
 ## 基本設定
 
-最も一般的に設定するエージェントのプロパティは次のとおりです。
+エージェントで最も一般的に設定するプロパティは次のとおりです。
 
--   `name`: エージェントを識別する必須の文字列です。
--   `instructions`: developer メッセージまたは system prompt とも呼ばれます。
--   `model`: 使用する LLM と、temperature、top_p などのモデル調整パラメーターを構成する任意の `model_settings`。
--   `tools`: エージェントがタスク達成のために使用できるツールです。
+- `name`: エージェントを識別する必須の文字列。
+- `instructions`: developer message または system prompt とも呼ばれます。
+- `model`: 使用する LLM と、temperature、top_p などのモデル調整パラメーターを設定する任意の `model_settings`。
+- `tools`: エージェントがタスクを達成するために使用できるツール。
 
 ```python
 from agents import Agent, ModelSettings, function_tool
@@ -26,14 +26,14 @@ def get_weather(city: str) -> str:
 agent = Agent(
     name="Haiku agent",
     instructions="Always respond in haiku form",
-    model="o3-mini",
+    model="gpt-5-nano",
     tools=[get_weather],
 )
 ```
 
 ## コンテキスト
 
-エージェントは `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、list、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) を使用するようになります。
 
-## マルチエージェント システムの設計パターン
+## マルチエージェントの設計パターン
 
-マルチエージェント システムを設計する方法は多岐にわたりますが、広く適用できるパターンとして次の 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,13 +151,13 @@ agent = Agent[UserContext](
 )
 ```
 
-## ライフサイクルイベント（フック）
+## ライフサイクルイベント (フック)
 
-場合によっては、エージェントのライフサイクルを観察したいことがあります。たとえば、イベントのログ記録や、特定のイベント発生時にデータを事前取得したい場合です。`hooks` プロパティでエージェントのライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、関心のあるメソッドをオーバーライドしてください。
+エージェントのライフサイクルを観察したい場合があります。たとえば、イベントをログに記録したり、特定のイベント発生時にデータを先読みしたりする場合です。`hooks` プロパティを使ってエージェントのライフサイクルにフックできます。[`AgentHooks`][agents.lifecycle.AgentHooks] クラスをサブクラス化し、関心のあるメソッドをオーバーライドしてください。
 
 ## ガードレール
 
-ガードレールにより、エージェントの実行と並行してユーザー入力に対するチェック/検証を行い、エージェントの出力が生成された後にもチェックを実行できます。たとえば、ユーザー入力とエージェント出力の関連性をスクリーニングできます。詳しくは [ガードレール](guardrails.md) のドキュメントを参照してください。
+ガードレールにより、エージェント実行と並行してユーザー入力に対するチェック/バリデーションを実行し、エージェントの出力が生成された後にはその出力に対してもチェックを行えます。たとえば、ユーザーの入力とエージェントの出力を関連性でスクリーニングできます。詳細は [ガードレール](guardrails.md) のドキュメントをご覧ください。
 
 ## エージェントのクローン/コピー
 
@@ -167,7 +167,7 @@ agent = Agent[UserContext](
 pirate_agent = Agent(
     name="Pirate",
     instructions="Write like a pirate",
-    model="o3-mini",
+    model="gpt-4.1",
 )
 
 robot_agent = pirate_agent.clone(
@@ -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
@@ -201,9 +201,9 @@ 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 が再びツール呼び出しを生成し続けることによって発生します。
+    無限ループを防ぐため、フレームワークはツール呼び出し後に `tool_choice` を自動的に "auto" にリセットします。この挙動は [`agent.reset_tool_choice`][agents.agent.Agent.reset_tool_choice] で設定可能です。無限ループは、ツール結果が LLM に送られ、その後 `tool_choice` によって LLM がさらに別のツール呼び出しを生成し続けるために発生します。

openai_agents-0.3.3/docs/ja/config.md

@@ -0,0 +1,98 @@
+---
+search:
+  exclude: true
+---
+# SDK の設定
+
+## API キーとクライアント
+
+デフォルトでは、この SDK はインポートされた時点で LLM リクエストとトレーシング用に `OPENAI_API_KEY` 環境変数を探します。アプリ起動前にその環境変数を設定できない場合は、[set_default_openai_key()][agents.set_default_openai_key] 関数でキーを設定できます。
+
+```python
+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] 関数を使用します。
+
+```python
+from openai import AsyncOpenAI
+from agents import set_default_openai_client
+
+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] 関数を使用します。
+
+```python
+from agents import set_default_openai_api
+
+set_default_openai_api("chat_completions")
+```
+
+## トレーシング
+
+トレーシングはデフォルトで有効です。デフォルトでは上記の OpenAI API キー（環境変数、または設定したデフォルトキー）が使われます。トレーシングに使用する API キーを個別に設定するには、[`set_tracing_export_api_key`][agents.set_tracing_export_api_key] 関数を使用します。
+
+```python
+from agents import set_tracing_export_api_key
+
+set_tracing_export_api_key("sk-...")
+```
+
+[`set_tracing_disabled()`][agents.set_tracing_disabled] 関数を使って、トレーシングを完全に無効化することもできます。
+
+```python
+from agents import set_tracing_disabled
+
+set_tracing_disabled(True)
+```
+
+## デバッグログ
+
+この SDK にはハンドラーが設定されていない 2 つの Python ロガーがあります。デフォルトでは、警告とエラーは `stdout` に送られ、それ以外のログは抑制されます。
+
+詳細なログを有効にするには、[`enable_verbose_stdout_logging()`][agents.enable_verbose_stdout_logging] 関数を使用します。
+
+```python
+from agents import enable_verbose_stdout_logging
+
+enable_verbose_stdout_logging()
+```
+
+あるいは、ハンドラー、フィルター、フォーマッターなどを追加してログをカスタマイズできます。詳細は [Python ロギングガイド](https://docs.python.org/3/howto/logging.html)をご覧ください。
+
+```python
+import logging
+
+logger = logging.getLogger("openai.agents") # or openai.agents.tracing for the Tracing logger
+
+# To make all logs show up
+logger.setLevel(logging.DEBUG)
+# To make info and above show up
+logger.setLevel(logging.INFO)
+# To make warning and above show up
+logger.setLevel(logging.WARNING)
+# etc
+
+# You can customize this as needed, but this will output to `stderr` by default
+logger.addHandler(logging.StreamHandler())
+```
+
+### ログ内の機微データ
+
+一部のログには（たとえば ユーザー データなどの）機微なデータが含まれる場合があります。これらのデータが記録されないようにするには、次の環境変数を設定してください。
+
+LLM の入力と出力の記録を無効化するには:
+
+```bash
+export OPENAI_AGENTS_DONT_LOG_MODEL_DATA=1
+```
+
+ツールの入力と出力の記録を無効化するには:
+
+```bash
+export OPENAI_AGENTS_DONT_LOG_TOOL_DATA=1
+```

openai_agents-0.3.3/docs/ja/context.md

@@ -0,0 +1,82 @@
+---
+search:
+  exclude: true
+---
+# コンテキスト管理
+
+コンテキストという用語は多義的です。ここでは主に次の 2 つのクラスのコンテキストがあります。
+
+1. コードからローカルに利用可能なコンテキスト: これは、ツール関数の実行時、`on_handoff` のようなコールバック中、ライフサイクルフックなどで必要になる可能性があるデータや依存関係です。
+2. LLM に利用可能なコンテキスト: これは、LLM が応答を生成する際に参照するデータです。
+
+## ローカルコンテキスト
+
+これは、[`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` からアクセスできます。
+
+ **最も重要な** 点: 特定のエージェント実行におけるすべてのエージェント、ツール関数、ライフサイクルなどは、同じ _type_ のコンテキストを使用しなければなりません。
+
+コンテキストは次のような用途に使えます:
+
+-   実行のためのコンテキストデータ（例: ユーザー名/uid など、ユーザーに関する情報）
+-   依存関係（例: ロガーオブジェクト、データフェッチャーなど）
+-   ヘルパー関数
+
+!!! danger "注意"
+
+    コンテキストオブジェクトは LLM に **送信されません**。これは純粋にローカルなオブジェクトであり、読み取り・書き込み・メソッド呼び出しができます。
+
+```python
+import asyncio
+from dataclasses import dataclass
+
+from agents import Agent, RunContextWrapper, Runner, function_tool
+
+@dataclass
+class UserInfo:  # (1)!
+    name: str
+    uid: int
+
+@function_tool
+async def fetch_user_age(wrapper: RunContextWrapper[UserInfo]) -> str:  # (2)!
+    """Fetch the age of the user. Call this function to get user's age information."""
+    return f"The user {wrapper.context.name} is 47 years old"
+
+async def main():
+    user_info = UserInfo(name="John", uid=123)
+
+    agent = Agent[UserInfo](  # (3)!
+        name="Assistant",
+        tools=[fetch_user_age],
+    )
+
+    result = await Runner.run(  # (4)!
+        starting_agent=agent,
+        input="What is the age of the user?",
+        context=user_info,
+    )
+
+    print(result.final_output)  # (5)!
+    # The user John is 47 years old.
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+1. これがコンテキストオブジェクトです。ここでは dataclass を使用していますが、任意の型を使用できます。
+2. これはツールです。`RunContextWrapper[UserInfo]` を受け取ることがわかります。ツールの実装はコンテキストから読み取ります。
+3. エージェントにジェネリクスの `UserInfo` を指定し、型チェッカーがエラーを検知できるようにします（たとえば、異なるコンテキスト型を受け取るツールを渡そうとした場合など）。
+4. `run` 関数にコンテキストを渡します。
+5. エージェントはツールを正しく呼び出して年齢を取得します。
+
+## エージェント/ LLM コンテキスト
+
+LLM が呼び出されるとき、LLM が参照できるデータは会話履歴にあるもの **のみ** です。つまり、LLM に新しいデータを利用可能にしたい場合は、その履歴で参照できる形で提供する必要があります。これにはいくつかの方法があります:
+
+1. Agent の `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. リトリーバルや Web 検索を使用します。これらはファイルやデータベース（リトリーバル）、または Web（Web 検索）から関連データを取得できる特別なツールです。関連するコンテキストデータに基づいて応答を「グラウンディング」するのに有用です。