ハンドオフ
ハンドオフは、あるエージェントが別のエージェントにタスクを委譲できるようにする仕組みです。これは、異なるエージェントがそれぞれ異なる分野を専門としているシナリオで特に有用です。たとえば、カスタマーサポートアプリでは、注文状況、返金、FAQ などのタスクを個別に担当するエージェントがいるかもしれません。
ハンドオフは LLM に対してツールとして表現されます。たとえば、Refund Agent という名前のエージェントへのハンドオフがある場合、ツール名は transfer_to_refund_agent となります。
ハンドオフの作成
すべてのエージェントは handoffs パラメーターを持ち、これは Agent を直接受け取ることも、ハンドオフをカスタマイズする Handoff オブジェクトを受け取ることもできます。
Agents SDK が提供する handoff() 関数を使ってハンドオフを作成できます。この関数では、引き渡し先のエージェントに加えて、任意のオーバーライドや入力フィルターを指定できます。
基本的な使い方
シンプルなハンドオフの作成方法は次のとおりです。
from agents import Agent, handoff
billing_agent = Agent(name="Billing agent")
refund_agent = Agent(name="Refund agent")
# (1)!
triage_agent = Agent(name="Triage agent", handoffs=[billing_agent, handoff(refund_agent)])
billing_agentのようにエージェントを直接使うことも、handoff()関数を使うこともできます。
handoff() 関数によるハンドオフのカスタマイズ
handoff() 関数では、さまざまなカスタマイズが可能です。
agent: 引き渡し先となるエージェントです。tool_name_override: 既定ではHandoff.default_tool_name()関数が使用され、transfer_to_<agent_name>に解決されます。これを上書きできます。tool_description_override:Handoff.default_tool_description()の既定のツール説明を上書きします。on_handoff: ハンドオフが呼び出されたときに実行されるコールバック関数です。ハンドオフが呼ばれたことが分かった時点でデータ取得を開始するなどに有用です。この関数はエージェント コンテキストを受け取り、任意で LLM 生成の入力も受け取れます。入力データはinput_typeパラメーターで制御します。input_type: ハンドオフが期待する入力の型(任意)。input_filter: 次のエージェントが受け取る入力をフィルタリングできます。詳細は以下を参照してください。is_enabled: ハンドオフが有効かどうか。真偽値または真偽値を返す関数を指定でき、実行時に動的に有効・無効を切り替えられます。
from agents import Agent, handoff, RunContextWrapper
def on_handoff(ctx: RunContextWrapper[None]):
print("Handoff called")
agent = Agent(name="My agent")
handoff_obj = handoff(
agent=agent,
on_handoff=on_handoff,
tool_name_override="custom_handoff_tool",
tool_description_override="Custom description",
)
ハンドオフの入力
状況によっては、ハンドオフを呼び出す際に LLM に何らかのデータを提供してほしいことがあります。たとえば、「Escalation agent」へのハンドオフを想像してみてください。ログのために理由を提供してほしい場合があります。
from pydantic import BaseModel
from agents import Agent, handoff, RunContextWrapper
class EscalationData(BaseModel):
reason: str
async def on_handoff(ctx: RunContextWrapper[None], input_data: EscalationData):
print(f"Escalation agent called with reason: {input_data.reason}")
agent = Agent(name="Escalation agent")
handoff_obj = handoff(
agent=agent,
on_handoff=on_handoff,
input_type=EscalationData,
)
入力フィルター
ハンドオフが発生すると、新しいエージェントが会話を引き継ぎ、直前までの会話履歴全体を閲覧できるかのように振る舞います。これを変更したい場合は、input_filter を設定できます。入力フィルターは、既存の入力を HandoffInputData 経由で受け取り、新しい HandoffInputData を返す関数です。
既定では、runner は直前のトランスクリプトを 1 つのアシスタント要約メッセージに折りたたむようになりました(RunConfig.nest_handoff_history を参照)。この要約は、同一の実行中に複数のハンドオフが発生した場合に新しいターンを追加し続ける <CONVERSATION HISTORY> ブロック内に表示されます。完全な input_filter を書かずに生成されたメッセージを置き換えるには、RunConfig.handoff_history_mapper で独自のマッピング関数を提供できます。これは、ハンドオフ側と実行側のいずれも明示的な input_filter を提供しない場合にのみ適用されるため、すでにペイロードをカスタマイズしている既存のコード(このリポジトリ内の code examples を含む)は、変更なしで現在の動作を維持します。単一のハンドオフに対してネスト動作を上書きするには、handoff(...) に nest_handoff_history=True または False を渡します。これは Handoff.nest_handoff_history を設定します。生成された要約のラッパーテキストだけを変更したい場合は、エージェントを実行する前に set_conversation_history_wrappers(必要に応じて reset_conversation_history_wrappers)を呼び出してください。
いくつかの一般的なパターン(たとえば履歴からすべてのツール呼び出しを削除するなど)は、agents.extensions.handoff_filters に実装済みです。
from agents import Agent, handoff
from agents.extensions import handoff_filters
agent = Agent(name="FAQ agent")
handoff_obj = handoff(
agent=agent,
input_filter=handoff_filters.remove_all_tools, # (1)!
)
- これは、
FAQ agentが呼び出されたときに履歴から自動的にすべてのツールを削除します。
推奨プロンプト
LLM がハンドオフを正しく理解できるように、エージェント内にハンドオフに関する情報を含めることを推奨します。agents.extensions.handoff_prompt.RECOMMENDED_PROMPT_PREFIX に推奨のプレフィックスが用意されています。あるいは、agents.extensions.handoff_prompt.prompt_with_handoff_instructions を呼び出して、推奨データをプロンプトに自動的に追加できます。