如何正确管理Chainlit中LangChain应用的会话状态

本文旨在解决LangChain与Chainlit集成时常见的`input_variables`配置错误及`cl.user_session`误用问题。文章将详细解释如何正确定义提示模板的输入变量，并着重纠正“UserSession.set() missing 1 required positional argument”这一常见错误，通过提供代码示例和最佳实践，确保开发者能够构建稳定、高效的会话式AI应用。

构建会话式AI：LangChain与Chainlit的集成挑战

在开发基于大型语言模型（LLM）的会话式AI应用时，LangChain提供了强大的链式处理能力，而Chainlit则提供了一个直观的前端界面，两者结合能够快速构建功能丰富的聊天机器人。然而，在集成过程中，开发者常会遇到一些关于提示模板（PromptTemplate）的input_variables配置以及Chainlit会话状态管理（cl.user_session）的问题。理解并正确处理这些问题是确保应用稳定运行的关键。

常见集成问题分析

在使用LangChain和Chainlit构建检索增强生成（RAG）应用时，以下两个问题尤为突出：

1. input_variables与提示模板配置

LangChain的PromptTemplate通过input_variables来定义在渲染模板时需要填充的动态变量。对于RetrievalQA.from_chain_type，特别是当chain_type设置为"stuff"时，它会期望一个用于填充检索到文档的变量名，默认通常是"context"。

用户遇到的问题： 报告的错误信息是"1 validation error for StuffDocumentsChain root document_variable_name context was not found in llm_chain input_variables: ['', 'question']"。 虽然用户提供的custom_prompt_template和set_custom_prompt函数中，PromptTemplate明确定义了input_variables = ['context', 'question']，并且模板字符串中也包含Context: {}，但这个错误提示表明在链的内部，StuffDocumentsChain未能正确识别或接收到'context'变量。这可能发生在：

• chain_type_kwargs中的prompt没有正确传递给StuffDocumentsChain。
• StuffDocumentsChain内部的llm_chain在处理输入时，其input_variables没有包含'context'。
• 或者，这可能是由于其他配置问题导致的连锁反应，例如Chainlit会话管理错误。

代码示例（用户原始的PromptTemplate定义，这部分本身是正确的）：

custom_prompt_template = """Use the following pieces of information to answer the user's question.
If you don't know the answer, please just say that you don't know the answer, don't try to make up
an answer.

Context: {}
Question: {question}

Only returns the helpful answer below and nothing else.
Helpful answer:

"""

def set_custom_prompt():
    prompt = PromptTemplate(template = custom_prompt_template, input_variables = ['context','question'])
    return prompt

2. cl.user_session的错误使用

cl.user_session是Chainlit提供的一种便捷机制，用于在用户与机器人交互的整个会话生命周期中存储和检索用户特定的数据。正确使用set()和get()方法对于维护会话状态至关重要。

用户遇到的问题： 报告的错误是"UserSession.set() missing 1 required positional argument: 'value'"。 这个错误清晰地指出cl.user_session.set()函数被错误地调用了。

用户原始的@cl.on_message函数中的问题代码：

@cl.on_message
async def main(message):
    chain = cl.user_session.set("chain") # <-- 问题所在
    # ... 后续代码

在@cl.on_chat_start函数中，cl.user_session.set('chain', chain)已经将chain对象存储到了会话中。当用户发送消息时，@cl.on_message函数需要从会话中获取这个已存储的chain对象，而不是尝试再次设置它。cl.user_session.set("chain")只提供了一个键，缺少了要存储的值，因此导致了missing 1 required positional argument: 'value'的错误。

解决方案：纠正cl.user_session操作与输入处理

针对上述问题，核心解决方案在于正确使用cl.user_session以及确保传递给LangChain链的输入格式正确。

1. 修正cl.user_session的用法

将@cl.on_message函数中错误的set操作改为正确的get操作：

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

56

查看详情

原代码：

chain = cl.user_session.set("chain")

修正后：

chain = cl.user_session.get("chain")

通过cl.user_session.get("chain")，我们可以从当前用户的会话中检索到在@cl.on_chat_start时已经初始化并存储的LangChain chain对象。

2. 确保传递给LangChain链的输入正确

当用户在Chainlit界面输入消息时，@cl.on_message装饰器会将用户消息封装成一个cl.Message对象传递给main函数。LangChain链通常期望接收一个字符串作为查询输入，而不是整个cl.Message对象。

原代码：

res = await chain.acall(message, callbacks = [cb])

修正后：

res = await chain.acall(message.content, callbacks = [cb])

通过message.content，我们提取了用户输入的实际文本内容，并将其传递给LangChain链进行处理。

完整修正后的@cl.on_message函数

结合上述两点修正，@cl.on_message函数应更新为：

import chainlit as cl
# ... 其他导入和函数定义保持不变 ...

@cl.on_chat_start
async def start():
    chain = qa_bot()
    msg = cl.Message(content="Starting the bot......")    
    await msg.send()
    msg.content = "Hi, Welcome to the Medical Bot. What is your query?"
    await msg.update()
    cl.user_session.set('chain', chain) # 正确设置chain

@cl.on_message
async def main(message: cl.Message): # 建议明确类型提示
    chain = cl.user_session.get("chain") # 正确获取chain
    cb = cl.AsyncLangchainCallbackHandler(
        stream_final_answer = True, answer_prefix_tokens = ["FINAL", "ANSWER"]
        )
    cb.answer_reached = True
    # 确保将消息内容传递给链
    res = await chain.acall(message.content, callbacks = [cb]) 
    answer = res["result"]
    sources = res["source_documents"]

    if sources:
        answer += f"\nSources:" + str(sources)
    else:
        answer += f"\nNo Sources Found"

    await cl.Message(content = answer).send()

注意事项与最佳实践

1. cl.user_session的生命周期： cl.user_session中的数据在单个用户会话期间保持不变。当用户关闭或刷新页面时，会话结束，数据也会被清除。
2. input_variables的匹配： 始终确保你的PromptTemplate中的input_variables与LangChain链（特别是RetrievalQA这类封装了多个组件的链）所期望的变量名和数量完全匹配。对于RAG应用，'context'和'question'是常见的必要变量。
3. 错误信息解读： 仔细阅读错误信息是调试的关键。“missing positional argument”通常指向函数调用参数不匹配；“validation error”则可能与数据结构或类型不符有关。
4. 逐步调试： 在集成复杂系统时，建议分模块进行测试。例如，先确保LangChain链本身在没有Chainlit的情况下能正常工作，然后再集成到Chainlit中。
5. 类型提示： 在Python函数中添加类型提示（如message: cl.Message）可以提高代码的可读性，并帮助IDE在开发阶段捕获潜在的类型错误。

总结

通过正确区分cl.user_session.set()和cl.user_session.get()的用途，并确保将cl.Message对象的content属性传递给LangChain链，我们可以有效解决在LangChain与Chainlit集成过程中常见的会话管理和输入处理问题。这些修正不仅能消除运行时错误，还能使你的会话式AI应用更加健壮和用户友好。

以上就是如何正确管理Chainlit中LangChain应用的会话状态的详细内容，更多请关注php中文网其它相关文章！