扣子
扣子
扣子扣子编程扣子罗盘教程资源
AI 助手
扣子 AI 帮助与支持
你好，我是 扣子 文档问答助手 🎉 你在阅读当前文档的过程中，无论对文档概念的解释，还是文档内容方面的疑问，都可以随时向我提问，我会全力为你解答
推荐问题
扣子 3.0 都有什么新特性？
扣子和扣子编程有什么区别？
扣子如何收费？
文档反馈
低代码项目
动态
快速开始
智能体
工作流
基础节点
业务逻辑节点
输入和输出节点
数据库节点
知识和数据节点
图像处理节点
音视频处理节点
组件节点
触发器节点
会话管理节点
会话历史节点
消息节点
应用
资源
发布
模型
多人协作
开发工具
推广与变现
低代码/工作流/导入与导出低代码工作流

导入与导出低代码工作流

低代码工作流（包含对话流）支持导出为 Zip 格式的压缩包。开发者下载该压缩包到本地后，可根据业务需求编辑文件。编辑完成后，再将该压缩包灵活导入至任意工作空间来创建一个新的低代码工作流。

说明

  • 订阅套餐：仅付费套餐支持此功能。
  • 导出模式：企业旗舰版和原企业版支持基础模式和高级模式，其他套餐仅支持基础模式。
  • 低代码应用专属的低代码工作流不支持导出、导入。
  • 在团队版和企业版中，企业超级管理员可以通过功能访问控制，控制功能的可见范围。如果你未看到预期的功能，请联系企业超级管理员确认。更多信息，请参考功能访问控制。

应用场景

工作流的导出与导入功能适用于历史版本管理或跨空间、跨账号复制工作流等场景需求。

  • 历史版本管理：能够基于历史版本创建新的工作流，即导出某个历史版本的工作流，通过导入创建一个新的工作流。
  • 跨空间、跨账号复制工作流：直接将导出的压缩包导入至目标账号的工作空间中，就能完成完整的工作流复制。

导出模式

工作流导出操作支持基础模式和高级模式，两者在导出内容上存在差异，具体说明如下：

对比项 基础模式 高级模式
导出 HTTP 节点的鉴权信息 支持 支持

导出引用资源

不支持

支持导出子工作流

每次导出工作流时，最多同步导出 40 个子工作流。
同空间导入 工作流的知识库、数据库、私有插件、子工作流配置均不受影响，可正常运行。 工作流的知识库、数据库、私有插件、子工作流配置均不受影响，可正常运行。
跨空间导入 工作流的知识库、数据库、私有插件、子工作流配置均失效，需重新选择所在空间内的资源。 子工作流可正常运行，知识库、数据库、私有插件仍不支持跨空间导入，需要重新选择所在空间内的资源。

导出操作

你可以在资源库列表页面、工作流编排页面或发布历史列表页面，单击导出，导出工作流。

  • 在资源库列表页面、工作流编排页面，单击导出时，导出当前草稿版本的工作流。工作流压缩包名称为 Workflow-${工作流名称}-draft-随机数.zip 。
  • 在发布历史列表页面，可选择导出提交或发布版本的工作流。提交版本工作流的压缩包名称为 Workflow-${工作流名称}-commit-随机数.zip，发布版本工作流的压缩包名称为 Workflow-${工作流名称}-${工作流版本号}-随机数.zip。

说明

在导出过程中，请勿删除任务，删除任务将导致导出失败。

资源库列表页面

Image

工作流编排页面

Image

发布历史列表页面

Image

在同时导出以下资源库资源对话框中，你可选择随工作流同步导出的资源。当前，高级模式支持导出 HTTP 节点的鉴权信息和工作流所绑定的子工作流。

  • 选中目标资源，系统将同步导出对应的资源。重新导入时，资源不会失效，你无需重新配置。
  • 不选中目标资源，系统将不会同步导出。重新导入时，你需要重新配置。

注意

如果工作流中包含 HTTP 节点的鉴权信息，请谨慎选择，避免泄露。

Image

导入操作

你可以在资源库列表页面、智能体编排页面，单击导入，导入工作流。导入时，你需要上传已导出的工作流 Zip 压缩包，系统将自动读取压缩包内的信息，预填工作流的名称和描述。导入完成后，即可实现工作流的完整复制。

说明

  • 导入后的工作流，默认为草稿状态。
  • 重新导入时，系统会自动校验工作流压缩包的合法性。

资源库列表页面

Image

智能体编排页面

Image

本地管理

导出工作流压缩文件后，你可以在本地解压并编辑其中的工作流文件，实现工作流的本地编排。编辑完成后，再重新导入到扣子编程。

文件结构

压缩包中包含如下文件及文件夹。

Image

  • MANIFEST.yml 文件：工作流的配置文件。
  • workflow 文件夹：包含以${工作流名称} 开头的yaml 文件，表示工作流的 DSL 文件，定义了工作流的详细数据结构和编排逻辑。如果同步导出子工作流，则压缩包中还会包含子工作流的 DSL 文件。

编辑文件

说明

在本地编辑文件时，请勿修改界面上不支持变更的内容（如开始节点名称、节点图标等）。否则，将导致重新导入时校验失败，无法导入。

你可以在 workflow 文件夹中，打开 yaml 文件进行编辑。

例如要修改图像生成节点的名称，你可在 DSL 文件的 nodes 部分，通过节点类型（image_generate）找到图像生成节点，并将该节点的 title 字段值更改为图片节点。重新导入工作流到扣子编程后，新工作流中的图像生成节点将重名命为图片节点。

Image

Schema 数据

下载工作流压缩包后，你可以参考本章节罗列的工作流元数据 DSL 结构、字段说明及配置说明，编辑文件。

DSL 结构

以 YAML 格式展示工作流的 DSL 结构，包括工作流名称、描述、模式、图标、语法版本、节点和连线等定义。

schema_version: 1.0.0
name: summarize_article_1_783
id: 7482702358159*****
description: 示例：总结提炼文章中的要点
mode: workflow
icon: plugin_icon/workflow.png
nodes:
    - id: "100001"
      type: start
      title: 开始
      icon: https://lf3-static.bytednsdoc.com/obj/eden-cn/dvsmryvd_avi_dvsm/ljhwZthlaukjlkulzlp/icon/icon-Start-v2.jpg
      description: 工作流的起始节点，用于设定启动工作流需要的信息
      position:
        x: 180
        "y": 39.7
      parameters:
        node_outputs:
            article_url:
                type: string
                required: true
                description: 文章的链接地址
    - id: "900001"
      type: end
      title: 结束
      icon: https://lf3-static.bytednsdoc.com/obj/eden-cn/dvsmryvd_avi_dvsm/ljhwZthlaukjlkulzlp/icon/icon-End-v2.jpg
      description: 工作流的最终节点，用于返回工作流运行后的结果信息
      position:
        x: 1560
        "y": 26.700000000000003
      parameters:
        node_inputs:
            - name: topic
              input:
                type: string
                value:
                    path: topic
                    ref_node: "197398"
            - name: event_or_opinion
              input:
                type: list
                items:
                    type: object
                    properties:
                        detail:
                            type: string
                            description: 每个事件下的详情或观点下的依据
                        event_or_opinion:
                            type: string
                            description: 事件或观点
                value:
                    path: event_or_opinion
                    ref_node: "197398"
            - name: point
              input:
                type: list
                items:
                    type: string
                value:
                    path: point
                    ref_node: "197398"
            - name: summary
              input:
                type: string
                value:
                    path: summary
                    ref_node: "197398"
        terminatePlan: returnVariables
    - id: "140349"
      type: plugin
      title: 读取网页内容
      icon: https://lf3-static.bytednsdoc.com/obj/eden-cn/dvsmryvd_avi_dvsm/ljhwZthlaukjlkulzlp/icon/icon-Api.png
      description: 当你需要获取网页、pdf、抖音视频内容时，使用此工具。可以获取url链接下的标题和内容。
      position:
        x: 640
        "y": 26
      parameters:
        apiParam:
            - name: apiID
              input:
                type: string
                value: "7379227817307029513"
            - name: apiName
              input:
                type: string
                value: "LinkReaderPlugin"
            - name: pluginID
              input:
                type: string
                value: "7379227817307013129"
            - name: pluginName
              input:
                type: string
                value: "链接读取"
            - name: pluginVersion
              input:
                type: string
                value: ""
            - name: tips
              input:
                type: string
                value: ""
            - name: outDocLink
              input:
                type: string
                value: ""
            - name: updateTime
              input:
                type: integer
                value: 1.750141501e+09
        node_inputs:
            - name: url
              input:
                value:
                    path: article_url
                    ref_node: "100001"
        node_outputs:
            code:
                type: integer
                description: 错误码
            data:
                type: object
                properties:
                    content:
                        type: string
                    images:
                        type: list
                        items:
                            type: object
                            properties:
                                alt:
                                    type: string
                                height:
                                    type: integer
                                title:
                                    type: string
                                url:
                                    type: string
                                width:
                                    type: integer
                    title:
                        type: string
                description: 网页的内容
            err_msg:
                type: string
                description: 错误信息
            error_code:
                type: string
                description: 错误码
            error_msg:
                type: string
                description: 错误信息
            message:
                type: string
                description: 错误信息
            pdf_content:
                type: string
                description: pdf的内容
        settingOnError:
            processType: 1
            retryTimes: 0
            timeoutMs: 180000
    - id: "197398"
      type: llm
      title: 文章提炼
      icon: https://lf3-static.bytednsdoc.com/obj/eden-cn/dvsmryvd_avi_dvsm/ljhwZthlaukjlkulzlp/icon/icon-LLM-v2.jpg
      description: 调用大语言模型,使用变量和提示词生成回复
      version: "3"
      position:
        x: 1100
        "y": 0
      parameters:
        llmParam:
            - name: temperature
              input:
                type: float
                value: "1"
            - name: topP
              input:
                type: float
                value: "0.7"
            - name: responseFormat
              input:
                type: integer
                value: "2"
            - name: maxTokens
              input:
                type: integer
                value: "1024"
            - name: modelName
              input:
                type: string
                value: 豆包·工具调用
            - name: modelType
              input:
                type: integer
                value: "1706077826"
            - name: generationDiversity
              input:
                type: string
                value: balance
            - name: prompt
              input:
                type: string
                value: ' '
            - name: enableChatHistory
              input:
                type: boolean
                value: false
            - name: chatHistoryRound
              input:
                type: integer
                value: "3"
            - name: systemPrompt
              input:
                type: string
                value: |
                    你是一个专业的文章阅读助手，请阅读以下文章，按照要求进行完整的总结。

                    ==原始内容==

                    {{input}}

                    ====End======

                    要求：
                    1. 文章主题。（一个主题）
                    2. 事件或观点。（判断文章是在讲新的事件还是发表观点，三至五个核心事件或观点，如果事件和观点都存在，可以放在一句话里）
                    3. 事件详情或观点依据。（每个事件或观点提炼2-4个详情或依据）
                    4. 重要金句或反常识的观点（1-4个）
                    5. 整体总结。用初中学生能听的懂的方式简练总结。
            - name: stableSystemPrompt
              input:
                type: string
                value: ""
        node_inputs:
            - name: input
              input:
                value:
                    path: data.content
                    ref_node: "140349"
        node_outputs:
            event_or_opinion:
                type: list
                items:
                    type: object
                    properties:
                        detail:
                            type: string
                            description: 每个 事件下的详情或观点下的依据
                        event_or_opinion:
                            type: string
                            description: 事件或观点
                description: 事件或观点
            point:
                type: list
                items:
                    type: string
                description: 重要金句或反常识的观点
            summary:
                type: string
                description: 整体总结
            topic:
                type: string
                description: 文章主题
        settingOnError:
            processType: 1
            retryTimes: 0
            switch: false
            timeoutMs: 600000
    - id: "157201"
      type: comment
      title: ""
      icon: ""
      description: ""
      position:
        x: 577.7948051948052
        "y": 207.6188311688312
      size:
        width: 235.61688311688312
        height: 80
      parameters:
        note: '[{"type":"paragraph","children":[{"text":"在流程中调用读取插件，将文本传递给大模型节点来提炼标题、总结、关键信息点","type":"text"}]}]'
        schemaType: slate
edges:
    - source_node: "100001"
      target_node: "140349"
    - source_node: "197398"
      target_node: "900001"
    - source_node: "140349"
      target_node: "197398"

字段说明

基础字段

工作流基础字段说明如下表所示，包括工作流名称、描述、类型、图标等定义。

名称 数据类型 是否必填 描述
schema_version String 是 当前语法的版本，固定为 1.0.0，请勿修改。
name String 是 工作流的名称。
description String 是 工作流的描述。
mode String 是 工作流的类型。
icon String 是 工作流的图标，请勿修改。
nodes Array 是 工作流节点列表。

edges

Array

是

工作流节点之间的连线。

edges 子字段说明，请参考edges 字段。
nodes 字段
nodes 基础字段

节点相关的字段说明如下表所示，包括工作流节点 ID、类型、位置、描述、批处理、异常处理等定义。

名称 数据类型 是否必填 描述
id string 是 工作流节点 ID。

type

string

是

工作流节点类型。可选值如下：

  • start：开始节点
  • end：结束节点
  • llm：大模型节点
  • plugin：插件节点
  • subflow：工作流节点
  • code：代码节点
  • intent：意图识别节点
  • condition：选择器节点
  • loop：循环节点
  • batch：批处理节点
  • variable_merge：变量聚合节点
  • input：输入节点
  • output：输出节点
  • database：SQL 自定义节点
  • update_database：更新数据节点
  • select_database：查询数据节点
  • delete_database：删除数据节点
  • insert_database：新增数据节点
  • ltm：长期记忆节点
  • ltm_write：长期记忆写入节点
  • ltm_read：长期记忆检索节点
  • dataset_write：知识库写入节点
  • dataset_delete：知识库删除节点
  • knowledge：知识库检索节点
  • drawing_board：画板节点
  • image_generate：图像生成节点
  • video_audio_extractor：视频提取音频节点
  • video_frame_extractor：视频抽帧节点
  • video_generation：视频生成节点
  • text：文本处理节点
  • question：问答节点
  • to_json：JSON 序列化节点
  • from_json：JSON 反序列化节点
  • http：HTTP 请求节点
  • conversation_list：查询会话列表节点
  • conversation_delete：删除会话节点
  • conversation_create：创建会话节点
  • conversation_update：修改会话节点
  • conversation_clear：清空会话历史节点
  • conversation_history_list：查询会话历史节点
  • message_list：查询消息列表节点
  • message_create：创建消息节点
  • message_update：修改消息节点
  • message_delete：删除消息节点
title string 是 工作流节点的标题。
icon String 是 工作流节点的图标。
description string 是 工作流节点的描述。

position

object

是

节点在画布中的位置，包括如下字段：

  • position.x：number 类型，必填，X 轴坐标，节点上边框中间点与原点在 X 轴方向的距离。
  • position.y：number 类型，必填，Y 轴坐标。节点上边框中间点与原点在 Y 轴方向的距离。

系统在初始画布的正中间设有一个 1512 px✖️644 px 的虚拟区域，以该区域的左上角为原点，X 轴向右为正， Y 轴向下为正。当对画布执行平移、放大或缩小操作时，原点位置会随之相应改变。

canvasPosition

object

否

子画布的位置，只有循环节点和批处理节点支持该配置。包括如下字段：

  • canvasPosition.x：number 类型，选填，子画布的 X 轴坐标。
  • canvasPosition.y：number 类型，选填，子画布的 Y 轴坐标。
parameters object 是 工作流节点的配置信息，可参考各个工作流节点文档，例如开始和结束节点。

parameters.node_inputs

object

是

工作流节点输入参数。

node_inputs 子字段说明，请参考node_inputs 字段。
parameters.batch array 否 批处理的输入参数配置。

parameters.settingOnError

object

否

异常处理配置。

settingOnError 子字段说明，请参考settingOnError 字段。

parameters.node_outputs

object

否

工作流节点输出参数配置。

node_outputs 子字段说明，请参考node_outputs 字段。
node_inputs 字段

node_inputs 字段表示工作流节点的输入参数，其子字段说明如下表所示。

名称 数据类型 是否必填 说明
$key string 是 对象中的属性名称。
$value object 是 描述对象属性的结构信息。
$value.type string 是 对象属性的数据类型，详情请参考数据类型说明。
$value.required boolean 是 具体的对象属性是否必填。
$value.items object 否 数组类型的嵌套结构。
settingOnError 字段

settingOnError 字段表示工作流异常处理配置，其子字段说明如下表所示。其中，详细的配置说明可参考各个工作流节点文档，如异常处理。

名称 数据类型 是否必填 说明
switch boolean 否 是否开启异常处理配置。

processType

integer

否

异常处理方式，可选值：

  • 1：中断流程。
  • 2：返回设定内容。
  • 3：执行异常流程。
timeoutMs integer 否 超时时间。
retryTimes integer 否 重试次数。
node_outputs 字段

node_outputs 字段表示工作流节点的输出参数，其子字段说明如下表所示。

名称 数据类型 是否必填 说明
type string 是 数据类型，详情请参考数据类型说明。
properties object 否 一个对象的属性集合。
properties.$key string 是 属性名称。
properties.$value.type string 是 属性的数据类型，详情请参考数据类型说明。
properties.$value.required boolean 是 属性是否必填。
items object 否 数组类型的嵌套结构。
数据类型说明

参数的数据类型说明如下表所示。

关键字 名称
string 字符串
integer 整数
number 数字
boolean 布尔
time 时间
object 对象
array 数组
file 文件
image 图片
svg SVG
audio 音频
video 视频
voice 音色
doc 文档
ppt PPT
excel 表格
txt 文本
code 代码
zip 压缩包
edges 字段

edges 字段表示节点之间连线，其子字段如下表所示。

名称 数据类型 是否必填 描述
source_node String 是 连线开始节点的 ID。
target_node String 是 连线结束节点的 ID。
source_port String 否 连线开始节点的分支 ID。

输入参数配置说明

工作流节点中的大部分输入参数支持配置为固定值或引用变量，你可以参考如下说明编辑输入参数。

参数值配置方式 说明 示例

配置为固定值

当输入参数值指定为固定值时，必须指定输入参数的数据类型。
  • 示例1
    modelType 参数的数据类型为 integer。 
    name: modelType
input:
    type: integer
    value: '1737521813'
  • 示例2
    data 参数的数据类型为 list。 
    # 复杂数据类型 list<string>
name: data
input:
    type: list
    items:
        type: string
    value: '[]'
  • 示例3
    data 参数的数据类型为 object，子字段 f1 为 string 类型，f2 为 integer 类型。 
    # 复杂数据类型 object
name: data
input:
    type: object
    properties:
        f1:
            type: string
            value: 'f1'
        f2:
            type: integer
            value: 10

引用变量

当输入参数值指定为引用变量时，Yaml 文件中不会展示类型信息。

将 Yaml 文件重新导入到扣子编程中时，系统会自动根据引用关系将类型信息再补充完整。
  • 示例1
    指定 i5 字段值引用 100001 节点中的 input 字段。 
    name: i5
input:
    value:
        ref_node: '100001'
        path: 'input'
  • 示例2
    指定 data 字段值引用 100001 节点中的 input.name.a 字段。 
    # object嵌套object，引用某个属性
name: data
input:
    value:
        ref_node: '100001'
        path: 'input.name.a'

上一篇
使用低代码工作流
下一篇
批量执行低代码工作流
应用场景
导出模式
导出操作
导入操作
本地管理
文件结构
编辑文件
Schema 数据
DSL 结构
字段说明
基础字段
nodes 字段
nodes 基础字段
node_inputs 字段
settingOnError 字段
node_outputs 字段
数据类型说明
edges 字段
输入参数配置说明