如何使用模型调用工具 #
先决条件
本教程假定您对以下概念有一定了解:
工具调用允许聊天模型通过“调用工具”来回应给定的提示。
请记住,虽然“工具调用”这个名称暗示模型直接执行某个操作,但实际情况并非如此!模型只生成工具的参数,而真正运行工具(或者不运行)则由用户决定。
工具调用是一种通用技术,可以从模型生成结构化输出,即使您不打算调用任何工具,也可以使用它。一个例子是从非结构化文本中提取信息。
如果您想了解如何使用模型生成的工具调用来实际运行工具,请查看此指南。
支持的模型
工具调用并不是通用的,但许多流行的LLM提供商支持它。您可以在这里找到所有支持工具调用的模型列表。
LangChain 实现了用于定义工具、将其传递给 LLM 和表示工具调用的标准接口。本指南将介绍如何将工具绑定到 LLM,然后调用 LLM 生成这些参数。
定义tool schemas #
为了让模型能够调用工具,我们需要传入描述工具功能及其参数的tool schemas。支持工具调用功能的聊天模型实现了一个 .bind_tools()
方法,用于将tool schemas 传递给模型。tool schemas 可以以 Python 函数(带有类型提示和文档字符串)、Pydantic模型、TypedDict 类或 LangChain Tool 对象的形式传入。模型的后续调用将会将这些tool schemas与prompt一起传入。
Python functions #
我们的tool schemas可以是 Python 函数:
1# The function name, type hints, and docstring are all part of the tool
2# schema that's passed to the model. Defining good, descriptive schemas
3# is an extension of prompt engineering and is an important part of
4# getting models to perform well.
5def add(a: int, b: int) -> int:
6 """Add two integers.
7
8 Args:
9 a: First integer
10 b: Second integer
11 """
12 return a + b
13
14
15def multiply(a: int, b: int) -> int:
16 """Multiply two integers.
17
18 Args:
19 a: First integer
20 b: Second integer
21 """
22 return a * b
LangChain Tool #
LangChain还实现了一个 @tool
装饰器,它允许对工具模式进行更进一步的控制,比如工具名称和参数描述。详情请参阅这里的使用指南。
Pydantic class #
您可以使用 Pydantic 以同等方式定义tool schemas,而无需附带函数。
请注意,除非提供默认值,否则所有字段都是 required
(必需的)。
1from pydantic import BaseModel, Field
2
3
4class add(BaseModel):
5 """Add two integers."""
6
7 a: int = Field(..., description="First integer")
8 b: int = Field(..., description="Second integer")
9
10
11class multiply(BaseModel):
12 """Multiply two integers."""
13
14 a: int = Field(..., description="First integer")
15 b: int = Field(..., description="Second integer")
TypedDict class #
或者使用TypedDict和注解(annotations):
Requires langchain-core>=0.2.25
1from typing_extensions import Annotated, TypedDict
2
3
4class add(TypedDict):
5 """Add two integers."""
6
7 # Annotations must have the type and can optionally include a default value and description (in that order).
8 a: Annotated[int, ..., "First integer"]
9 b: Annotated[int, ..., "Second integer"]
10
11
12class multiply(TypedDict):
13 """Multiply two integers."""
14
15 a: Annotated[int, ..., "First integer"]
16 b: Annotated[int, ..., "Second integer"]
17
18
19tools = [add, multiply]
Tool calls #
要实际将这些schemas绑定到聊天模型,我们将使用 .bind_tools()
方法。这个方法会处理将 add
和 multiply
schemas转换为模型所需的正确格式。之后,每次调用模型时都会传入tool schemas。
1pip install -qU langchain-openai
1from langchain_openai import ChatOpenAI
2model = ChatOpenAI(model=MODEL_NAME)
1model_with_tools = model.bind_tools(tools)
2query = "What is 3 * 12?"
3model_with_tools.invoke(query)
1AIMessage(content='', additional_kwargs={'tool_calls': [{'id': 'call_iXj4DiW1p7WLjTAQMRO0jxMs', 'function': {'arguments': '{"a":3,"b":12}', 'name': 'multiply'}, 'type': 'function'}], 'refusal': None}, response_metadata={'token_usage': {'completion_tokens': 17, 'prompt_tokens': 80, 'total_tokens': 97}, 'model_name': 'gpt-4o-mini-2024-07-18', 'system_fingerprint': 'fp_483d39d857', 'finish_reason': 'tool_calls', 'logprobs': None}, id='run-0b620986-3f62-4df7-9ba3-4595089f9ad4-0', tool_calls=[{'name': 'multiply', 'args': {'a': 3, 'b': 12}, 'id': 'call_iXj4DiW1p7WLjTAQMRO0jxMs', 'type': 'tool_call'}], usage_metadata={'input_tokens': 80, 'output_tokens': 17, 'total_tokens': 97})
我们可以看到,我们的大语言模型(LLM)为工具生成了参数!您可以查阅bind_tools()的文档,了解所有用于自定义LLM 选择工具的方法。此外,还可以参考这个指南,了解如何强制LLM 调用某个工具,而不是让它自行决定。
如果LLM响应中包含工具调用,它们将作为工具调用对象的列表附加到相应的消息messages或消息块 message chunk的.tool_calls
属性中。
请注意,聊天模型可以一次调用多个工具。
ToolCall
是一个包含工具名称、参数值字典和标识符(可选)的类型化字典。没有工具调用的消息默认为此属性的空列表。
1query = "What is 3 * 12? Also, what is 11 + 49?"
2
3model_with_tools.invoke(query).tool_calls
1[{'name': 'multiply',
2 'args': {'a': 3, 'b': 12},
3 'id': 'call_V7ffQum6fcItboyZOQQNQQw4',
4 'type': 'tool_call'},
5 {'name': 'add',
6 'args': {'a': 11, 'b': 49},
7 'id': 'call_YaMkDpKJBPpJyHGGUvnyIff7',
8 'type': 'tool_call'}]
.tool_calls
属性应包含有效的工具调用。请注意,有时,模型提供者可能会输出格式错误的工具调用(例如,不是有效 JSON 的参数)。当这些情况下解析失败时,InvalidToolCall的实例填充到.invalid_tool_calls
属性中。InvalidToolCall
可以具有名称、字符串参数、标识符和错误消息。
Parsing #
如需,输出解析器output parsers可以进一步处理输出。例如,我们可以使用PydanticToolsParser将填充在.tool_calls
上的现有值转换为Pydantic对象:
1from langchain_core.output_parsers import PydanticToolsParser
2from pydantic import BaseModel, Field
3
4
5class add(BaseModel):
6 """Add two integers."""
7
8 a: int = Field(..., description="First integer")
9 b: int = Field(..., description="Second integer")
10
11
12class multiply(BaseModel):
13 """Multiply two integers."""
14
15 a: int = Field(..., description="First integer")
16 b: int = Field(..., description="Second integer")
17
18
19chain = model | PydanticToolsParser(tools=[add, multiply])
20chain.invoke(query)
API Reference: PydanticToolsParser
1[multiply(a=3, b=12), add(a=11, b=49)]
下一步 #
现在您已经了解了如何将tool scheams绑定到聊天模型并让模型调用工具。
接下来,请查看本指南,了解如何通过调用函数并将结果返回给模型来实际使用工具:
您还可以查看一些更具体的工具调用用法: