History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
POST /image/auditing HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
<Request><Input><DataId></DataId><Url></Url><Object></Object><Content></Content><Interval></Interval><MaxFrames></MaxFrames><LargeImageDetect></LargeImageDetect><UserInfo><TokenId></TokenId></UserInfo></Input><Input><DataId></DataId><Url></Url><Object></Object><Content></Content><Interval></Interval><MaxFrames></MaxFrames></Input><Conf><DetectType>Porn,Ads</DetectType><BizType>b81d45f94b91a683255e9a9506f45a11</BizType><Async></Async><Callback></Callback></Conf></Request>
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Request | 无 | 图片批量审核的具体配置项。 | Container | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Input | Request | 需要审核的内容，如有多个图片，请传入多个 Input 结构。 | Container Array | 是 |
Conf | Request | 审核规则配置。 | Container | 是 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
Object | Request.Input | 存储在 COS 存储桶中的图片文件名称，例如在目录 test 中的文件 image.jpg，则文件名称为 test/image.jpg。Content，Object 和 Url 只能选择其中一种，传入多个时仅一个生效，按 Content，Object， Url 顺序。 | String | 否 |
Url | Request.Input | 图片文件的链接地址，例如 http://a-1250000.cos.ap-shanghai.myqcloud.com/image.jpg。Content，Object 和 Url 只能选择其中一种，传入多个时仅一个生效，按 Content，Object， Url 顺序。 | String | 否 |
Content | Request.Input | 图片文件的内容，需要先经过 base64 编码。Content，Object 和 Url 只能选择其中一种，传入多个时仅一个生效，按 Content，Object， Url 顺序。 | String | 否 |
Interval | Request.Input | 截帧频率，GIF 图检测专用，默认值为5，表示从第一帧（包含）开始每隔5帧截取一帧。 | Int | 否 |
MaxFrames | Request.Input | 最大截帧数量，GIF 图检测专用，默认值为5，表示只截取 GIF 的5帧图片进行审核，必须大于0。 | Int | 否 |
DataId | Request.Input | 图片标识，该字段在结果中返回原始内容，长度限制为512字节。 | String | 否 |
LargeImageDetect | Request.Input | 对于超过大小限制的图片是否进行压缩后再审核，取值为： 0（不压缩），1（压缩）。默认为0。注：压缩最大支持32M的图片，且会收取压缩费用。 | Int | 否 |
UserInfo | Request.Input | 用户业务字段。 | Container | 否 |
节点名称（关键字） | 描述 | 类型 | 是否必选 |
TokenId | 一般用于表示账号信息，长度不超过128字节。 | String | 否 |
Nickname | 一般用于表示昵称信息，长度不超过128字节。 | String | 否 |
DeviceId | 一般用于表示设备信息，长度不超过128字节。 | String | 否 |
AppId | 一般用于表示 App 的唯一标识，长度不超过128字节。 | String | 否 |
Room | 一般用于表示房间号信息，长度不超过128字节。 | String | 否 |
IP | 一般用于表示 IP 地址信息，长度不超过128字节。 | String | 否 |
Type | 一般用于表示业务类型，长度不超过128字节。 | String | 否 |
ReceiveTokenId | 一般用于表示接收消息的用户账号，长度不超过128字节。 | String | 否 |
Gender | 一般用于表示性别信息，长度不超过128字节。 | String | 否 |
Level | 一般用于表示等级信息，长度不超过128字节。 | String | 否 |
Role | 一般用于表示角色信息，长度不超过128字节。 | String | 否 |
节点名称（关键字） | 父节点 | 描述 | 类型 | 是否必选 |
BizType | Request.Conf | 表示审核策略的唯一标识，您可以通过控制台上的审核策略页面，配置您希望审核的场景，如涉黄、广告、违法违规等，配置指引： 设置公共审核策略。您可以在控制台上获取到 BizType。BizType 填写时，此条审核请求将按照该审核策略中配置的场景进行审核。BizType 不填写时，将自动使用默认的审核策略。 | String | 否 |
DetectType | Request.Conf | （后续不再维护）审核的场景类型，有效值：Porn（涉黄）、Ads（广告）等，可以传入多种类型，不同类型以逗号分隔，例如：Porn,Ads。如您有更多场景的审核需要，请使用 BizType 参数。 | String | 否 |
Async | Request.Conf | 是否异步进行审核，0：同步返回结果，1：异步进行审核。默认值为 0。 | Integer | 否 |
Callback | Request.Conf | 审核结果（Detail版本）以回调形式发送至您的回调地址，异步审核时生效，支持以 http:// 或者 https:// 开头的地址，例如：http://www.callback.com。 | String | 否 |
<Response><JobsDetail><DataId></DataId><Url></Url><PornInfo><HitFlag>1</HitFlag><Score>100</Score><Category>xxx</Category><SubLabel>xxx</SubLabel></PornInfo></JobsDetail><JobsDetail><Code>InvalidArgument</Code><Message>Param MaxFrames is illegal</Message><DataId></DataId></JobsDetail></Response>
节点名称（关键字） | 父节点 | 描述 |
Response | Container | 图片批量审核返回的具体响应内容。 |
参数名称 | 类型 | 描述 |
JobsDetail | Container Array | 图片审核的结果 |
RequestId | String | 每次请求发送时，服务端将会自动为请求生成一个 ID，遇到问题时，该 ID 能更快地协助定位问题。 |
节点名称（关键字） | 类型 | 描述 |
Code | String | |
Message | String | 错误描述，只有失败时返回。 |
DataId | String | 图片标识，审核结果会返回原始内容，长度限制为512字节。 |
JobId | String | 本次审核任务的 ID。 |
State | String | 审核任务的状态，值为 Submitted（已提交审核）、Failed（审核失败）其中一个。 |
Object | String | 存储在 COS 存储桶中的图片文件名称，创建任务使用Object时返回。 |
Url | String | 图片文件的链接地址，创建任务使用Url时返回。 |
参数名称 | 类型 | 描述 |
Code | String | |
Message | String | 错误描述，只有失败时返回。 |
DataId | String | 图片标识，审核结果会返回原始内容，长度限制为512字节。 |
JobId | String | 本次审核任务的 ID。 |
State | String | 审核任务的状态，值为Success（审核成功）、Failed（审核失败）其中一个。 |
Object | String | 存储在 COS 存储桶中的图片文件名称，创建任务使用Object时返回。 |
Url | String | 图片文件的链接地址，创建任务使用Url时返回。 |
CompressionResult | Integer | 图片是否被压缩处理，值为 0（未压缩），1（正常压缩）。 |
Label | String | 该字段用于返回检测结果中所对应的优先级最高的恶意标签，表示模型推荐的审核结果，建议您按照业务所需，对不同违规类型与建议值进行处理。 返回值：Normal：正常，Porn：色情，Ads：广告等。 |
Result | Integer | 该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）。 |
Score | Integer | 该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息。例如：色情 99，表明该内容非常有可能属于色情内容。 |
Category | String | 该图命中的审核类别结果。 |
SubLabel | String | 该图命中的二级标签结果。 |
Text | String | 该图里的文字内容（OCR），当审核策略开启文本内容检测时返回。 |
PornInfo | Container | 审核场景为涉黄的审核结果信息。 |
AdsInfo | Container | 审核场景为广告引导的审核结果信息。 |
UserInfo | Container | 请求中设置的 UserInfo 原样返回。 |
ListInfo | Container | 账号黑白名单结果。 |
参数名称 | 类型 | 描述 |
Code | Integer | |
Msg | String | 具体错误信息，如正常则为 OK。 |
HitFlag | Integer | 用于返回该审核场景的审核结果，返回值：0：正常。1：确认为当前场景的违规内容。2：疑似为当前场景的违规内容。 |
Score | Integer | 该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息例如：色情 99，则表明该内容非常有可能属于色情内容。 |
Label | String | 该图的结果标签（为综合标签，可能为 SubLabel，可能为人物名字等）。 |
Category | String | 该字段为 Label的子集，表示审核命中的具体审核类别。例如 Sexy，表示色情标签中的性感类别。 |
SubLabel | String | 该图的二级标签结果。 |
OcrResults | Container Array | 该字段表示 OCR 文本识别的详细检测结果，包括文本坐标信息、文本识别结果等信息，有相关违规内容时返回。 |
LibResults | Container Array | 该字段用于返回基于风险库识别的结果。注意：未命中风险库中样本时，此字段不返回。 |
节点名称（关键字） | 类型 | 描述 |
ImageId | String | 该字段表示命中的风险库中的图片样本ID。 |
Score | Integer | 该字段用于返回当前标签下的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表当前的图片越有可能命中库中的样本。例如：色情 99，则表明该数据非常有可能命中库中的色情样本。 |
节点名称（关键字） | 类型 | 描述 |
Text | String | 有敏感信息的 Ocr 文本内容。 |
Keywords | String Array | 该段内容中的敏感文字。 |
Location | Container | 该段文字在图片中的位置信息。 |
节点名称（关键字） | 类型 | 描述 |
Name | String | 敏感内容的字称。 |
Location | Container | 该内容在图片中的位置信息。 |
节点名称（关键字） | 类型 | 描述 |
X | Float | 相对于原点（图片左上角）的 X 坐标。 |
Y | Float | 相对于原点（图片左上角）的 Y 坐标。 |
Height | Float | 敏感区域的高度。 |
Width | Float | 敏感区域的宽度。 |
Rotate | Float | 敏感区域的旋转角度。 |
节点名称（关键字） | 描述 | 类型 | 是否必选 |
TokenId | 一般用于表示账号信息，长度不超过128字节。 | String | 否 |
Nickname | 一般用于表示昵称信息，长度不超过128字节。 | String | 否 |
DeviceId | 一般用于表示设备信息，长度不超过128字节。 | String | 否 |
AppId | 一般用于表示App的唯一标识，长度不超过128字节。 | String | 否 |
Room | 一般用于表示房间号信息，长度不超过128字节。 | String | 否 |
IP | 一般用于表示IP地址信息，长度不超过128字节。 | String | 否 |
Type | 一般用于表示业务类型，长度不超过128字节。 | String | 否 |
ReceiveTokenId | 一般用于表示接收消息的用户账号，长度不超过128字节。 | String | 否 |
Gender | 一般用于表示性别信息，长度不超过128字节。 | String | 否 |
Level | 一般用于表示等级信息，长度不超过128字节。 | String | 否 |
Role | 一般用于表示角色信息，长度不超过128字节。 | String | 否 |
节点名称（关键字） | 类型 | 描述 |
ListResults | Container Array | 命中的所有名单结果。 |
节点名称（关键字） | 类型 | 描述 |
ListType | Integer | 命中的名单类型，取值为0（白名单）和1（黑名单）。 |
ListName | String | 命中的名单名称。 |
Entity | String | 命中了名单中的哪条内容。 |
POST /image/auditing HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0**********&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.comContent-Length: 166Content-Type: application/xml<Request><Input><Object>a.jpg</Object></Input><Input><Url>http://exsample.com/b.jpg</Url></Input><Conf><DetectType>Porn,Ads</DetectType></Conf></Request>
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 645Date: Tue, 03 Apr 2018 09:06:16 GMTStatus: 200 OKx-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****<Response><JobsDetail><JobId>xxxxxxxxxx</JobId><CompressionResult>0</CompressionResult><Object>a.jpg</Object><Label>Porn</Label><Result>1</Result><Score>100</Score><SubLabel>xxx</SubLabel><PornInfo><Code>0</Code><Msg>OK</Msg><HitFlag>1</HitFlag><Score>100</Score><Label>xxx</Label><SubLabel>xxx</SubLabel></PornInfo></JobsDetail><JobsDetail><JobId>yyyyyyyyyy</JobId><CompressionResult>0</CompressionResult><Url>http://exsample.com/b.jpg</Url><Label>Porn</Label><Result>1</Result><Score>100</Score><SubLabel>xxx</SubLabel><PornInfo><Code>0</Code><Msg>OK</Msg><HitFlag>1</HitFlag><Score>100</Score><Label>xxx</Label><SubLabel>xxx</SubLabel></PornInfo></JobsDetail><RequestId>xxxxxxxxxxx</RequestId></Response>
文档反馈