Skip to main content
Open on GitHub

工具

先决条件

概览​

LangChain中的工具抽象将Python的函数与一个模式关联起来，该模式定义了函数的名称、描述和预期参数。

工具 可以传递给支持 工具调用 的 聊天模型，使模型能够请求执行特定函数并提供特定输入。

核心概念​

  • 工具是一种将函数及其模式封装起来的方式，以便传递给聊天模型。
  • 使用 LangChain 创建工具@tool装饰器，可简化工具创建过程，支持以下功能：
    • 自动推断工具的 名称、描述 和 预期参数，同时支持自定义。
    • 定义返回成果（例如图像、数据框等）的工具
    • 使用注入工具参数从模式（从而从模型）中隐藏输入参数。

工具接口​

工具接口在 BaseTool 类中定义，该类是 Runnable Interface 类的子类。

与工具的 模式 对应的关键属性：

  • 名称: 工具的名称。
  • 描述: 该工具功能的描述。
  • args: 返回工具参数 JSON 模式的属性。

执行与 工具 关联函数的关键方法：

使用 @tool 装饰器创建工具​

推荐的创建工具的方式是使用 @tool 装饰器。此装饰器旨在简化工具创建过程，在大多数情况下都应使用它。定义函数后，你可以用 @tool 装饰器来创建一个实现 Tool Interface 工具接口的工具。

from langchain_core.tools import tool

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

有关如何创建工具的更多详细信息，请参阅 如何创建自定义工具 指南。

笔记

LangChain 有几种其他方式来创建工具；例如，通过继承 BaseTool 类或使用 StructuredTool。这些方法在 如何创建自定义工具指南 中有所展示，但 我们通常建议在大多数情况下使用 @tool 装饰器。

直接使用该工具​

定义工具后，你可以通过调用函数直接使用它。例如，使用上面定义的 multiply 工具：

multiply.invoke({"a": 2, "b": 3})

检查​

你还可以检查工具的模式和其他属性：

print(multiply.name) # multiply
print(multiply.description) # Multiply two numbers.
print(multiply.args) 
# {
# 'type': 'object', 
# 'properties': {'a': {'type': 'integer'}, 'b': {'type': 'integer'}}, 
# 'required': ['a', 'b']
# }
笔记

如果您正在使用预构建的 LangChain 或 LangGraph 组件（例如 create_react_agent），可能不需要直接与工具交互。然而，了解如何使用它们对于调试和测试来说是有价值的。此外，在构建自定义的 LangGraph 工作流时，您可能会发现直接操作工具是必要的。

配置模式​

@tool 装饰器提供了额外的选项来配置工具的模式（例如，修改名称、描述，或解析函数的文档字符串以推断模式）。

请参阅 @tool 的 API 参考 以获取更多详细信息，并查看 如何创建自定义工具 指南以了解示例。

工具构件​

工具 是模型可以调用的实用程序，其输出旨在反馈给模型。然而，有时在工具执行过程中会产生一些我们希望下游组件或代理访问的产物，但又不希望向模型暴露的内容。例如，如果一个工具返回的是自定义对象、数据框或图像，我们可能希望将有关此输出的一些元数据传递给模型，而不将实际输出传递给模型。同时，我们可能还希望能够在其他地方（例如在下游工具中）访问此完整输出。

@tool(response_format="content_and_artifact")
def some_tool(...) -> Tuple[str, Any]:
    """Tool that does something."""
    ...
    return 'Message for chat model', some_artifact

查看 如何从工具返回工件 以获取更多详细信息。

特殊类型注解​

在工具函数签名中可以使用多种特殊类型注解，以配置该工具的运行时行为。

以下类型注解将导致该参数从工具的模式中移除。这对于不应向模型暴露且模型无法控制的参数非常有用。

  • InjectedToolArg: 值应在运行时使用 .invoke 或 .ainvoke 手动注入。
  • RunnableConfig: 将 RunnableConfig 对象传递给工具。
  • InjectedState: 将 LangGraph 图的总体状态传递给工具。
  • InjectedStore: 将 LangGraph 存储对象传递给工具。

您还可以使用 Annotated 类型配合字符串字面量，为相应的参数提供一个 描述，该描述 将 在工具的模式中暴露出来。

  • Annotated[..., "string literal"] -- 为将暴露在工具模式中的参数添加描述。

InjectedToolArg​

在某些情况下，某些参数需要在运行时传递给工具，但不应由模型自动生成。为此，我们使用 InjectedToolArg 注解，这允许某些参数从工具的模式中隐藏。

例如，如果某个工具需要在运行时动态注入一个 user_id，可以按这种方式进行结构化：

from langchain_core.tools import tool, InjectedToolArg

@tool
def user_specific_tool(input_data: str, user_id: InjectedToolArg) -> str:
    """Tool that processes input data."""
    return f"User {user_id} processed {input_data}"
API 参考：工具 |InjectedToolArg

使用 InjectedToolArg 标注 user_id 参数表示 LangChain 不应将此参数作为工具模式的一部分暴露。

查看 如何向工具传递运行时值 以了解如何使用 InjectedToolArg 的更多详情。

RunnableConfig​

您可以使用 RunnableConfig 对象将自定义运行时值传递给工具。

如果您需要在工具内部访问 RunnableConfig 对象。可以通过在工具函数签名中使用 RunnableConfig 注解来实现。

from langchain_core.runnables import RunnableConfig

@tool
async def some_func(..., config: RunnableConfig) -> ...:
    """Tool that does something."""
    # do something with config
    ...

await some_func.ainvoke(..., config={"configurable": {"value": "some_value"}})
API 参考：RunnableConfig

config 将不会包含在工具的模式中，并将在运行时注入适当的值。

笔记

您可能需要访问 config 对象，以手动将其传播到子类。如果您在 异步 环境中使用 Python 3.9 / 3.10，并且需要手动将 config 对象传播到子调用，则会发生这种情况。

请阅读 Propagation RunnableConfig 以了解如何手动将 RunnableConfig 传播到调用链中（或升级到 Python 3.11，此时此问题不再存在）。

InjectedState​

请参阅 InjectedState 文档以了解更多信息。

InjectedStore​

请参阅 InjectedStore 文档以获取更多详细信息。

最佳实践​

在设计供模型使用的工具时，请牢记以下几点：

  • 命名恰当、文档正确且类型提示完善的工具，更易于模型使用。
  • 设计简单且范围狭窄的工具，因为它们更易于模型正确使用。
  • 使用支持 工具调用 API 的聊天模型来利用工具。

工具包​

LangChain有一个名为工具包的概念。这是一个非常简单的抽象，它将一组设计用于特定任务的工具组合在一起。

界面​

所有工具包都暴露了一个 get_tools 方法，该方法返回一个工具列表。 因此你可以这样做：

# Initialize a toolkit
toolkit = ExampleTookit(...)

# Get list of tools
tools = toolkit.get_tools()

有关更多信息，请参阅以下资源：