0

0

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

霞舞

霞舞

发布时间:2025-10-15 13:02:10

|

398人浏览过

|

来源于php中文网

原创

如何正确管理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操作:

GentleAI
GentleAI

GentleAI是一个高效的AI工作平台,为普通人提供智能计算、简单易用的界面和专业技术支持。让人工智能服务每一个人。

下载

原代码:

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应用更加健壮和用户友好。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

492

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

382

2023.10.25

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1568

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

651

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1228

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1204

2024.04.29

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 5万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号