昇腾社区首页
中文
注册

请求参数

表1 请求Header参数

参数

是否必选

参数类型

Content-Type

String

application/json

表2 请求body参数

参数

是否必选

参数类型

备注

ProjectName

必选

String

项目名称。

TaskName

必选

String

任务名称。

TaskType

可选

String

任务类型,检测、OCR、分割场景必选。

  • WithReg:做配准+后处理模式。
  • WithoutReg:纯推理,用于建模。
  • SetTemplate:建模完毕后用于设置模板。
  • Annot:用于错漏反、OCR、胶体检测半自动标注。

错漏反场景:WithReg/WithoutReg

工业OCR场景:WithReg

胶体检测场景:WithReg/WithoutReg/SetTemplate

半自动标注场景:Annot

MachineId

可选

String

工控机ID。

使用WithReg/SetTemplate模式必选

ProductCode

可选

String

当前生产的产品编码。

使用WithReg/SetTemplate模式必选

CameraID

可选

String

相机ID。

使用WithReg/SetTemplate模式必选

ProductSN

可选

String

产品SN码,默认是空字符串

SerialNumber

可选

String

序列码

ProductName

可选

String

产品名称

TableName

可选

String

线体。

使用WithReg/SetTemplate模式必选

ROIs

可选

Array of 表3 objects

ROI区域列表, 可为空。

CodeType

必选

String

图片编码格式,支持格式包括jpg,JPG,jpeg,JPEG,png,PNG,bmp,BMP。

Patterns

可选

Array of 表4 objects

配准的模板,错漏反场景下使用。

使用WithReg模式为必选参数,且列表不能为空。

Files

必选

Array of 表5 objects

图片列表,单个图片大小不得大于20MB。

Template

可选

表6 object

胶体检测场景下,TaskType为SetTemplate时使用。

MatchParams

可选

表7 objects

配准时的全局匹配参数,错漏反和胶体检测场景下WithReg模式必选

RegisterMatrix

可选

Array

配准时的旋转平移矩阵,3x3的一个矩阵,错漏反和胶体检测场景下使用。用于将配准前的框转换为配准后的框,即检测坐标(x',y')乘以旋转平移矩阵,转换为模板坐标系下的坐标(x,y),公式参见如下。

数组中每个元素大小范围为 [-100000, 100000]。

特别注意

WithReg模式下,胶体检测仅支持请求传入RegisterMatrix,错漏反支持如下。

  • 如果传入RegisterMatrix,使用此旋转偏移矩阵完成配准。
  • 如果未传入RegisterMatrix,则系统会根据传入的Patterns和检测框结果计算出一个最佳旋转平移矩阵用于配准,但需要注意系统自带配准需满足检测目标大于或等于2个。

ExtraParams

可选

object

保留字段。

表3 ROI

参数

是否必选

参数类型

备注

Type

必选

String

  • include:只处理ROI以内的区域(默认)。
  • exclude:只处理ROI以外的区域。

X

必选

Int, Float

矩形框x坐标的值,取值范围为 [0, 10000]。

Y

必选

Int, Float

矩形框y坐标的值,取值范围为 [0, 10000]。

Width

必选

Int, Float

矩形框宽度,取值范围为 [0, 10000]。

Height

必选

Int, Float

矩形框高度,取值范围为 [0, 10000]。

表4 Pattern

参数

是否必选

参数类型

备注

X

必选

Int, Float

矩形框x坐标的值,取值范围为 [0, 10000]。

Y

必选

Int, Float

矩形框y坐标的值,取值范围为 [0, 10000]。

Width

必选

Int, Float

矩形框宽度,取值范围为 [0, 10000]。

Height

必选

Int, Float

矩形框高度,取值范围为 [0, 10000]。

Lable

必选

String

模版类别。

detail_label

可选

String

二次分类类别。

det_cls场景,如果需要校验二次分类(cls)类别,必须设置“detail_label”值为非空。

num_match

可选

Int

ROI区域匹配的检测框数目, 取值范围[1, 5], 推荐取值为1。

overlap_metric

可选

String

模板框与检测框重叠度匹配算法, 可选“IOU”“IOMax”“IOMin”,推荐“IOU”

overlap_thresh

可选

Float

重叠度阈值,取值范围[0, 1],推荐取值为0.3。

conf_thresh

可选

Float

置信度阈值,取值范围[0, 1],推荐取值为0.5。

result

可选

String

请求时不必携带,WithReg模式会返回与检测框的配准结果。可选OK或NG。

表5 Files

参数

是否必选

参数类型

备注

FileName

必选

String

图片名称。

ImageData

必选

String

图片base64编码。

Content

可选

表11 objects

半导体质检场景,必选字段。

表6 Template

参数

是否必选

参数类型

备注

BlobMask

必选

String

模板图片的base64编码。

CodeType

必选

String

图片格式,支持格式包括jpg,JPG,jpeg,JPEG,png,PNG,bmp,BMP。

Blobs

必选

Array of 表8 objects

模板中包含的Blob信息。

SelectBlobs

必选

Array

模板选中的Blob id的值。

表7 MatchParam

参数

是否必选

参数类型

备注

global_thresh

可选

objects,表9

全局匹配参数。

label_spec_thresh

可选

Array,表10 of objects

单个类别对应的匹配参数。

reg_params

可选

objects,表12

系统自带配准高级参数设置。

表8 Blobs

参数

是否必选

参数类型

备注

Area

必选

Int

分割区域的面积,取值范围为 [1, 100000000]。

ID

必选

Int

分割区域像素点的值,取值范围为 [1, 100]。

Label

必选

String

分割区域代表的类别。

Overlap

可选

Float

WithReg模式下返回的Blob与模板匹配的重叠度,取值范围为 [0, 1]。

result

可选

String

WithReg模式下返回的Blob与模板匹配结果,OK/NG。

表9 global_thresh

参数

是否必选

参数类型

备注

conf_thresh

必选

Float

全局置信度阈值,取值范围[0, 1], 推荐取值为0.5。

overlap_thresh

必选

Float

全局重叠度阈值,取值范围[0, 1], 推荐取值为0.3。

overlap_metric

必选

String

全局重叠度匹配算法,可选IOU、IOMax、IOMin, 推荐IOU。

表10 label_spec_thresh

参数

是否必选

参数类型

备注

conf_thresh

必选

Float

单个类别置信度阈值,取值范围[0, 1], 推荐取值为0.5。

overlap_thresh

必选

Float

单个类别重叠度阈值,取值范围[0, 1], 推荐取值为0.3。

overlap_metric

必选

String

单个类别重叠度匹配算法,可选IOU、IOMax、IOMin, 推荐IOU。

Label

必选

String

类别。

表11 Content

参数

是否必选

参数类型

备注

x_img

必选

Float

x坐标。取值范围为[0, 100000]。

y_img

必选

Float

y坐标。取值范围为[0, 100000]。

setup_id

必选

String

封装层型号。

device

必选

String

芯片型号。

station_name

必选

String

机台信息。

deviceshort

必选

String

端产品名称。

表12 reg_params

参数

是否必选

参数类型

数据约束

示例数据

说明

iou_thre

可选

Float

(0,1]

0.5

一对检测对的IOU阈值。

transform_guess

可选

Array

数组大小必须为 3 * 3。

数组中每个元素大小范围为[-100000, 100000],且3 * 3位置元素不能为0。

[[1, 0, 0],

[0, 1, 0],

[0, 0, 1]]

初始化的旋转偏移矩阵估计。

search_angle_range

可选

Array

一组数组,最多有50个元素。

数组中每个元素数值范围是[-180,180]。

[0, 45, -45, 180, -90, -90, 135, -135]

旋转角度的搜索范围。

transform_type

可选

String

rigid、affine、perspective,三个值中的一个。

rigid

变换类型,默认按目标的个数来选择使用的转换类型,默认为仿射变换,小于3对匹配点对退化到刚体变换。可选:rigid(刚性变换)、affine(仿射变换)、perspective(透视变换)。

extension_ratio

可选

Float

[0, 100]

1

外扩的比例。