From e306e413e1a15488dc93c859b594324a7a133827 Mon Sep 17 00:00:00 2001 From: AllenWriter Date: Mon, 16 Jun 2025 18:19:51 +0800 Subject: [PATCH] Docs: update app and node history --- docs.json | 3 +- .../knowledge-base-creation/introduction.mdx | 2 +- ...ug-node.mdx => debug-node-block-point.mdx} | 0 .../debug-and-preview/history-and-logs.mdx | 59 +++++++++++++++ .../workflow/debug-and-preview/history.mdx | 49 ------------ .../debug-and-preview/preview-and-run.mdx | 56 +++++++------- .../workflow/debug-and-preview/step-run.mdx | 74 ++++++++++++++++--- .../debug-and-preview/variable-inspect.mdx | 48 ++++++------ zh-hans/guides/workflow/node/code.mdx | 2 +- 9 files changed, 181 insertions(+), 112 deletions(-) rename zh-hans/guides/workflow/debug-and-preview/{debug-node.mdx => debug-node-block-point.mdx} (100%) create mode 100644 zh-hans/guides/workflow/debug-and-preview/history-and-logs.mdx delete mode 100644 zh-hans/guides/workflow/debug-and-preview/history.mdx diff --git a/docs.json b/docs.json index d91beb3d..1c252cf1 100644 --- a/docs.json +++ b/docs.json @@ -756,8 +756,7 @@ "pages": [ "zh-hans/guides/workflow/debug-and-preview/preview-and-run", "zh-hans/guides/workflow/debug-and-preview/step-run", - "zh-hans/guides/workflow/debug-and-preview/log", - "zh-hans/guides/workflow/debug-and-preview/history", + "zh-hans/guides/workflow/debug-and-preview/history-and-logs", "zh-hans/guides/workflow/debug-and-preview/variable-inspect" ] }, diff --git a/zh-hans/guides/knowledge-base/knowledge-base-creation/introduction.mdx b/zh-hans/guides/knowledge-base/knowledge-base-creation/introduction.mdx index 746ffcc1..a521557d 100644 --- a/zh-hans/guides/knowledge-base/knowledge-base-creation/introduction.mdx +++ b/zh-hans/guides/knowledge-base/knowledge-base-creation/introduction.mdx @@ -33,7 +33,7 @@ title: 创建步骤 #### ETL -在 RAG 的生产级应用中，为了获得更好的数据召回效果，需要对多源数据进行预处理和清洗，即 ETL （_extract, transform, load_）。为了增强非结构化/半结构化数据的预处理能力，Dify 支持了可选的 ETL 方案：**Dify ETL** 和[**Unstructured ETL**](https://docs.unstructured.io/welcome)[**Unstructured ETL** ](https://unstructured.io/)。Unstructured 能够高效地提取并转换你的数据为干净的数据用于后续的步骤。Dify 各版本的 ETL 方案选择： +在 RAG 的生产级应用中，为了获得更好的数据召回效果，需要对多源数据进行预处理和清洗，即 ETL （_extract, transform, load_）。为了增强非结构化/半结构化数据的预处理能力，Dify 支持了可选的 ETL 方案：**Dify ETL** 和[**Unstructured ETL**](https://docs.unstructured.io/welcome)。Unstructured 能够高效地提取并转换你的数据为干净的数据用于后续的步骤。Dify 各版本的 ETL 方案选择： * SaaS 版不可选，默认使用 Unstructured ETL； * 社区版可选，默认使用 Dify ETL ，可通过[环境变量](/zh-hans/getting-started/install-self-hosted/environments)开启 Unstructured ETL； diff --git a/zh-hans/guides/workflow/debug-and-preview/debug-node.mdx b/zh-hans/guides/workflow/debug-and-preview/debug-node-block-point.mdx similarity index 100% rename from zh-hans/guides/workflow/debug-and-preview/debug-node.mdx rename to zh-hans/guides/workflow/debug-and-preview/debug-node-block-point.mdx diff --git a/zh-hans/guides/workflow/debug-and-preview/history-and-logs.mdx b/zh-hans/guides/workflow/debug-and-preview/history-and-logs.mdx new file mode 100644 index 00000000..114d5c1b --- /dev/null +++ b/zh-hans/guides/workflow/debug-and-preview/history-and-logs.mdx @@ -0,0 +1,59 @@ +--- +title: 调试历史 +--- + +调试 Chatflow / Workflow 应用时将生成详细的历史记录，包括整个应用的执行日志和应用内各个节点的运行详情。开发者可以查看不同维度的历史记录以快速定位问题、分析应用的性能表现并优化工作流配置。 + + + 如需查看发布应用后用户所产生的应用使用记录，请参考[日志与标注](/zh-hans/guides/annotation/logs)。 + + +应用的运行记录分为以下两个维度。 + +## 应用调试历史 + +运行应用后将产生**运行历史（Run History）**，每次运行节点时将产生一次版本记录。每个版本包含当前应用的**对话记录（Conversation Log）**，以及当前版本记录内各个节点的**追踪日志（TRACING）**。这些记录按时间顺序排列，显示应用内每次对话交互的基本信息，包括运行时间、执行状态、输入输出参数概要等。你可以通过该列表快速找到过往的应用运行详情。 + +![](https://assets-docs.dify.ai/2025/04/08a885858cfa6e8863faac891a5be319.png) + +点击任意一条运行记录查看该次执行的详细信息。每次版本运行包含三个主要部分： + +### 运行结果（RESULT） + + + 运行结果仅面向 Workflow 应用类型。 + + +显示工作流的最终输出结果，即用户最终看到的内容。如果工作流执行失败，此处会显示错误信息和失败原因。 + +![](https://assets-docs.dify.ai/2025/06/22856751d278ffad99d0533d2d96e125.png) + +### 运行详情（DETAIL） + +包含每次应用运行/对话时的完整输入参数、系统元数据和配置信息。你可以在这里查看： + +- 用户输入的原始数据 +- 工作流应用的输出数据 +- 系统自动生成的元数据 + +![](https://assets-docs.dify.ai/2025/06/882b783cd843ab666f5bc3c06f78521d.png) + +### 追踪（TRACING） + +在这个视图内你可以查看以下信息： + +- **节点执行顺序**：工作流中各个节点的实际执行顺序。 +- **数据流转过程**：数据在节点间的传递和转换情况。你也可以通过[变量检查](/zh-hans/guides/workflow/debug-and-preview/variable-inspect)进行查看。 +- **执行时间分析**：每个节点的运行时长，帮助识别性能瓶颈。 +- **资源消耗统计**：Token 使用量、API 调用次数等成本信息。 +- **错误定位**：快速找到执行失败的具体节点和原因。 + +![](https://assets-docs.dify.ai/2025/06/9e614ac01b1f6e0aeadda78c91ce93b7.png) + +通过节点追踪视图，你可以深入了解工作流的内部运行机制，这对于调试复杂工作流和优化性能表现非常有价值。特别是当工作流包含多个分支或循环逻辑时，追踪视图能够清晰地展示实际的执行路径。 + +## 节点调试记录 + +除了查看应用整体的运行历史，你还可以在工作流编辑界面中查看单个节点在最后一次调试过程时产生的记录。点击任意节点内节点配置面板中的 **上次运行** 进行查看。 + +![](https://assets-docs.dify.ai/2025/06/9c6e57236d85f426a930424863042d7d.png) diff --git a/zh-hans/guides/workflow/debug-and-preview/history.mdx b/zh-hans/guides/workflow/debug-and-preview/history.mdx deleted file mode 100644 index 5f871151..00000000 --- a/zh-hans/guides/workflow/debug-and-preview/history.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: 运行历史 ---- - -工作流运行后会生成详细的历史记录，包括整个应用的执行日志和各个节点的运行状态。通过这些历史记录，你可以快速定位问题、分析性能表现和优化工作流配置。 - -## 工作流应用运行历史 - -每次运行工作流都会在运行历史页面生成一条完整的执行记录。这些记录按时间顺序排列，显示了每次运行的基本信息，包括运行时间、执行状态、输入输出概要等。你可以通过这个列表快速找到需要分析的特定运行记录中的完整运行详情。 - -![](https://assets-docs.dify.ai/2025/04/08a885858cfa6e8863faac891a5be319.png) - -点击任意一条运行记录，可以查看该次执行的详细信息。运行详情分为三个主要部分： - -### 运行结果（RESULT） - -显示工作流的最终输出结果，这是用户最终看到的内容。如果工作流执行失败，这里会显示错误信息和失败原因。 - -### 运行详情（DETAIL） - -包含该次运行的完整输入参数、系统元数据和配置信息。你可以在这里查看： - -- 用户输入的原始数据 -- 工作流应用的输入输出数据 -- 系统自动生成的元数据 - -![](https://assets-docs.dify.ai/2025/06/882b783cd843ab666f5bc3c06f78521d.png) - -### 追踪（TRACING） - -在这个视图内你可以查看以下信息： - -- **节点执行顺序**：工作流中各个节点的实际执行顺序。 -- **数据流转过程**：数据在节点间的传递和转换情况。你也可以通过[变量视图](/zh-hans/guides/workflow/debug-and-preview/variable-inspect)进行查看。 -- **执行时间分析**：每个节点的运行时长，帮助识别性能瓶颈。 -- **资源消耗统计**：Token 使用量、API 调用次数等成本信息。 -- **错误定位**：快速找到执行失败的具体节点和原因。 - -![](https://assets-docs.dify.ai/2025/06/9e614ac01b1f6e0aeadda78c91ce93b7.png) - -通过节点追踪视图，你可以深入了解工作流的内部运行机制，这对于调试复杂工作流和优化性能表现非常有价值。特别是当工作流包含多个分支或循环逻辑时，追踪视图能够清晰地展示实际的执行路径。 - -## 单个节点运行历史 - -除了查看整体运行历史，你还可以在工作流编辑界面中查看单个节点的运行记录。点击任意节点，在节点配置面板中的 **上次运行** 查看该节点在不同调试过程中的历史执行记录。 - -单个节点的历史记录让你能够专注于解决局部问题，无需重新运行整个工作流，从而提高调试效率。 - -![](https://assets-docs.dify.ai/2025/06/9c6e57236d85f426a930424863042d7d.png) diff --git a/zh-hans/guides/workflow/debug-and-preview/preview-and-run.mdx b/zh-hans/guides/workflow/debug-and-preview/preview-and-run.mdx index 474c927f..2cde515e 100644 --- a/zh-hans/guides/workflow/debug-and-preview/preview-and-run.mdx +++ b/zh-hans/guides/workflow/debug-and-preview/preview-and-run.mdx @@ -1,62 +1,66 @@ --- -title: 预览与调试应用 +title: 功能简介 --- -工作流创建完成后，建议开发者在发布应用前完成应用调试以确保各个节点正常运行、变量内的数据能够正确流转。Dify 提供了完整的调试工具，帮助你快速定位问题、检查变量传递和查看详细日志。本文介绍调试工作流应用的方法和技巧。 +创建工作流后，开发者可在发布应用前调试应用以确保各个节点正常运行、验证变量内的数据是否能够正确流转。Dify 提供了完整的调试工具，帮助你快速定位问题、检查变量传递和查看详细日志。 + +本文介绍工作流应用调试的完整流程，包括单节点调试、变量检查、运行历史查看以及整体测试方法。 ![](https://assets-docs.dify.ai/2025/06/8e7933b45a69241a9861a09fa47d5c62.png) -## 调试工作流 +## 调试工作流应用 ### 单节点调试 -当工作流中某个节点出现问题导致工作流应用无法正常运行时，可以单独调试该节点来快速定位问题。 +当工作流中某个节点出现问题导致工作流应用无法正常运行时，单独调试该节点以快速定位问题。 -点击节点右上角的调试按钮，输入测试数据并查看输出结果。在调试过程中，建议从简单的测试数据开始，逐步增加数据复杂度，确保节点在各种输入情况下都能正常工作。详细的单节点调试方法请参考[调试节点](/zh-hans/guides/workflow/debug-and-preview/debug-node)。 +点击节点右上角的调试按钮，输入测试数据并查看输出结果。在调试过程中，建议从简单的测试数据开始，逐步增加数据复杂度，确保节点在各种输入情况下都能正常工作。 + +关于详细的单节点调试方法，请参考[调试节点](/zh-hans/guides/workflow/debug-and-preview/debug-node)。 ![](https://assets-docs.dify.ai/2025/06/44decb6644b140e46ed2e1e9246f48f7.png) -### 变量检查 +### 逐步调试节点 -工作流中节点间的变量传递是最容易出现问题的环节，特别是数据类型转换和变量映射配置。在调试时要重点检查每个节点的输入变量是否正确接收了上游节点的输出，变量的数据格式是否匹配预期。 +逐步调试节点指的是基于上游节点的变量，检查下游节点是否正确处理变量内的数据并输出预期处理结果。 -常见问题包括字符串和数组的转换、JSON 格式的解析错误、以及变量引用路径不正确。你可以通过变量检查功能查看实际传递的变量值，对比预期结果来发现问题，详细说明请参考[变量检查](/zh-hans/guides/workflow/debug-and-preview/variable-inspect)。 +详细使用方法请参考[变量检查](/zh-hans/guides/workflow/debug-and-preview/variable-inspect)。 ![](https://assets-docs.dify.ai/2025/06/887630764b180a60becb6a4fcee2c622.png) -### 节点运行历史 +### 查看节点调试记录 -每个节点执行后将生成详细的运行日志，帮助开发者排查问题。点击节点详情页中的“上次运行”可以查看执行日志，包括输入参数、输出结果、执行时间和错误信息。详细说明请参考[节点日志](/zh-hans/guides/workflow/debug-and-preview/history)。 +执行节点后将生成详细的运行记录，帮助开发者排查问题。点击节点详情页中的“上次运行”查看执行日志，包括输入参数、输出结果、执行时间和错误信息。详细说明请参考[调试历史 - 节点运行记录](/zh-hans/guides/workflow/debug-and-preview/history-and-logs#节点运行记录)。 ![](https://assets-docs.dify.ai/2025/06/a6011d5966c78a4d1705f2af44ed8af1.png) ### 调试整体流程 -单个节点调试完成后，需要运行整个工作流来验证端到端的执行效果。点击右上角的"预览"按钮进入调试模式，输入符合实际使用场景的测试数据，观察工作流的完整执行过程。 +完成所有节点的调试工作后，接下来运行整个工作流来验证端到端的执行效果。 -系统会自动检查工作流配置，如果发现节点连接错误、必填参数缺失等问题，会在界面右上角进行提示，解决所有问题后方可运行应用。工作流运行时，你可以在右侧面板查看每个节点的执行状态，包括输入参数、输出结果和执行日志。通过节点上的状态指示器（绿色表示成功）可以快速识别流程在哪个节点处异常而造成中断。 +使用预览功能体验应用的最终用户界面，该模式将完整展示包括输入框、输出展示和交互流程。主要用于验证用户体验是否符合预期。系统在预览时会进行自动检查，确保所有节点配置正确且连接完整。 + +![](https://assets-docs.dify.ai/2025/06/de00849b363ec9356e5764b88b4331fb.png) + +#### 检查清单 + +系统会自动检查工作流配置，如果发现节点连接错误、必填参数缺失等问题，会在界面右上角进行提示，解决所有问题后方可运行应用。 + +![](https://assets-docs.dify.ai/2025/06/85bafda1f786549c22404cd5ec711d0f.png) + +运行工作流时，在右侧面板查看每个节点的执行状态，包括输入参数、输出结果和执行日志。通过节点上的状态指示器（绿色表示成功）快速识别流程在哪个节点处异常而造成中断。 建议在正式发布前进行多轮测试，使用不同类型和复杂度的数据来验证工作流的稳定性。 ![](https://assets-docs.dify.ai/2025/06/c09f788f77b5f8ebdd635ddba66a1b99.png) -## 检查清单 +## 查看应用的运行日志 -正式进入调试流程之前，你可以在检查清单内检查是否有未完成配置、未连线的节点或未配置的变量。 +发布应用后，开发者可以通过应用的**日志和监测功能**查看用户使用该应用的对话记录和性能数据。这些历史记录有助于查看用户的行为路径、分析应用性能变化和复盘问题原因。 -![](https://assets-docs.dify.ai/2025/06/85bafda1f786549c22404cd5ec711d0f.png) - -## 预览应用 - -完成所有调试工作后，使用预览功能体验应用的最终用户界面。预览模式会展示应用发布后用户实际看到的界面效果，包括输入框、输出展示和交互流程。这个功能主要用于验证用户体验是否符合预期，而技术问题的排查还是要依靠上述的调试功能。系统在预览时会进行自动检查，确保所有节点配置正确且连接完整。 - -![](https://assets-docs.dify.ai/2025/06/de00849b363ec9356e5764b88b4331fb.png) - -## 工作流应用运行历史 - -你可以通过应用的日志和监测功能查看用户使用该应用的对话记录和性能数据。这些历史记录有助于查看用户的行为路径、分析应用性能变化和复盘问题原因。 +![](https://assets-docs.dify.ai/2025/06/6dd8e8a7186089a390679b6de4bb97b9.png) 详细说明请参考以下文档： -- [日志与标注](/zh-hans/guides/annotation/logs) +- [运行历史](/zh-hans/guides/workflow/debug-and-preview/history) - [监测](/zh-hans/guides/monitoring/README) diff --git a/zh-hans/guides/workflow/debug-and-preview/step-run.mdx b/zh-hans/guides/workflow/debug-and-preview/step-run.mdx index e3513351..f8cc192f 100644 --- a/zh-hans/guides/workflow/debug-and-preview/step-run.mdx +++ b/zh-hans/guides/workflow/debug-and-preview/step-run.mdx @@ -1,33 +1,85 @@ --- -title: 单步调试 +title: 调试节点 --- -Workflow / Chatflow 类型应用通常包含多个节点，每个节点互有关联。若要确保应用整体运行正常，需要确认每个节点的输入输出符合预期。调试节点功能可以帮助开发者检测应用是否按照设计预期提供服务，提前发现并解决潜在问题，避免在生产环境中出现错误。 +Workflow / Chatflow 类型应用通常包含多个节点，每个节点互有关联。若要确保应用整体运行正常，需要确认每个节点的输入输出符合预期。 + +调试节点功能可以帮助开发者检测应用是否按照设计预期提供服务，提前发现并解决潜在问题，避免在生产环境中出现错误。 + +调试节点分为单步调试和逐步执行两种方法。 + +## 单步调试 + +### 方法简介 单步调试允许你对工作流内的特定节点进行独立测试，无需执行整个工作流。它可以帮助开发者在应用内添加新节点时验证其功能、排查特定节点的错误以及测试节点对不同输入的响应。 -## 操作步骤 +### 操作步骤 1. 在工作流编辑界面选择需要调试的节点 -2. 点击节点右上角的 **run step** 按钮 -3. 在弹出的调试面板中填写该节点的输入变量 -4. 点击执行按钮触发节点运行 -5. 查看节点的输出结果及运行状态 +2. 在节点的设置页内填写输入变量 +3. 点击执行按钮触发节点运行 +4. 查看节点的输出结果及运行状态 -例如，在工作流内添加了一个 HTTP 节点，为验证该节点能否正确获取并处理 API 响应，你可以使用单步调试功能模拟节点的实际工作状态，而不会影响下游节点。 +### 示例 + +在工作流内添加 HTTP 节点，为验证该节点能否正确获取并处理 API 响应，你可以使用单步调试功能模拟节点的实际工作状态，确保能够正确向下游节点传递数据。 ![](https://assets-docs.dify.ai/2025/04/376c9de6f92cb7a5f97a6661c5e0e9eb.png) -调试完成后，你可以看到当前节点的运行状态、输入/输出、元数据信息。如遇报错，可通过报错信息快速排查错误，避免节点异常导致的应用整体运行失败。 +调试完成后，你可以“上次运行”页查看当前节点的运行状态、查看输入/输出、元数据信息。如遇报错，可通过报错信息快速排查错误，避免单个节点运行异常而导致整体运行失败。 回答、结束节点不支持单步调试。 +## 逐步执行 + +### 方法简介 + +工作流的运行依赖于数据能够正确地从一个节点流转到下一个节点。若工作流较为复杂，该过程容易出错，常见问题包括： + +- 数据格式不匹配（如文本传给了需要数字的节点） +- 变量配置错误 +- JSON 数据解析失败 +- 变量路径引用错误 + +逐步执行节点的调试方法能够帮助开发者在复杂的工作流应用内快速排查错误。 + +调试节点时，节点的输出变量将会被缓存至“变量检查”内。开发者可以直接在“变量检查”内修改变量，快速修改上游变量内的数据，验证不同数值对于下游节点的影响， + +该方法适用于测试多个相互依赖的节点组合。 + +![](https://assets-docs.dify.ai/2025/06/f8656d8deeeaefeab0a8d9169f0ed2d3.png) + +运行节点后，系统会自动将输出数据保存到"变量检查"视图中。你可以使用以下方法排除潜在问题： + +1. **查看实际数据**：对比节点输出的数据是否符合预期 +2. **修改测试数据**：直接在视图内修改变量值，测试对后续节点的影响 +3. **验证数据流转**：确认数据能正确传递到下游节点 + +### 操作步骤 + +1. 在调试模式中运行应用 +2. 点击应用底部的变量检查，查看变量缓存 +3. 定位需要调试的节点，查看它引用了哪个变量 +4. 在变量检查内修改该变量的值，重新运行节点 +5. 比对运行效果 + +### 示例 + +假设存在一个工作流：数据获取(A 节点) → 数据处理(B 节点) → 结果展示(C 节点)。 + +B 节点的功能完全依赖于 A 节点的输出数据，并且不同的数据将影响 B 节点的运行情况。 + +运行 A 节点后的输出变量值将保存至“变量检查”内。开发者可以修改“变量检查”内的数据，验证对于 B 节点的影响而无需手动再次运行 A 节点。 + +逐步执行过程中，你可以观察局部工作流的运行情况，基于结果及时调整节点的配置、数据流向和处理逻辑，确保工作流的效率和准确性。 + ## 查看节点调试记录 -每个节点运行完成后都会生成操作日志，你可以点击节点详情页中的“上次运行”查看运行历史。 +每个节点运行完成后都会生成操作记录，点击节点详情页中的 Last run 进行查看。 -![](https://assets-docs.dify.ai/2025/06/9c6e57236d85f426a930424863042d7d.png) +![](https://assets-docs.dify.ai/2025/04/5ee92e6406979f5101d21865f95a86e5.png) 如需查看应用整体的运行历史，详细说明请参考[运行历史](/zh-hans/guides/workflow/debug-and-preview/history)。 diff --git a/zh-hans/guides/workflow/debug-and-preview/variable-inspect.mdx b/zh-hans/guides/workflow/debug-and-preview/variable-inspect.mdx index 780ff70c..8a1caeb3 100644 --- a/zh-hans/guides/workflow/debug-and-preview/variable-inspect.mdx +++ b/zh-hans/guides/workflow/debug-and-preview/variable-inspect.mdx @@ -25,39 +25,43 @@ title: 变量检查 支持的主要操作包括： -- **查看值**：展开变量查看当前结构及内容（支持对象/数组层级展开） -- **清除变量**：点击 **Clear** 按钮清除当前所有已记录的变量缓存，用于重新调试 -- **重置值**：恢复至上一次运行时的变量状态 +- **查看**：展开变量查看当前结构及内容（支持对象/数组层级展开） +- **清除**：点击 **Clear** 按钮清除当前所有已记录的变量缓存，用于重新调试 +- **重置**：恢复至上一次运行时的变量状态 +- **编辑**：修改某个变量所对应的数据 -> 当画布中无任何节点运行时，变量检查将自动收起。 +## 支持的变量和数据类型 -## 变量检查支持的变量类型 +### 变量类型示例 -### 变量类型 - -| 变量类别 | 示例变量 | 描述 | +| 变量类别 | 示例变量 | 描述 | 是否可以被编辑 |---------|---------|------| | **系统变量** | sys.query, sys.user_id, sys.conversation_id | 系统提供的当前会话信息 | -| **会话历史变量** | chat_history, custom_chat_history | 对话历史记录 | | **节点输出变量** | output, structured_output, usage, loop_variable | 各节点的输出结果 | | **异常变量** | error_message, error_type | 节点的异常输出结果 | | **自定义变量** | [用户定义名称], 文件变量 | 用户在开始节点中自定义的输入变量，上传的文件变量 | | **环境变量** | OPENAI_KEY, PORT | 系统环境配置 | +| **循环变量** | OPENAI_KEY, PORT | 系统环境配置 | -### 数据类型 +### 数据类型示例 -| 类型 | 描述 | 示例 | 是否可编辑 | -|------|------|------|--------------| -| `string` | 文本类型，常用于模型输入输出 | `"Hello, world!"` | ✅ | -| `number` | 数值类型，适用于评分、标记等场景 | `0.85` | ✅ | -| `boolean` | 布尔值，用于条件判断节点 | `true` / `false` | ✅ | -| `object` | 结构化 JSON 数据 | `{ "key": "value" }` | ✅ | -| `array` | 列表数组，适用于多项输出/上下文记录 | `[1, 2, 3]` | ✅ | -| `secret` | 隐私变量（如 API 密钥） | `******` | ❌ | +| 类型 | 描述 | 示例 | +|------|------|------| +| `string` | 文本类型，常用于模型输入输出 | `"Hello, world!"` | +| `number` | 数值类型，适用于评分、标记等场景 | `0.85` | +| `boolean` | 布尔值，用于条件判断节点 | `true` / `false` | +| `object` | 结构化 JSON 数据 | `{ "key": "value" }` | +| `array` | 列表数组，适用于多项输出/上下文记录 | `[1, 2, 3]` | +| `secret` | 隐私变量（如 API 密钥） | `******` | +## 实践示例 -## 最佳实践 +> 该部分文档待补充，最好是给一个 DSL 示例，还在准备 -- 在流程开发过程中，建议每完成一步配置后通过变量检查验证节点输出是否正确。 -- 出现节点报错时，优先查看变量检查中的 `error_message` 和 `error_type` 获取诊断信息。 -- 编辑变量值后可直接运行下游节点，模拟真实运行情况，辅助判断流程稳定性。 +假设存在一个工作流：数据获取(A 节点) → 数据处理(B 节点) → 结果展示(C 节点)。 + +B 节点的功能完全依赖于 A 节点的输出数据，并且不同的数据将影响 B 节点的运行情况。 + +运行 A 节点后的输出变量值将保存至“变量检查”内。开发者可以修改“变量检查”内的数据，验证对于 B 节点的影响而无需手动再次运行 A 节点。 + +逐步执行过程中，你可以观察局部工作流的运行情况，基于结果及时调整节点的配置、数据流向和处理逻辑，确保工作流的效率和准确性。 diff --git a/zh-hans/guides/workflow/node/code.mdx b/zh-hans/guides/workflow/node/code.mdx index 37cc5020..b541a2c5 100644 --- a/zh-hans/guides/workflow/node/code.mdx +++ b/zh-hans/guides/workflow/node/code.mdx @@ -27,7 +27,7 @@ title: 代码执行 ### 结构化数据处理 -在工作流中，经常要面对非结构化的数据处理，如JSON字符串的解析、提取、转换等。最典型的例子就是HTTP节点的数据处理，在常见的API返回结构中，数据可能会被嵌套在多层JSON对象中，而我们需要提取其中的某些字段。代码节点可以帮助你完成这些操作，下面是一个简单的例子，它从HTTP节点返回的JSON字符串中提取了`data.name`字段： +在工作流中，经常要面对非结构化的数据处理，如 JSON 字符串的解析、提取、转换等。最典型的例子就是 HTTP 节点的数据处理，在常见的 API 返回结构中，数据可能会被嵌套在多层 JSON 对象中，而我们需要提取其中的某些字段。代码节点可以帮助你完成这些操作，下面是一个简单的例子，它从 HTTP 节点返回的 JSON 字符串中提取了`data.name`字段： ```python def main(http_response: str) -> str: