跳至主要内容

如何创建工具

在构建代理时，你需要为它提供一个它可以使用的 Tool 列表。除了实际调用的函数外，Tool 还包含几个组件

属性类型描述
namestr在提供给 LLM 或代理的一组工具中必须是唯一的。
descriptionstr描述工具的功能。用作 LLM 或代理的上下文。
args_schemapydantic.BaseModel可选但推荐，如果使用回调处理程序，则必填。它可以用于提供更多信息（例如，少样本示例）或对预期参数进行验证。
return_directboolean仅与代理相关。当为 True 时，在调用给定的工具后，代理将停止并将结果直接返回给用户。

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 参考：tool
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

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

from typing import Annotated, List


@tool
def multiply_by_max(
    a: Annotated[str, "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)


multiply_by_max.args_schema.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


foo.args_schema.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'}}

从 Runnable 创建工具​

LangChain Runnable 接受字符串或 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, Type

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


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: Type[BaseModel] = CalculatorInput
    return_direct: bool = True

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

    async def _arun(
        self,
        a: int,
        b: int,
        run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
    ) -> str:
        """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 工具实现了 Runnable 接口 🏃。

所有 Runnable 都公开了 invoke 和 ainvoke 方法（以及其他方法，如 batch、abatch、astream 等）。

因此，即使您只提供工具的 同步 实现，您仍然可以使用 ainvoke 接口，但有一些重要事项需要注意

  • LangChain 默认情况下提供了一个异步实现，该实现假设该函数计算成本很高，因此它会将执行委托给另一个线程。
  • 如果您在异步代码库中工作，您应该创建异步工具而不是同步工具，以避免因该线程而产生少量开销。
  • 如果您需要同步和异步实现，请使用 StructuredTool.from_function 或从 BaseTool 子类化。
  • 如果您同时实现同步和异步，并且同步代码运行速度很快，请覆盖默认的 LangChain 异步实现，并简单地调用同步代码。
  • 您不能也不应该对 异步 工具使用同步 invoke。
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.`'

返回工具执行的工件​

有时，工具执行会有一些工件，我们希望将其提供给链或代理中的下游组件，但我们不想将其暴露给模型本身。例如，如果工具返回自定义对象（如文档），我们可能希望将有关此输出的某些视图或元数据传递给模型，而不会将原始输出传递给模型。同时，我们可能希望能够在其他地方访问此完整输出，例如在下游工具中。

Tool 和 ToolMessage 接口使得能够区分工具输出中专为模型设计的部分（即 ToolMessage.content）以及专为模型外部使用设计的那些部分（ToolMessage.artifact）。

需要 langchain-core >= 0.2.19

此功能是在 langchain-core == 0.2.19 中添加的。请确保您的软件包已更新。

如果我们希望工具区分消息内容和其他工件，我们需要在定义工具时指定 response_format="content_and_artifact"，并确保我们返回一个 (content, 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 参考：tool

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

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

如果我们使用 ToolCall（例如由调用工具的模型生成的 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])

此页面是否有帮助？


您也可以留下详细的反馈 在 GitHub 上.