Writer Tools

本笔记本提供了一个快速概览，帮助您开始使用 Writer 工具。有关 Writer 所有功能和配置的详细文档，请访问 Writer 文档。

概述

集成详情

Class	Package	Local	Serializable	JS support	Package downloads	Package latest
GraphTool	langchain-writer	❌	❌	❌

功能

我们提供了两种类型的工具与 ChatWriter 一起使用：function 和 graph。

函数

函数是最常见的工具类型，它允许 LLM 调用外部 API，从数据库获取数据，并通常执行您想做的任何外部操作。请访问我们的 tool calling 文档 以获取更多信息。

图

Graph 工具是 Writer 基于图的检索增强生成 (RAG)，称为 Knowledge Graph（知识图谱）。此工具使开发人员只需将图 ID 传递给模型，它将返回提示中问题的答案。要了解更多信息，请参阅我们的 Knowledge Graph API 文档。

设置

注册 Writer AI Studio 以生成 API 密钥（您可以按照此 快速入门）。然后，设置 WRITER_API_KEY 环境变量

import getpass
import os

if not os.getenv("WRITER_API_KEY"):
    os.environ["WRITER_API_KEY"] = getpass.getpass("Enter your Writer API key: ")

用法

您可以将图或函数工具绑定到 ChatWriter。

图工具

要绑定图工具，首先使用您要用作源的 graph_ids 创建并初始化一个 GraphTool 实例

from langchain_writer.chat_models import ChatWriter
from langchain_writer.tools import GraphTool

chat = ChatWriter()

graph_id = getpass.getpass("Enter Writer Knowledge Graph ID: ")
graph_tool = GraphTool(graph_ids=[graph_id])

实例化

from typing import Optional

from langchain_core.tools import tool
from pydantic import BaseModel, Field


@tool
def get_supercopa_trophies_count(club_name: str) -> Optional[int]:
    """Returns information about supercopa trophies count.

    Args:
        club_name: Club you want to investigate info of supercopa trophies about

    Returns:
        Number of supercopa trophies or None if there is no info about requested club
    """

    if club_name == "Barcelona":
        return 15
    elif club_name == "Real Madrid":
        return 13
    elif club_name == "Atletico Madrid":
        return 2
    else:
        return None


class GetWeather(BaseModel):
    """Get the current weather in a given location"""

    location: str = Field(..., description="The city and state, e.g. San Francisco, CA")


get_product_info = {
    "type": "function",
    "function": {
        "name": "get_product_info",
        "description": "Get information about a product by its id",
        "parameters": {
            "type": "object",
            "properties": {
                "product_id": {
                    "type": "number",
                    "description": "The unique identifier of the product to retrieve information for",
                }
            },
            "required": ["product_id"],
        },
    },
}

API 参考:tool

绑定工具

然后，您可以简单地将所有工具绑定到 ChatWriter 实例

chat.bind_tools(
    [graph_tool, get_supercopa_trophies_count, GetWeather, get_product_info]
)

所有工具都存储在 ChatWriter 实例的 tools 属性中

chat.tools

工具选择模式存储在 tool_choice 属性中，默认为 auto

chat.tool_choice

调用

模型将在所有模式（流式/非流式，同步/异步）的调用期间自动选择工具。

from langchain_core.messages import HumanMessage

messages = [
    HumanMessage(
        "Use knowledge graph tool to compose this answer. Tell me what th first line of documents stored in your KG. Also I want to know: how many SuperCopa trophies have Barcelona won?"
    )
]

response = chat.invoke(messages)
messages.append(response)

API 参考:HumanMessage

在函数工具的情况下，您将收到一条包含工具调用请求的助手消息。

print(response.tool_calls)

然后您可以手动处理工具调用请求，发送到模型并接收最终响应

for tool_call in response.tool_calls:
    selected_tool = {
        "get_supercopa_trophies_count": get_supercopa_trophies_count,
    }[tool_call["name"].lower()]
    tool_msg = selected_tool.invoke(tool_call)
    messages.append(tool_msg)

response = chat.invoke(messages)
print(response.content)

使用 GraphTool，模型将远程调用它，并在 additional_kwargs 的 graph_data 键下返回使用信息

print(response.additional_kwargs["graph_data"])

content 属性包含最终响应

print(response.content)

链式调用

由于 Writer Graph 工具的特殊性（您无需手动调用它，Writer 服务器将自行调用它并返回基于 RAG 的生成），因此无法单独调用它，因此 GraphTool 不能用作链式调用的一部分

API 参考

有关所有 GraphTool 功能和配置的详细文档，请访问 API 参考。

相关

• 工具 概念指南
• 工具 操作指南