エージェントの実行

エージェントは Runner クラスで実行できます。方法は 3 つあります。

Runner.run(): 非同期で実行し、RunResult を返します。
Runner.run_sync(): 同期メソッドで、内部的には .run() を実行します。
Runner.run_streamed(): 非同期で実行し、RunResultStreaming を返します。LLM をストリーミングモードで呼び出し、受信したイベントをそのままストリーミングします。

from agents import Agent, Runner

async def main():
    agent = Agent(name="Assistant", instructions="You are a helpful assistant")

    result = await Runner.run(agent, "Write a haiku about recursion in programming.")
    print(result.final_output)
    # Code within the code,
    # Functions calling themselves,
    # Infinite loop's dance

詳しくは結果ガイドをご覧ください。

エージェントループ

Runner の run メソッドを使うときは、開始するエージェントと入力を渡します。入力は文字列（ユーザーのメッセージと見なされます）か、OpenAI Responses API の入力アイテムのリストのいずれかです。

Runner は次のループを実行します。

現在のエージェントと入力で LLM を呼び出します。
LLM が出力を生成します。
1. LLM が final_output を返した場合、ループを終了して結果を返します。
2. LLM がハンドオフした場合、現在のエージェントと入力を更新してループを再実行します。
3. LLM がツール呼び出しを生成した場合、それらを実行して結果を追加し、ループを再実行します。
渡された max_turns を超えた場合、MaxTurnsExceeded 例外を送出します。

Note

LLM の出力が「最終出力」と見なされる条件は、所望の型のテキスト出力を生成し、ツール呼び出しがないことです。

ストリーミング

ストリーミングを使うと、LLM の実行中にストリーミングイベントも受け取れます。ストリームが完了すると、RunResultStreaming には、生成された新しい出力を含む実行全体の情報が含まれます。ストリーミングイベントは .stream_events() を呼び出してください。詳しくはストリーミングガイドを参照してください。

実行設定 (Run config)

run_config パラメーターでは、エージェント実行のグローバル設定を構成できます。

model: 各 Agent の model 設定に関係なく、使用するグローバルな LLM モデルを設定できます。
model_provider: モデル名の解決に使うモデルプロバイダーで、デフォルトは OpenAI です。
model_settings: エージェント固有の設定を上書きします。たとえば、グローバルな temperature や top_p を設定できます。
input_guardrails, output_guardrails: すべての実行に含める入力/出力のガードレールのリストです。
handoff_input_filter: すべてのハンドオフに適用するグローバルな入力フィルター（ハンドオフに既に設定がない場合）。入力フィルターは、新しいエージェントに送る入力を編集できます。詳しくは Handoff.input_filter のドキュメントをご覧ください。
tracing_disabled: 実行全体のトレーシングを無効化できます。
trace_include_sensitive_data: トレースに、LLM やツール呼び出しの入出力などの機微情報を含めるかを設定します。
workflow_name, trace_id, group_id: 実行のトレーシングにおけるワークフロー名、トレース ID、トレースグループ ID を設定します。少なくとも workflow_name の設定を推奨します。グループ ID は任意で、複数の実行にまたがるトレースを関連付けられます。
trace_metadata: すべてのトレースに含めるメタデータです。

会話/チャットスレッド

いずれの run メソッドの呼び出しでも、1 つ以上のエージェント（したがって 1 回以上の LLM 呼び出し）が実行される場合がありますが、チャット会話における 1 つの論理的なターンを表します。例:

ユーザーのターン: ユーザーがテキストを入力
Runner の実行: 最初のエージェントが LLM を呼び出し、ツールを実行し、2 番目のエージェントへハンドオフ。2 番目のエージェントがさらにツールを実行し、その後に出力を生成。

エージェントの実行が終わったら、ユーザーに何を表示するかを選べます。たとえば、エージェントが生成したすべての新しいアイテムを見せるか、最終出力だけを見せるかです。どちらの場合でも、ユーザーが追質問をするかもしれません。その場合は、再度 run メソッドを呼び出してください。

手動の会話管理

次のターンの入力を取得するために、RunResultBase.to_input_list() メソッドを使って、会話履歴を手動で管理できます。

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    thread_id = "thread_123"  # Example thread ID
    with trace(workflow_name="Conversation", group_id=thread_id):
        # First turn
        result = await Runner.run(agent, "What city is the Golden Gate Bridge in?")
        print(result.final_output)
        # San Francisco

        # Second turn
        new_input = result.to_input_list() + [{"role": "user", "content": "What state is it in?"}]
        result = await Runner.run(agent, new_input)
        print(result.final_output)
        # California

Sessions による自動会話管理

より簡単な方法として、Sessions を使用すると、.to_input_list() を手動で呼び出さなくても会話履歴を自動処理できます。

from agents import Agent, Runner, SQLiteSession

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    # Create session instance
    session = SQLiteSession("conversation_123")

    thread_id = "thread_123"  # Example thread ID
    with trace(workflow_name="Conversation", group_id=thread_id):
        # First turn
        result = await Runner.run(agent, "What city is the Golden Gate Bridge in?", session=session)
        print(result.final_output)
        # San Francisco

        # Second turn - agent automatically remembers previous context
        result = await Runner.run(agent, "What state is it in?", session=session)
        print(result.final_output)
        # California

Sessions は自動で次を行います。

各実行の前に会話履歴を取得
各実行の後に新しいメッセージを保存
セッション ID ごとに別々の会話を維持

詳細は Sessions のドキュメントを参照してください。

サーバー管理の会話

to_input_list() や Sessions でローカルに管理する代わりに、OpenAI の conversation state 機能にサーバー側で会話状態を管理させることもできます。これにより、過去のメッセージをすべて手動で再送せずに会話履歴を保持できます。詳しくは OpenAI Conversation state ガイドを参照してください。

OpenAI はターン間で状態を追跡する 2 つの方法を提供します。

1. `conversation_id` を使う

まず OpenAI Conversations API で会話を作成し、その ID を以降のすべての呼び出しで再利用します。

from agents import Agent, Runner
from openai import AsyncOpenAI

client = AsyncOpenAI()

async def main():
    # Create a server-managed conversation
    conversation = await client.conversations.create()
    conv_id = conversation.id    

    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    # First turn
    result1 = await Runner.run(agent, "What city is the Golden Gate Bridge in?", conversation_id=conv_id)
    print(result1.final_output)
    # San Francisco

    # Second turn reuses the same conversation_id
    result2 = await Runner.run(
        agent,
        "What state is it in?",
        conversation_id=conv_id,
    )
    print(result2.final_output)
    # California

2. `previous_response_id` を使う

もう 1 つの方法は、各ターンが前のターンのレスポンス ID に明示的にリンクする、レスポンスのチェイニング です。

from agents import Agent, Runner

async def main():
    agent = Agent(name="Assistant", instructions="Reply very concisely.")

    # First turn
    result1 = await Runner.run(agent, "What city is the Golden Gate Bridge in?")
    print(result1.final_output)
    # San Francisco

    # Second turn, chained to the previous response
    result2 = await Runner.run(
        agent,
        "What state is it in?",
        previous_response_id=result1.last_response_id,
    )
    print(result2.final_output)
    # California

長時間実行エージェントと human-in-the-loop

Agents SDK の Temporal 連携を使うと、human-in-the-loop を含む耐久性のある長時間実行ワークフローを実行できます。Temporal と Agents SDK が連携して長時間のタスクを完了するデモはこの動画を、ドキュメントはこちらをご覧ください。

例外

SDK は特定の場合に例外を送出します。完全な一覧は agents.exceptions にあります。概要は次のとおりです。

AgentsException: SDK 内で送出されるすべての例外の基底クラスです。他の特定の例外はすべてこの汎用型から派生します。
MaxTurnsExceeded: エージェントの実行が Runner.run、Runner.run_sync、Runner.run_streamed メソッドに渡された max_turns 制限を超えたときに送出されます。指定されたインタラクションのターン数内にタスクを完了できなかったことを示します。
ModelBehaviorError: 基盤のモデル (LLM) が予期しない、または無効な出力を生成したときに発生します。これには次が含まれます。
- 不正な JSON: 特定の output_type が定義されている場合に特に、ツール呼び出しや直接の出力で不正な JSON 構造を返したとき。
- 予期しないツール関連の失敗: モデルが期待どおりの方法でツールを使用できなかったとき。
UserError: SDK を使用する（コードを書く）あなたが、SDK の使用中にエラーを起こしたときに送出されます。これは通常、不正なコード実装、無効な設定、SDK の API の誤用に起因します。
InputGuardrailTripwireTriggered, OutputGuardrailTripwireTriggered: 入力ガードレールまたは出力ガードレールの条件が満たされたときに、それぞれ送出されます。入力ガードレールは処理前の受信メッセージを、出力ガードレールは配信前のエージェントの最終レスポンスを検査します。