Skip to main content
Open In ColabOpen on GitHub

如何创建工具

在构建一个 代理 时，您需要为其提供一个它可使用的 工具 列表。除了实际调用的函数外，工具还包含多个组件：

属性类型描述
namestrMust be unique within a set of tools provided to an LLM or agent.
descriptionstrDescribes what the tool does. Used as context by the LLM or agent.
args_schemapydantic.BaseModelOptional but recommended, and required if using callback handlers. It can be used to provide more information (e.g., few-shot examples) or validation for expected parameters.
return_directbooleanOnly relevant for agents. When True, after invoking the given tool, the agent will stop and return the result direcly to the user.

LangChain 支持从以下内容创建工具：

  1. 函数
  2. LangChain 可运行的;
  3. 通过从 BaseTool 继承——这是最灵活的方法，提供了最大的控制度，但需要更多的努力和代码。

从函数创建工具对于大多数用例来说可能已经足够，可以通过简单的 @tool 装饰器 实现。如果需要更多配置——例如，同时指定同步和异步实现——也可以使用 StructuredTool.from_function 类方法。

在本指南中，我们将概述这些方法。

提示

如果工具的名称、描述和 JSON 模式选择得当，模型的表现将会更好。

从函数创建工具​

@tool 装饰器​

这个 @tool 装饰器是定义自定义工具的最简单方法。该装饰器默认使用函数名称作为工具名称，但可以通过传入字符串作为第一个参数来覆盖。此外，装饰器会使用函数的文档字符串作为工具的描述——因此必须提供文档字符串。

from langchain_core.tools import tool


@tool
def multiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


# Let's inspect some of the attributes associated with the tool.
print(multiply.name)
print(multiply.description)
print(multiply.args)
API 参考：工具
multiply
Multiply two numbers.
{'a': {'title': 'A', 'type': 'integer'}, 'b': {'title': 'B', 'type': 'integer'}}

或者创建一个 异步 实现，如下所示：

from langchain_core.tools import tool


@tool
async def amultiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b
API 参考：工具

请注意，@tool 支持注解解析、嵌套模式和其他功能：

from typing import Annotated, List


@tool
def multiply_by_max(
    a: Annotated[int, "scale factor"],
    b: Annotated[List[int], "list of ints over which to take maximum"],
) -> int:
    """Multiply a by the maximum of b."""
    return a * max(b)


print(multiply_by_max.args_schema.model_json_schema())
{'description': 'Multiply a by the maximum of b.',
 'properties': {'a': {'description': 'scale factor',
   'title': 'A',
   'type': 'string'},
  'b': {'description': 'list of ints over which to take maximum',
   'items': {'type': 'integer'},
   'title': 'B',
   'type': 'array'}},
 'required': ['a', 'b'],
 'title': 'multiply_by_maxSchema',
 'type': 'object'}

您还可以通过将工具名称和 JSON 参数传递给工具装饰器来对其进行自定义。

from pydantic import BaseModel, Field


class CalculatorInput(BaseModel):
    a: int = Field(description="first number")
    b: int = Field(description="second number")


@tool("multiplication-tool", args_schema=CalculatorInput, return_direct=True)
def multiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


# Let's inspect some of the attributes associated with the tool.
print(multiply.name)
print(multiply.description)
print(multiply.args)
print(multiply.return_direct)
multiplication-tool
Multiply two numbers.
{'a': {'description': 'first number', 'title': 'A', 'type': 'integer'}, 'b': {'description': 'second number', 'title': 'B', 'type': 'integer'}}
True

文档字符串解析​

@tool 可选择解析 Google 风格的文档字符串，并将文档字符串的各个部分（如参数描述）与工具模式的相关部分关联起来。要切换此行为，请指定 parse_docstring：

@tool(parse_docstring=True)
def foo(bar: str, baz: int) -> str:
    """The foo.

    Args:
        bar: The bar.
        baz: The baz.
    """
    return bar


print(foo.args_schema.model_json_schema())
{'description': 'The foo.',
 'properties': {'bar': {'description': 'The bar.',
   'title': 'Bar',
   'type': 'string'},
  'baz': {'description': 'The baz.', 'title': 'Baz', 'type': 'integer'}},
 'required': ['bar', 'baz'],
 'title': 'fooSchema',
 'type': 'object'}
注意

默认情况下，如果文档字符串无法正确解析，@tool(parse_docstring=True) 将引发 ValueError。详细信息和示例请参阅 API 参考。

StructuredTool​

StructuredTool.from_function 类方法比 @tool 装饰器提供了更多的配置选项，且无需额外编写太多代码。

from langchain_core.tools import StructuredTool


def multiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


async def amultiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


calculator = StructuredTool.from_function(func=multiply, coroutine=amultiply)

print(calculator.invoke({"a": 2, "b": 3}))
print(await calculator.ainvoke({"a": 2, "b": 5}))
API 参考：StructuredTool
6
10

配置它：

class CalculatorInput(BaseModel):
    a: int = Field(description="first number")
    b: int = Field(description="second number")


def multiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


calculator = StructuredTool.from_function(
    func=multiply,
    name="Calculator",
    description="multiply numbers",
    args_schema=CalculatorInput,
    return_direct=True,
    # coroutine= ... <- you can specify an async method if desired as well
)

print(calculator.invoke({"a": 2, "b": 3}))
print(calculator.name)
print(calculator.description)
print(calculator.args)
6
Calculator
multiply numbers
{'a': {'description': 'first number', 'title': 'A', 'type': 'integer'}, 'b': {'description': 'second number', 'title': 'B', 'type': 'integer'}}

从可运行对象创建工具​

LangChain 可运行的 接受字符串或 dict 输入的组件可以使用 as_tool 方法转换为工具，从而允许指定名称、描述以及参数的额外模式信息。

使用示例：

from langchain_core.language_models import GenericFakeChatModel
from langchain_core.output_parsers import StrOutputParser
from langchain_core.prompts import ChatPromptTemplate

prompt = ChatPromptTemplate.from_messages(
    [("human", "Hello. Please respond in the style of {answer_style}.")]
)

# Placeholder LLM
llm = GenericFakeChatModel(messages=iter(["hello matey"]))

chain = prompt | llm | StrOutputParser()

as_tool = chain.as_tool(
    name="Style responder", description="Description of when to use tool."
)
as_tool.args
/var/folders/4j/2rz3865x6qg07tx43146py8h0000gn/T/ipykernel_95770/2548361071.py:14: LangChainBetaWarning: This API is in beta and may change in the future.
  as_tool = chain.as_tool(
{'answer_style': {'title': 'Answer Style', 'type': 'string'}}

查看 此指南 以了解更多信息。

继承 BaseTool​

您可以通过从 BaseTool 继承来定义一个自定义工具。这提供了对工具定义的最大控制，但需要编写更多的代码。

from typing import Optional

from langchain_core.callbacks import (
    AsyncCallbackManagerForToolRun,
    CallbackManagerForToolRun,
)
from langchain_core.tools import BaseTool
from langchain_core.tools.base import ArgsSchema
from pydantic import BaseModel, Field


class CalculatorInput(BaseModel):
    a: int = Field(description="first number")
    b: int = Field(description="second number")


# Note: It's important that every field has type hints. BaseTool is a
# Pydantic class and not having type hints can lead to unexpected behavior.
class CustomCalculatorTool(BaseTool):
    name: str = "Calculator"
    description: str = "useful for when you need to answer questions about math"
    args_schema: Optional[ArgsSchema] = CalculatorInput
    return_direct: bool = True

    def _run(
        self, a: int, b: int, run_manager: Optional[CallbackManagerForToolRun] = None
    ) -> int:
        """Use the tool."""
        return a * b

    async def _arun(
        self,
        a: int,
        b: int,
        run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
    ) -> int:
        """Use the tool asynchronously."""
        # If the calculation is cheap, you can just delegate to the sync implementation
        # as shown below.
        # If the sync calculation is expensive, you should delete the entire _arun method.
        # LangChain will automatically provide a better implementation that will
        # kick off the task in a thread to make sure it doesn't block other async code.
        return self._run(a, b, run_manager=run_manager.get_sync())
multiply = CustomCalculatorTool()
print(multiply.name)
print(multiply.description)
print(multiply.args)
print(multiply.return_direct)

print(multiply.invoke({"a": 2, "b": 3}))
print(await multiply.ainvoke({"a": 2, "b": 3}))
Calculator
useful for when you need to answer questions about math
{'a': {'description': 'first number', 'title': 'A', 'type': 'integer'}, 'b': {'description': 'second number', 'title': 'B', 'type': 'integer'}}
True
6
6

如何创建异步工具​

LangChain 工具实现了 可运行接口 🏃。

所有可运行对象都暴露了 invoke 和 ainvoke 方法（以及其他方法，如 batch、abatch、astream 等）。

即使您仅提供工具的 sync 实现，仍然可以使用 ainvoke 接口，但有几点重要事项需要注意：

  • LangChain 默认提供一个异步实现，该实现假设函数的计算成本较高，因此会将执行任务委派给另一个线程。
  • 如果你在使用异步代码库，应创建异步工具而非同步工具，以避免因线程切换带来的微小开销。
  • 如果您需要同步和异步两种实现方式，请使用 StructuredTool.from_function 或从 BaseTool 继承子类。
  • 如果同时实现同步和异步，且同步代码的执行速度很快，请覆盖 LangChain 默认的异步实现，直接调用同步代码。
  • 您不能且不应将同步 invoke 与 async 工具一起使用。
from langchain_core.tools import StructuredTool


def multiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


calculator = StructuredTool.from_function(func=multiply)

print(calculator.invoke({"a": 2, "b": 3}))
print(
    await calculator.ainvoke({"a": 2, "b": 5})
)  # Uses default LangChain async implementation incurs small overhead
API 参考：StructuredTool
6
10
from langchain_core.tools import StructuredTool


def multiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


async def amultiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


calculator = StructuredTool.from_function(func=multiply, coroutine=amultiply)

print(calculator.invoke({"a": 2, "b": 3}))
print(
    await calculator.ainvoke({"a": 2, "b": 5})
)  # Uses use provided amultiply without additional overhead
API 参考：StructuredTool
6
10

在仅提供异步定义时，你不应且不能使用 .invoke。

@tool
async def multiply(a: int, b: int) -> int:
    """Multiply two numbers."""
    return a * b


try:
    multiply.invoke({"a": 2, "b": 3})
except NotImplementedError:
    print("Raised not implemented error. You should not be doing this.")
Raised not implemented error. You should not be doing this.

处理工具错误​

如果你使用工具与代理，可能需要一个错误处理策略，以便代理在发生错误时能够恢复并继续执行。

一种简单的策略是在工具内部抛出 ToolException，并使用 handle_tool_error 指定一个错误处理程序。

当指定了错误处理程序时，异常将被捕获，错误处理程序将决定从工具返回哪个输出。

您可以设置 handle_tool_error 到 True 之间的值、一个字符串值，或一个函数。如果是一个函数，则该函数应接受一个 ToolException 作为参数并返回一个值。

请注意，仅将 ToolException 提高是无效的。您需要先将工具的 handle_tool_error 设置为某个值，因为其默认值是 False。

from langchain_core.tools import ToolException


def get_weather(city: str) -> int:
    """Get weather for the given city."""
    raise ToolException(f"Error: There is no city by the name of {city}.")
API 参考：ToolException

这是默认 handle_tool_error=True 行为的一个示例。

get_weather_tool = StructuredTool.from_function(
    func=get_weather,
    handle_tool_error=True,
)

get_weather_tool.invoke({"city": "foobar"})
'Error: There is no city by the name of foobar.'

我们可以将 handle_tool_error 设置为一个始终会被返回的字符串。

get_weather_tool = StructuredTool.from_function(
    func=get_weather,
    handle_tool_error="There is no such city, but it's probably above 0K there!",
)

get_weather_tool.invoke({"city": "foobar"})
"There is no such city, but it's probably above 0K there!"

使用函数处理错误：

def _handle_error(error: ToolException) -> str:
    return f"The following errors occurred during tool execution: `{error.args[0]}`"


get_weather_tool = StructuredTool.from_function(
    func=get_weather,
    handle_tool_error=_handle_error,
)

get_weather_tool.invoke({"city": "foobar"})
'The following errors occurred during tool execution: `Error: There is no city by the name of foobar.`'

返回工具执行的结果​

有时，工具执行过程中会产生一些我们希望传递给链或代理中下游组件的产物，但又不希望直接暴露给模型本身。例如，如果一个工具返回自定义对象（如文档），我们可能希望将该输出的某个视图或元数据传递给模型，而无需将原始输出直接传给模型。同时，我们可能还需要在其他地方（例如下游工具）访问完整的输出。

工具和 ToolMessage 接口使得能够区分工具输出中供模型使用的部分（这是 ToolMessage.content）以及供模型外部使用的部分（ToolMessage.artifact）。

需要 langchain-core >= 0.2.19

此功能已在 langchain-core == 0.2.19 版本中添加。请确保您的包已更新至最新版本。

如果我们希望工具能够区分消息内容和其他内容，我们在定义工具时需要指定 response_format="content_and_artifact"，并确保返回一个包含 (内容, 其他内容) 的元组：

import random
from typing import List, Tuple

from langchain_core.tools import tool


@tool(response_format="content_and_artifact")
def generate_random_ints(min: int, max: int, size: int) -> Tuple[str, List[int]]:
    """Generate size random ints in the range [min, max]."""
    array = [random.randint(min, max) for _ in range(size)]
    content = f"Successfully generated array of {size} random ints in [{min}, {max}]."
    return content, array
API 参考：工具

如果我们直接使用工具参数调用工具，我们将只得到输出的内容部分：

generate_random_ints.invoke({"min": 0, "max": 9, "size": 10})
'Successfully generated array of 10 random ints in [0, 9].'

如果我们使用 ToolCall（如工具调用模型生成的那些）调用工具，将返回一个包含工具生成的内容和成果物的 ToolMessage：

generate_random_ints.invoke(
    {
        "name": "generate_random_ints",
        "args": {"min": 0, "max": 9, "size": 10},
        "id": "123",  # required
        "type": "tool_call",  # required
    }
)
ToolMessage(content='Successfully generated array of 10 random ints in [0, 9].', name='generate_random_ints', tool_call_id='123', artifact=[4, 8, 2, 4, 1, 0, 9, 5, 8, 1])

当我们继承 BaseTool 时，也可以做同样的事情：

from langchain_core.tools import BaseTool


class GenerateRandomFloats(BaseTool):
    name: str = "generate_random_floats"
    description: str = "Generate size random floats in the range [min, max]."
    response_format: str = "content_and_artifact"

    ndigits: int = 2

    def _run(self, min: float, max: float, size: int) -> Tuple[str, List[float]]:
        range_ = max - min
        array = [
            round(min + (range_ * random.random()), ndigits=self.ndigits)
            for _ in range(size)
        ]
        content = f"Generated {size} floats in [{min}, {max}], rounded to {self.ndigits} decimals."
        return content, array

    # Optionally define an equivalent async method

    # async def _arun(self, min: float, max: float, size: int) -> Tuple[str, List[float]]:
    #     ...
API 参考：BaseTool
rand_gen = GenerateRandomFloats(ndigits=4)

rand_gen.invoke(
    {
        "name": "generate_random_floats",
        "args": {"min": 0.1, "max": 3.3333, "size": 3},
        "id": "123",
        "type": "tool_call",
    }
)
ToolMessage(content='Generated 3 floats in [0.1, 3.3333], rounded to 4 decimals.', name='generate_random_floats', tool_call_id='123', artifact=[1.5566, 0.5134, 2.7914])