流式输出¶
流式传输API¶
LangGraph SDK允许您从LangGraph API服务器流式传输输出。
基本用法示例
from langgraph_sdk import get_client
client = get_client(url=<DEPLOYMENT_URL>, api_key=<API_KEY>)
# Using the graph deployed with the name "agent"
assistant_id = "agent"
# create a thread
thread = await client.threads.create()
thread_id = thread["thread_id"]
# create a streaming run
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> });
// Using the graph deployed with the name "agent"
const assistantID = "agent";
// create a thread
const thread = await client.threads.create();
const threadID = thread["thread_id"];
// create a streaming run
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>)
# Using the graph deployed with the name "agent"
assistant_id = "agent"
# create a thread
thread = await client.threads.create()
thread_id = thread["thread_id"]
# create a streaming run
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> });
// Using the graph deployed with the name "agent"
const assistantID = "agent";
// create a thread
const thread = await client.threads.create();
const threadID = thread["thread_id"];
// create a streaming run
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库方法 |
|---|---|---|
值 |
在每个超级步骤之后流式传输完整的图状态。 | .stream() / .astream()，带有stream_mode="values" |
更新 |
流式传输图每一步之后状态的更新。如果同一步骤中进行了多次更新（例如，运行了多个节点），则这些更新将单独流式传输。 | .stream() / .astream()，带有stream_mode="updates" |
消息-元组 |
流式传输LLM令牌以及调用LLM的图节点的元数据（适用于聊天应用程序）。 | .stream() / .astream()，带有stream_mode="messages" |
调试 |
在图的整个执行过程中尽可能多地流式传输信息。 | .stream() / .astream()，带有stream_mode="debug" |
自定义 |
从图内部流式传输自定义数据 | .stream() / .astream()，带有stream_mode="custom" |
事件 |
流式传输所有事件（包括图的状态）；主要在迁移大型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
# Define subgraph
class SubgraphState(TypedDict):
foo: str # note that this key is shared with the parent graph state
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()
# Define parent graph
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>)
# Using the graph deployed with the name "agent"
assistant_id = "agent"
# create a thread
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> });
// Using the graph deployed with the name "agent"
const assistantID = "agent";
// create a thread
const thread = await client.threads.create();
const threadID = thread["thread_id"];
// create a streaming run
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令牌¶
使用messages-tuple流模式从图的任何部分（包括节点、工具、子图或任务）逐个令牌地流式传输大型语言模型（LLM）输出。
来自messages-tuple模式的流式输出是(message_chunk, metadata)元组，其中：
message_chunk：来自LLM的令牌或消息片段。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):
"""Call the LLM to generate a joke about a topic"""
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流式传输的令牌，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流式传输的令牌，metadata是一个字典，包含有关调用LLM的图节点的信息以及其他信息。
过滤LLM令牌¶
- 要按LLM调用过滤流式令牌，您可以将
tags与LLM调用关联。 - 要仅从特定节点流式传输令牌，请使用
stream_mode="messages"并按流式元数据中的langgraph_node字段过滤输出。
流式传输自定义数据¶
发送自定义用户定义数据
流式传输事件¶
流式传输所有事件，包括图的状态