短期记忆 API 参考¶

类

SummarizationNode –

一个 LangGraph 节点，当消息超出令牌限制时，它会总结这些消息并将其替换为一条总结消息。
SummarizationResult –

消息总结的结果。
RunningSummary –

用于存储先前总结相关信息的对象。

函数

summarize_messages –

当消息超出令牌限制时，总结这些消息并将其替换为一条总结消息。

SummarizationNode ¶

继承自： RunnableCallable

一个 LangGraph 节点，当消息超出令牌限制时，它会总结这些消息并将其替换为一条总结消息。

方法

__init__ –

一个 LangGraph 节点，当消息超出令牌限制时，它会总结这些消息并将其替换为一条总结消息。

init ¶

__init__(
    *,
    model: LanguageModelLike,
    max_tokens: int,
    max_tokens_before_summary: int | None = None,
    max_summary_tokens: int = 256,
    token_counter: TokenCounter = count_tokens_approximately,
    initial_summary_prompt: ChatPromptTemplate = DEFAULT_INITIAL_SUMMARY_PROMPT,
    existing_summary_prompt: ChatPromptTemplate = DEFAULT_EXISTING_SUMMARY_PROMPT,
    final_prompt: ChatPromptTemplate = DEFAULT_FINAL_SUMMARY_PROMPT,
    input_messages_key: str = "messages",
    output_messages_key: str = "summarized_messages",
    name: str = "summarization",
) -> None

一个 LangGraph 节点，当消息超出令牌限制时，它会总结这些消息并将其替换为一条总结消息。

按从旧到新的顺序处理消息：一旦消息的累计令牌数达到 max_tokens_before_summary，max_tokens_before_summary 内的所有消息（排除系统消息，如果有）将被总结并替换为一条新的总结消息。结果消息列表为 [总结消息] + 剩余消息。

参数

model (LanguageModelLike) –

用于生成总结的语言模型。
max_tokens (int) –

最终输出中返回的最大令牌数。仅在总结后强制执行此限制。
max_tokens_before_summary (int | None, default: None ) –

在触发总结之前累积的最大令牌数。如果未提供，则默认为 max_tokens 的值。这允许在需要时将更多令牌放入用于总结的 LLM 中。

注意

如果 max_tokens_before_summary 内的最后一条消息是包含工具调用的 AI 消息，则所有后续相应的工具消息也将被总结。

注意

如果要总结的令牌数量大于 max_tokens，则只会总结其中的最后 max_tokens。这样做是为了防止超出用于总结的 LLM 的上下文窗口（假设上限为 max_tokens）。
max_summary_tokens (int, default: 256 ) –

总结的预算最大令牌数。

注意

此参数不会传递给生成总结的 LLM 以限制总结的长度。它仅用于正确估算允许的最大令牌预算。如果要强制执行此限制，需要将 model.bind(max_tokens=max_summary_tokens) 作为 model 参数传递给此函数。
token_counter (TokenCounter, default: count_tokens_approximately ) –

计算消息中令牌数的函数。默认为近似计数。对于更准确的计数，可以使用 model.get_num_tokens_from_messages。
initial_summary_prompt (ChatPromptTemplate, default: DEFAULT_INITIAL_SUMMARY_PROMPT ) –

用于生成首次总结的提示模板。
existing_summary_prompt (ChatPromptTemplate, default: DEFAULT_EXISTING_SUMMARY_PROMPT ) –

用于更新现有（运行中）总结的提示模板。
final_prompt (ChatPromptTemplate, default: DEFAULT_FINAL_SUMMARY_PROMPT ) –

返回前将总结与剩余消息合并的提示模板。
input_messages_key (str, default: 'messages' ) –

输入图状态中包含要总结的消息列表的键。
output_messages_key (str, default: 'summarized_messages' ) –

状态更新中包含更新后消息列表的键。

警告

默认情况下，output_messages_key 与 input_messages_key 不同。这样做是为了将总结后的消息与图状态中的主消息列表（即 input_messages_key）解耦。只有当您想覆盖主消息列表（即 input_messages_key）时，才应将它们设置为相同。
name (str, default: 'summarization' ) –

总结节点的名称。

返回值

None –

以下格式的 LangGraph 状态更新

{
    "output_messages_key": <list of updated messages ready to be input to the LLM after summarization, including a message with a summary (if any)>,
    "context": {"running_summary": <RunningSummary object>}
}

示例

from typing import Any, TypedDict
from langchain_openai import ChatOpenAI
from langchain_core.messages import AnyMessage
from langgraph.graph import StateGraph, START, MessagesState
from langgraph.checkpoint.memory import InMemorySaver
from langmem.short_term import SummarizationNode, RunningSummary

model = ChatOpenAI(model="gpt-4o")
summarization_model = model.bind(max_tokens=128)


class State(MessagesState):
    context: dict[str, Any]


class LLMInputState(TypedDict):
    summarized_messages: list[AnyMessage]
    context: dict[str, Any]


summarization_node = SummarizationNode(
    model=summarization_model,
    max_tokens=384,
    max_tokens_before_summary=512,
    max_summary_tokens=128,
)


def call_model(state: LLMInputState):
    response = model.invoke(state["summarized_messages"])
    return {"messages": [response]}


checkpointer = InMemorySaver()
workflow = StateGraph(State)
workflow.add_node(call_model)
workflow.add_node("summarize", summarization_node)
workflow.add_edge(START, "summarize")
workflow.add_edge("summarize", "call_model")
graph = workflow.compile(checkpointer=checkpointer)

config = {"configurable": {"thread_id": "1"}}
graph.invoke({"messages": "hi, my name is bob"}, config)
graph.invoke({"messages": "write a short poem about cats"}, config)
graph.invoke({"messages": "now do the same but for dogs"}, config)
graph.invoke({"messages": "what's my name?"}, config)

SummarizationResult `dataclass` ¶

消息总结的结果。

属性

messages (list[AnyMessage]) –

总结后准备输入给 LLM 的更新消息列表，包括一条带有总结的消息（如果有）。
running_summary (RunningSummary | None) –

关于先前总结的信息（总结文本和先前总结的消息 ID）。

messages `instance-attribute` ¶

messages: list[AnyMessage]

总结后准备输入给 LLM 的更新消息列表，包括一条带有总结的消息（如果有）。

running_summary `class-attribute` `instance-attribute` ¶

running_summary: RunningSummary | None = None

关于先前总结的信息（总结文本和先前总结的消息 ID）。如果没有执行总结（消息不足以总结），则可以为 None。

RunningSummary `dataclass` ¶

用于存储先前总结相关信息的对象。

在后续调用 summarize_messages 时使用，以避免重复总结相同的消息。

属性

summary (str) –

消息的最新总结，每次执行总结时更新。
summarized_message_ids (set[str]) –

所有先前已总结消息的 ID。
last_summarized_message_id (str | None) –

最后一条被总结消息的 ID。

summary `instance-attribute` ¶

summary: str

消息的最新总结，每次执行总结时更新。

summarized_message_ids `instance-attribute` ¶

summarized_message_ids: set[str]

所有先前已总结消息的 ID。

last_summarized_message_id `instance-attribute` ¶

last_summarized_message_id: str | None

最后一条被总结消息的 ID。

summarize_messages ¶

summarize_messages(
    messages: list[AnyMessage],
    *,
    running_summary: RunningSummary | None,
    model: LanguageModelLike,
    max_tokens: int,
    max_tokens_before_summary: int | None = None,
    max_summary_tokens: int = 256,
    token_counter: TokenCounter = count_tokens_approximately,
    initial_summary_prompt: ChatPromptTemplate = DEFAULT_INITIAL_SUMMARY_PROMPT,
    existing_summary_prompt: ChatPromptTemplate = DEFAULT_EXISTING_SUMMARY_PROMPT,
    final_prompt: ChatPromptTemplate = DEFAULT_FINAL_SUMMARY_PROMPT,
) -> SummarizationResult

当消息超出令牌限制时，总结这些消息并将其替换为一条总结消息。

此函数按从旧到新的顺序处理消息：一旦消息的累计令牌数达到 max_tokens_before_summary，max_tokens_before_summary 内的所有消息（排除系统消息，如果有）将被总结并替换为一条新的总结消息。结果消息列表为 [总结消息] + 剩余消息。

参数

messages (list[AnyMessage]) –

要处理的消息列表。
running_summary (RunningSummary | None) –

可选的运行总结对象，包含先前总结的信息。如果提供： - 只会处理先前未总结的消息 - 如果没有生成新的总结，运行总结将被添加到返回的消息中 - 如果需要生成新的总结，则会通过整合运行总结中现有的总结值来生成
model (LanguageModelLike) –

用于生成总结的语言模型。
max_tokens (int) –

最终输出中返回的最大令牌数。仅在总结后强制执行此限制。
max_tokens_before_summary (int | None, default: None ) –

在触发总结之前累积的最大令牌数。如果未提供，则默认为 max_tokens 的值。这允许在需要时将更多令牌放入用于总结的 LLM 中。

注意

如果 max_tokens_before_summary 内的最后一条消息是包含工具调用的 AI 消息，则所有后续相应的工具消息也将被总结。

注意

如果要总结的令牌数量大于 max_tokens，则只会总结其中的最后 max_tokens。这样做是为了防止超出用于总结的 LLM 的上下文窗口（假设上限为 max_tokens）。
max_summary_tokens (int, default: 256 ) –

总结的预算最大令牌数。

注意

此参数不会传递给生成总结的 LLM 以限制总结的长度。它仅用于正确估算允许的最大令牌预算。如果要强制执行此限制，需要将 model.bind(max_tokens=max_summary_tokens) 作为 model 参数传递给此函数。
token_counter (TokenCounter, default: count_tokens_approximately ) –

计算消息中令牌数的函数。默认为近似计数。对于更准确的计数，可以使用 model.get_num_tokens_from_messages。
initial_summary_prompt (ChatPromptTemplate, default: DEFAULT_INITIAL_SUMMARY_PROMPT ) –

用于生成首次总结的提示模板。
existing_summary_prompt (ChatPromptTemplate, default: DEFAULT_EXISTING_SUMMARY_PROMPT ) –

用于更新现有（运行中）总结的提示模板。
final_prompt (ChatPromptTemplate, default: DEFAULT_FINAL_SUMMARY_PROMPT ) –

返回前将总结与剩余消息合并的提示模板。

返回值

SummarizationResult –

一个 SummarizationResult 对象，包含更新后的消息和运行总结。 - messages：准备输入给 LLM 的更新消息列表 - running_summary：RunningSummary 对象 - summary：最新总结的文本 - summarized_message_ids：先前已总结的消息 ID 集合 - last_summarized_message_id：最后一条被总结消息的 ID

示例

from langgraph.graph import StateGraph, START, MessagesState
from langgraph.checkpoint.memory import InMemorySaver
from langmem.short_term import summarize_messages, RunningSummary
from langchain_openai import ChatOpenAI

model = ChatOpenAI(model="gpt-4o")
summarization_model = model.bind(max_tokens=128)


class SummaryState(MessagesState):
    summary: RunningSummary | None


def call_model(state):
    summarization_result = summarize_messages(
        state["messages"],
        running_summary=state.get("summary"),
        model=summarization_model,
        max_tokens=384,
        max_tokens_before_summary=512,
        max_summary_tokens=128,
    )
    response = model.invoke(summarization_result.messages)
    state_update = {"messages": [response]}
    if summarization_result.running_summary:
        state_update["summary"] = summarization_result.running_summary
    return state_update


checkpointer = InMemorySaver()
workflow = StateGraph(SummaryState)
workflow.add_node(call_model)
workflow.add_edge(START, "call_model")
graph = workflow.compile(checkpointer=checkpointer)

config = {"configurable": {"thread_id": "1"}}
graph.invoke({"messages": "hi, my name is bob"}, config)
graph.invoke({"messages": "write a short poem about cats"}, config)
graph.invoke({"messages": "now do the same but for dogs"}, config)
graph.invoke({"messages": "what's my name?"}, config)

短期记忆 API 参考¶

SummarizationNode ¶

__init__ ¶

SummarizationResult dataclass ¶

messages instance-attribute ¶

running_summary class-attribute instance-attribute ¶

RunningSummary dataclass ¶

summary instance-attribute ¶

summarized_message_ids instance-attribute ¶

last_summarized_message_id instance-attribute ¶