对于新应用,我们推荐事件流——这是 LangGraph v1.2 中引入的类型化投影 API。事件流为每个投影(消息、值、子图、输出)提供独立的迭代器,这样您就可以独立消费它们,而无需基于
stream_mode 块进行分支处理。updates、values、messages、custom、checkpoints、tasks 和 debug 等流模式暴露图执行过程。当您需要直接访问图运行时事件或特定流模式输出时,请使用此 API。
开始使用
基本用法
LangGraph 图暴露了stream(同步)和 astream(异步)方法,以迭代器的形式生成流式输出。传递一个或多个流模式来控制您接收的数据。
for chunk in graph.stream(
{"topic": "ice cream"},
stream_mode=["updates", "custom"],
version="v2",
):
if chunk["type"] == "updates":
for node_name, state in chunk["data"].items():
print(f"Node {node_name} updated: {state}")
elif chunk["type"] == "custom":
print(f"Status: {chunk['data']['status']}")
Output
Status: thinking of a joke...
Node generate_joke updated: {'joke': 'Why did the ice cream go to school? To get a sundae education!'}
完整示例
完整示例
from typing import TypedDict
from langgraph.graph import StateGraph, START, END
from langgraph.config import get_stream_writer
class State(TypedDict):
topic: str
joke: str
def generate_joke(state: State):
writer = get_stream_writer()
writer({"status": "thinking of a joke..."})
return {"joke": f"Why did the {state['topic']} go to school? To get a sundae education!"}
graph = (
StateGraph(State)
.add_node(generate_joke)
.add_edge(START, "generate_joke")
.add_edge("generate_joke", END)
.compile()
)
for chunk in graph.stream(
{"topic": "ice cream"},
stream_mode=["updates", "custom"],
version="v2",
):
if chunk["type"] == "updates":
for node_name, state in chunk["data"].items():
print(f"Node {node_name} updated: {state}")
elif chunk["type"] == "custom":
print(f"Status: {chunk['data']['status']}")
Output
Status: thinking of a joke...
Node generate_joke updated: {'joke': 'Why did the ice cream go to school? To get a sundae education!'}
流输出格式 (v2)
要求 LangGraph >= 1.1。本页面的所有示例均使用
version="v2"。stream() 或 astream() 传递 version="v2" 可获得统一的输出格式。每个块都是一个具有固定结构的 StreamPart 字典——无论流模式、模式数量或子图设置如何:
{
"type": "values" | "updates" | "messages" | "custom" | "checkpoints" | "tasks" | "debug",
"ns": (), # 命名空间元组,子图事件时填充
"data": ..., # 实际负载(类型因流模式而异)
}
TypedDict,包含 ValuesStreamPart、UpdatesStreamPart、MessagesStreamPart、CustomStreamPart、CheckpointStreamPart、TasksStreamPart、DebugStreamPart。您可以从 langgraph.types 导入这些类型。联合类型 StreamPart 是基于 part["type"] 的不相交联合,可在编辑器和类型检查器中实现完整的类型收窄。
使用 v1(默认)时,输出格式会根据您的流选项而变化(单模式返回原始数据,多模式返回 (mode, data) 元组,子图返回 (namespace, data) 元组)。使用 v2 时,格式始终相同:
for chunk in graph.stream(inputs, stream_mode="updates", version="v2"):
print(chunk["type"]) # "updates"
print(chunk["ns"]) # ()
print(chunk["data"]) # {"node_name": {"key": "value"}}
for chunk in graph.stream(inputs, stream_mode="updates"):
print(chunk) # {"node_name": {"key": "value"}}
chunk["type"] 过滤块并获得正确的负载类型。每个分支都会将 part["data"] 收窄为该模式的特定类型:
for part in graph.stream(
{"topic": "ice cream"},
stream_mode=["values", "updates", "messages", "custom"],
version="v2",
):
if part["type"] == "values":
# ValuesStreamPart — 每一步后的完整状态快照
print(f"State: topic={part['data']['topic']}")
elif part["type"] == "updates":
# UpdatesStreamPart — 仅每个节点更改的键
for node_name, state in part["data"].items():
print(f"Node `{node_name}` updated: {state}")
elif part["type"] == "messages":
# MessagesStreamPart — 来自 LLM 调用的 (message_chunk, metadata) 元组
msg, metadata = part["data"]
print(msg.content, end="", flush=True)
elif part["type"] == "custom":
# CustomStreamPart — 来自 get_stream_writer() 的任意数据
print(f"Progress: {part['data']['progress']}%")
流模式
向stream 或 astream 方法传递以下一个或多个流模式(作为列表):
| 模式 | 类型 | 描述 |
|---|---|---|
| values | ValuesStreamPart | 每一步后的完整状态。 |
| updates | UpdatesStreamPart | 每一步后的状态更新。同一步中的多个更新会分别流式传输。 |
| messages | MessagesStreamPart | 来自 LLM 调用的 (LLM token, metadata) 2 元组。 |
| custom | CustomStreamPart | 节点通过 get_stream_writer 发出的自定义数据。 |
| checkpoints | CheckpointStreamPart | 检查点事件(格式与 get_state() 相同)。需要检查点保存器。 |
| tasks | TasksStreamPart | 任务开始/完成事件(包含结果和错误)。需要检查点保存器。 |
| debug | DebugStreamPart | 所有可用信息——结合了 checkpoints 和 tasks 及额外的元数据。 |
图状态
使用流模式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()
)
- updates
- values
使用此模式仅流式传输节点在每一步后返回的 状态更新。流式输出包含节点名称及其更新内容。
for chunk in graph.stream(
{"topic": "ice cream"},
stream_mode="updates",
version="v2",
):
if chunk["type"] == "updates":
for node_name, state in chunk["data"].items():
print(f"Node `{node_name}` updated: {state}")
Output
Node `refine_topic` updated: {'topic': 'ice cream and cats'}
Node `generate_joke` updated: {'joke': 'This is a joke about ice cream and cats'}
使用此模式在每一步后流式传输图的 完整状态。
for chunk in graph.stream(
{"topic": "ice cream"},
stream_mode="values",
version="v2",
):
if chunk["type"] == "values":
print(f"topic: {chunk['data']['topic']}, joke: {chunk['data']['joke']}")
Output
topic: ice cream, joke:
topic: ice cream and cats, joke:
topic: ice cream and cats, joke: This is a joke about ice cream and cats
LLM tokens
使用messages 流模式从图的任何部分(包括节点、工具、子图或任务)逐个 token 流式传输大型语言模型(LLM)的输出。
messages 模式的流式输出是一个元组 (message_chunk, metadata),其中:
message_chunk:来自 LLM 的 token 或消息段。metadata:一个包含图节点和 LLM 调用详细信息的字典。
如果您的 LLM 作为 LangChain 集成不可用,您仍然可以使用 custom 模式流式传输其输出。详情请参见与任何 LLM 配合使用。
Python < 3.11 的异步需要手动配置
在 Python < 3.11 中使用异步代码时,您必须显式将
RunnableConfig 传递给 ainvoke() 以启用正确的流式传输。详情请参见Python < 3.11 的异步支持或升级到 Python 3.11+。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 = ""
model = init_chat_model(model="gpt-5.4-mini")
def call_model(state: MyState):
"""调用 LLM 生成一个关于主题的笑话"""
# 注意:即使 LLM 使用 .invoke 而不是 .stream 运行,也会发出消息事件
model_response = model.invoke(
[
{"role": "user", "content": f"Generate a joke about {state.topic}"}
]
)
return {"joke": model_response.content}
graph = (
StateGraph(MyState)
.add_node(call_model)
.add_edge(START, "call_model")
.compile()
)
# "messages" 流模式流式传输带有元数据的 LLM token
# 使用 version="v2" 以获得统一的 StreamPart 格式
for chunk in graph.stream(
{"topic": "ice cream"},
stream_mode="messages",
version="v2",
):
if chunk["type"] == "messages":
message_chunk, metadata = chunk["data"]
if message_chunk.content:
print(message_chunk.content, end="|", flush=True)
按 LLM 调用过滤
您可以将tags 与 LLM 调用关联,以便按 LLM 调用过滤流式传输的 token。
from langchain.chat_models import init_chat_model
# model_1 标记为 "joke"
model_1 = init_chat_model(model="gpt-5.4-mini", tags=['joke'])
# model_2 标记为 "poem"
model_2 = init_chat_model(model="gpt-5.4-mini", tags=['poem'])
graph = ... # 定义一个使用这些 LLM 的图
# stream_mode 设置为 "messages" 以流式传输 LLM token
# metadata 包含 LLM 调用的信息,包括 tags
async for chunk in graph.astream(
{"topic": "cats"},
stream_mode="messages",
version="v2",
):
if chunk["type"] == "messages":
msg, metadata = chunk["data"]
# 通过元数据中的 tags 字段过滤流式传输的 token,仅包含
# 标记为 "joke" 的 LLM 调用的 token
if metadata["tags"] == ["joke"]:
print(msg.content, end="|", flush=True)
扩展示例:按标签过滤
扩展示例:按标签过滤
from typing import TypedDict
from langchain.chat_models import init_chat_model
from langgraph.graph import START, StateGraph
# joke_model 标记为 "joke"
joke_model = init_chat_model(model="gpt-5.4-mini", tags=["joke"])
# poem_model 标记为 "poem"
poem_model = init_chat_model(model="gpt-5.4-mini", tags=["poem"])
class State(TypedDict):
topic: str
joke: str
poem: str
async def call_model(state, config):
topic = state["topic"]
print("Writing joke...")
# 注意:显式传递 config 在 Python < 3.11 中是必需的
# 因为在那之前没有添加上下文变量支持: https://docs.python.org/3/library/asyncio-task.html#creating-tasks
# 显式传递 config 以确保上下文变量正确传播
# 这在 Python < 3.11 中使用异步代码时是必需的。更多详情请参见异步部分
joke_response = await joke_model.ainvoke(
[{"role": "user", "content": f"Write a joke about {topic}"}],
config,
)
print("\n\nWriting poem...")
poem_response = await poem_model.ainvoke(
[{"role": "user", "content": f"Write a short poem about {topic}"}],
config,
)
return {"joke": joke_response.content, "poem": poem_response.content}
graph = (
StateGraph(State)
.add_node(call_model)
.add_edge(START, "call_model")
.compile()
)
# stream_mode 设置为 "messages" 以流式传输 LLM token
# metadata 包含 LLM 调用的信息,包括 tags
async for chunk in graph.astream(
{"topic": "cats"},
stream_mode="messages",
version="v2",
):
if chunk["type"] == "messages":
msg, metadata = chunk["data"]
if metadata["tags"] == ["joke"]:
print(msg.content, end="|", flush=True)
从流中省略消息
使用nostream 标签可完全排除 LLM 输出。标记为 nostream 的调用仍然会运行并产生输出;只是它们的 token 不会在 messages 模式中发出。
这在以下情况下很有用:
- 您需要 LLM 输出用于内部处理(例如结构化输出),但不希望将其流式传输到客户端
- 您通过不同的通道(例如自定义 UI 消息)流式传输相同的内容,并希望避免在
messages流中出现重复输出
from typing import Any, TypedDict
from langchain_anthropic import ChatAnthropic
from langgraph.graph import START, StateGraph
stream_model = ChatAnthropic(model_name="claude-haiku-4-5-20251001")
internal_model = ChatAnthropic(model_name="claude-haiku-4-5-20251001").with_config(
{"tags": ["nostream"]}
)
class State(TypedDict):
topic: str
answer: str
notes: str
def answer(state: State) -> dict[str, Any]:
r = stream_model.invoke(
[{"role": "user", "content": f"简要回答关于 {state['topic']}"}]
)
return {"answer": r.content}
def internal_notes(state: State) -> dict[str, Any]:
# 由于 nostream,来自此模型的 token 被从 stream_mode="messages" 中省略
r = internal_model.invoke(
[{"role": "user", "content": f"私有笔记关于 {state['topic']}"}]
)
return {"notes": r.content}
graph = (
StateGraph(State)
.add_node("write_answer", answer)
.add_node("internal_notes", internal_notes)
.add_edge(START, "write_answer")
.add_edge("write_answer", "internal_notes")
.compile()
)
initial_state: State = {"topic": "AI", "answer": "", "notes": ""}
stream = graph.stream_events(initial_state, version="v3")
按节点过滤
要仅从特定节点流式传输 token,请使用stream_mode="messages" 并通过流式元数据中的 langgraph_node 字段过滤输出:
# "messages" 流模式流式传输带有元数据的 LLM token
# 使用 version="v2" 以获得统一的 StreamPart 格式
for chunk in graph.stream(
inputs,
stream_mode="messages",
version="v2",
):
if chunk["type"] == "messages":
msg, metadata = chunk["data"]
# 通过元数据中的 langgraph_node 字段过滤流式传输的 token
# 以仅包含来自指定节点的 token
if msg.content and metadata["langgraph_node"] == "some_node_name":
...
扩展示例:从特定节点流式传输 LLM token
扩展示例:从特定节点流式传输 LLM token
from typing import TypedDict
from langgraph.graph import START, StateGraph
from langchain_openai import ChatOpenAI
model = ChatOpenAI(model="gpt-5.4-mini")
class State(TypedDict):
topic: str
joke: str
poem: str
def write_joke(state: State):
topic = state["topic"]
joke_response = model.invoke(
[{"role": "user", "content": f"Write a joke about {topic}"}]
)
return {"joke": joke_response.content}
def write_poem(state: State):
topic = state["topic"]
poem_response = model.invoke(
[{"role": "user", "content": f"Write a short poem about {topic}"}]
)
return {"poem": poem_response.content}
graph = (
StateGraph(State)
.add_node(write_joke)
.add_node(write_poem)
# 并发写笑话和诗
.add_edge(START, "write_joke")
.add_edge(START, "write_poem")
.compile()
)
# "messages" 流模式流式传输带有元数据的 LLM token
# 使用 version="v2" 以获得统一的 StreamPart 格式
for chunk in graph.stream(
{"topic": "cats"},
stream_mode="messages",
version="v2",
):
if chunk["type"] == "messages":
msg, metadata = chunk["data"]
# 通过元数据中的 langgraph_node 字段过滤流式传输的 token
# 以仅包含来自 write_poem 节点的 token
if msg.content and metadata["langgraph_node"] == "write_poem":
print(msg.content, end="|", flush=True)
自定义数据
要从 LangGraph 节点或工具内部发送自定义用户定义数据,请遵循以下步骤:- 使用
get_stream_writer访问流编写器并发出自定义数据。 - 调用
.stream()或.astream()时设置stream_mode="custom",以便在流中获取自定义数据。您可以组合多种模式(例如["updates", "custom"]),但其中至少一种必须是"custom"。
Python < 3.11 的异步环境中没有
get_stream_writer
在 Python < 3.11 上运行的异步代码中,get_stream_writer 将不起作用。
请改为向您的节点或工具添加 writer 参数并手动传递它。
有关使用示例,请参见 Python < 3.11 的异步支持。- 节点
- 工具
from typing import TypedDict
from langgraph.config import get_stream_writer
from langgraph.graph import StateGraph, START
class State(TypedDict):
query: str
answer: str
def node(state: State):
# 获取流编写器以发送自定义数据
writer = get_stream_writer()
# 发出一个自定义键值对(例如,进度更新)
writer({"custom_key": "Generating custom data inside node"})
return {"answer": "some data"}
graph = (
StateGraph(State)
.add_node(node)
.add_edge(START, "node")
.compile()
)
inputs = {"query": "example"}
# 设置 stream_mode="custom" 以在流中接收自定义数据
for chunk in graph.stream(inputs, stream_mode="custom", version="v2"):
if chunk["type"] == "custom":
print(f"Custom event: {chunk['data']['custom_key']}")
from langchain.tools import tool
from langgraph.config import get_stream_writer
@tool
def query_database(query: str) -> str:
"""查询数据库。"""
# 访问流编写器以发送自定义数据
writer = get_stream_writer()
# 发出一个自定义键值对(例如,进度更新)
writer({"data": "Retrieved 0/100 records", "type": "progress"})
# 执行查询
# 发出另一个自定义键值对
writer({"data": "Retrieved 100/100 records", "type": "progress"})
return "some-answer"
graph = ... # 定义一个使用此工具的图
# 设置 stream_mode="custom" 以在流中接收自定义数据
for chunk in graph.stream(inputs, stream_mode="custom", version="v2"):
if chunk["type"] == "custom":
print(f"{chunk['data']['type']}: {chunk['data']['data']}")
子图输出
要将子图的输出包含在流式输出中,您可以在父图的.stream() 方法中设置 subgraphs=True。这将同时流式传输来自父图和任何子图的输出。
输出将以元组 (namespace, data) 的形式流式传输,其中 namespace 是一个包含调用子图的节点路径的元组,例如 ("parent_node:<task_id>", "child_node:<task_id>")。
- v2 (LangGraph >= 1.1)
- v1 (默认)
使用
version="v2" 时,子图事件使用相同的 StreamPart 格式。ns 字段标识来源:for chunk in graph.stream(
{"foo": "foo"},
subgraphs=True,
stream_mode="updates",
version="v2",
):
print(chunk["type"]) # "updates"
print(chunk["ns"]) # () 为根,("node_name:<task_id>",) 为子图
print(chunk["data"]) # {"node_name": {"key": "value"}}
for chunk in graph.stream(
{"foo": "foo"},
# 设置 subgraphs=True 以流式传输子图的输出
subgraphs=True,
stream_mode="updates",
):
print(chunk)
这适用于每个
stream_mode,包括 "messages"。像 create_agent 这样的代理构建器返回一个编译后的图,因此将其添加为节点会将其变为子图。如果未设置 subgraphs=True,父图上的 stream_mode="messages" 将不会发出内部代理 LLM 调用的 token 块。直接调用 agent.stream(...) 则会发出,这就是为什么通常只在包装后才出现此问题。from langchain.agents import create_agent
from langgraph.graph import END, START, StateGraph
graph = (
StateGraph(State)
.add_node("agent", create_agent(model, tools, state_schema=State))
.add_edge(START, "agent")
.add_edge("agent", END)
.compile()
)
for chunk in graph.stream(
{"messages": [{"role": "user", "content": "..."}]},
stream_mode="messages",
subgraphs=True,
version="v2",
):
print(chunk["type"]) # "messages"
print(chunk["ns"]) # () 为根,("agent:<task_id>",) 为子图
print(chunk["data"]) # (token, metadata)
扩展示例:从子图流式传输
扩展示例:从子图流式传输
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()
for chunk in graph.stream(
{"foo": "foo"},
stream_mode="updates",
# 设置 subgraphs=True 以流式传输子图的输出
subgraphs=True,
version="v2",
):
if chunk["type"] == "updates":
if chunk["ns"]:
print(f"Subgraph {chunk['ns']}: {chunk['data']}")
else:
print(f"Root: {chunk['data']}")
import operator
import json
from typing import TypedDict
from typing_extensions import Annotated
from langgraph.graph import StateGraph, START
from openai import AsyncOpenAI
openai_client = AsyncOpenAI()
model_name = "gpt-5.4-mini"
async def stream_tokens(model_name: str, messages: list[dict]):
response = await openai_client.chat.completions.create(
messages=messages, model=model_name, stream=True
)
role = None
async for chunk in response:
delta = chunk.choices[0].delta
if delta.role is not None:
role = delta.role
if delta.content:
yield {"role": role, "content": delta.content}
# 这是我们的工具
async def get_items(place: str) -> str:
"""使用此工具列出你被询问的地方可能找到的物品。"""
writer = get_stream_writer()
response = ""
async for msg_chunk in stream_tokens(
model_name,
[
{
"role": "user",
"content": (
"你能告诉我我在以下地方可能找到什么样的物品吗: '{place}'。 "
"列出至少3件这样的物品,用逗号分隔。 "
"并包括对每件物品的简要描述。"
),
}
],
):
response += msg_chunk["content"]
writer(msg_chunk)
return response
class State(TypedDict):
messages: Annotated[list[dict], operator.add]
# 这是调用工具的图节点
async def call_tool(state: State):
ai_message = state["messages"][-1]
tool_call = ai_message["tool_calls"][-1]
function_name = tool_call["function"]["name"]
if function_name != "get_items":
raise ValueError(f"Tool {function_name} not supported")
function_arguments = tool_call["function"]["arguments"]
arguments = json.loads(function_arguments)
function_response = await get_items(**arguments)
tool_message = {
"tool_call_id": tool_call["id"],
"role": "tool",
"name": function_name,
"content": function_response,
}
return {"messages": [tool_message]}
graph = (
StateGraph(State)
.add_node(call_tool)
.add_edge(START, "call_tool")
.compile()
)
AIMessage] 来调用该图:inputs = {
"messages": [
{
"content": None,
"role": "assistant",
"tool_calls": [
{
"id": "1",
"function": {
"arguments": '{"place":"bedroom"}',
"name": "get_items",
},
"type": "function",
}
],
}
]
}
async for chunk in graph.astream(
inputs,
stream_mode="custom",
version="v2",
):
if chunk["type"] == "custom":
print(chunk["data"]["content"], end="|", flush=True)
禁用特定聊天模型的流式传输
如果你的应用程序混合使用了支持流式传输和不支持流式传输的模型,你可能需要明确地为不支持流式传输的模型禁用它。 在初始化模型时设置streaming=False。
- init_chat_model
- Chat model interface
from langchain.chat_models import init_chat_model
model = init_chat_model(
"claude-sonnet-4-6",
# 设置 streaming=False 以禁用该聊天模型的流式传输
streaming=False
)
from langchain_openai import ChatOpenAI
# 设置 streaming=False 以禁用该聊天模型的流式传输
model = ChatOpenAI(model="gpt-5.5", streaming=False)
并非所有聊天模型集成都支持
streaming 参数。如果你的模型不支持它,请改用 disable_streaming=True。这个参数在所有聊天模型上通过基类都可用。迁移到 v2
v2 流式格式(在整个页面中使用)提供了一个统一的输出格式。以下是关键差异以及如何迁移的总结:| 场景 | v1(默认) | v2 (version="v2") |
|---|---|---|
| 单流模式 | 原始数据(字典) | 包含 type, ns, data 的 StreamPart 字典 |
| 多流模式 | (mode, data) 元组 | 相同的 StreamPart 字典,通过 chunk["type"] 过滤 |
| 子图流式传输 | (namespace, data) 元组 | 相同的 StreamPart 字典,检查 chunk["ns"] |
| 多模式 + 子图 | (namespace, mode, data) 三元组 | 相同的 StreamPart 字典 |
invoke() 返回类型 | 普通字典(状态) | 具有 .value 和 .interrupts 属性的 GraphOutput |
| 中断位置(流式) | 状态字典中的 __interrupt__ 键 | values 流部分上的 interrupts 字段 |
| 中断位置(调用) | 结果字典中的 __interrupt__ 键 | GraphOutput 上的 .interrupts 属性 |
| Pydantic/dataclass 输出 | 返回普通字典 | 强制转换为模型/dataclass 实例 |
v2 调用格式
当你向invoke() 或 ainvoke() 传递 version="v2" 时,它会返回一个具有 .value 和 .interrupts 属性的 @[GraphOutput] 对象:
from langgraph.types import GraphOutput
result = graph.invoke(inputs, version="v2")
assert isinstance(result, GraphOutput)
result.value # 你的输出 — 字典、Pydantic 模型或 dataclass
result.interrupts # tuple[Interrupt, ...],如果没有发生则为空
"values" 以外的任何流模式,invoke(..., stream_mode="updates", version="v2") 返回 list[StreamPart] 而不是 list[tuple]。
在
GraphOutput 上使用字典风格访问 (result["key"], "key" in result, result["__interrupt__"]) 为了向后兼容仍然有效,但已被弃用,将在未来版本中移除。请迁移到使用 result.value 和 result.interrupts。__interrupt__ 下:
config = {"configurable": {"thread_id": "thread-1"}}
result = graph.invoke(inputs, config=config, version="v2")
if result.interrupts:
print(result.interrupts[0].value)
graph.invoke(Command(resume=True), config=config, version="v2")
config = {"configurable": {"thread_id": "thread-1"}}
result = graph.invoke(inputs, config=config)
if "__interrupt__" in result:
print(result["__interrupt__"][0].value)
graph.invoke(Command(resume=True), config=config)
Pydantic 和 dataclass 状态强制转换
当你的图状态是 Pydantic 模型或 dataclass 时,v2 的values 模式会自动将输出强制转换为正确的类型:
from pydantic import BaseModel
from typing import Annotated
import operator
class MyState(BaseModel):
value: str
items: Annotated[list[str], operator.add]
# 使用 version="v2" 时,chunk["data"] 是一个 MyState 实例
for chunk in graph.stream(
{"value": "x", "items": []}, stream_mode="values", version="v2"
):
print(type(chunk["data"])) # <class 'MyState'>
Python < 3.11 版本的异步支持
在 Python 版本 < 3.11 中,异步任务 不支持context 参数。
这限制了 LangGraph 自动传播上下文的能力,并以两种关键方式影响 LangGraph 的流式机制:
- 你必须在异步 LLM 调用(例如
ainvoke())中显式传递RunnableConfig,因为回调不会自动传播。 - 你不能在异步节点或工具中使用 @[
get_stream_writer]——你必须直接传递一个writer参数。
扩展示例:带有手动配置的异步 LLM 调用
扩展示例:带有手动配置的异步 LLM 调用
from typing import TypedDict
from langgraph.graph import START, StateGraph
from langchain.chat_models import init_chat_model
model = init_chat_model(model="gpt-5.4-mini")
class State(TypedDict):
topic: str
joke: str
# 在异步节点函数中接受 config 作为参数
async def call_model(state, config):
topic = state["topic"]
print("生成笑话...")
# 将 config 传递给 model.ainvoke() 以确保正确的上下文传播
joke_response = await model.ainvoke(
[{"role": "user", "content": f"写一个关于{topic}的笑话"}],
config,
)
return {"joke": joke_response.content}
graph = (
StateGraph(State)
.add_node(call_model)
.add_edge(START, "call_model")
.compile()
)
# 设置 stream_mode="messages" 以流式传输 LLM 令牌
async for chunk in graph.astream(
{"topic": "ice cream"},
stream_mode="messages",
version="v2",
):
if chunk["type"] == "messages":
message_chunk, metadata = chunk["data"]
if message_chunk.content:
print(message_chunk.content, end="|", flush=True)
扩展示例:使用流写入器的异步自定义流式传输
扩展示例:使用流写入器的异步自定义流式传输
from typing import TypedDict
from langgraph.types import StreamWriter
class State(TypedDict):
topic: str
joke: str
# 在异步节点或工具的函数签名中添加 writer 作为参数
# LangGraph 将自动将流写入器传递给函数
async def generate_joke(state: State, writer: StreamWriter):
writer({"custom_key": "在生成笑话时流式传输自定义数据"})
return {"joke": f"这是一个关于{state['topic']}的笑话"}
graph = (
StateGraph(State)
.add_node(generate_joke)
.add_edge(START, "generate_joke")
.compile()
)
# 设置 stream_mode="custom" 以在流中接收自定义数据
async for chunk in graph.astream(
{"topic": "ice cream"},
stream_mode="custom",
version="v2",
):
if chunk["type"] == "custom":
print(chunk["data"])
---
<div className="source-links">
<Callout icon="terminal-2">
[Connect these docs](/use-these-docs) to Claude, VSCode, and more via MCP for real-time answers.
</Callout>
<Callout icon="edit">
[Edit this page on GitHub](https://github.com/langchain-ai/docs/edit/main/src/oss/langgraph/streaming.mdx) or [file an issue](https://github.com/langchain-ai/docs/issues/new/choose).
</Callout>
</div>

