如何在 LangSmith 中为图运行传递自定义运行 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
搜索和过滤跟踪。
TLDR¶
import uuid
# Generate a random UUID -- it must be a UUID
config = {"run_id": uuid.uuid4()}, "tags": ["my_tag1"], "metadata": {"a": 5}}
# Works with all standard Runnable methods
# like invoke, batch, ainvoke, astream_events etc
graph.stream(inputs, config, stream_mode="values")
本操作指南的其余部分将展示一个完整的代理。
设置¶
首先,让我们安装所需的包并设置我们的 API 密钥
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")
提示
注册 LangSmith 以快速发现问题并提高 LangGraph 项目的性能。LangSmith 允许您使用跟踪数据来调试、测试和监控您使用 LangGraph 构建的 LLM 应用程序——在此处阅读更多关于如何入门的信息。
定义图¶
在此示例中,我们将使用预构建的 ReAct 代理。
API 参考:ChatOpenAI | create_react_agent | tool
from langchain_openai import ChatOpenAI
from typing import Literal
from langgraph.prebuilt import create_react_agent
from langchain_core.tools import tool
# First we initialize the model we want to use.
model = ChatOpenAI(model="gpt-4o", temperature=0)
# For this tutorial we will use custom tool that returns pre-defined values for weather in two cities (NYC & SF)
@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]
# Define the graph
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”的自定义运行。
此外,您将能够使用提供的标签或元数据事后过滤跟踪。例如,