ツール

ツールを使用すると、エージェントがデータ取得、コード実行、外部 API 呼び出し、さらにはコンピュータ操作などのアクションを実行できます。Agents SDK には以下の 3 種類のツールがあります。

ホスト型ツール：AI モデルと共に LLM サーバー上で実行されます。OpenAI は、検索、ウェブ検索、コンピュータ操作をホスト型ツール（OpenAI がホストするツール）として提供しています。
関数呼び出し：任意の Python 関数をツールとして使用できます。
エージェントをツールとして使用：エージェントをツールとして使用でき、エージェント間でハンドオフを行わずに他のエージェントを呼び出せます。

ホスト型ツール

[OpenAIResponsesModel][agents.models.openai_responses.OpenAIResponsesModel] を使用する場合、OpenAI はいくつかの組み込みツールを提供しています。

[WebSearchTool][agents.tool.WebSearchTool] は、エージェントがウェブ検索を行うためのツールです。
[FileSearchTool][agents.tool.FileSearchTool] は、OpenAI のベクトルストアから情報を取得するためのツールです。
[ComputerTool][agents.tool.ComputerTool] は、コンピュータ操作タスクを自動化するためのツールです。

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 のスタイルなどを上書き設定できます。
デコレータを付けた関数をツールのリストに渡すことができます。

??? note "クリックして出力を表示"

```
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][agents.tool.FunctionTool] を作成できます。作成時には以下を指定する必要があります：

name
description
引数の JSON スキーマを示す params_json_schema
非同期関数である on_invoke_tool（コンテキストと引数を 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,
)

引数とドックストリングの自動解析

前述の通り、関数のシグネチャを自動的に解析してツールのスキーマを抽出し、ドックストリングを解析してツールおよび各引数の説明を抽出します。これに関する注意点は以下の通りです：

シグネチャの解析は inspect モジュールを使用して行われます。型アノテーションを用いて引数の型を把握し、動的に Pydantic モデルを構築して全体のスキーマを表現します。Python の基本型（basic components）、Pydantic モデル、TypedDict など、ほとんどの型をサポートしています。
ドックストリングの解析には griffe を使用します。サポートされるドックストリング形式は google、sphinx、numpy です。ドックストリング形式は自動検出を試みますが、これはベストエフォートであり、function_tool 呼び出し時に明示的に指定することも可能です。また、use_docstring_info を False に設定することでドックストリングの解析を無効化できます。

スキーマ抽出のコードは [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)

関数ツールにおけるエラー処理

@function_tool を使用して関数ツールを作成する際、failure_error_function を渡すことができます。これはツール呼び出しがクラッシュした場合に、LLM にエラー応答を提供する関数です。

デフォルト（何も渡さない場合）では、エラーが発生したことを LLM に通知する default_tool_error_function が実行されます。
独自のエラー関数を渡した場合は、それが代わりに実行され、その応答が LLM に送信されます。
明示的に None を渡した場合、ツール呼び出しのエラーは再度発生（re-raise）し、自分で処理する必要があります。この場合、モデルが無効な JSON を生成した場合は ModelBehaviorError、コードがクラッシュした場合は UserError などが発生します。

手動で FunctionTool オブジェクトを作成する場合は、on_invoke_tool 関数内でエラーを処理する必要があります。

10 KiB Raw Blame History Unescape Escape

ツール