流式输出¶
流式 API¶
LangGraph SDK 允许你从 LangGraph API 服务器流式输出。
基本使用示例：
from langgraph_sdk import get_client
client = get_client(url=<DEPLOYMENT_URL>, api_key=<API_KEY>)
# 使用名为 "agent" 的已部署图
assistant_id = "agent"
# 创建线程
thread = await client.threads.create()
thread_id = thread["thread_id"]
# 创建流式运行
async for chunk in client.runs.stream(
thread_id,
assistant_id,
input=inputs,
stream_mode="updates"
):
print(chunk.data)
import { Client } from "@langchain/langgraph-sdk";
const client = new Client({ apiUrl: <DEPLOYMENT_URL>, apiKey: <API_KEY> });
// 使用名为 "agent" 的已部署图
const assistantID = "agent";
// 创建线程
const thread = await client.threads.create();
const threadID = thread["thread_id"];
// 创建流式运行
const streamResponse = client.runs.stream(
threadID,
assistantID,
{
input,
streamMode: "updates"
}
);
for await (const chunk of streamResponse) {
console.log(chunk.data);
}
扩展示例：流式更新
这是一个你可以运行在 LangGraph API 服务器上的示例图。 更多详情请参阅 LangGraph 平台快速入门。
# graph.py
from typing import TypedDict
from langgraph.graph import StateGraph, START, END
class State(TypedDict):
topic: str
joke: str
def refine_topic(state: State):
return {"topic": state["topic"] + " and cats"}
def generate_joke(state: State):
return {"joke": f"This is a joke about {state['topic']}"}
graph = (
StateGraph(State)
.add_node(refine_topic)
.add_node(generate_joke)
.add_edge(START, "refine_topic")
.add_edge("refine_topic", "generate_joke")
.add_edge("generate_joke", END)
.compile()
)
当你有一个正在运行的 LangGraph API 服务器时，可以使用 LangGraph SDK 与它进行交互。
from langgraph_sdk import get_client
client = get_client(url=<DEPLOYMENT_URL>)
# 使用名为 "agent" 的已部署图
assistant_id = "agent"
# 创建线程
thread = await client.threads.create()
thread_id = thread["thread_id"]
# 创建流式运行
async for chunk in client.runs.stream( # (1)!
thread_id,
assistant_id,
input={"topic": "ice cream"},
stream_mode="updates" # (2)!
):
print(chunk.data)
client.runs.stream()方法返回一个迭代器，用于生成流式输出。- 设置
stream_mode="updates"以仅流式传输每个节点后的图状态更新。还有其他流式模式可用。有关详细信息，请参阅 支持的流式模式。
import { Client } from "@langchain/langgraph-sdk";
const client = new Client({ apiUrl: <DEPLOYMENT_URL> });
// 使用名为 "agent" 的已部署图
const assistantID = "agent";
// 创建线程
const thread = await client.threads.create();
const threadID = thread["thread_id"];
// 创建流式运行
const streamResponse = client.runs.stream( // (1)!
threadID,
assistantID,
{
input: { topic: "ice cream" },
streamMode: "updates" // (2)!
}
);
for await (const chunk of streamResponse) {
console.log(chunk.data);
}
client.runs.stream()方法返回一个迭代器，用于生成流式输出。- 设置
streamMode: "updates"以仅流式传输每个节点后的图状态更新。还有其他流式模式可用。有关详细信息，请参阅 支持的流式模式。
支持的流式模式¶
| 模式 | 描述 | LangGraph 库方法 |
|---|---|---|
values |
在每个 超级步骤 后流式传输完整的图状态。 | .stream() / .astream() 与 stream_mode="values" |
updates |
流式传输图中每个步骤后对状态的更新。如果在同一步骤中进行了多次更新（例如，运行了多个节点），这些更新将分别流式传输。 | .stream() / .astream() 与 stream_mode="updates" |
messages-tuple |
流式传输调用 LLM 的图节点的 LLM 令牌和元数据（适用于聊天应用）。 | .stream() / .astream() 与 stream_mode="messages" |
debug |
在图执行过程中尽可能多地流式传输信息。 | .stream() / .astream() 与 stream_mode="debug" |
custom |
从你的图内部流式传输自定义数据 | .stream() / .astream() 与 stream_mode="custom" |
events |
流式传输所有事件（包括图的状态）；主要用于迁移大型 LCEL 应用。 | .astream_events() |
流式传输多种模式¶
你可以将列表作为 stream_mode 参数传递，以同时流式传输多种模式。
流式输出将是 (mode, chunk) 的元组，其中 mode 是流式模式的名称，chunk 是该模式流式传输的数据。
流式图状态¶
使用流式模式 updates 和 values 来在图执行过程中流式传输图的状态。
updates在图的每个步骤后流式传输**状态更新**。values在图的每个步骤后流式传输**完整状态值**。
示例图
from typing import TypedDict
from langgraph.graph import StateGraph, START, END
class State(TypedDict):
topic: str
joke: str
def refine_topic(state: State):
return {"topic": state["topic"] + " and cats"}
def generate_joke(state: State):
return {"joke": f"This is a joke about {state['topic']}"}
graph = (
StateGraph(State)
.add_node(refine_topic)
.add_node(generate_joke)
.add_edge(START, "refine_topic")
.add_edge("refine_topic", "generate_joke")
.add_edge("generate_joke", END)
.compile()
)
有状态的运行
下面的示例假设您希望在 checkpointer 数据库中**持久化流式运行的输出**，并且已经创建了一个线程。要创建一个线程：
如果您不需要持久化运行的输出，可以在流式传输时传入 None 而不是 thread_id。
使用此模式仅流式传输每个步骤后由节点返回的**状态更新**。流式传输的输出包括节点名称以及更新内容。
使用此模式流式传输每个步骤后的**完整图状态**。
子图¶
要将 子图 的输出包含在流式输出中，可以在父图的 .stream() 方法中设置 subgraphs=True。这将同时流式传输来自父图和任何子图的输出。
for chunk in client.runs.stream(
thread_id,
assistant_id,
input={"foo": "foo"},
stream_subgraphs=True, # (1)!
stream_mode="updates",
):
print(chunk)
- 设置
stream_subgraphs=True以从子图流式传输输出。
扩展示例：从子图流式传输
这是一个你可以在 LangGraph API 服务器上运行的示例图。 更多详情请参见 LangGraph 平台快速入门。
# graph.py
from langgraph.graph import START, StateGraph
from typing import TypedDict
# 定义子图
class SubgraphState(TypedDict):
foo: str # 注意这个键与父图状态中的键相同
bar: str
def subgraph_node_1(state: SubgraphState):
return {"bar": "bar"}
def subgraph_node_2(state: SubgraphState):
return {"foo": state["foo"] + state["bar"]}
subgraph_builder = StateGraph(SubgraphState)
subgraph_builder.add_node(subgraph_node_1)
subgraph_builder.add_node(subgraph_node_2)
subgraph_builder.add_edge(START, "subgraph_node_1")
subgraph_builder.add_edge("subgraph_node_1", "subgraph_node_2")
subgraph = subgraph_builder.compile()
# 定义父图
class ParentState(TypedDict):
foo: str
def node_1(state: ParentState):
return {"foo": "hi! " + state["foo"]}
builder = StateGraph(ParentState)
builder.add_node("node_1", node_1)
builder.add_node("node_2", subgraph)
builder.add_edge(START, "node_1")
builder.add_edge("node_1", "node_2")
graph = builder.compile()
一旦你有了正在运行的 LangGraph API 服务器，你可以使用 LangGraph SDK
from langgraph_sdk import get_client
client = get_client(url=<DEPLOYMENT_URL>)
# 使用名称为 "agent" 部署的图
assistant_id = "agent"
# 创建一个线程
thread = await client.threads.create()
thread_id = thread["thread_id"]
async for chunk in client.runs.stream(
thread_id,
assistant_id,
input={"foo": "foo"},
stream_subgraphs=True, # (1)!
stream_mode="updates",
):
print(chunk)
- 设置
stream_subgraphs=True以从子图流式传输输出。
import { Client } from "@langchain/langgraph-sdk";
const client = new Client({ apiUrl: <DEPLOYMENT_URL> });
// 使用名称为 "agent" 部署的图
const assistantID = "agent";
// 创建一个线程
const thread = await client.threads.create();
const threadID = thread["thread_id"];
// 创建一个流式运行
const streamResponse = client.runs.stream(
threadID,
assistantID,
{
input: { foo: "foo" },
streamSubgraphs: true, // (1)!
streamMode: "updates"
}
);
for await (const chunk of streamResponse) {
console.log(chunk);
}
- 设置
streamSubgraphs: true以从子图流式传输输出。
注意 我们不仅接收节点更新，还接收命名空间，这些命名空间告诉我们我们是从哪个图（或子图）进行流式传输的。
调试¶
使用 debug 流式传输模式，可以在图执行过程中尽可能多地传输信息。流式输出包括节点的名称以及完整状态。
LLM tokens¶
使用 messages-tuple 流式传输模式，可以从图中的任何部分（包括节点、工具、子图或任务）逐**token**流式传输大型语言模型（LLM）的输出。
从 messages-tuple 模式 流式传输的输出是一个元组 (message_chunk, metadata)，其中：
message_chunk: 来自 LLM 的 token 或消息片段。metadata: 一个包含有关图节点和 LLM 调用信息的字典。
示例图
from dataclasses import dataclass
from langchain.chat_models import init_chat_model
from langgraph.graph import StateGraph, START
@dataclass
class MyState:
topic: str
joke: str = ""
llm = init_chat_model(model="openai:gpt-4o-mini")
def call_model(state: MyState):
"""调用 LLM 生成关于某个主题的笑话"""
llm_response = llm.invoke( # (1)!
[
{"role": "user", "content": f"Generate a joke about {state.topic}"}
]
)
return {"joke": llm_response.content}
graph = (
StateGraph(MyState)
.add_node(call_model)
.add_edge(START, "call_model")
.compile()
)
- 注意即使使用
.invoke而不是.stream运行 LLM，消息事件也会被发出。
async for chunk in client.runs.stream(
thread_id,
assistant_id,
input={"topic": "ice cream"},
stream_mode="messages-tuple",
):
if chunk.event != "messages":
continue
message_chunk, metadata = chunk.data # (1)!
if message_chunk["content"]:
print(message_chunk["content"], end="|", flush=True)
"messages-tuple"流式传输模式返回一个由元组(message_chunk, metadata)组成的迭代器，其中message_chunk是 LLM 流式传输的 token，metadata是一个包含 LLM 被调用的图节点和其他信息的字典。
const streamResponse = client.runs.stream(
threadID,
assistantID,
{
input: { topic: "ice cream" },
streamMode: "messages-tuple"
}
);
for await (const chunk of streamResponse) {
if (chunk.event !== "messages") {
continue;
}
console.log(chunk.data[0]["content"]); // (1)!
}
"messages-tuple"流式传输模式返回一个由元组(message_chunk, metadata)组成的迭代器，其中message_chunk是 LLM 流式传输的 token，metadata是一个包含 LLM 被调用的图节点和其他信息的字典。
过滤 LLM tokens¶
- 要通过 LLM 调用来过滤流式传输的 tokens，可以 将
tags关联到 LLM 调用。 - 要仅从特定节点流式传输 tokens，请使用
stream_mode="messages"并 通过流式传输的 metadata 中的langgraph_node字段来过滤输出。
流式传输自定义数据¶
要发送 自定义用户定义数据：
流式事件¶
要流式传输所有事件，包括图的状态：