エージェント

エージェントはアプリケーションの基本的な構成要素です。エージェントは、大規模言語モデル（LLM）であり、 instructions と tools を用いて設定されます。

基本設定

エージェントの設定でよく使われるプロパティは以下の通りです。

instructions : 開発者メッセージまたはシステムプロンプトとも呼ばれます。
model : 使用する LLM を指定します。オプションで model_settings を指定し、temperature や top_p などのモデル調整パラメータを設定できます。
tools : エージェントがタスクを達成するために使用できるツールです。

from agents import Agent, ModelSettings, function_tool

@function_tool
def get_weather(city: str) -> str:
    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:
  uid: str
  is_pro_user: bool

  async def fetch_purchases() -> list[Purchase]:
     return ...

agent = Agent[UserContext](
    ...,
)

出力タイプ

デフォルトでは、エージェントはプレーンテキスト（つまり str ）を出力します。特定の型の出力を生成させたい場合は、 output_type パラメータを使用します。一般的には Pydantic オブジェクトを使用しますが、Pydantic の TypeAdapter でラップ可能な型（データクラス、リスト、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](https://platform.openai.com/docs/guides/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][agents.lifecycle.AgentHooks] クラスをサブクラス化し、関心のあるメソッドをオーバーライドします。

ガードレール

ガードレールを使用すると、エージェントの実行と並行してユーザー入力に対するチェックや検証を実行できます。例えば、ユーザー入力の関連性を検証できます。詳細はガードレールのドキュメントを参照してください。