流水线节点说明

开始节点

「开始」 节点是每个 API 流水线必备的预设节点，作为整个流程的入口点，负责接收和定义外部输入参数。

节点功能

开始节点的主要作用：

• 流程入口：标识 API 流水线的开始位置
• 参数接收：接收来自外部的输入数据
• 数据类型定义：规范输入数据的格式和类型

输入参数

接收来自外部的变量，支持多种输入参数类型，可根据业务需求灵活配置：

• 文本：用于输入字符串内容。
• 数字：仅允许用户输入数字。
• 单文件：允许应用使用者单独上传文件，支持文档、图片、音频、视频类型文件。支持通过本地上传文件。

系统变量

系统变量指的是在 API 流水线内预设的系统级参数，可以被应用内的其它节点全局读取。通常用于记录不同应用和用户的使用行为等。包括以下变量：

• sys.workflow_run_id：API 流水线的运行 ID，用于追踪应用的历次运行情况。
• sys.workflow_id：API 流水线的唯一标识符，用于区分不同 API 流水线。
• sys.user_id：用户 ID，每个用户在使用 API 流水线时，系统会自动向用户分配唯一标识符，用以区分不同的用户。

配置方法

1. 选中开始节点
2. 在右侧详情面板点击输入字段的 「+」 按钮
3. 选择合适的参数类型
4. 设置参数名称和描述

模型节点

模型节点提供调用模型的能力，可处理用户在 “开始” 节点中输入的信息以及其它模型节点输出的信息（自然语言、上传的文件或图片），给出有效的回应信息。

模型设置

模型节点支持调用多种类型的模型，包括文本生成模型、视觉模型、图像生成、语音识别、语音合成、风控识别等模型。在模型下拉菜单，可点击选择模型。

接口设置

有的模型只有一个接口，例如文本生成模型，只有一个文本生成的接口；图像生成模型，可能有多种接口，如：垫图、局部重绘、风格迁移等。

参数设置

根据模型要求，设置输入参数，例如stream、max_tokens、temperature等。在接口下拉菜单的右侧，可点击选择参数设置，如下图：

变量设置

在参数设置中，可以设置参数的变量，例如：input、image、file等，变量可以从开始节点获取，也可以从上游模型节点获取。

输出设置

模型的输出参数，不同类型的模型的输出变量会不同，例如：文本生成模型的输出变量为：text， 图像生成模型的输出变量为： image。

条件分支节点

条件分支节点用于根据条件选择不同的执行路径：

条件类型

条件分支节点支持的条件类型有以下几种：

• 包含
• 不包含
• 开始是
• 结束是
• 是
• 不是
• 为空
• 不为空

条件判断支持多个条件组合。

注释节点

注释节点用于在 API 流水线中添加说明文字、备注信息或描述，帮助开发者更好地理解和维护流程逻辑。

节点功能

注释节点的主要作用：

• 流程说明：为复杂的流程逻辑添加文字说明
• 备注记录：记录设计思路、注意事项或待办事项
• 文档化：提升流水线的可读性和可维护性
• 团队协作：便于团队成员理解流程设计意图

特点说明

• 非执行节点：注释节点仅用于说明，不参与实际的流程执行
• 独立存在：不需要连接到其他节点，可以独立放置在画布任意位置

添加方法

1. 右击鼠标，弹出菜单，选择“添加注释”，或者在工具栏中点击“添加注释”按钮
2. 在文本框中输入注释内容
3. 根据需要调整注释节点在画布中的位置

结束节点

每个 API 流水线必须包含至少一个结束节点作为其执行的终点，该节点负责输出流程的最终结果。结束节点标志着流程的终止，其后不能再连接任何节点。

API 流水线中只有运行到结束节点才会输出执行结果。如果流程中存在分支（如条件判断），则可能需要定义多个结束节点（每个分支路径一个）。在结束节点上，需要定义其输出的变量，这些变量可以基于该节点之前任何上游节点的输出值进行设置。