如何通过 RemoteGraph 与部署进行交互¶

前提条件

RemoteGraph 是一个接口，它允许您像操作常规的本地定义的 LangGraph 图（例如 CompiledGraph）一样与您的 LangGraph 平台部署进行交互。本指南将向您展示如何初始化一个 RemoteGraph 并与之交互。

初始化图¶

在初始化 RemoteGraph 时，你必须始终指定以下内容：

name: 你想交互的图的名称。这与你在部署时使用的 langgraph.json 配置文件中的图名称相同。
api_key: 一个有效的 LangSmith API 密钥。可以作为环境变量 (LANGSMITH_API_KEY) 设置，也可以通过 api_key 参数直接传递。如果 LangGraphClient / SyncLangGraphClient 是使用 api_key 参数初始化的，API 密钥也可以通过 client / sync_client 参数提供。

此外，你还必须提供以下之一：

url: 你想交互的部署的 URL。如果你传递了 url 参数，将使用提供的 URL、标头（如果有）和默认配置值（例如超时等）创建同步和异步客户端。
client: 用于异步交互部署的 LangGraphClient 实例（例如使用 .astream()、.ainvoke()、.aget_state()、.aupdate_state() 等）。
sync_client: 用于同步交互部署的 SyncLangGraphClient 实例（例如使用 .stream()、.invoke()、.get_state()、.update_state() 等）。

注意

如果你同时传递了 client 或 sync_client 以及 url 参数，它们将优先于 url 参数。如果没有提供 client / sync_client / url 参数中的任何一个，RemoteGraph 在运行时将引发 ValueError。

使用 URL¶

PythonJavaScript

from langgraph.pregel.remote import RemoteGraph

url = <DEPLOYMENT_URL>
graph_name = "agent"
remote_graph = RemoteGraph(graph_name, url=url)

import { RemoteGraph } from "@langchain/langgraph/remote";

const url = `<DEPLOYMENT_URL>`;
const graphName = "agent";
const remoteGraph = new RemoteGraph({ graphId: graphName, url });

使用客户端¶

PythonJavaScript

from langgraph_sdk import get_client, get_sync_client
from langgraph.pregel.remote import RemoteGraph

url = <DEPLOYMENT_URL>
graph_name = "agent"
client = get_client(url=url)
sync_client = get_sync_client(url=url)
remote_graph = RemoteGraph(graph_name, client=client, sync_client=sync_client)

import { Client } from "@langchain/langgraph-sdk";
import { RemoteGraph } from "@langchain/langgraph/remote";

const client = new Client({ apiUrl: `<DEPLOYMENT_URL>` });
const graphName = "agent";
const remoteGraph = new RemoteGraph({ graphId: graphName, client });

调用图谱¶

由于 RemoteGraph 是一个实现了与 CompiledGraph 相同方法的 Runnable，你可以像平常使用编译后的图谱一样与其进行交互，即通过调用 .invoke()、.stream()、.get_state()、.update_state() 等方法（以及它们的异步对应方法）。

异步调用¶

注意

若要异步使用图谱，初始化 RemoteGraph 时必须提供 url 或 client。

PythonJavaScript

# 调用图谱
result = await remote_graph.ainvoke({
    "messages": [{"role": "user", "content": "what's the weather in sf"}]
})

# 从图谱中流式输出
async for chunk in remote_graph.astream({
    "messages": [{"role": "user", "content": "what's the weather in la"}]
}):
    print(chunk)

// 调用图谱
const result = await remoteGraph.invoke({
    messages: [{role: "user", content: "what's the weather in sf"}]
})

// 从图谱中流式输出
for await (const chunk of await remoteGraph.stream({
    messages: [{role: "user", content: "what's the weather in la"}]
})):
    console.log(chunk)

同步调用¶

注意

若要同步使用图谱，初始化 RemoteGraph 时必须提供 url 或 sync_client。

Python

# 调用图谱
result = remote_graph.invoke({
    "messages": [{"role": "user", "content": "what's the weather in sf"}]
})

# 从图谱中流式输出
for chunk in remote_graph.stream({
    "messages": [{"role": "user", "content": "what's the weather in la"}]
}):
    print(chunk)

线程级持久化¶

默认情况下，图的运行（即 .invoke() 或 .stream() 调用）是无状态的——检查点和图的最终状态不会被持久化。如果您希望持久化图运行的输出（例如，以启用人机协作功能），可以创建一个线程，并通过 config 参数提供线程 ID，方式与您对常规编译后的图操作相同：

PythonJavaScript

from langgraph_sdk import get_sync_client
url = <DEPLOYMENT_URL>
graph_name = "agent"
sync_client = get_sync_client(url=url)
remote_graph = RemoteGraph(graph_name, url=url)

# 创建一个线程（或使用现有线程）
thread = sync_client.threads.create()

# 使用线程配置调用图
config = {"configurable": {"thread_id": thread["thread_id"]}}
result = remote_graph.invoke({
    "messages": [{"role": "user", "content": "what's the weather in sf"}]
}, config=config)

# 验证状态是否已持久化到线程中
thread_state = remote_graph.get_state(config)
print(thread_state)

import { Client } from "@langchain/langgraph-sdk";
import { RemoteGraph } from "@langchain/langgraph/remote";

const url = `<DEPLOYMENT_URL>`;
const graphName = "agent";
const client = new Client({ apiUrl: url });
const remoteGraph = new RemoteGraph({ graphId: graphName, url });

// 创建一个线程（或使用现有线程）
const thread = await client.threads.create();

// 使用线程配置调用图
const config = { configurable: { thread_id: thread.thread_id }};
const result = await remoteGraph.invoke({
  messages: [{ role: "user", content: "what's the weather in sf" }],
}, config);

// 验证状态是否已持久化到线程中
const threadState = await remoteGraph.getState(config);
console.log(threadState);

作为子图使用¶

注意

如果你需要在一个包含 RemoteGraph 子图节点的图中使用 checkpointer，请确保使用 UUID 作为线程 ID。

由于 RemoteGraph 的行为与常规的 CompiledGraph 相同，因此也可以在另一个图中作为子图使用。例如：

PythonJavaScript

from langgraph_sdk import get_sync_client
from langgraph.graph import StateGraph, MessagesState, START
from typing import TypedDict

url = <DEPLOYMENT_URL>
graph_name = "agent"
remote_graph = RemoteGraph(graph_name, url=url)

# 定义父图
builder = StateGraph(MessagesState)
# 将远程图直接作为节点添加
builder.add_node("child", remote_graph)
builder.add_edge(START, "child")
graph = builder.compile()

# 调用父图
result = graph.invoke({
    "messages": [{"role": "user", "content": "what's the weather in sf"}]
})
print(result)

# 流式输出来自父图和子图的内容
for chunk in graph.stream({
    "messages": [{"role": "user", "content": "what's the weather in sf"}]
}, subgraphs=True):
    print(chunk)

import { MessagesAnnotation, StateGraph, START } from "@langchain/langgraph";
import { RemoteGraph } from "@langchain/langgraph/remote";

const url = `<DEPLOYMENT_URL>`;
const graphName = "agent";
const remoteGraph = new RemoteGraph({ graphId: graphName, url });

// 定义父图并直接将远程图作为节点添加
const graph = new StateGraph(MessagesAnnotation)
  .addNode("child", remoteGraph)
  .addEdge(START, "child")
  .compile()

// 调用父图
const result = await graph.invoke({
  messages: [{ role: "user", content: "what's the weather in sf" }]
});
console.log(result);

// 流式输出来自父图和子图的内容
for await (const chunk of await graph.stream({
  messages: [{ role: "user", content: "what's the weather in la" }]
}, { subgraphs: true })) {
  console.log(chunk);
}