lblab Component Docs

AIGC 对话组件

AIGC 对话组件

这是一款 AIGC 对话组件

🎨 支持流式对话输出,开箱即用,支持internLM 及 lmdeploy api,也支持自定义api
😀 支持 md 格式代码块、latex 公式、表格、图片及视频渲染
😝 支持约定格式的插件渲染
👻支持流式对话安全审核
😏 提供样式自定义接口

Chatbox 范例及 live 代码展示如下:

对接 delployLM reset api 进行流式输出,demo 如下:

支持代码块、latex 公式及表格渲染,并配置头像及自定义气泡样式

支持自定义对话框样式

配置 SSE 请求地址、token,通过 ref 方式暴露发起、停止,重试 sse 请求及获取 sse 状态接口。

若为自定义接口,数据返回格式需满足 自定义API SSE返回的数据格式说明,且为GET 请求

插件显示配置

参数说明

组件入参说明

参数说明是否必需类型默认值版本
apiTypeAPI类型配置 InternLM(或自定义api):1 lmdeploy:2enum
urlsse 连接地址(可为lmdeploy 或 internLM 对话请求api地址,也可为自定义api,自定义api数据返回格式参考:SSE返回的数据格式说明),若只想直接渲染propsSessionList,url可填空字符串string
propsSessionList历史对话记录SseMesage[]
eventNamesse 返回数据时,监听事件名称,默认为 messagestring
style对话框样式自定义React.CSSProperties
sseMaxWaitTimeSSE 连接超时时长number
sseNoMessageWaitTime无消息,会话超时时长number
sseActiveWaitTime会话中(已收到消息),超时提示等待时长number
sseActiveCloseTime会话中(已收到消息),超时主动关闭时长number
token头部鉴权信息string
requestMessageContainerStyle提问对话框样式自定义React.CSSProperties
responseMessageContainerStyle回答对话框样式自定义React.CSSProperties
isShowStopGenerateButton是否显示停止生成按钮booleantrue
stopGenerateButtonStyle停止生成按钮样式自定义React.CSSProperties
stopGenerateWords停止生成文字配置string停止生成
isShowRegenerateButton当会话失败时, 是否显示重新生成按钮booleantrue
reGenerateComponent重新生成组件自定义JSX.Element
tooLongErrorComponent超长提示组件自定义JSX.Element
modelCloseStyle模型关闭样式自定义React.CSSProperties
sseStopCallbacksse会话结束回调(url:string)=>void
userAvatar用户头像自定义JSX.Element
modelAvatar模型头像自定义JSX.Element
reviewCallback人工审核回调(id:string,result:number,raw ?:any)=>void
reviewInfoCallback审核详情点击回调(id:string)=>void
reviewTimeingComponent自定义审核计时器插槽JSX.Element
reviewTimoutComponent自定义审核超时插槽JSX.Element
isPluginCollpaseed插件是否展开boolean
bodypost请求body配置Body

Body说明

参数说明是否必需类型默认值版本
session_id会话idnumber
interactive_mode是否交互模式boolean
stream是否流式返回boolean
request_output_len指定模型输出的期望长度或大小number
top_p控制生成 token 的概率大小number
top_k控制模型生成回答时考虑的上下文单词数量的参数number
temperature模型生成文本时创造性和多样性的超参数number
repetition_penalty控制模型生成文本时重复性的方法number
ignore_eos是否忽略或不在意"End of Sequence"(EOS)标记boolean

SseMesage格式说明

参数说明是否必需类型默认值版本
id聊天id(唯一)number
status对话状态AllStatus
message对话回复信息string
question对话问题string
machineAuditResult机器审核结果0审核不通过,1审核通过,2待审核
personAuditResult人工审核结果0审核不通过,1审核通过,2待审核,3审核超时
tools插件回复列表ToolInfo[]

插件数据(ToolInfo)格式说明

参数说明是否必需类型默认值版本
thought思考步骤string------
type类型string------
args执行内容{ text:string}------
errmsg错误信息string------
result执行结果any------
state状态number------
valid是否有效number------

自定义API SSE返回的数据格式说明

参数说明是否必需类型默认值版本
code状态码AllStatus
data数据Data
AllStatus格式说明
枚举值说明版本
3发起请求5s 内,无消息
4发起请求5s 后,无消息
1接收到event stream,流式输出中
-1接收出错
0接收完成
-20003会话超长
-20008模型关闭
Data格式说明
参数说明是否必需类型默认值版本
contextstring
idnumber
requeststring
responsestring
Edit this page on GitLab