模型检测功能使用说明

本文阅读时长:11分钟更新于2025-05-30

一、功能介绍

模型检测功能旨在帮助在建模阶段早期发现潜在问题,以应对参数化模型日益增长的复杂性。通过自动化的检测机制,本功能可以有效识别模型中可能存在的错误配置不合理参数结构缺陷,从而:

  • 降低风险:显著减少因模型错误导致的生产环境返工,避免可能造成的资损
  • 提升效率:替代繁琐的人工检查和工具内测试,将原先复杂的检测流程缩短至更简便的步骤
  • 保障质量:通过预设的通用特征和灵活的自定义特征,对模型进行多维度检查,提升模型库的整体质量

二、面向用户

全体参数化编辑器建模的用户,逐步开放中

三、操作步骤

1、模型检测入口

模型检测功能入口位于后台的变量与数据页面,点击模型检测即可进入

2、模型检测主界面

进入后,您会看到主要的功能区域,包括选择检测范围、选择检测特征、管理特征、开始检测、检测历史等功能

3、执行模型检测

模型检测执行以任务的形式发起

第一步:选择检测范围

1)选择模型范围

  • 首先,在“请选择检测范围”下,从下拉框中选择您需要检测模型所在的行业线(如:全屋家具定制)
  • 接着,在“请选择类目”中进一步选择库节点/文件夹来圈定模型范围
  • 支持选择所有编辑器可打开的模型、虚拟模型
  • 支持跨行业线选择模型,但不支持跨库选择

2)选择模型版本

  • 优先正式版本(默认选中)
  • 优先草稿版本

第二步:选择检测特征

1)通用特征

  • 系统预置了一系列常用的检测脚本,封装为“通用特征”选,这些特征覆盖了常见的模型错误类型
  • 您可以根据需要,勾选一个或多个通用特征进行检测,各特征之间独立检查
  • 例如:“传递隐藏变量配置错误”、“包含某个材质”、“子部件上使用了@A.constants.xx的语法”等

2)自定义特征

  • 如果您有特定的检测需求,可以通过“自定义特征”来实现
  • 已创建的自定义特征会在此列出,您可以勾选使用。
  • 点击“+管理自定义特征”超链接,可以跳转到自定义特征管理界面,进行NCQL脚本的编写和封装。(详见“4、 管理自定义特征”)

第三步:开始检测

1)完成模型和特征选择后,点击右下角的开始检测按钮

2)系统会弹窗提示“确认是否检测”,点击确认后,将发起一次检测任务

3)任务发起后,您可以在检测历史中查看任务的执行状态和结果

4、管理自定义特征

第一步:点击“检测”页面的“+管理自定义特征”链接

第二步:此区域提供一个独立的开发环境,您可以通过编写NCQL脚本来定义新的检测逻辑

第三步:编写完成的脚本可以封装为一个自定义特征选项,供后续在“检测”页面选择使用

  • 注意:通用特征不允许删除,但您创建的自定义特征可以被删除

第四步:此页面主要包含以下四个区域:

1)左侧:脚本导航区

  • 作用:展示和管理所有的特征脚本
  • 内容:
    • 通用特征:列出系统预设的通用特征脚本,供用户查看和参考其实现方式
    • 自定义特征:列出用户已创建的自定义特征脚本。用户可以点击选择已有脚本,或点击此区域的“+”号(或类似按钮)来新建脚本

2)中间:脚本编辑区

  • 作用:用户在此区域编写、查看或修改NCQL脚本的具体代码
  • 联动:当在左侧选择一个脚本或新建脚本后,其代码内容会显示在此处以供编辑

3)右侧:脚本校验结果区

  • 作用:实时显示当前编辑区内NCQL脚本的语法校验结果
  • 指示:告知用户脚本是否存在语法错误或警告

4)下方:开发文档区

  • 作用:提供编写NCQL脚本时必要的参考信息
  • 内容
    • 类型文档:说明脚本中可以访问和操作的模型数据结构及其属性
    • 函数文档:列出脚本中可以调用的内置函数及其功能描述

5. 检测历史

在检测历史中,您可以查看所有已发起检测任务的记录

  • 检测时间: 任务发起的时间
  • 任务ID: 系统为每个检测任务生成的唯一标识
  • 任务状态:
    • 执行中: 任务正在进行

    • 成功: 任务成功

    • 失败: 检测过程出错(例如网络波动、脚本能力不完善等)

    • 已取消: 用户手动取消的检测任务

    • 已过期: 超过30天存储期限的任务

  • 详情:当前检测任务相应的检测特征
  • 操作人: 发起检测任务的用户

  • 检测结果:

    • 若检测成功,显示“下载”超链接,点击可下载该任务的检测结果统计表
    • 若检测失败,显示“-”

四、常见问题

Q1: 我可以同时运行多个检测任务吗?
A1: 不可以。系统限制同时只能有1个检测任务在执行。如果您在已有任务执行时尝试发起新任务,系统会提示:“检测任务正在进行,请稍后再试”

Q2: 如果检测任务失败了怎么办?
A2: 如果任务状态显示为“失败”,请查看“备注”列获取失败原因。可能的原因有脚本故障、网络波动等。您可以根据提示尝试重试,或联系工作人员协助排查

Q3: 检测结果会保存多久?
A3: 检测历史和结果会保存30天。超过30天的任务状态会变为“已过期”,结果可能无法再下载

Q4: “通用特征”和“自定义特征”有什么区别?我可以修改或删除“通用特征”吗?
A4: “通用特征”是系统预设的、经过验证的常用检测规则,不允许用户删除或修改。“自定义特征”是用户根据自身需求,通过编写NCQL脚本创建的检测规则,用户可以对其进行管理和删除

Q5: “自定义特征”中的NCQL脚本需要我自己从零开始写吗?
A5: 是的,“自定义特征”功能提供了一个独立的开发环境,您可以在其中编写NCQL脚本来实现特定的检测逻辑,并将其封装成一个可供选择的特征项

Q6: “检测所有测试用例”模式是什么时候会用到?
A6: “检测所有测试用例”是二期规划的功能。它允许您为模型定义多组参数组合(测试用例),并在这些组合下运行特征检测,以覆盖更多场景。一期功能主要围绕“检测当前值”进行


可以随时点赞啦