ツール
ツールは エージェント に行動を取らせます。たとえば、データの取得、コードの実行、外部 API の呼び出し、さらにはコンピュータの使用などです。Agents SDK には 3 つのツールのクラスがあります。
- ホスト型ツール: これらは LLM サーバー 上で AI モデルと並行して実行されます。OpenAI は リトリーバル (retrieval)、Web 検索、コンピュータ操作 をホスト型ツールとして提供します。
- Function calling: 任意の Python 関数をツールとして使用できます。
- ツールとしてのエージェント: エージェントをツールとして使用でき、ハンドオフ せずにエージェントが他の エージェント を呼び出せます。
ホスト型ツール
OpenAIResponsesModel
を使用する際、OpenAI はいくつかの組み込みツールを提供します:
WebSearchTool
は エージェント に Web を検索させます。FileSearchTool
は OpenAI ベクトルストア から情報を取得できます。ComputerTool
は コンピュータ操作 タスクを自動化します。CodeInterpreterTool
は LLM にサンドボックス環境でコードを実行させます。HostedMCPTool
はリモート MCP サーバー のツールをモデルに公開します。ImageGenerationTool
はプロンプトから画像を生成します。LocalShellTool
はあなたのマシン上でシェルコマンドを実行します。
from agents import Agent, FileSearchTool, Runner, WebSearchTool
agent = Agent(
name="Assistant",
tools=[
WebSearchTool(),
FileSearchTool(
max_num_results=3,
vector_store_ids=["VECTOR_STORE_ID"],
),
],
)
async def main():
result = await Runner.run(agent, "Which coffee shop should I go to, taking into account my preferences and the weather today in SF?")
print(result.final_output)
関数ツール
任意の Python 関数をツールとして使用できます。Agents SDK が自動的にツールをセットアップします:
- ツール名は Python 関数名になります(または任意の名前を指定できます)
- ツールの説明は関数の docstring から取得します(または任意の説明を指定できます)
- 関数入力のスキーマは関数の引数から自動生成されます
- 各入力の説明は、無効化しない限り関数の docstring から取得します
Python の inspect
モジュールで関数シグネチャを抽出し、griffe
で docstring を解析し、pydantic
でスキーマを作成します。
import json
from typing_extensions import TypedDict, Any
from agents import Agent, FunctionTool, RunContextWrapper, function_tool
class Location(TypedDict):
lat: float
long: float
@function_tool # (1)!
async def fetch_weather(location: Location) -> str:
# (2)!
"""Fetch the weather for a given location.
Args:
location: The location to fetch the weather for.
"""
# In real life, we'd fetch the weather from a weather API
return "sunny"
@function_tool(name_override="fetch_data") # (3)!
def read_file(ctx: RunContextWrapper[Any], path: str, directory: str | None = None) -> str:
"""Read the contents of a file.
Args:
path: The path to the file to read.
directory: The directory to read the file from.
"""
# In real life, we'd read the file from the file system
return "<file contents>"
agent = Agent(
name="Assistant",
tools=[fetch_weather, read_file], # (4)!
)
for tool in agent.tools:
if isinstance(tool, FunctionTool):
print(tool.name)
print(tool.description)
print(json.dumps(tool.params_json_schema, indent=2))
print()
- 関数の引数には任意の Python 型を使用でき、関数は同期・非同期どちらでも構いません。
- docstring があれば、説明や引数の説明の取得に使用します。
- 関数は任意で
context
を受け取れます(最初の引数である必要があります)。ツール名、説明、どの docstring スタイルを使うかなどの上書きも設定できます。 - デコレートした関数をツールのリストに渡せます。
出力を表示
fetch_weather
Fetch the weather for a given location.
{
"$defs": {
"Location": {
"properties": {
"lat": {
"title": "Lat",
"type": "number"
},
"long": {
"title": "Long",
"type": "number"
}
},
"required": [
"lat",
"long"
],
"title": "Location",
"type": "object"
}
},
"properties": {
"location": {
"$ref": "#/$defs/Location",
"description": "The location to fetch the weather for."
}
},
"required": [
"location"
],
"title": "fetch_weather_args",
"type": "object"
}
fetch_data
Read the contents of a file.
{
"properties": {
"path": {
"description": "The path to the file to read.",
"title": "Path",
"type": "string"
},
"directory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The directory to read the file from.",
"title": "Directory"
}
},
"required": [
"path"
],
"title": "fetch_data_args",
"type": "object"
}
カスタム関数ツール
Python 関数をツールとして使いたくない場合もあります。その場合は、直接 FunctionTool
を作成できます。次を指定する必要があります:
name
description
params_json_schema
(引数の JSON シェーマ)on_invoke_tool
(ToolContext
と JSON 文字列の引数を受け取り、ツールの出力を文字列で返す非同期関数)
from typing import Any
from pydantic import BaseModel
from agents import RunContextWrapper, FunctionTool
def do_some_work(data: str) -> str:
return "done"
class FunctionArgs(BaseModel):
username: str
age: int
async def run_function(ctx: RunContextWrapper[Any], args: str) -> str:
parsed = FunctionArgs.model_validate_json(args)
return do_some_work(data=f"{parsed.username} is {parsed.age} years old")
tool = FunctionTool(
name="process_user",
description="Processes extracted user data",
params_json_schema=FunctionArgs.model_json_schema(),
on_invoke_tool=run_function,
)
引数と docstring の自動解析
前述のとおり、ツールのスキーマを抽出するために関数シグネチャを自動解析し、ツールおよび各引数の説明を抽出するために docstring を解析します。補足事項:
- シグネチャの解析は
inspect
モジュールで行います。引数の型を型注釈から把握し、全体のスキーマを表す Pydantic モデルを動的に構築します。Python の基本型、Pydantic モデル、TypedDict など、ほとんどの型をサポートします。 - docstring の解析には
griffe
を使用します。対応する docstring 形式はgoogle
、sphinx
、numpy
です。docstring 形式は自動検出を試みますがベストエフォートであり、function_tool
呼び出し時に明示的に設定できます。use_docstring_info
をFalse
に設定して docstring 解析を無効化することもできます。
スキーマ抽出のコードは agents.function_schema
にあります。
ツールとしてのエージェント
一部のワークフローでは、ハンドオフ で制御を渡すのではなく、中央の エージェント が専門 エージェント 群のオーケストレーションを行いたい場合があります。エージェントをツールとしてモデリングすることで実現できます。
from agents import Agent, Runner
import asyncio
spanish_agent = Agent(
name="Spanish agent",
instructions="You translate the user's message to Spanish",
)
french_agent = Agent(
name="French agent",
instructions="You translate the user's message to French",
)
orchestrator_agent = Agent(
name="orchestrator_agent",
instructions=(
"You are a translation agent. You use the tools given to you to translate."
"If asked for multiple translations, you call the relevant tools."
),
tools=[
spanish_agent.as_tool(
tool_name="translate_to_spanish",
tool_description="Translate the user's message to Spanish",
),
french_agent.as_tool(
tool_name="translate_to_french",
tool_description="Translate the user's message to French",
),
],
)
async def main():
result = await Runner.run(orchestrator_agent, input="Say 'Hello, how are you?' in Spanish.")
print(result.final_output)
ツール化したエージェントのカスタマイズ
agent.as_tool
関数は、エージェントを簡単にツール化するためのユーティリティです。すべての設定をサポートするわけではありません。たとえば max_turns
は設定できません。高度なユースケースでは、ツール実装内で直接 Runner.run
を使用してください:
@function_tool
async def run_my_agent() -> str:
"""A tool that runs the agent with custom configs"""
agent = Agent(name="My agent", instructions="...")
result = await Runner.run(
agent,
input="...",
max_turns=5,
run_config=...
)
return str(result.final_output)
出力のカスタム抽出
場合によっては、中央の エージェント に返す前に ツール化したエージェント の出力を変更したいことがあります。これは次のような場合に有用です:
- サブエージェントのチャット履歴から特定の情報(例: JSON ペイロード)を抽出する。
- エージェントの最終回答を変換・再整形する(例: Markdown をプレーンテキストや CSV に変換)。
- エージェントの応答が欠落または不正な場合に、出力を検証したりフォールバック値を提供したりする。
これは as_tool
メソッドに custom_output_extractor
引数を渡すことで実現できます:
async def extract_json_payload(run_result: RunResult) -> str:
# Scan the agent’s outputs in reverse order until we find a JSON-like message from a tool call.
for item in reversed(run_result.new_items):
if isinstance(item, ToolCallOutputItem) and item.output.strip().startswith("{"):
return item.output.strip()
# Fallback to an empty JSON object if nothing was found
return "{}"
json_tool = data_agent.as_tool(
tool_name="get_data_json",
tool_description="Run the data agent and return only its JSON payload",
custom_output_extractor=extract_json_payload,
)
ツールの条件付き有効化
実行時に is_enabled
パラメーター を使って エージェント ツールを条件付きで有効・無効にできます。これにより、コンテキスト、ユーザーの嗜好、実行時の状況に基づいて、LLM に提供されるツールを動的にフィルタリングできます。
import asyncio
from agents import Agent, AgentBase, Runner, RunContextWrapper
from pydantic import BaseModel
class LanguageContext(BaseModel):
language_preference: str = "french_spanish"
def french_enabled(ctx: RunContextWrapper[LanguageContext], agent: AgentBase) -> bool:
"""Enable French for French+Spanish preference."""
return ctx.context.language_preference == "french_spanish"
# Create specialized agents
spanish_agent = Agent(
name="spanish_agent",
instructions="You respond in Spanish. Always reply to the user's question in Spanish.",
)
french_agent = Agent(
name="french_agent",
instructions="You respond in French. Always reply to the user's question in French.",
)
# Create orchestrator with conditional tools
orchestrator = Agent(
name="orchestrator",
instructions=(
"You are a multilingual assistant. You use the tools given to you to respond to users. "
"You must call ALL available tools to provide responses in different languages. "
"You never respond in languages yourself, you always use the provided tools."
),
tools=[
spanish_agent.as_tool(
tool_name="respond_spanish",
tool_description="Respond to the user's question in Spanish",
is_enabled=True, # Always enabled
),
french_agent.as_tool(
tool_name="respond_french",
tool_description="Respond to the user's question in French",
is_enabled=french_enabled,
),
],
)
async def main():
context = RunContextWrapper(LanguageContext(language_preference="french_spanish"))
result = await Runner.run(orchestrator, "How are you?", context=context.context)
print(result.final_output)
asyncio.run(main())
is_enabled
パラメーター は次を受け付けます:
- ** ブール値 ** : True
(常に有効)または False
(常に無効)
- ** 呼び出し可能関数 ** : (context, agent)
を受け取り真偽値を返す関数
- ** 非同期関数 ** : 複雑な条件ロジック用の async 関数
無効化されたツールは実行時に LLM から完全に隠されるため、次の用途に便利です: - ユーザー権限に基づく機能ゲーティング - 環境別のツール提供(dev と prod) - 異なるツール構成の A/B テスト - 実行時の状態に基づく動的ツールフィルタリング
関数ツールでのエラー処理
@function_tool
で関数ツールを作成する際、failure_error_function
を渡せます。これは、ツール呼び出しがクラッシュした場合に LLM へエラー応答を提供する関数です。
- 既定(すなわち何も渡さない場合)は、エラーが発生したことを LLM に伝える
default_tool_error_function
を実行します。 - 独自のエラー関数を渡した場合はそれが実行され、その応答が LLM に送信されます。
- 明示的に
None
を渡した場合、ツール呼び出しのエラーは再スローされ、あなたが処理する必要があります。モデルが不正な JSON を生成した場合はModelBehaviorError
、あなたのコードがクラッシュした場合はUserError
などになり得ます。
from agents import function_tool, RunContextWrapper
from typing import Any
def my_custom_error_function(context: RunContextWrapper[Any], error: Exception) -> str:
"""A custom function to provide a user-friendly error message."""
print(f"A tool call failed with the following error: {error}")
return "An internal server error occurred. Please try again later."
@function_tool(failure_error_function=my_custom_error_function)
def get_user_profile(user_id: str) -> str:
"""Fetches a user profile from a mock API.
This function demonstrates a 'flaky' or failing API call.
"""
if user_id == "user_123":
return "User profile for user_123 successfully retrieved."
else:
raise ValueError(f"Could not retrieve profile for user_id: {user_id}. API returned an error.")
FunctionTool
オブジェクトを手動で作成する場合は、on_invoke_tool
関数内でエラーを処理する必要があります。