ガードレール

ガードレールは、ユーザー入力とエージェント出力の検査・検証を可能にします。たとえば、顧客からのリクエスト対応にとても賢い（そのため遅く/高価な）モデルを使うエージェントがあるとします。悪意のあるユーザーが、そのモデルに数学の宿題を手伝わせようとするのは避けたいはずです。そこで、速く/安価なモデルでガードレールを実行できます。ガードレールが悪意ある利用を検知した場合、直ちにエラーを発生させて高価なモデルの実行を防ぎ、時間とコストを節約できます（ ブロッキング型ガードレールを使用する場合。並列ガードレールでは、ガードレールの完了前に高価なモデルがすでに実行を開始している可能性があります。詳細は下記「実行モード」を参照してください）。

ガードレールには 2 つの種類があります:

入力ガードレールは最初のユーザー入力で実行されます
出力ガードレールは最終的なエージェント出力で実行されます

入力ガードレール

入力ガードレールは 3 つの手順で実行されます:

まず、ガードレールはエージェントに渡されたものと同じ入力を受け取ります。
次に、ガードレール関数を実行して GuardrailFunctionOutput を生成し、それを InputGuardrailResult にラップします。
最後に、.tripwire_triggered が true かどうかを確認します。true の場合は InputGuardrailTripwireTriggered 例外を送出し、ユーザーへの適切な応答や例外処理ができるようにします。

Note

入力ガードレールはユーザー入力に対して実行されることを意図しているため、エージェントのガードレールは、そのエージェントが最初のエージェントである場合にのみ実行されます。なぜ guardrails プロパティがエージェント側にあり、Runner.run に渡さないのか疑問に思うかもしれません。これは、ガードレールが実際のエージェントに密接に関係する傾向があるためです。エージェントごとに異なるガードレールを実行することになるため、コードを同じ場所に置くと読みやすくなります。

実行モード

入力ガードレールは 2 つの実行モードをサポートします:

並列実行（既定、run_in_parallel=True）: ガードレールはエージェントの実行と同時に並行して実行されます。両者が同時に開始されるため、待ち時間に最も優れています。ただし、ガードレールが失敗した場合でも、エージェントはキャンセルされる前にすでにトークンを消費し、ツールを実行している可能性があります。
ブロッキング実行（run_in_parallel=False）: ガードレールはエージェントが開始する前に実行され、完了します。ガードレールのトリップワイヤーが発動した場合、エージェントは一切実行されず、トークン消費やツール実行を防げます。これはコスト最適化や、ツール呼び出しによる副作用を避けたい場合に最適です。

出力ガードレール

出力ガードレールは 3 つの手順で実行されます:

まず、ガードレールはエージェントが生成した出力を受け取ります。
次に、ガードレール関数を実行して GuardrailFunctionOutput を生成し、それを OutputGuardrailResult にラップします。
最後に、.tripwire_triggered が true かどうかを確認します。true の場合は OutputGuardrailTripwireTriggered 例外を送出し、ユーザーへの適切な応答や例外処理ができるようにします。

Note

出力ガードレールは最終的なエージェント出力に対して実行されることを意図しているため、エージェントのガードレールは、そのエージェントが最後のエージェントである場合にのみ実行されます。入力ガードレールと同様に、ガードレールは実際のエージェントに密接に関係する傾向があるため、コードを同じ場所に置くと読みやすくなります。

出力ガードレールは常にエージェントの完了後に実行されるため、run_in_parallel パラメーターはサポートしません。

トリップワイヤー

入力または出力がガードレールに不合格となった場合、ガードレールはトリップワイヤーでそれを通知できます。トリップワイヤーが発動したガードレールを検出すると、直ちに {Input,Output}GuardrailTripwireTriggered 例外を送出し、エージェントの実行を停止します。

ガードレールの実装

入力を受け取り、GuardrailFunctionOutput を返す関数を用意する必要があります。この例では、内部でエージェントを実行してこれを行います。

from pydantic import BaseModel
from agents import (
    Agent,
    GuardrailFunctionOutput,
    InputGuardrailTripwireTriggered,
    RunContextWrapper,
    Runner,
    TResponseInputItem,
    input_guardrail,
)

class MathHomeworkOutput(BaseModel):
    is_math_homework: bool
    reasoning: str

guardrail_agent = Agent( # (1)!
    name="Guardrail check",
    instructions="Check if the user is asking you to do their math homework.",
    output_type=MathHomeworkOutput,
)


@input_guardrail
async def math_guardrail( # (2)!
    ctx: RunContextWrapper[None], agent: Agent, input: str | list[TResponseInputItem]
) -> GuardrailFunctionOutput:
    result = await Runner.run(guardrail_agent, input, context=ctx.context)

    return GuardrailFunctionOutput(
        output_info=result.final_output, # (3)!
        tripwire_triggered=result.final_output.is_math_homework,
    )


agent = Agent(  # (4)!
    name="Customer support agent",
    instructions="You are a customer support agent. You help customers with their questions.",
    input_guardrails=[math_guardrail],
)

async def main():
    # This should trip the guardrail
    try:
        await Runner.run(agent, "Hello, can you help me solve for x: 2x + 3 = 11?")
        print("Guardrail didn't trip - this is unexpected")

    except InputGuardrailTripwireTriggered:
        print("Math homework guardrail tripped")

このエージェントをガードレール関数内で使用します。
これはエージェントの入力/コンテキストを受け取り、結果を返すガードレール関数です。
ガードレール結果に追加情報を含めることができます。
これはワークフローを定義する実際のエージェントです。

出力ガードレールも同様です。

from pydantic import BaseModel
from agents import (
    Agent,
    GuardrailFunctionOutput,
    OutputGuardrailTripwireTriggered,
    RunContextWrapper,
    Runner,
    output_guardrail,
)
class MessageOutput(BaseModel): # (1)!
    response: str

class MathOutput(BaseModel): # (2)!
    reasoning: str
    is_math: bool

guardrail_agent = Agent(
    name="Guardrail check",
    instructions="Check if the output includes any math.",
    output_type=MathOutput,
)

@output_guardrail
async def math_guardrail(  # (3)!
    ctx: RunContextWrapper, agent: Agent, output: MessageOutput
) -> GuardrailFunctionOutput:
    result = await Runner.run(guardrail_agent, output.response, context=ctx.context)

    return GuardrailFunctionOutput(
        output_info=result.final_output,
        tripwire_triggered=result.final_output.is_math,
    )

agent = Agent( # (4)!
    name="Customer support agent",
    instructions="You are a customer support agent. You help customers with their questions.",
    output_guardrails=[math_guardrail],
    output_type=MessageOutput,
)

async def main():
    # This should trip the guardrail
    try:
        await Runner.run(agent, "Hello, can you help me solve for x: 2x + 3 = 11?")
        print("Guardrail didn't trip - this is unexpected")

    except OutputGuardrailTripwireTriggered:
        print("Math output guardrail tripped")

これは実際のエージェントの出力型です。
これはガードレールの出力型です。
これはエージェントの出力を受け取り、結果を返すガードレール関数です。
これはワークフローを定義する実際のエージェントです。