如何在 LangSmith 中为图运行传递自定义 run ID 或设置标签和元数据¶

前置知识

本指南假设你熟悉以下内容：

在 IDE 或终端中调试图运行有时可能会很困难。LangSmith 让你能够使用追踪数据来调试、测试和监控使用 LangGraph 构建的 LLM 应用 — 阅读 LangSmith 文档了解更多入门信息。

为了更容易识别和分析图调用期间生成的追踪，你可以在运行时设置额外的配置（参见 RunnableConfig）：

字段	类型	描述
run_name	`str`	此调用的追踪器运行名称。默认为类名。
run_id	`UUID`	此调用的追踪器运行唯一标识符。如果未提供，将生成一个新的 UUID。
tags	`List[str]`	此调用及任何子调用（例如，链调用 LLM）的标签。你可以使用这些标签来过滤调用。
metadata	`Dict[str, Any]`	此调用及任何子调用（例如，链调用 LLM）的元数据。键应为字符串，值应可 JSON 序列化。

LangGraph 图实现了 LangChain Runnable 接口，并在 invoke、ainvoke、stream 等方法中接受第二个参数（RunnableConfig）。

LangSmith 平台允许你根据 run_name、run_id、tags 和 metadata 搜索和过滤追踪。

简要说明¶

import uuid
# 生成随机 UUID -- 必须是 UUID
config = {"run_id": uuid.uuid4()}, "tags": ["my_tag1"], "metadata": {"a": 5}}
# 适用于所有标准 Runnable 方法
# 如 invoke、batch、ainvoke、astream_events 等
graph.stream(inputs, config, stream_mode="values")

本操作指南的其余部分将展示一个完整的智能代理。

设置¶

首先，让我们安装所需的包并设置 API 密钥

%%capture --no-stderr
%pip install --quiet -U langgraph langchain_openai

import getpass
import os


def _set_env(var: str):
    if not os.environ.get(var):
        os.environ[var] = getpass.getpass(f"{var}: ")


_set_env("OPENAI_API_KEY")
_set_env("LANGSMITH_API_KEY")

Tip

注册 LangSmith 以快速发现问题并提升 LangGraph 项目的性能。LangSmith 让你能够使用追踪数据来调试、测试和监控使用 LangGraph 构建的 LLM 应用 — 在这里阅读更多入门信息。

定义图¶

在此示例中，我们将使用预构建的 ReAct 智能代理。

from langchain_openai import ChatOpenAI
from typing import Literal
from langgraph.prebuilt import create_react_agent
from langchain_core.tools import tool

# 首先初始化我们要使用的模型。
model = ChatOpenAI(model="gpt-4o", temperature=0)


# 在本教程中，我们将使用自定义工具，该工具返回两个城市（纽约和旧金山）的预定义天气值
@tool
def get_weather(city: Literal["nyc", "sf"]):
    """Use this to get weather information."""
    if city == "nyc":
        return "It might be cloudy in nyc"
    elif city == "sf":
        return "It's always sunny in sf"
    else:
        raise AssertionError("Unknown city")


tools = [get_weather]


# 定义图
graph = create_react_agent(model, tools=tools)

运行图¶

现在我们已经定义了图，让我们运行一次并在 LangSmith 中查看追踪。为了让我们的追踪在 LangSmith 中易于访问，我们将在配置中传入自定义的 run_id。

这假设你已经设置了 LANGSMITH_API_KEY 环境变量。

注意，你也可以通过设置 LANGCHAIN_PROJECT 环境变量来配置追踪到哪个项目，默认情况下运行将追踪到 default 项目。

import uuid


def print_stream(stream):
    for s in stream:
        message = s["messages"][-1]
        if isinstance(message, tuple):
            print(message)
        else:
            message.pretty_print()


inputs = {"messages": [("user", "what is the weather in sf")]}

config = {"run_name": "agent_007", "tags": ["cats are awesome"]}

print_stream(graph.stream(inputs, config, stream_mode="values"))

输出:

================================ Human Message ==================================

what is the weather in sf
================================== Ai Message ===================================
Tool Calls:
  get_weather (call_9ZudXyMAdlUjptq9oMGtQo8o)
 Call ID: call_9ZudXyMAdlUjptq9oMGtQo8o
  Args:
    city: sf
================================= Tool Message ==================================
Name: get_weather

It's always sunny in sf
================================== Ai Message ===================================

The weather in San Francisco is currently sunny.

在 LangSmith 中查看追踪¶

现在我们已经运行了图，让我们前往 LangSmith 查看追踪。首先点击进入你追踪到的项目（在我们的例子中是默认项目）。你应该能看到一个带有自定义运行名称 "agent_007" 的运行。

LangSmith 追踪视图

此外，你还可以使用提供的标签或元数据在事后过滤追踪。例如，

LangSmith 过滤视图