エージェント
エージェントは、アプリの中核となる構成要素です。エージェントとは、指示、ツール、およびハンドオフ、ガードレール、structured outputs などの任意の実行時動作を設定した大規模言語モデル(LLM)です。
SandboxAgent ではなく、単一の基本 Agent を定義またはカスタマイズする場合は、このページを使用してください。複数のエージェントをどのように連携させるかを決定する場合は、エージェントオーケストレーションを参照してください。マニフェストで定義されたファイルとサンドボックスネイティブの機能を備えた分離ワークスペース内でエージェントを実行する場合は、サンドボックスエージェントの概念を参照してください。
SDK は、OpenAIモデルに対してデフォルトで Responses API を使用しますが、ここで重要なのはオーケストレーションです。Agent と Runner を組み合わせることで、SDK がターン、ツール、ガードレール、ハンドオフ、セッションを管理できます。このループを自身で管理する場合は、代わりに Responses API を直接使用してください。
次のガイドの選択
このページは、エージェント定義のハブとして使用してください。次に決定する必要がある内容に応じて、関連するガイドに進んでください。
| 目的 | 次に読むガイド |
|---|---|
| モデルまたはプロバイダーの設定を選択する | モデル |
| エージェントに機能を追加する | ツール |
| 実際のリポジトリ、ドキュメント一式、または分離ワークスペースを対象にエージェントを実行する | サンドボックスエージェントのクイックスタート |
| マネージャー方式のオーケストレーションとハンドオフのどちらを使用するか決定する | エージェントオーケストレーション |
| ハンドオフの動作を設定する | ハンドオフ |
| ターンの実行、イベントのストリーミング、または会話状態の管理を行う | エージェントの実行 |
| 最終出力、実行項目、または再開可能な状態を確認する | 実行結果 |
| ローカルの依存関係と実行時状態を共有する | コンテキスト管理 |
基本設定
エージェントで最も一般的なプロパティは次のとおりです。
| プロパティ | 必須 | 説明 |
|---|---|---|
name |
はい | 人が読める形式のエージェント名です。 |
instructions |
いいえ | システムプロンプトまたは動的な指示のコールバックです。使用を強く推奨します。動的な指示を参照してください。 |
prompt |
いいえ | OpenAIの Responses API 用プロンプト設定です。静的なプロンプトオブジェクトまたは関数を受け取ります。プロンプトテンプレートを参照してください。 |
handoff_description |
いいえ | このエージェントがハンドオフ先として提示される際に公開される短い説明です。 |
handoffs |
いいえ | 会話を専門エージェントに委譲します。ハンドオフを参照してください。 |
model |
いいえ | 使用するLLMです。モデルを参照してください。 |
model_settings |
いいえ | temperature、top_p、tool_choice などのモデル調整パラメーターです。 |
tools |
いいえ | エージェントが呼び出せるツールです。ツールを参照してください。 |
mcp_servers |
いいえ | MCP対応ツールをエージェントに提供するMCPサーバーです。MCPガイドを参照してください。 |
mcp_config |
いいえ | スキーマの strict モードへの変換やMCPエラーの形式調整など、MCPツールの準備方法を詳細に調整します。MCPガイドを参照してください。 |
input_guardrails |
いいえ | このエージェントチェーンへの最初のユーザー入力に対して実行されるガードレールです。ガードレールを参照してください。 |
output_guardrails |
いいえ | このエージェントの最終出力に対して実行されるガードレールです。ガードレールを参照してください。 |
output_type |
いいえ | プレーンテキストの代わりに使用する構造化された出力型です。出力型を参照してください。 |
hooks |
いいえ | エージェント単位のライフサイクルコールバックです。ライフサイクルイベント(フック)を参照してください。 |
tool_use_behavior |
いいえ | ツールの実行結果をモデルに戻してループを継続するか、実行を終了するかを制御します。ツール使用時の動作を参照してください。 |
reset_tool_choice |
いいえ | ツール使用ループを回避するため、ツール呼び出し後に tool_choice をリセットします(デフォルト:True)。ツール使用の強制を参照してください。 |
from agents import Agent
from agents.decorators import tool
@tool
def get_weather(city: str) -> str:
"""returns weather info for the specified city."""
return f"The weather in {city} is sunny"
agent = Agent(
name="Haiku agent",
instructions="Always respond in haiku form",
model="gpt-5-nano",
tools=[get_weather],
)
このセクションの内容はすべて Agent に適用されます。SandboxAgent は同じ考え方を基盤とし、ワークスペース単位の実行向けに default_manifest、base_instructions、capabilities、run_as を追加します。サンドボックスエージェントの概念を参照してください。
プロンプトテンプレート
prompt を設定することで、OpenAIプラットフォームで作成したプロンプトテンプレートを参照できます。これは、Responses API 経由でOpenAIモデルにアクセスする場合に機能します。
使用手順は次のとおりです。
- https://platform.openai.com/playground/prompts にアクセスします。
- 新しいプロンプト変数
poem_styleを作成します。 -
次の内容でシステムプロンプトを作成します。
-
--prompt-idフラグを指定してコード例を実行します。
from agents import Agent
agent = Agent(
name="Prompted assistant",
prompt={
"id": "pmpt_123",
"version": "1",
"variables": {"poem_style": "haiku"},
},
)
実行時にプロンプトを動的に生成することもできます。
from dataclasses import dataclass
from agents import Agent, GenerateDynamicPromptData, Runner
@dataclass
class PromptContext:
prompt_id: str
poem_style: str
async def build_prompt(data: GenerateDynamicPromptData):
ctx: PromptContext = data.context.context
return {
"id": ctx.prompt_id,
"version": "1",
"variables": {"poem_style": ctx.poem_style},
}
agent = Agent(name="Prompted assistant", prompt=build_prompt)
result = await Runner.run(
agent,
"Say hello",
context=PromptContext(prompt_id="pmpt_123", poem_style="limerick"),
)
コンテキスト
エージェントは、その context 型に関してジェネリックです。コンテキストは依存性注入の仕組みです。自身で作成して Runner.run() に渡すオブジェクトであり、すべてのエージェント、ツール、ハンドオフなどに渡されます。また、エージェント実行に必要な依存関係と状態をまとめる柔軟なコンテナとして機能します。コンテキストには任意の Python オブジェクトを指定できます。
RunContextWrapper の全機能、共有の使用量追跡、ネストされた tool_input、シリアライズに関する注意事項については、コンテキストガイドを参照してください。
from dataclasses import dataclass
@dataclass
class Purchase:
id: str
@dataclass
class UserContext:
name: str
uid: str
is_pro_user: bool
async def fetch_purchases(self) -> list[Purchase]:
# implement your logic here
return []
agent = Agent[UserContext](
...,
)
出力型
デフォルトでは、エージェントはプレーンテキスト(つまり str)形式の出力を生成します。エージェントに特定の型の出力を生成させる場合は、output_type パラメーターを使用できます。一般的には Pydantic オブジェクトを使用しますが、Pydantic の TypeAdapter でラップできる任意の型をサポートしています。これには、dataclass、リスト、TypedDict などが含まれます。
from pydantic import BaseModel
from agents import Agent
class CalendarEvent(BaseModel):
name: str
date: str
participants: list[str]
agent = Agent(
name="Calendar extractor",
instructions="Extract calendar events from text",
output_type=CalendarEvent,
)
Note
output_type を渡すと、通常のプレーンテキストレスポンスではなく、structured outputsを使用するようモデルに指示します。
マルチエージェントシステムの設計パターン
マルチエージェントシステムには多くの設計方法がありますが、一般的には広く適用できる次の 2 つのパターンが使用されます。
- マネージャー(agents as tools):中央のマネージャー/オーケストレーターが専門サブエージェントをツールとして呼び出し、会話の制御を維持します。
- ハンドオフ:対等なエージェントが、会話を引き継ぐ専門エージェントに制御をハンドオフします。これは分散型のパターンです。
詳細については、エージェント構築の実践ガイドを参照してください。
マネージャー(agents as tools)
customer_facing_agent はすべてのユーザー操作を処理し、ツールとして公開された専門サブエージェントを呼び出します。詳細については、ツールのドキュメントを参照してください。
from agents import Agent
booking_agent = Agent(...)
refund_agent = Agent(...)
customer_facing_agent = Agent(
name="Customer-facing agent",
instructions=(
"Handle all direct user communication. "
"Call the relevant tools when specialized expertise is needed."
),
tools=[
booking_agent.as_tool(
tool_name="booking_expert",
tool_description="Handles booking questions and requests.",
),
refund_agent.as_tool(
tool_name="refund_expert",
tool_description="Handles refund questions and requests.",
)
],
)
ハンドオフ
設定されたハンドオフ先は、エージェントが処理を委譲できるサブエージェントです。ハンドオフが発生すると、委譲先のエージェントが会話履歴を受け取り、会話を引き継ぎます。このパターンにより、単一のタスクに特化したモジュール式の専門エージェントを構築できます。詳細については、ハンドオフのドキュメントを参照してください。
from agents import Agent
booking_agent = Agent(...)
refund_agent = Agent(...)
triage_agent = Agent(
name="Triage agent",
instructions=(
"Help the user with their questions. "
"If they ask about booking, hand off to the booking agent. "
"If they ask about refunds, hand off to the refund agent."
),
handoffs=[booking_agent, refund_agent],
)
動的な指示
ほとんどの場合、エージェントの作成時に指示を指定できます。ただし、関数を使用して動的な指示を指定することもできます。この関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と async 関数の両方を使用できます。
from agents import Agent, RunContextWrapper
def dynamic_instructions(
context: RunContextWrapper[UserContext], agent: Agent[UserContext]
) -> str:
return f"The user's name is {context.context.name}. Help them with their questions."
agent = Agent[UserContext](
name="Triage agent",
instructions=dynamic_instructions,
)
ライフサイクルイベント(フック)
エージェントのライフサイクルを監視したい場合があります。たとえば、特定のイベントが発生したときに、イベントのログ記録、データの事前取得、使用量の記録を行う場合です。
フックには次の 2 つのスコープがあります。
RunHooksは、他のエージェントへのハンドオフを含むRunner.run(...)呼び出し全体を監視します。AgentHooksは、agent.hooksを介して特定のエージェントインスタンスにアタッチされます。
コールバックのコンテキストも、イベントに応じて変わります。
- エージェントの開始/終了フックは、元のコンテキストをラップし、共有の実行使用量状態を保持する
AgentHookContextを受け取ります。 - LLM、ツール、ハンドオフの各フックは、
RunContextWrapperを受け取ります。
一般的なフックのタイミングは次のとおりです。
on_agent_start:特定のエージェントが実行を開始したとき。on_agent_end:そのエージェントが最終出力の生成を完了したとき。on_llm_start/on_llm_end:各モデル呼び出しの直前と直後。on_tool_start/on_tool_end:各ローカルツール呼び出しの前後。関数ツールの場合、フックのcontextは通常ToolContextであるため、tool_call_idなどのツール呼び出しメタデータを確認できます。on_handoff:制御があるエージェントから別のエージェントに移ったとき。
ワークフロー全体を単一のオブザーバーで監視する場合は RunHooks を使用し、特定のエージェントに限定されたライフサイクルコールバックが必要な場合は AgentHooks を使用してください。
from agents import Agent, RunHooks, Runner
class LoggingHooks(RunHooks):
async def on_agent_start(self, context, agent):
print(f"Starting {agent.name}")
async def on_llm_end(self, context, agent, response):
print(f"{agent.name} produced {len(response.output)} output items")
async def on_agent_end(self, context, agent, output):
print(f"{agent.name} finished with usage: {context.usage}")
agent = Agent(name="Assistant", instructions="Be concise.")
result = await Runner.run(agent, "Explain quines", hooks=LoggingHooks())
print(result.final_output)
コールバックの全機能については、ライフサイクル API リファレンスを参照してください。
ガードレール
ガードレールを使用すると、エージェントの実行と並行してユーザー入力に対するチェック/検証を実行し、生成後のエージェント出力に対してもチェック/検証を実行できます。たとえば、ユーザー入力とエージェント出力の関連性を確認できます。詳細については、ガードレールのドキュメントを参照してください。
エージェントのクローン/コピー
エージェントの clone() メソッドを使用すると、エージェントを複製し、必要に応じて任意のプロパティを変更できます。
pirate_agent = Agent(
name="Pirate",
instructions="Write like a pirate",
model="gpt-5.6-sol",
)
robot_agent = pirate_agent.clone(
name="Robot",
instructions="Write like a robot",
)
ツール使用の強制
ツールのリストを指定しても、LLMが必ずツールを使用するとは限りません。ModelSettings.tool_choice を設定することで、ツールの使用を強制できます。有効な値は次のとおりです。
auto:ツールを使用するかどうかをLLMが判断できます。required:LLMにツールの使用を要求しますが、どのツールを使用するかはLLMが適切に判断できます。none:LLMにツールを 使用させない ことを要求します。my_toolなどの特定の文字列を設定すると、LLMにその特定のツールの使用を要求します。
OpenAI Responses のツール検索を使用する場合、名前付きツールの選択にはさらに制約があります。tool_choice では、修飾なしの名前空間名や遅延のみのツールを指定できず、tool_choice="tool_search" では ToolSearchTool を指定できません。このような場合は、auto または required を使用してください。Responses 固有の制約については、ホスト型ツール検索を参照してください。
from agents import Agent, ModelSettings
from agents.decorators import tool
@tool
def get_weather(city: str) -> str:
"""Returns weather info for the specified city."""
return f"The weather in {city} is sunny"
agent = Agent(
name="Weather Agent",
instructions="Retrieve weather details.",
tools=[get_weather],
model_settings=ModelSettings(tool_choice="get_weather")
)
ツール使用時の動作
Agent 設定の tool_use_behavior パラメーターは、ツール出力の処理方法を制御します。
"run_llm_again":デフォルトです。ツールが実行され、その結果をLLMが処理して最終レスポンスを生成します。"stop_on_first_tool":最初のツール呼び出しの出力を、LLMによる追加処理なしで最終レスポンスとして使用します。
from agents import Agent
from agents.decorators import tool
@tool
def get_weather(city: str) -> str:
"""Returns weather info for the specified city."""
return f"The weather in {city} is sunny"
agent = Agent(
name="Weather Agent",
instructions="Retrieve weather details.",
tools=[get_weather],
tool_use_behavior="stop_on_first_tool"
)
StopAtTools(stop_at_tool_names=[...]):指定されたツールのいずれかが呼び出されると停止し、その出力を最終レスポンスとして使用します。
from agents import Agent
from agents.agent import StopAtTools
from agents.decorators import tool
@tool
def get_weather(city: str) -> str:
"""Returns weather info for the specified city."""
return f"The weather in {city} is sunny"
@tool
def sum_numbers(a: int, b: int) -> int:
"""Adds two numbers."""
return a + b
agent = Agent(
name="Stop At Stock Agent",
instructions="Get weather or sum numbers.",
tools=[get_weather, sum_numbers],
tool_use_behavior=StopAtTools(stop_at_tool_names=["get_weather"])
)
ToolsToFinalOutputFunction:ツールの実行結果を処理し、最終出力で実行を終了するか、LLMによる処理を続行するかを決定するカスタム関数です。
from agents import Agent, FunctionToolResult, RunContextWrapper
from agents.agent import ToolsToFinalOutputResult
from agents.decorators import tool
from typing import List, Any
@tool
def get_weather(city: str) -> str:
"""Returns weather info for the specified city."""
return f"The weather in {city} is sunny"
def custom_tool_handler(
context: RunContextWrapper[Any],
tool_results: List[FunctionToolResult]
) -> ToolsToFinalOutputResult:
"""Processes tool results to decide final output."""
for result in tool_results:
if result.output and "sunny" in result.output:
return ToolsToFinalOutputResult(
is_final_output=True,
final_output=f"Final weather: {result.output}"
)
return ToolsToFinalOutputResult(
is_final_output=False,
final_output=None
)
agent = Agent(
name="Weather Agent",
instructions="Retrieve weather details.",
tools=[get_weather],
tool_use_behavior=custom_tool_handler
)
Note
無限ループを防ぐため、フレームワークはツール呼び出し後に tool_choice を自動的に「auto」にリセットします。この動作は、agent.reset_tool_choice で設定できます。無限ループが発生する理由は、ツールの実行結果がLLMに送信された後、tool_choice によってLLMがさらに別のツール呼び出しを生成し続けるためです。