一 LangChain 自定義工具概述

• LangChain提供了一套工具、組件和接口，可簡化創建由大型語言模型(LLM)和聊天模型提供支持的應用程序的過程。
• 在構建智能代理時，為其提供合適的工具是確保其強大功能的關鍵，LangChain作為一個支持創建和管理工具的框架，能讓開發者以模塊化方式擴展代理的能力。

---

• 當構建代理時，需要為其提供一組工具列表，代理可以使用這些工具。除了調用的實際函數之外，工具由幾個組件組成：
  • name(str)是必需的，并且在提供給代理的工具集中必須是唯一的；
  • description(str)是可選的但建議的，因為代理使用它來確定工具的使用方式；
  • return_direct(bool)默認為False；
  • args_schema(PydanticBaseModel)是可選的但建議的，可以用于提供更多信息或用于驗證預期參數。

二創建自定義工具的三種方法

• LangChain為開發人員提供了不同的方式來創建工具，這些工具可以被智能代理或語言模型調用。
  • 第一種方法是使用@tool裝飾器(定義自定義工具的最簡單方法)；
  • 第二種方法是使用StructuredTool類，允許更細粒度的配置而無需過多的代碼；
  • 第三種方法是基于BaseTool類構造子類顯式自定義工具，工具定義提供最大限度的把控，但需要做更多的工作。

2.1 方法一：@tool 裝飾器

• 使用@tool修飾符是自定義工具最簡單的方法。默認情況下修飾符用函數的名字作為工具名稱，但傳字符串作為第一個參數可以重命名工具名稱。例如，可以創建一個總是返回字符串"LangChain"的虛構搜索函數，或者將兩個數字相乘的乘法函數。這些函數最大的區別是第一個函數只有一個輸入，第二個函數需要多個輸入。

---

2.1.1 同步方法案例

from langchain_core.tools import tool
@tool
def multiply(a:int,b:int)->int:"""Multiply two numbers"""return a*bprint(multiply.name) # multiply
print(multiply.description) # Multiply two numbers
print(multiply.args) # {'a': {'title': 'A', 'type': 'integer'}, 'b': {'title': 'B', 'type': 'integer'}}

---

2.1.2 工具描述方式1：傳參

• 通過將工具名稱和 JSON 參數傳遞給工具裝飾器進行自定義

from langchain_core.tools import tool
from pydantic import BaseModel, Fieldclass CalculatorInput(BaseModel):a: int = Field(description="The first number")b: int = Field(description="The second number")@tool("multiplication-tool", args_schema=CalculatorInput, return_direct=True)
def multiply(a: int, b: int) -> int:"""Multiply two numbers"""return a * bprint(multiply.name)  # multiplication-tool
print(multiply.description)  # Multiply two numbers
print(multiply.args)  # {'a': {'title': 'A', 'type': 'integer'}, 'b': {'title': 'B', 'type': 'integer'}}
print(multiply.return_direct)  # True

2.1.3 工具描述方式2：文檔字符串

• @tool 可以選擇性地解析 Google 風格文檔字符串，并將文檔字符串組件（如參數描述）與工具模式的相關部分關聯起來。

@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'}

2.2 方法二：StructuredTool類

• 使用StructuredTool類，允許更細粒度的配置而無需過多的代碼

2.2.1 StructuredTool創建自定義工具

• 使用StructuredTool的from_function可以創建自定義工具，包含兩個參數func,coroutine，分別指定同步方法和異步方法。

import asyncio
from langchain_core.tools import StructuredTooldef multiply(a:int,b:int)->int:"""Multiply two numbers"""return a*b
async def a_multiply(a:int,b:int)->int:"""Multiply two numbers"""return a*basync def main():calculator=StructuredTool.from_function(func=multiply,coroutine=a_multiply)print(calculator.run({"a":2, "b":3}))print(calculator.invoke({"a":2, "b":3}))print(await calculator.ainvoke({"a":2, "b":5}))asyncio.run(main())

2.2.2 StructuredTool配置信息

import asyncio
from langchain_core.tools import StructuredTool
from pydantic import Field, BaseModelclass CalculatorInput(BaseModel):a: int = Field(description="The first number")b: int = Field(description="The second number")#創建同步、異步包裝器函數
def multiply(a:int,b:int)->int:"""Multiply two numbers"""return a*b
async def async_multiply(a:int,b:int)->int:"""Multiply two numbers"""return a*basync def main():calculator=StructuredTool.from_function(func=multiply,name="calculator",description="Multiply two numbers",args_schema=CalculatorInput,coroutine=async_multiply,return_direct=True)print(calculator.name)print(calculator.description)print(calculator.args)asyncio.run(main())

2.3 方法三：BaseTool類

• 接受字符串或 dict 輸入的 LangChain Runnables 可以使用 as_tool 方法轉換為工具，該方法允許為參數指定名稱、描述和其他模式信息。

# 導入所需的模塊
from langchain_core.language_models import GenericFakeChatModel  # 導入一個假的聊天模型，用于測試
from langchain_core.output_parsers import StrOutputParser  # 導入字符串輸出解析器
from langchain_core.prompts import ChatPromptTemplate  # 導入聊天提示模板# 創建一個聊天提示模板，包含一個占位符 {answer_style}
prompt = ChatPromptTemplate.from_messages([("human", "Hello. Please respond in the style of {answer_style}.")]
)# 創建一個假的聊天模型實例，并提供一個固定的響應
llm = GenericFakeChatModel(messages=iter(["hello matey"]))# 構建一個鏈式調用：先應用提示模板，然后調用 LLM，最后解析輸出為字符串
chain = prompt | llm | StrOutputParser()# 將 chain 轉換為一個工具（Tool），并指定名稱和描述
as_tool = chain.as_tool(name="Style responder", description="Description of when to use tool."
)# 打印工具的參數信息
print(as_tool.args) # {'answer_style': {'title': 'Answer Style', 'type': 'string'}}

三 異步工具的實現

• LangChain的工具可以實現異步版本，以節省計算資源和提高效率。在定義異步工具時，需要使用async/await語法，并確保函數和工具名準確反映功能，提供詳細的文檔字符串。對于涉及外部API調用的工具，建議使用API代理服務來提高訪問的穩定性，并確保異步工具充分利用并發優勢，避免阻塞操作。

from langchain_core.tools import tool@tool
async def multiply(a:int,b:int)->int:"""Multiply two numbers"""return a*bprint(multiply.name) # multiply
print(multiply.description) # Multiply two numbers
print(multiply.args) # {'a': {'title': 'A', 'type': 'integer'}, 'b': {'title': 'B', 'type': 'integer'}}

四 工具錯誤處理策略

• 為了讓代理能從錯誤中恢復并繼續執行，需要特定的錯誤處理策略。可以拋出ToolException并定義錯誤處理函數，設置handle_tool_error屬性來定義工具錯誤的應對策略，可以是字符串、布爾值或函數。需要注意的是僅引發ToolException是無效的，需要先設置該工具的handle_tool_error，因為它的默認值為False。

from langchain_core.tools import StructuredTool
from langchain_core.tools import ToolExceptiondef get_weather(city: str) -> str:"""獲取給定城市的天氣。"""raise ToolException(f"錯誤：沒有名為{city}的城市。")get_weather_tool = StructuredTool.from_function(func=get_weather,# 默認情況下，如果函數拋出TooLException，則將TooLException的message作為響應。# 如果設置為True，則將返回TooLException異常文本，False將會拋出TooLExceptionhandle_tool_error=True,
)response = get_weather_tool.invoke({"city":"天京"})
print(response) # 錯誤：沒有名為天京的城市。

• 定義異常處理

from langchain_core.tools import StructuredTool
from langchain_core.tools import ToolExceptiondef get_weather(city: str) -> str:"""獲取給定城市的天氣。"""raise ToolException(f"錯誤：沒有名為{city}的城市。")get_weather_tool = StructuredTool.from_function(func=get_weather,handle_tool_error="沒有找到這個城市",
)response = get_weather_tool.invoke({"city":"天京"})
print(response) # 沒有找到這個城市

• 異常個性化處理

from langchain_core.tools import StructuredTool
from langchain_core.tools import ToolExceptiondef get_weather(city: str) -> str:"""獲取給定城市的天氣。"""raise ToolException(f"錯誤：沒有名為{city}的城市。")def _handle_tool_error(error: ToolException) -> str:"""處理工具錯誤。"""return f"工具執行期間發生以下錯誤：`{error.args[0]}`"get_weather_tool = StructuredTool.from_function(func=get_weather,handle_tool_error=_handle_tool_error
)response = get_weather_tool.invoke({"city":"天京"})
print(response) # 工具執行期間發生以下錯誤：`錯誤：沒有名為天京的城市。`