Skip to main content
Open In Colab在 GitHub 上打开

如何添加消息历史记录

先决条件

本指南假定您熟悉以下概念:

注意

本指南之前介绍了 RunnableWithMessageHistory 抽象。您可以在 v0.2 文档中访问此版本的指南。

从 LangChain v0.3 版本开始,我们建议 LangChain 用户利用 LangGraph 持久化来整合memory导入到新的 LangChain 应用程序中。

如果您的代码已经依赖于RunnableWithMessageHistoryBaseChatMessageHistory,则无需进行任何更改。我们不打算在不久的将来弃用此功能,因为它适用于简单的聊天应用程序和任何使用RunnableWithMessageHistory将继续按预期工作。

有关更多详细信息,请参阅如何迁移到 LangGraph 内存

在构建聊天机器人时,将对话状态传入和传出链至关重要。LangGraph 实现了一个内置的持久层,允许链状态自动持久化在内存或 SQLite、Postgres 或 Redis 等外部后端中。有关详细信息,请参阅 LangGraph 持久化文档

在本指南中,我们将演示如何通过将任意 LangChain 可运行对象包装在最小的 LangGraph 应用程序中来为它们添加持久性。这让我们可以持久化消息历史和链状态的其他元素,从而简化多轮应用程序的开发。它还支持多个线程,使单个应用程序能够单独与多个用户交互。

设置

让我们初始化一个聊天模型:

pip install -qU "langchain[openai]"
import getpass
import os

if not os.environ.get("OPENAI_API_KEY"):
os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")

from langchain.chat_models import init_chat_model

llm = init_chat_model("gpt-4o-mini", model_provider="openai")

示例:消息输入

聊天模型添加内存提供了一个简单的示例。聊天模型接受消息列表作为输入并输出消息。LangGraph 包括一个内置的MessagesState我们可以用于此目的。

下面,我们:

  1. 将图形状态定义为消息列表;
  2. 向图中添加调用聊天模型的单个节点;
  3. 使用内存中的检查点程序编译图形,以便在运行之间存储消息。
信息

LangGraph 应用程序的输出是它的状态。这可以是任何 Python 类型,但在这种情况下,它通常是TypedDict与 Runnable 的 schema 匹配。

from langchain_core.messages import HumanMessage
from langgraph.checkpoint.memory import MemorySaver
from langgraph.graph import START, MessagesState, StateGraph

# Define a new graph
workflow = StateGraph(state_schema=MessagesState)


# Define the function that calls the model
def call_model(state: MessagesState):
response = llm.invoke(state["messages"])
# Update message history with response:
return {"messages": response}


# Define the (single) node in the graph
workflow.add_edge(START, "model")
workflow.add_node("model", call_model)

# Add memory
memory = MemorySaver()
app = workflow.compile(checkpointer=memory)

当我们运行应用程序时,我们传入一个配置dict,它指定了thread_id.此 ID 用于区分会话线程(例如,在不同用户之间)。

config = {"configurable": {"thread_id": "abc123"}}

然后我们可以调用应用程序:

query = "Hi! I'm Bob."

input_messages = [HumanMessage(query)]
output = app.invoke({"messages": input_messages}, config)
output["messages"][-1].pretty_print() # output contains all messages in state
================================== Ai Message ==================================

It's nice to meet you, Bob! I'm Claude, an AI assistant created by Anthropic. How can I help you today?
query = "What's my name?"

input_messages = [HumanMessage(query)]
output = app.invoke({"messages": input_messages}, config)
output["messages"][-1].pretty_print()
================================== Ai Message ==================================

Your name is Bob, as you introduced yourself at the beginning of our conversation.

请注意,不同线程的状态是分开的。如果我们向使用新的thread_id,则模型指示它不知道答案:

query = "What's my name?"
config = {"configurable": {"thread_id": "abc234"}}

input_messages = [HumanMessage(query)]
output = app.invoke({"messages": input_messages}, config)
output["messages"][-1].pretty_print()
================================== Ai Message ==================================

I'm afraid I don't actually know your name. As an AI assistant, I don't have personal information about you unless you provide it to me directly.

示例:字典输入

LangChain 可运行对象通常通过单个 key 中的单独 key 接受多个输入dict论点。一个常见的示例是具有多个参数的提示模板。

以前我们的 runnable 是一个聊天模型,而现在我们将提示模板和聊天模型链接在一起。

from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder

prompt = ChatPromptTemplate.from_messages(
[
("system", "Answer in {language}."),
MessagesPlaceholder(variable_name="messages"),
]
)

runnable = prompt | llm

对于此方案,我们定义图形状态以包括这些参数(除了消息历史记录之外)。然后,我们以与以前相同的方式定义单节点图。

请注意,在以下状态下:

  • messageslist 将附加消息;
  • languagestring 将覆盖字符串。
from typing import Sequence

from langchain_core.messages import BaseMessage
from langgraph.graph.message import add_messages
from typing_extensions import Annotated, TypedDict


class State(TypedDict):
messages: Annotated[Sequence[BaseMessage], add_messages]
language: str


workflow = StateGraph(state_schema=State)


def call_model(state: State):
response = runnable.invoke(state)
# Update message history with response:
return {"messages": [response]}


workflow.add_edge(START, "model")
workflow.add_node("model", call_model)

memory = MemorySaver()
app = workflow.compile(checkpointer=memory)
API 参考:BaseMessage | add_messages
config = {"configurable": {"thread_id": "abc345"}}

input_dict = {
"messages": [HumanMessage("Hi, I'm Bob.")],
"language": "Spanish",
}
output = app.invoke(input_dict, config)
output["messages"][-1].pretty_print()
================================== Ai Message ==================================

¡Hola, Bob! Es un placer conocerte.

管理消息历史记录

消息历史记录(以及应用程序状态的其他元素)可以通过.get_state:

state = app.get_state(config).values

print(f'Language: {state["language"]}')
for message in state["messages"]:
message.pretty_print()
Language: Spanish
================================ Human Message =================================

Hi, I'm Bob.
================================== Ai Message ==================================

¡Hola, Bob! Es un placer conocerte.

我们还可以通过.update_state.例如,我们可以手动附加一条新消息:

from langchain_core.messages import HumanMessage

_ = app.update_state(config, {"messages": [HumanMessage("Test")]})
API 参考:HumanMessage
state = app.get_state(config).values

print(f'Language: {state["language"]}')
for message in state["messages"]:
message.pretty_print()
Language: Spanish
================================ Human Message =================================

Hi, I'm Bob.
================================== Ai Message ==================================

¡Hola, Bob! Es un placer conocerte.
================================ Human Message =================================

Test

有关管理状态(包括删除消息)的详细信息,请参阅 LangGraph 文档: