Skip to main content
Open In ColabOpen on GitHub

如何创建工具

在构建代理时,您需要为其提供一系列可以使用的工具。除了实际调用的函数外,工具还包括几个组件:

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

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

  1. 函数;
  2. LangChain Runnables;
  3. 通过从BaseTool子类化——这是最灵活的方法,它提供了最大程度的控制,但需要更多的努力和代码。

从函数创建工具可能足以满足大多数用例,并且可以通过简单的@tool 装饰器完成。如果需要更多配置——例如,同步和异步实现的规范——也可以使用StructuredTool.from_function类方法。

在本指南中,我们提供了这些方法的概述。

tip

如果工具的名称、描述和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 Reference: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 Reference:tool

请注意,@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'}
caution

默认情况下,@tool(parse_docstring=True) 如果文档字符串解析不正确,将会引发 ValueError。详情和示例请参见 API Reference

结构化工具

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 Reference: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'}}

从Runnables创建工具

LangChain Runnables 接受字符串或 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, 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: 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 接口 🏃

所有Runnables都暴露了invokeainvoke方法(以及其他方法如batchabatchastream等)。

所以即使你只提供了一个工具的sync实现,你仍然可以使用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 Reference: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 Reference: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 Reference: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)成为可能。

Requires 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 Reference:tool

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

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 Reference: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])

这个页面有帮助吗?