diff --git a/docs/workflow.md b/docs/workflow.md index aedd6a966b1b3df734318c2989974acf9fe0beef..dc20480905dca7f1848c24b8e3b234d7286210d4 100644 --- a/docs/workflow.md +++ b/docs/workflow.md @@ -1,17 +1,17 @@ -# API 编排 +# API 流水线 ## 基本介绍 -API 编排是一种可视化工作流引擎,支持通过节点自由组合多种模型 API(如文本对话、图像生成、音频处理等),构建自动化任务流程。它能快速串联不同模型的输入输出,智能处理参数转换,降低多模型协作的复杂度。优势在于开箱即用的 AI 能力集成、低代码交互设计,以及灵活适配复杂业务场景,显著提升开发效率。 +API 流水线是一种可视化工作流引擎,支持通过节点自由组合多种模型 API(如文本对话、图像生成、音频处理等),构建自动化任务流程。它能快速串联不同模型的输入输出,智能处理参数转换,降低多模型协作的复杂度。优势在于开箱即用的 AI 能力集成、低代码交互设计,以及灵活适配复杂业务场景,显著提升开发效率。 -![工作流](/img/workflow/example-vision.png) -![工作流](/img/workflow/example-text.png) +![API 流水线](/img/workflow/example-vision.png) +![API 流水线](/img/workflow/example-text.png) ## 快速开始 -如果您是首次使用 API 编排,建议按以下顺序阅读: +如果您是首次使用 API 流水线,建议按以下顺序阅读: 1. **[快速上手](/docs/workflow/quick-start)** - 通过实际示例快速上手 2. **[节点说明](/docs/workflow/node/start)** - 了解各种节点的功能和配置 @@ -20,21 +20,21 @@ API 编排是一种可视化工作流引擎,支持通过节点自由组合多 ## 关键概念 ### 节点类型 -工作流由不同功能的节点组成,每个节点执行特定的操作: +API 流水线由不同功能的节点组成,每个节点执行特定的操作: -- **[开始节点](/docs/workflow/node/start)** - 工作流的入口,定义输入参数 +- **[开始节点](/docs/workflow/node/start)** - API 流水线的入口,定义输入参数 - **[模型节点](/docs/workflow/node/model)** - 调用AI模型处理数据 - **[条件分支节点](/docs/workflow/node/condition)** - 根据条件选择执行路径 -- **[结束节点](/docs/workflow/node/end)** - 工作流的出口,定义输出结果 +- **[结束节点](/docs/workflow/node/end)** - API 流水线的出口,定义输出结果 ### 变量系统 -变量用于串联工作流内前后节点的输入与输出,实现流程中的复杂处理逻辑: +变量用于串联 API 流水线内前后节点的输入与输出,实现流程中的复杂处理逻辑: - **系统变量**:由系统自动生成和管理的变量 - **节点变量**:每个节点产生的输出变量 ### 执行流程 -工作流按照节点连接的顺序执行: +API 流水线按照节点连接的顺序执行: 1. 从开始节点获取输入参数 2. 按照连接顺序依次执行各个节点 @@ -43,7 +43,7 @@ API 编排是一种可视化工作流引擎,支持通过节点自由组合多 ## 支持的模型类型 -工作流支持多种类型的AI模型,满足不同的业务需求: +API 流水线支持多种类型的 AI 模型,满足不同的业务需求: | 模型类型 | 主要功能 | 应用场景 | |---------|---------|---------| @@ -54,9 +54,9 @@ API 编排是一种可视化工作流引擎,支持通过节点自由组合多 | [风控识别](/docs/workflow/scene/security) | 内容安全审核 | 内容监控、合规检查 | ## 计费模式 -工作流的费用基于模型调用情况结算,具体取决于模型节点的类型和数量。计费与您使用的[访问令牌(token)](/docs/workflow/api#访问令牌)所绑定的资源包权限直接关联。 +API 流水线的费用基于模型调用情况结算,具体取决于模型节点的类型和数量。计费与您使用的[访问令牌(token)](/docs/workflow/api#访问令牌)所绑定的资源包权限直接关联。 -不同资源包包含的可用模型及对应价格可能不同。为确保您的工作流拥有所有模型的完整调用权限,强烈建议购买[全模型资源包](https://ai.gitee.com/serverless-api/packages/1910),并使用绑定了该资源包的访问令牌进行调用。 +不同资源包包含的可用模型及对应价格可能不同。为确保您的 API 流水线拥有所有模型的完整调用权限,强烈建议购买[全模型资源包](https://ai.gitee.com/serverless-api/packages/1910),并使用绑定了该资源包的访问令牌进行调用。 ### 计费规则 - 每个模型节点的调用都会产生费用 @@ -64,18 +64,18 @@ API 编排是一种可视化工作流引擎,支持通过节点自由组合多 - 总费用 = 所有模型节点调用费用之和 ### 示例 -假设一个工作流包含: +假设一个 API 流水线包含: - 1个文本生成模型节点(0.02元/次) - 1个图像生成模型节点(0.05元/次) -则该工作流每次调用的费用为:**0.02 + 0.05 = 0.07元** +则该 API 流水线每次调用的费用为:**0.02 + 0.05 = 0.07元** > 具体每个模型的费用请参考 [模型广场](https://ai.gitee.com/serverless-api) ## 下一步 -准备开始使用工作流了吗? +准备开始使用 API 流水线了吗? -👉 [查看操作步骤](/docs/workflow/quick-start) 了解如何创建您的第一个工作流 +👉 [查看操作步骤](/docs/workflow/quick-start) 了解如何创建您的第一个 API 流水线 👉 [浏览应用场景](/docs/workflow/scene/text) 寻找适合您业务的解决方案 diff --git a/docs/workflow/api.md b/docs/workflow/api.md index 2b6faacdb073c4904dc9239195c05d9f6e0e5fb2..a007873805484af0823db236dfae65fb8e1e435e 100644 --- a/docs/workflow/api.md +++ b/docs/workflow/api.md @@ -1,13 +1,13 @@ # 访问 API ## 介绍 -我们为编排应用提供了标准化 REST API 接口,您可以通过编程方式调用您的编排应用。 +我们为 API 流水线提供了标准化 REST API 接口,您可以通过编程方式调用您的 API 流水线。 ![api](/img/workflow/api-1.png) ## API 文档 -您可以到 [API 文档](https://ai.gitee.com/docs/openapi/v1#tag/工作流/POST/workflows/{workflowId}/run) 中查看 API 的详细调用说明。 +您可以到 [API 文档](https://ai.gitee.com/docs/openapi/v1#tag/api流水线/POST/workflows/{workflowId}/run) 中查看 API 的详细调用说明。 ## 访问令牌 访问令牌是调用 API 的凭证,您需要在 工作台 - 设置 - 访问令牌,获取您的 API Key。 diff --git a/docs/workflow/node/end.md b/docs/workflow/node/end.md index 9c425a7f806fff5ca1341422e11a60f7ff643bf0..f81cd1443e89491469bdd8700c9e05313d4774cf 100644 --- a/docs/workflow/node/end.md +++ b/docs/workflow/node/end.md @@ -1,8 +1,8 @@ # 结束 ## 定义 -每个工作流必须包含至少一个结束节点作为其执行的终点,该节点负责输出流程的最终结果。结束节点标志着流程的终止,其后不能再连接任何节点。 +每个 API 流水线必须包含至少一个结束节点作为其执行的终点,该节点负责输出流程的最终结果。结束节点标志着流程的终止,其后不能再连接任何节点。 -工作流应用中只有运行到结束节点才会输出执行结果。如果流程中存在分支(如条件判断),则可能需要定义多个结束节点(每个分支路径一个)。在结束节点上,需要定义其输出的变量,这些变量可以基于该节点之前任何上游节点的输出值进行设置。 +API 流水线中只有运行到结束节点才会输出执行结果。如果流程中存在分支(如条件判断),则可能需要定义多个结束节点(每个分支路径一个)。在结束节点上,需要定义其输出的变量,这些变量可以基于该节点之前任何上游节点的输出值进行设置。 ![模型节点](/img/workflow/end.png) diff --git a/docs/workflow/node/start.md b/docs/workflow/node/start.md index 5cc8a44adf4f744f879c06480678906e7f181a2b..4f8d9b4044f01091192a49c9845a04c3a44c8bc7 100644 --- a/docs/workflow/node/start.md +++ b/docs/workflow/node/start.md @@ -1,7 +1,7 @@ # 开始 ## 定义 -**「开始」** 节点是每个编排应用必备的预设节点,作为整个流程的入口点,负责接收和定义外部输入参数。 +**「开始」** 节点是每个 API 流水线必备的预设节点,作为整个流程的入口点,负责接收和定义外部输入参数。 ![开始节点](/img/workflow/start.png) @@ -9,7 +9,7 @@ 开始节点的主要作用: -- **流程入口**:标识工作流的开始位置 +- **流程入口**:标识 API 流水线的开始位置 - **参数接收**:接收来自外部的输入数据 - **数据类型定义**:规范输入数据的格式和类型 @@ -26,11 +26,11 @@ ## 系统变量 -系统变量指的是在 API 编排应用内预设的系统级参数,可以被应用内的其它节点全局读取。通常用于记录不同应用和用户的使用行为等。包括以下变量: +系统变量指的是在 API 流水线内预设的系统级参数,可以被应用内的其它节点全局读取。通常用于记录不同应用和用户的使用行为等。包括以下变量: -- **sys.workflow_run_id**:API 编排应用的运行 ID,用于追踪应用的历次运行情况。 -- **sys.workflow_id**:API 编排应用的唯一标识符,用于区分不同工作流。 -- **sys.user_id**:用户 ID,每个用户在使用工作流应用时,系统会自动向用户分配唯一标识符,用以区分不同的用户。 +- **sys.workflow_run_id**:API 流水线的运行 ID,用于追踪应用的历次运行情况。 +- **sys.workflow_id**:API 流水线的唯一标识符,用于区分不同 API 流水线。 +- **sys.user_id**:用户 ID,每个用户在使用 API 流水线时,系统会自动向用户分配唯一标识符,用以区分不同的用户。 ## 配置方法 diff --git a/docs/workflow/quick-start.md b/docs/workflow/quick-start.md index 31755e259a5ae6ccb733c4a54891f26c03e6b04b..3e51d9433cb6bff0d5a5209cd9f75706358460ad 100644 --- a/docs/workflow/quick-start.md +++ b/docs/workflow/quick-start.md @@ -1,17 +1,17 @@ # 快速上手 -以下是一个简单的示例,演示了如何创建一个 API 编排应用。 +以下是一个简单的示例,演示了如何创建一个 API 流水线。 -## 新建编排应用 +## 新建 API 流水线 -进入[API 编排](https://ai.gitee.com/dashboard/workflows)页面,点击 **「新建编排应用」** 按钮,打开新建弹窗,输入 **应用名称** 和 **描述** ,创建一个 API 编排应用。 +进入[API 流水线](https://ai.gitee.com/dashboard/workflows)页面,点击 **「新建 API 流水线」** 按钮,打开新建弹窗,输入 **名称** 和 **描述** ,创建一个 API 流水线。 -![新建编排](/img/workflow/step-1.png) -![新建编排](/img/workflow/step-2.png) +![新建 API 流水线](/img/workflow/step-1.png) +![新建 API 流水线](/img/workflow/step-2.png) ## 添加开始节点 -创建成功之后会进入当前编排页面,点击选中 **「开始」** 节点,右边会显示节点详情,点击输入字段右侧的 **「+」** 按钮,可以添加输入变量。可根据需求添加多个输入变量。例如,添加一个名为 **「input」** 的 **变量名称**。 +创建成功之后会进入当前 API 流水线页面,点击选中 **「开始」** 节点,右边会显示节点详情,点击输入字段右侧的 **「+」** 按钮,可以添加输入变量。可根据需求添加多个输入变量。例如,添加一个名为 **「input」** 的 **变量名称**。 ![配置开始节点](/img/workflow/step-3.png) ![添加输入变量](/img/workflow/input-1.png) @@ -33,15 +33,15 @@ ## 添加结束节点 -添加一个 **结束** 节点,点击 **「保存」** 按钮,保存当前 API 编排应用。 +添加一个 **结束** 节点,点击 **「保存」** 按钮,保存当前 API 流水线。 -![保存编排](/img/workflow/step-6.png) +![保存 API 流水线](/img/workflow/step-6.png) ## 完成 -恭喜!您已经成功创建了第一个 API 编排应用。 +恭喜!您已经成功创建了第一个 API 流水线。 ## 下一步 -- [了解如何运行](/docs/workflow/run) - 查看 API 编排应用运行结果 +- [了解如何运行](/docs/workflow/run) - 查看 API 流水线运行结果 - [了解更多节点类型](/docs/workflow/node/start) - 探索开始、模型、条件分支、结束节点的详细功能 - [查看应用场景](/docs/workflow/scene/text) - 学习不同模型的实际应用案例 diff --git a/docs/workflow/run.md b/docs/workflow/run.md index e3f6d48c2190b944b969acce3f263940c48f1b2a..a16aa25f601b47e0231aeeb06a357624c6321caa 100644 --- a/docs/workflow/run.md +++ b/docs/workflow/run.md @@ -1,6 +1,6 @@ # 预览与运行 -API 编排提供了运行功能,点击 **「运行」** 打开运行面板。 +API 流水线提供了运行功能,点击 **「运行」** 打开运行面板。 ![运行](/img/workflow/run.png) diff --git a/docs/workflow/scene/audio.md b/docs/workflow/scene/audio.md index ad67e05f8510002270af336250a8b95687738f95..f49ff9c0073e2e77e62a47438691ad3176e365e0 100644 --- a/docs/workflow/scene/audio.md +++ b/docs/workflow/scene/audio.md @@ -2,7 +2,7 @@ 语音模型包括自动语音识别(ASR)和语音合成(TTS)两大类型,为音频内容的理解和生成提供强大能力。 -![工作流](/img/workflow/example-audio.png) +![API 流水线](/img/workflow/example-audio.png) ## 自动语音识别模型 diff --git a/docs/workflow/scene/image.md b/docs/workflow/scene/image.md index 99619625f4b5f747b39ff07d61dae3c0b1c3abd2..3245ad66af2539cdeb09b6c82dfbb7aabef1f3e4 100644 --- a/docs/workflow/scene/image.md +++ b/docs/workflow/scene/image.md @@ -2,7 +2,7 @@ 图像生成模型能够根据文字描述或其他图像生成高质量的图像内容,支持多种创作和编辑场景,为视觉内容创作提供强大支持。 -![工作流](/img/workflow/example-image.png) +![API 流水线](/img/workflow/example-image.png) ## 主要应用场景 diff --git a/docs/workflow/scene/security.md b/docs/workflow/scene/security.md index 3a0cf6a63fead6a485494d222c4e2016688949b3..7b619251d22d177858b226d262649f55700ef88d 100644 --- a/docs/workflow/scene/security.md +++ b/docs/workflow/scene/security.md @@ -2,7 +2,7 @@ 风控识别模型专门用于内容安全审核,能够自动识别和过滤不当内容,保障平台和业务的安全合规运营。 -![工作流](/img/workflow/example-vision.png) +![API 流水线](/img/workflow/example-vision.png) ## 主要应用场景 diff --git a/docs/workflow/scene/text.md b/docs/workflow/scene/text.md index 468dfa5f845b426d7f35a22296f94a8b7ab9d4e7..fc3aac50cb88637b4aa647ebc7029e1507b7e397 100644 --- a/docs/workflow/scene/text.md +++ b/docs/workflow/scene/text.md @@ -1,6 +1,6 @@ # 文本生成模型应用场景 -文本生成模型(LLM) 节点是能够利用大语言模型的对话/生成/分类/处理等能力,根据给定的提示词处理广泛的任务类型,并能够在工作流的不同环节使用。包含多种主流模型,如DeepSeek、Qwen系列等。 +文本生成模型(LLM) 节点是能够利用大语言模型的对话/生成/分类/处理等能力,根据给定的提示词处理广泛的任务类型,并能够在 API 流水线的不同环节使用。包含多种主流模型,如DeepSeek、Qwen系列等。 ![模型节点](/img/workflow/run.png) ![模型节点](/img/workflow/example-text.png) diff --git a/sidebars.ts b/sidebars.ts index 643e647e090cd6756ba90c87ebf32f97ebdcfe16..fc049ea461e992a411b57783b46797f8cfbfb479 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -287,7 +287,7 @@ const sidebars: SidebarsConfig = { { type: 'category', collapsed: true, - label: 'API 编排', + label: 'API 流水线', link: { type: 'doc', id: 'workflow', diff --git a/static/img/workflow/step-1.png b/static/img/workflow/step-1.png index b3ffe2e7f57198a3e7debe3048fa5f8be51a43bf..6c7844ab4b303b5deaf181c841839109e69ca540 100644 Binary files a/static/img/workflow/step-1.png and b/static/img/workflow/step-1.png differ diff --git a/static/img/workflow/step-2.png b/static/img/workflow/step-2.png index 40ec2e71ce6e8f238b0682c96ddcdd6200980bcf..34f723912a943ae59e1dd0b5030cbdce1a50745e 100644 Binary files a/static/img/workflow/step-2.png and b/static/img/workflow/step-2.png differ