エージェント
エージェントはアプリの中核となる基本コンポーネントです。エージェントは instructions とツールで構成された大規模言語モデル( LLM )です。
基本設定
エージェントで最も一般的に設定するプロパティは次のとおりです。
name
: エージェントを識別する必須の文字列です。instructions
: developer メッセージまたは システムプロンプト とも呼ばれます。model
: 使用する LLM と、temperature、top_p などのモデル調整パラメーターを設定する任意のmodel_settings
。tools
: エージェントがタスクを達成するために使用できるツールです。
from agents import Agent, ModelSettings, function_tool
@function_tool
def get_weather(city: str) -> str:
"""returns weather info for the specified city."""
return f"The weather in {city} is sunny"
agent = Agent(
name="Haiku agent",
instructions="Always respond in haiku form",
model="o3-mini",
tools=[get_weather],
)
コンテキスト
エージェントは context
型に対してジェネリックです。コンテキストは依存性注入のためのツールで、あなたが作成して Runner.run()
に渡すオブジェクトです。これはすべてのエージェント、ツール、ハンドオフなどに渡され、エージェント実行のための依存関係と状態の入れ物として機能します。コンテキストには任意の Python オブジェクトを指定できます。
@dataclass
class UserContext:
name: str
uid: str
is_pro_user: bool
async def fetch_purchases() -> list[Purchase]:
return ...
agent = Agent[UserContext](
...,
)
出力タイプ
デフォルトでは、エージェントはプレーンテキスト(すなわち str
)を出力します。特定の型の出力を生成させたい場合は、output_type
パラメーターを使用できます。一般的な選択肢は Pydantic オブジェクトですが、Pydantic の TypeAdapter でラップ可能な任意の型(dataclasses、lists、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 を使用するよう指示されます。
ハンドオフ
ハンドオフは、エージェントが委譲できるサブエージェントです。ハンドオフのリストを提供すると、関連する場合にエージェントがそれらへ委譲できます。これは、単一のタスクに特化して優れた結果を出す、モジュール型の専門エージェントをオーケストレーションできる強力なパターンです。詳細は ハンドオフ のドキュメントをご覧ください。
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, handoff to the booking agent."
"If they ask about refunds, handoff to the refund agent."
),
handoffs=[booking_agent, refund_agent],
)
動的 instructions
多くの場合、エージェント作成時に instructions を与えられますが、関数を介して動的に instructions を提供することもできます。この関数はエージェントとコンテキストを受け取り、プロンプトを返す必要があります。通常の関数と async
関数の両方が使用可能です。
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,
)
ライフサイクルイベント(フック)
エージェントのライフサイクルを観察したい場合があります。たとえば、イベントを記録したり、特定のイベント発生時にデータを事前取得したりします。hooks
プロパティでエージェントのライフサイクルにフックできます。AgentHooks
クラスをサブクラス化し、関心のあるメソッドをオーバーライドしてください。
ガードレール
ガードレールにより、エージェントの実行と並行して ユーザー 入力に対するチェックや検証を、またエージェントの出力が生成された後に出力に対するチェックや検証を実行できます。たとえば、 ユーザー の入力とエージェントの出力の関連性をスクリーニングできます。詳細は ガードレール のドキュメントをご覧ください。
エージェントのクローン/コピー
エージェントの clone()
メソッドを使用すると、エージェントを複製し、必要に応じて任意のプロパティを変更できます。
pirate_agent = Agent(
name="Pirate",
instructions="Write like a pirate",
model="o3-mini",
)
robot_agent = pirate_agent.clone(
name="Robot",
instructions="Write like a robot",
)
ツール使用の強制
ツールのリストを指定しても、LLM が必ずしもツールを使用するとは限りません。ModelSettings.tool_choice
を設定するとツール使用を強制できます。有効な値は次のとおりです。
auto
: ツールを使用するかどうかを LLM に任せます。required
: LLM にツールの使用を必須にします(ただし、どのツールを使うかは賢く判断します)。none
: LLM にツールを使用しないことを必須にします。- 文字列を指定(例:
my_tool
): その特定のツールを使用することを LLM に必須にします。
from agents import Agent, Runner, function_tool, ModelSettings
@function_tool
def get_weather(city: str) -> str:
"""Returns weather info for the specified city."""
return f"The weather in {city} is sunny"
agent = Agent(
name="Weather Agent",
instructions="Retrieve weather details.",
tools=[get_weather],
model_settings=ModelSettings(tool_choice="get_weather")
)
ツール使用の動作
Agent
の tool_use_behavior
パラメーターは、ツール出力の扱い方を制御します。
- "run_llm_again"
: デフォルト。ツールを実行し、LLM が結果を処理して最終応答を生成します。
- "stop_on_first_tool"
: 最初のツール呼び出しの出力を、その後の LLM 処理なしで最終応答として使用します。
from agents import Agent, Runner, function_tool, ModelSettings
@function_tool
def get_weather(city: str) -> str:
"""Returns weather info for the specified city."""
return f"The weather in {city} is sunny"
agent = Agent(
name="Weather Agent",
instructions="Retrieve weather details.",
tools=[get_weather],
tool_use_behavior="stop_on_first_tool"
)
StopAtTools(stop_at_tool_names=[...])
: 指定したいずれかのツールが呼び出されたら停止し、その出力を最終応答として使用します。from agents import Agent, Runner, function_tool from agents.agent import StopAtTools @function_tool def get_weather(city: str) -> str: """Returns weather info for the specified city.""" return f"The weather in {city} is sunny" @function_tool def sum_numbers(a: int, b: int) -> int: """Adds two numbers.""" return a + b agent = Agent( name="Stop At Stock Agent", instructions="Get weather or sum numbers.", tools=[get_weather, sum_numbers], tool_use_behavior=StopAtTools(stop_at_tool_names=["get_weather"]) )
ToolsToFinalOutputFunction
: ツール結果を処理し、停止するか LLM を継続するかを判断するカスタム関数です。
from agents import Agent, Runner, function_tool, FunctionToolResult, RunContextWrapper
from agents.agent import ToolsToFinalOutputResult
from typing import List, Any
@function_tool
def get_weather(city: str) -> str:
"""Returns weather info for the specified city."""
return f"The weather in {city} is sunny"
def custom_tool_handler(
context: RunContextWrapper[Any],
tool_results: List[FunctionToolResult]
) -> ToolsToFinalOutputResult:
"""Processes tool results to decide final output."""
for result in tool_results:
if result.output and "sunny" in result.output:
return ToolsToFinalOutputResult(
is_final_output=True,
final_output=f"Final weather: {result.output}"
)
return ToolsToFinalOutputResult(
is_final_output=False,
final_output=None
)
agent = Agent(
name="Weather Agent",
instructions="Retrieve weather details.",
tools=[get_weather],
tool_use_behavior=custom_tool_handler
)
Note
無限ループを防ぐため、フレームワークはツール呼び出し後に tool_choice
を自動的に "auto" にリセットします。この動作は agent.reset_tool_choice
で設定できます。無限ループは、ツールの結果が LLM に送られ、tool_choice
のために LLM が再度ツール呼び出しを生成し続けることが原因です。