Device
用于表示业务用户对应的设备信息
被如下接口引用：CreateImageModerationAsyncTask, ImageModeration。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 否 | 该字段表示业务用户对应设备的IP地址，同时支持IPv4和IPv6地址的记录；需要与IpType参数配合使用。 |
| Mac | String | 否 | 该字段表示业务用户对应的MAC地址，以方便设备识别与管理；其格式与取值与标准MAC地址一致。 |
| TokenId | String | 否 | 内测中，敬请期待。 |
| DeviceId | String | 否 | 内测中，敬请期待。 |
| IMEI | String | 否 | 该字段表示业务用户对应设备的IMEI码（国际移动设备识别码），该识别码可用于识别每一部独立的手机等移动通信设备，方便设备识别与管理。 备注：格式为15-17位纯数字。 |
| IDFA | String | 否 | iOS设备专用，该字段表示业务用户对应的IDFA(广告标识符),这是由苹果公司提供的用于标识用户的广告标识符，由一串16进制的32位数字和字母组成。 备注：苹果公司自2021年iOS14更新后允许用户手动关闭或者开启IDFA，故此字符串标记有效性可能有所降低。 |
| IDFV | String | 否 | iOS设备专用，该字段表示业务用户对应的IDFV(应用开发商标识符),这是由苹果公司提供的用于标注应用开发商的标识符，由一串16进制的32位数字和字母组成，可被用于唯一标识设备。 |
| IpType | Integer | 否 | 该字段表示记录的IP地址的类型，取值：0（代表IPv4地址）、1（代表IPv6地址）；需要与IpType参数配合使用。 |
LabelDetailItem
用于返回分类模型命中子标签的详细结果
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 该字段用于返回识别对象的ID以方便识别和区分。 注意：此字段可能返回 null，表示取不到有效值。 |
| Name | String | 该字段用于返回识命中的子标签名称。 注意：此字段可能返回 null，表示取不到有效值。 |
| Score | Integer | 该字段用于返回对应子标签命中的分值，取值为0-100，如：Porn-SexBehavior 99 则代表相应识别内容命中色情-性行为标签的分值为99。 注意：此字段可能返回 null，表示取不到有效值。 |
LabelResult
分类模型命中结果
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Scene | String | 该字段用于返回模型识别出的场景结果，如广告、色情、有害内容等场景。 |
| Suggestion | String | 该字段用于返回针对当前恶意标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Block：建议屏蔽，Review ：建议人工复审，Pass：建议通过 |
| Label | String | 该字段用于返回检测结果所对应的恶意标签。 返回值：Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告；以及其他令人反感、不安全或不适宜的内容类型。 |
| SubLabel | String | 该字段用于返回对应恶意标签下的子标签的检测结果，如：Porn-SexBehavior等子标签。 |
| Score | Integer | 该字段用于返回当前标签（Label）下的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表图片越有可能属于当前返回的标签；如：色情 99，则表明该图片非常有可能属于色情内容；色情 0，则表明该图片不属于色情内容。 |
| Details | Array of LabelDetailItem | 该字段用于返回分类模型命中子标签的详细信息，如：序号、命中标签名称、分数等信息。 注意：此字段可能返回 null，表示取不到有效值。 |
LibDetail
用于返回自定义库/黑白库的明细信息
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 该字段用于返回识别对象的ID以方便识别和区分。 |
| LibId | String | 该字段用于返回自定义库的ID，以方便自定义库管理和配置。 |
| LibName | String | 该字段用于返回自定义库的名称,以方便自定义库管理和配置。 注意：此字段可能返回 null，表示取不到有效值。 |
| ImageId | String | 该字段用于返回识别图像对象的ID以方便文件管理。 |
| Label | String | 该字段用于返回检测结果所对应的恶意标签。 返回值：Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告；以及其他令人反感、不安全或不适宜的内容类型。 |
| Tag | String | 该字段用于返回其他自定义标签以满足您的定制化场景需求，若无需求则可略过。 注意：此字段可能返回 null，表示取不到有效值。 |
| Score | Integer | 该字段用于返回对应模型命中的分值，取值为0-100，如：Porn 99 则代表相应识别内容命中色情标签的分值为99。 |
LibResult
用于返回黑白库比对结果的详细信息
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Scene | String | 该字段表示模型的场景识别结果，默认取值为Similar。 |
| Suggestion | String | 该字段用于返回后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Block：建议屏蔽，Review ：建议人工复审，Pass：建议通过 |
| Label | String | 该字段用于返回检测结果所对应的恶意标签。 返回值：Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告；以及其他令人反感、不安全或不适宜的内容类型。 |
| SubLabel | String | 该字段用于返回恶意标签下对应的子标签的检测结果，如：Porn-SexBehavior等子标签。 注意：此字段可能返回 null，表示取不到有效值。 |
| Score | Integer | 该字段用于返回图片检索模型识别的分值，取值为0-100，表示该审核图片与库中样本的相似分值，得分越高，代表当前内容越有可能命中相似图库内的样本。 |
| Details | Array of LibDetail | 该字段用于返回黑白库比对结果的详细信息，如：序号、库名称、恶意标签等信息；详细返回信息敬请参考对应数据结构（LibDetail）的描述文档 注意：此字段可能返回 null，表示取不到有效值。 |
Location
坐标
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| X | Float | 该参数用于返回检测框左上角位置的横坐标（x）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。 |
| Y | Float | 该参数用于返回检测框左上角位置的纵坐标（y）所在的像素位置，结合剩余参数可唯一确定检测框的大小和位置。 |
| Width | Float | 该参数用于返回检测框的宽度（由左上角出发在x轴向右延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。 |
| Height | Float | 该参数用于返回检测框的高度（由左上角出发在y轴向下延伸的长度），结合剩余参数可唯一确定检测框的大小和位置。 |
| Rotate | Float | 该参数用于返回检测框的旋转角度，该参数结合X和Y两个坐标参数可唯一确定检测框的具体位置；取值：0-360（角度制），方向为逆时针旋转。 |
ObjectDetail
实体检测结果明细，当检测场景为实体、广告台标、二维码时表示模型检测目标框的标签名称、标签值、标签分数以及检测框的位置信息。
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 该参数用于返回识别对象的ID以方便识别和区分。 |
| Name | String | 该参数用于返回命中的实体标签。 |
| Value | String | 该参数用于返回对应实体标签所对应的值或内容。如：当标签为二维码(QrCode)时，该字段为识别出的二维码对应的URL地址。 |
| Score | Integer | 该参数用于返回对应实体标签命中的分值，取值为0-100，如：QrCode 99 则代表相应识别内容命中二维码场景标签的概率非常高。 |
| Location | Location | 该字段用于返回实体检测框的坐标位置（左上角xy坐标、长宽、旋转角度）以方便快速定位实体的相关信息。 |
| SubLabel | String | 该参数用于返回命中的实体二级标签。 |
| ObjectId | String | 该参数用于返回命中的人脸id 注意：此字段可能返回 null，表示取不到有效值。 |
ObjectResult
用于返回实体检测结果详情
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Scene | String | 该字段用于返回实体识别出的实体场景结果，如二维码、logo、图片OCR等场景。 |
| Suggestion | String | 该字段用于返回针对当前恶意标签的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Block：建议屏蔽，Review ：建议人工复审，Pass：建议通过 |
| Label | String | 该字段用于返回检测结果所对应的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告；以及其他令人反感、不安全或不适宜的内容类型。 |
| SubLabel | String | 该字段用于返回当前恶意标签下对应的子标签的检测结果，如：Porn-SexBehavior 等子标签。 |
| Score | Integer | 该字段用于返回命中当前恶意标签下子标签的分值，取值为0-100，如：Porn-SexBehavior 99 则代表相应识别内容命中色情-性行为标签的分值为99。 |
| Names | Array of String | 该标签用于返回所识别出的实体名称。 注意：此字段可能返回 null，表示取不到有效值。 |
| Details | Array of ObjectDetail | 该标签用于返回所识别出实体的详细信息，如：序号、命中标签名称、位置坐标等信息，详细返回内容敬请参考相应数据结构（ObjectDetail ）。 注意：此字段可能返回 null，表示取不到有效值。 |
OcrResult
用于返回OCR结果检测详情
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Scene | String | 该字段表示识别场景，取值默认为OCR（图片OCR识别）。 |
| Suggestion | String | 该字段用于返回优先级最高的恶意标签对应的后续操作建议。当您获取到判定结果后，返回值表示系统推荐的后续操作；建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Block：建议屏蔽，Review ：建议人工复审，Pass：建议通过 |
| Label | String | 该字段用于返回OCR检测结果所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告；以及其他令人反感、不安全或不适宜的内容类型。 |
| SubLabel | String | 该字段用于返回当前标签（Label）下对应的子标签的检测结果，如：Porn-SexBehavior等子标签。 |
| Score | Integer | 该字段用于返回当前标签（Label）下的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表文本越有可能属于当前返回的标签；如：色情 99，则表明该文本非常有可能属于色情内容；色情 0，则表明该文本不属于色情内容。 |
| Details | Array of OcrTextDetail | 该字段用于返回OCR识别出的结果的详细内容，如：文本内容、对应标签、识别框位置等信息。 注意：此字段可能返回 null，表示取不到有效值。 |
| Text | String | 该字段用于返回OCR识别出的文字信息。 |
OcrTextDetail
用于返回OCR文本结果详情，图片中的文本越多，可能导致接口返回时间增加。
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 该字段用于返回OCR识别出的文本内容。 备注：OCR文本识别上限在5000字节内。 |
| Label | String | 该字段用于返回检测结果所对应的恶意标签。 返回值：Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告；以及其他令人反感、不安全或不适宜的内容类型。 |
| LibId | String | 该字段用于返回自定义库的ID，以方便自定义库管理和配置。 |
| LibName | String | 该字段用于返回自定义库的名称，以方便自定义库管理和配置。 |
| Keywords | Array of String | 该参数用于返回在当前label下命中的关键词。 |
| Score | Integer | 该参数用于返回在当前恶意标签下模型命中的分值，取值为0-100；分数越高，代表当前场景越符合该恶意标签所对应的场景。 |
| Location | Location | 该参数用于返回OCR检测框在图片中的位置（左上角xy坐标、长宽、旋转角度），以方便快速定位识别文字的相关信息。 |
| Rate | Integer | 该参数用于返回OCR文本识别结果的置信度，取值在0（置信度最低）-100（置信度最高），越高代表对应图像越有可能是识别出的文字；如：你好 99，则表明OCR识别框内的文字大概率是”你好“。 |
| SubLabel | String | 该字段用于返回检测结果所对应的恶意二级标签。 |
RecognitionResult
识别类型标签结果信息
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Label | String | 当前可能的取值：Scene（图片场景模型） 注意：此字段可能返回 null，表示取不到有效值。 示例值：Scene |
| Tags | Array of RecognitionTag | Label对应模型下的识别标签信息 注意：此字段可能返回 null，表示取不到有效值。 |
RecognitionTag
识别类型标签信息
被如下接口引用：ImageModeration。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 |
| Score | Integer | 置信分：0～100，数值越大表示置信度越高 注意：此字段可能返回 null，表示取不到有效值。 |
| Location | Location | 标签位置信息，若模型无位置信息，则可能为零值 注意：此字段可能返回 null，表示取不到有效值。 |
User
用于表示业务用户的账号相关信息
被如下接口引用：CreateImageModerationAsyncTask, ImageModeration。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| UserId | String | 否 | 该字段表示业务用户ID,填写后，系统可根据账号过往违规历史优化审核结果判定，有利于存在可疑违规风险时的辅助判断。 备注：该字段可传入微信openid、QQopenid、字符串等账号信息，与账号类别参数（AccountType）配合使用可确定唯一账号。 |
| Nickname | String | 否 | 该字段表示业务用户对应的账号昵称信息。 |
| AccountType | String | 否 | 该字段表示业务用户ID对应的账号类型，取值：1-微信uin，2-QQ号，3-微信群uin，4-qq群号，5-微信openid，6-QQopenid，7-其它string。 该字段与账号ID参数（UserId）配合使用可确定唯一账号。 |
| Gender | Integer | 否 | 该字段表示业务用户对应账号的性别信息。 取值：0（默认值，代表性别未知）、1（男性）、2（女性）。 |
| Age | Integer | 否 | 该字段表示业务用户对应账号的年龄信息。 取值：0（默认值，代表年龄未知）-（自定义年龄上限）之间的整数。 |
| Level | Integer | 否 | 该字段表示业务用户对应账号的等级信息。 取值：0（默认值，代表等级未知）、1（等级较低）、2（等级中等）、3（等级较高），目前暂不支持自定义等级。 |
| Phone | String | 否 | 该字段表示业务用户对应账号的手机号信息，支持全球各地区手机号的记录。 备注：请保持手机号格式的统一，如区号格式（086/+86）等。 |
| Desc | String | 否 | 该字段表示业务用户的简介信息，支持汉字、英文及特殊符号，长度不超过5000个汉字字符。 |
| HeadUrl | String | 否 | 该字段表示业务用户头像图片的访问链接(URL)，支持PNG、JPG、JPEG、BMP、GIF、WEBP格式。 备注：头像图片大小不超过5MB，建议分辨率不低于256x256；图片下载时间限制为3秒，超过则会返回下载超时。 |
