diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_2.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_2.png new file mode 100644 index 0000000000000000000000000000000000000000..c9a7196c773e848b5ea1276501722c1a92f1e2cb Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_2.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_3.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_3.png new file mode 100644 index 0000000000000000000000000000000000000000..ab27162c2c9eaf186cfea0da1c0d19f364f8b6be Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_3.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_4.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_4.png new file mode 100644 index 0000000000000000000000000000000000000000..3b4abe4ef43800e58a6d04da4ab02b96a1124d2f Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/api_button_4.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/button_1.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/button_1.png new file mode 100644 index 0000000000000000000000000000000000000000..7197ee877f1c095d577193e32fe96be5f4355c7e Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/button_1.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/delete_01.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/delete_01.png new file mode 100644 index 0000000000000000000000000000000000000000..6ebc8ca33c416a180d65b7fbbf97b8c9e0d462f5 Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/delete_01.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/test_1.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/test_1.png new file mode 100644 index 0000000000000000000000000000000000000000..623659295e576c660bfe5ec0acdfdb23f1ad73ff Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/test_1.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/test_2.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/test_2.png new file mode 100644 index 0000000000000000000000000000000000000000..14fbe4b7d7b747ec25f6e1a304bbd77e7d916b5c Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/test_2.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/updata_1.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/updata_1.png new file mode 100644 index 0000000000000000000000000000000000000000..e54efb060aeb36a63f6955b6967ed067cef2af0e Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/updata_1.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/use_01.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/use_01.png new file mode 100644 index 0000000000000000000000000000000000000000..169140a6fd1dc5cfaafe5b470155504a868341f8 Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/use_01.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_1.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_1.png new file mode 100644 index 0000000000000000000000000000000000000000..8ffe3f08b0e1837c2cdc160877e7707cf5ab835d Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_1.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_2.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_2.png new file mode 100644 index 0000000000000000000000000000000000000000..9f3dd1986187d2b1ff8ca064af9d0b8ca8a0c13a Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_2.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_3.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_3.png new file mode 100644 index 0000000000000000000000000000000000000000..bf57167f7ed8580e897cb70713c7d80159bc4cf7 Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_3.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_4.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_4.png new file mode 100644 index 0000000000000000000000000000000000000000..e312b90ae6781f7a42a8e587ce8bada7286ce08f Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_4.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_5.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_5.png new file mode 100644 index 0000000000000000000000000000000000000000..231bc41bf3ebc6bcc1226a7021c7e6d4305fa42b Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_5.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_6.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_6.png new file mode 100644 index 0000000000000000000000000000000000000000..b03defd599538a0fd7dae2e211bd2638e16e998a Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_6.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_7.png b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_7.png new file mode 100644 index 0000000000000000000000000000000000000000..74eabfa684c53b4948dfdcd78f31edbcbb7a8ec8 Binary files /dev/null and b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/pictures/workflow_7.png differ diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/workflow_guidance.md b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/workflow_guidance.md index cbb83f3811d35d76e2b115f7a7b82dc2f74760aa..4ebd76502939ae1b48e22225ecc9b0a95f7595e7 100644 --- a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/workflow_guidance.md +++ b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/workflow_guidance.md @@ -1,3 +1,87 @@ -# 工作流编排使用指导 +# 工作流服务指南 -（当前内容待更新，请等待） \ No newline at end of file +## 1. 概述 + +openEuler Intelligence 当前版本已经支持工作流的自定义创建与使用，使用流程主要分为以下几个步骤： + +1. 创建语义接口 +2. 创建工作流 +3. 测试工作流 +4. 发布工作流 +5. 使用工作流 +6. 编辑/删除工作流 + +> **说明**： +> +> - 创建、测试、发布和使用工作流为普通用户权限操作 +> - 使用的浏览器为Chrome + +## 2. 工作流的使用流程 + +以下流程以普通用户账号为例，展示工作流的完整使用流程： + +1. **创建语义接口** + + > **注意**：请确保语义接口的正确性，上传后无法修改与删除。若想要重复上传相同的语义接口，请修改成不同的标题 + + 点击进入左侧的插件中心进入其中页面，点击搜索栏旁的 "创建插件" 按钮，并点击出现的 "语义接口" + ![创建插件按钮](pictures/button_1.png) + + 点击后在页面右侧会出现上传语义接口的窗口，可以拖入文件也可以点击 "选择文件" 来上传接口文件 + ![上传接口文件](pictures/api_button_2.png) + + 上传后，文本框内会显示用户上传的文件，下方也会出现 "编辑" 与 "解析" 按钮。在确认接口文件正确后，点击 "解析" 按钮 + ![解析接口文件](pictures/api_button_3.png) + + 解析完成后，右边会显示相应的接口路径与描述，代表已经上传成功，点击关闭即可 + ![解析完成](pictures/api_button_4.png) + +2. **创建工作流** + + 点击左侧的应用中心进入其页面，点击搜索栏旁的 "创建应用" 按钮，并点击出现的 "工作流应用" ，最后点击确定，进入创建工作流的页面 + ![工作流应用按钮](pictures/workflow_1.png) + + 页面的上方有 "界面配置" 和 "工作流编排" 。"界面配置" 中可以在左侧修改界面需求，包括基本信息、对话次数、权限等；左侧为相应设置下显示的预览界面；最下方可以保存当前配置与最终发布。默认界面设置已经完成，即上方已变成绿色 + ![界面配置](pictures/workflow_2.png) + + 点击上方 "工作流编排" 按钮，进入其中页面。左侧为语义接口中心，包括系统默认提供的与用户自行创建上传的语义接口，右侧为可视化工作流编排界面，可以在其中进行工作流的编排 + ![工作流编排](pictures/workflow_3.png) + + 点击右侧中心的 "创建工作流" 按钮，在弹窗中输入相应的工作流名称与描述，点击确定进入编排页面 + ![编排界面](pictures/workflow_4.png) + + 在编排界面中，可以将左侧所需的接口拖入，并用线将其链接，形成用户所需的工作流。若想删掉连线，鼠标移动到对应的线条，摁下 "Backspace" 即可删除；想删除接口，可将鼠标移动到接口右上 "..." ，点击删除即可。下图展示其中一种工作流 + ![样例编排](pictures/workflow_5.png) + + 若其中接口文件的query不确定，请将鼠标移动到接口右上 "..." ，点击 "编辑" ,并且将其中的query置空（修改为query: {}）。最后点击下方保存即可 + ![修改前](pictures/workflow_6.png) + ![修改后](pictures/workflow_7.png) + +3. **测试工作流** + + 点击编排界面左上的小虫即可进入调试页面，在弹出的窗口中输入调试的语句并上传，查看输出结果。其中的各个步骤可以点击右侧箭头进行详细查看。测试成功完成后，上方的黄色表示会变成绿色 + ![测试工作流](pictures/test_1.png) + +4. **发布工作流** + + 点击下方的 "发布" 按钮后，会自动跳转到应用中心界面，此时页面中会出现用户已经发布的工作流。 + ![发布工作流](pictures/updata_1.png) + +5. **使用工作流** + + 点击发布的工作流，进入对话界面。在界面中进行对话即可使用 + ![使用工作流](pictures/use_01.png) + +6. **编辑/删除工作流** + + 返回应用中心界面，已发布的工作流的右下角都会存在 "编辑" 和 "删除" 按钮，点击 "编辑" 可重新进入之前创建工作流的界面进行修改，点击 "删除" 可以删除对应的工作流 + ![修改工作流](pictures/delete_01.png) + +## 3. 总结 + +通过上述流程，用户可创建与使用工作流。欢迎体验并探索更多功能，也欢迎反馈各种问题。 + +## 4. 附录 + +测试使用的语义接口链接: + [测试使用语义接口](yaml/car-plate-region.yaml) diff --git a/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/yaml/car-plate-region.yaml b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/yaml/car-plate-region.yaml new file mode 100644 index 0000000000000000000000000000000000000000..c6062781ff1ead0d1305dad1ac2b08368dc39fe9 --- /dev/null +++ b/docs/zh/openEuler_intelligence/intelligent_assistant/advance/work_flow/user_guide/yaml/car-plate-region.yaml @@ -0,0 +1,55 @@ +openapi: 3.0.0 +info: + title: 车牌归属地查询接口 + description: 输入车牌号查询归属地信息 + version: 1.0.0 +servers: + - url: http://shanhe.kim/api/za +paths: + /chepai.php: + get: + summary: 车牌归属地查询 + description: 通过车牌号查询所属省份和城市 + parameters: + - name: msg + in: query + required: true + schema: + type: string + example: 川A + description: 需要查询的车牌号码 + responses: + '200': + description: 成功获取归属地信息 + content: + application/json: + schema: + $ref: '#/components/schemas/ApiResponse' +components: + schemas: + ApiResponse: + type: object + properties: + code: + type: integer + example: 1 + description: 状态码（1表示成功） + msg: + type: string + example: 获取成功! + description: 操作状态描述 + data: + type: object + properties: + province: + type: string + example: 四川 + description: 所属省份 + city: + type: string + example: 成都 + description: 所属城市 + abbreviation: + type: string + example: 川A + description: 查询的车牌号 \ No newline at end of file