クイックスタート
プロジェクトと仮想環境の作成
これは一度だけ行えば十分です。
仮想環境の有効化
新しいターミナルセッションを開始するたびに行います。
macOS または Linux の場合:
Windows の場合:
Agents SDK のインストール
OpenAI API キーの設定
まだ持っていない場合は、こちらの手順に従って OpenAI API キーを作成してください。
これらのコマンドは、現在のターミナルセッションにキーを設定します。
macOS または Linux の場合:
Windows PowerShell の場合:
Windows Command Prompt の場合:
最初のエージェントの作成
エージェントは、instructions、名前、特定のモデルなどの任意の設定で定義されます。
from agents import Agent
agent = Agent(
name="History Tutor",
instructions="You answer history questions clearly and concisely.",
)
最初のエージェントの実行
Runner を使用してエージェントを実行し、RunResult を受け取ります。
import asyncio
from agents import Agent, Runner
agent = Agent(
name="History Tutor",
instructions="You answer history questions clearly and concisely.",
)
async def main():
result = await Runner.run(agent, "When did the Roman Empire fall?")
print(result.final_output)
if __name__ == "__main__":
asyncio.run(main())
2 ターン目では、result.to_input_list() を Runner.run(...) に渡し戻すか、session をアタッチするか、conversation_id / previous_response_id で OpenAI のサーバー管理状態を再利用できます。エージェントの実行ガイドでは、これらのアプローチを比較しています。
目安として、次のルールを使用してください。
| したいこと... | まず使うもの... |
|---|---|
| 完全な手動制御とプロバイダー非依存の履歴 | result.to_input_list() |
| SDK に履歴の読み込みと保存を任せる | session=... |
| OpenAI が管理するサーバー側の継続 | previous_response_id または conversation_id |
トレードオフと正確な動作については、エージェントの実行を参照してください。
タスクが主にプロンプト、ツール、会話状態で完結する場合は、通常の Agent と Runner を使用してください。エージェントが分離されたワークスペース内の実ファイルを検査または変更する必要がある場合は、Sandbox エージェントクイックスタートに進んでください。
エージェントへのツールの付与
エージェントにツールを与えて、情報を検索したりアクションを実行したりできます。
import asyncio
from agents import Agent, Runner, function_tool
@function_tool
def history_fun_fact() -> str:
"""Return a short history fact."""
return "Sharks are older than trees."
agent = Agent(
name="History Tutor",
instructions="Answer history questions clearly. Use history_fun_fact when it helps.",
tools=[history_fun_fact],
)
async def main():
result = await Runner.run(
agent,
"Tell me something surprising about ancient life on Earth.",
)
print(result.final_output)
if __name__ == "__main__":
asyncio.run(main())
さらにいくつかのエージェントの追加
マルチエージェントパターンを選ぶ前に、最終回答を誰が担当すべきかを決めます。
- ハンドオフ: スペシャリストがそのターンの該当部分について会話を引き継ぎます。
- Agents as tools: オーケストレーターが制御を維持し、スペシャリストをツールとして呼び出します。
このクイックスタートでは、最初の例として最も短い ハンドオフ を続けます。マネージャースタイルのパターンについては、エージェントオーケストレーション と ツール: Agents as tools を参照してください。
追加のエージェントも同じ方法で定義できます。handoff_description は、ルーティングエージェントに委任すべきタイミングについて追加のコンテキストを提供します。
from agents import Agent
history_tutor_agent = Agent(
name="History Tutor",
handoff_description="Specialist agent for historical questions",
instructions="You answer history questions clearly and concisely.",
)
math_tutor_agent = Agent(
name="Math Tutor",
handoff_description="Specialist agent for math questions",
instructions="You explain math step by step and include worked examples.",
)
ハンドオフの定義
エージェントでは、タスクの解決中に選択できる送信ハンドオフオプションの一覧を定義できます。
triage_agent = Agent(
name="Triage Agent",
instructions="Route each homework question to the right specialist.",
handoffs=[history_tutor_agent, math_tutor_agent],
)
エージェントオーケストレーションの実行
Runner は、個々のエージェントの実行、ハンドオフ、およびツール呼び出しを処理します。
import asyncio
from agents import Runner
async def main():
result = await Runner.run(
triage_agent,
"Who was the first president of the United States?",
)
print(result.final_output)
print(f"Answered by: {result.last_agent.name}")
if __name__ == "__main__":
asyncio.run(main())
参考コード例
リポジトリには、同じ中核パターンの完全なスクリプトが含まれています。
examples/basic/hello_world.pyは最初の実行用です。examples/basic/tools.pyは関数ツール用です。examples/agent_patterns/routing.pyはマルチエージェントルーティング用です。
トレースの表示
エージェントの実行中に何が起きたかを確認するには、OpenAI Dashboard の Trace viewerに移動して、エージェント実行のトレースを表示します。
次のステップ
より複雑なエージェント的フローを構築する方法を学びます。