本文档由 AI 自动翻译。如有任何不准确之处,请参考 英文原版。Chatflow 应用 运行在
advanced-chat 模式下,生成回复的同时流式传输工作流级别的事件(节点开始、完成、迭代、暂停)。之前的对话内容会保留为上下文,后续消息可引用更早的内容。
发送消息并接收流式回复
- 发送对话消息:向 Chatflow 应用发送用户提问。流式返回时,回复文本之外还会携带工作流和节点事件;阻塞式返回时,运行结束后才返回结果。
- 停止响应:在回复完成前中断流式输出。
- 获取下一轮建议问题列表:回复完成后,基于当前对话内容推荐后续问题。
管理会话
- 获取会话列表:按最近活跃时间排序,返回当前用户的会话。
- 获取会话历史消息:返回某个会话的历史消息,适合滚动加载的聊天界面。
- 重命名会话:设置或自动生成会话名称。
- 删除会话:删除指定会话。
- 获取对话变量:读取会话在多轮对话间保留的变量值。
- 更新对话变量:直接修改其中某个变量的值。
处理文件
- 上传文件:上传图片、文档、音频或视频文件,供 发送对话消息 引用。文件仅限上传的终端用户使用。
- 下载文件:预览或下载已上传的文件,前提是该文件属于当前应用内的某条消息。
- 获取终端用户信息:根据终端用户 ID(例如上传文件响应中的
created_by)查询该用户的详细信息。
语音转写与合成
人工介入暂停
当运行到达提交方式为 WebApp 的 人工介入 节点时,可通过 API 完成这次暂停的处理:监听暂停事件
事件流会推送
human_input_required 事件,其中携带 form_token 和本次运行的 workflow_run_id,随后以 workflow_paused 事件结束。获取表单
使用
form_token 调用 获取人工介入表单,加载表单内容。提交填写结果
通过 提交人工介入表单 发送接收者的填写内容。提交后运行恢复执行。
继续跟踪事件流
使用暂停时事件流中的
workflow_run_id,调用 流式获取工作流事件 打开新的事件流,跟踪剩余事件,直到最终回复。查看工作流运行
- 获取工作流执行情况:根据
workflow_run_id查询某次运行的状态与输出,该 ID 出现在对话回复附带的工作流和节点事件中。 - 获取工作流日志:返回运行级别的汇总信息(状态、token 用量、步骤数、耗时),而非逐节点的执行日志。
获取应用信息与配置
- 获取应用基本信息:返回应用的名称、描述、标签和模式。
- 获取应用参数:返回调用需在
inputs中传入的字段(名称、类型、默认值),以及应用的功能开关,可据此构建请求或客户端界面。 - 获取应用元数据:返回工具图标等配置元数据。
- 获取应用 WebApp 设置:返回 WebApp 的站点配置、主题和自定义选项。