调用ImAudit对图片、文本内容进行审核。
使用说明
本接口审核完成后审核结果同步返回。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ImAudit |
系统规定参数。取值:ImAudit。 |
Images | String | 否 | ["http://127.66.**.**/image.jpeg","http://127.66.**.**/photo.jpeg"] |
图片URL的JSON数组,最大长度为100张。可以通过MPS控制台 > 媒体管理 > 媒体列表获取。图片和文本至少填写一个。 |
Contents | String | 否 | ["你好呀","你是谁","我在哪里"] |
文本JSON数组,用户自定义数组,最大长度为100段。图片和文本至少填写一个。 |
Scenes | String | 是 | ["porn","terrorism","ad"] |
场景说明,用于指定审核场景。支持指定多个场景,用半角逗号(,)分隔。例如,{"porn","terrorism"}表示对图片同时进行智能鉴黄和暴恐摄政检测。取值:
|
BizType | String | 否 | 139440480445**** |
默认为公共配置。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TextQuotaExceed | Boolean | false |
文本审核QPS是否超过限制。取值:true、false。 |
ImageQuotaExceed | Boolean | false |
图片审核QPS是否超过限制。取值:true(不超过)、false(超过)。 |
RequestId | String | 5210DBB0-E327-4D45-ADBC-0B83C8793421 |
请求ID。 |
ImageResults | Object |
图片审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见图文审核接口返回数据。 |
|
result | Array of result |
图片审核结果。 |
|
code | Long | 200 |
错误码,和HTTP状态码一致。如果执行成功则此参数不返回。 |
dataId | String | uuid-1234-1234-1234 |
检测对象对应的数据ID。 说明 如果在检测请求参数中传入了dataId,则此处返回对应的dataId。
|
extras | Map |
额外附加信息。图文违规(ad)场景中,该参数可能返回以下内容。 hitLibInfo:如果图片中的文字命中了自定义文本库,则返回命中的文本库信息。格式为数组,更多结构描述请参见hitLibInfo。 |
|
msg | String | ok |
请求信息的响应信息。 |
results | Array of result |
返回结果。调用成功时,返回结果中包含一个或多个元素。每个元素是一个结构体。 |
|
Label | String | sexy |
检测结果的分类。不同检测场景的结果分类不同,具体如下:
|
Rate | double | 91.54 |
置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果suggestion为pass,则置信度越高,表示内容正常的可能性越高;如果suggestion为review或block,则置信度越低,表示内容违规的可能性越高。 说明 该值仅作为参考,强烈建议您不要在业务中使用。建议您参考suggestion和label(或者部分接口返回的sublabel)结果用于内容违规判定。
|
Scene | String | porn |
图片检测场景。可取值:
|
Suggestion | String | block |
建议您执行的后续操作。可取值:
|
taskId | String | img4wlJcb7p4wH4lAP3111111-12**** |
检测任务的ID。 |
url | String | http://example.com/example-****.jpg |
检测对象的URL。 |
TextResults | Object |
文本审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见图文审核接口返回数据。 |
|
result | Array of result |
文本审核结果。 |
|
code | Long | 200 |
错误码,和HTTP状态码一致。更多信息,请参见错误码表。 |
content | String | 这是一段测试文本 |
被检测文本,和调用请求中的待检测文本对应。 |
dataId | String | cfd33235-71a4-468b-8137-a5ffe323**** |
文字的顺序号。 |
msg | String | OK |
请求消息的响应消息。 |
results | Array of result |
返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体。 |
|
details | Array of details |
命中风险信息,一条文本可能命中多条风险详情。 |
|
Label | String | porn |
文本命中风险的分类。取值:
|
label | String | porn |
文本垃圾检测结果的分类。取值:
|
rate | double | 99.90 |
置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果suggestion为pass,则置信度越高,表示内容正常的可能性越高;如果suggestion为review或block,则置信度越低,表示内容违规的可能性越高。 说明 该值仅作为参考,强烈建议您不要在业务中使用。建议您参考suggestion和label(或者部分接口返回的sublabel)结果用于内容违规判定。
|
scene | String | antispam |
检测场景。 |
suggestion | String | block |
建议您执行的后续操作。取值:
|
taskId | String | txt6HB8NQoEbU@5fosnj2xVEM-1t**** |
检测任务的ID。 |
示例
请求示例
http(s)://mts.cn-shanghai.aliyuncs.com/?Action=ImAudit
&Images=["http://127.66.**.**/image.jpeg","http://127.66.**.**/photo.jpeg"]
&Contents=["你好呀","你是谁","我在哪里"]
&Scenes=["porn","terrorism","ad"]
&BizType=139440480445****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ImAuditResponse>
<TextQuotaExceed>false</TextQuotaExceed>
<ImageQuotaExceed>false</ImageQuotaExceed>
<RequestId>5210DBB0-E327-4D45-ADBC-0B83C8793421</RequestId>
<ImageResults>
<result>
<code>200</code>
<dataId>uuid-1234-1234-1234</dataId>
<msg>ok</msg>
<results>
<Label>sexy</Label>
<Rate>91.54</Rate>
<Scene>porn</Scene>
<Suggestion>block</Suggestion>
</results>
<taskId>img4wlJcb7p4wH4lAP3111111-12****</taskId>
<url>http://example.com/example-****.jpg</url>
</result>
</ImageResults>
<TextResults>
<result>
<code>200</code>
<content>这是一段测试文本</content>
<dataId>cfd33235-71a4-468b-8137-a5ffe323****</dataId>
<msg>OK</msg>
<results>
<details>
<Label>porn</Label>
</details>
<label>porn</label>
<rate>99.9</rate>
<scene>antispam</scene>
<suggestion>block</suggestion>
</results>
<taskId>txt6HB8NQoEbU@5fosnj2xVEM-1t****</taskId>
</result>
</TextResults>
</ImAuditResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TextQuotaExceed" : false,
"ImageQuotaExceed" : false,
"RequestId" : "5210DBB0-E327-4D45-ADBC-0B83C8793421",
"ImageResults" : {
"result" : [ {
"code" : 200,
"dataId" : "uuid-1234-1234-1234",
"msg" : "ok",
"results" : [ {
"Label" : "sexy",
"Rate" : 91.54,
"Scene" : "porn",
"Suggestion" : "block"
} ],
"taskId" : "img4wlJcb7p4wH4lAP3111111-12****",
"url" : "http://example.com/example-****.jpg"
} ]
},
"TextResults" : {
"result" : [ {
"code" : 200,
"content" : "这是一段测试文本",
"dataId" : "cfd33235-71a4-468b-8137-a5ffe323****",
"msg" : "OK",
"results" : [ {
"details" : [ {
"Label" : "porn"
} ],
"label" : "porn",
"rate" : 99.9,
"scene" : "antispam",
"suggestion" : "block"
} ],
"taskId" : "txt6HB8NQoEbU@5fosnj2xVEM-1t****"
} ]
}
}
错误码
访问错误中心查看更多错误码。