进行图片、文本内容审核,审核结果同步返回。
接口说明
本接口审核完成后审核结果同步返回。
图文审核功能,目前开通的地域为华北 2(北京)、华东 2(上海)、亚太东南 1(新加坡),其他地域暂不支持。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mts:ImAudit |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Images |
string |
否 |
图片 URL 的 JSON 数组,默认最多处理 5 张。可以通过 MPS 控制台 > 媒体管理 > 媒体列表获取。图片和文本至少填写一个。待审核图片文件需要符合下述限制,否则可能导致任务失败:
|
["http://127.66.**.**/image.jpeg","http://127.66.**.**/photo.jpeg"] |
| Contents |
string |
否 |
文本 JSON 数组,用户自定义数组,默认最多处理 5 段文本,每段文本最长 10,000 个字符(包含标点)。图片和文本至少填写一个。 |
["Hello","Who are you","Where am I"] |
| Scenes |
string |
是 |
场景说明,用于指定审核场景。支持指定多个场景,用半角逗号(,)分隔。例如,{"porn","terrorism"}表示对图片同时进行智能鉴黄和暴恐涉政检测。取值:
|
["porn","terrorism","ad"] |
| BizType |
string |
否 |
默认为公共配置。 |
139440480445**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| TextQuotaExceed |
boolean |
文本审核 QPS 是否超过限制,取值:true(超过)、false(不超过)。默认文本审核的 QPS 是 5。 |
false |
| ImageQuotaExceed |
boolean |
图片审核 QPS 是否超过限制。取值:true(超过)、false(不超过)。默认图片审核 QPS 是 5。 |
false |
| RequestId |
string |
请求 ID。 |
5210DBB0-E327-4D45-ADBC-0B83C8793421 |
| ImageResults |
object |
图片审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见图文审核接口返回数据。 |
|
| result |
array<object> |
图片审核结果。 |
|
|
array<object> |
图片审核结果详细信息。 |
||
| code |
integer |
错误码,和 HTTP 状态码一致。如果执行成功则此参数不返回。 |
200 |
| dataId |
string |
检测对象对应的数据 ID。 说明
如果在检测请求参数中传入了 dataId,则此处返回对应的 dataId。 |
uuid-1234-1234-1234 |
| extras |
object |
额外附加信息。图文违规(ad)场景中,该参数可能返回以下内容。 hitLibInfo:如果图片中的文字命中了自定义文本库,则返回命中的文本库信息。格式为数组,更多结构描述请参见 hitLibInfo 。 |
{"hitLibInfo":[{"context":"检测视频","libCode":"1234567","libName":"相似文本库a"}]} |
| msg |
string |
请求信息的响应信息。 |
ok |
| results |
array<object> |
返回结果。调用成功时,返回结果中包含一个或多个元素。每个元素是一个结构体。 |
|
|
array<object> |
返回结果详细信息。 |
||
| Label |
string |
检测结果的分类。不同检测场景的结果分类不同,具体如下:
|
sexy |
| Rate |
number |
置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果 suggestion 为 pass,则置信度越高,表示内容正常的可能性越高;如果 suggestion 为 review 或 block,则置信度越低,表示内容违规的可能性越高。 说明
该值仅作为参考,强烈建议您不要在业务中使用。建议您参考 suggestion 和 label(或者部分接口返回的 sublabel)结果用于内容违规判定。 |
91.54 |
| Scene |
string |
图片检测场景。可取值:
|
porn |
| Suggestion |
string |
建议您执行的后续操作。可取值:
|
block |
| hintWordsInfo |
array<object> |
图片中含有广告或文字违规信息时,返回图片中广告文字命中的风险关键词信息。 |
|
|
object |
hintWordsInfo |
||
| context |
string |
文字命中的风险关键词内容。 |
Sensitive keyword |
| qrcodeData |
array |
图片中含有二维码时,返回图片中所有二维码包含的文本信息。 |
|
|
string |
二维码包含的文本信息。 |
"http://example.com/01ZZOliO" |
|
| qrcodeLocations |
array<object> |
返回图片中识别到的二维码的坐标信息。 |
|
|
object |
qrcodeLocation |
||
| x |
number |
以图片左上角为坐标原点,二维码区域左上角到 y 轴距离,单位:像素。 |
11 |
| y |
number |
以图片左上角为坐标原点,二维码区域左上角到 x 轴距离,单位:像素。 |
0 |
| w |
number |
二维码区域宽度,单位:像素。 |
402.0 |
| h |
number |
二维码区域高度,单位:像素。 |
413.0 |
| qrcode |
string |
识别到的二维码链接。 |
http://xxx |
| programCodeData |
array<object> |
图片中含有小程序码时,返回小程序码的位置信息。 |
|
|
object |
小程序码列表。 |
||
| x |
number |
以图片左上角为坐标原点,小程序码区域左上角到 y 轴距离,单位:像素。 |
11.0 |
| y |
number |
以图片左上角为坐标原点,小程序码区域左上角到 x 轴距离,单位:像素。 |
0.0 |
| w |
number |
小程序码区域宽度,单位:像素。 |
402.0 |
| h |
number |
小程序码区域高度,单位:像素。 |
413.0 |
| logoData |
array<object> |
图片中含有 logo 时,返回识别出来的 logo 信息。 |
|
|
object |
识别出的 logo 列表。 |
||
| type |
string |
识别出的 logo 类型,取值为 TV (台标)。 |
TV |
| name |
string |
识别出的 logo 名称。 |
Hunan TV |
| x |
number |
以图片左上角为坐标原点,logo 区域左上角到 y 轴距离,单位:像素。 |
140 |
| y |
number |
以图片左上角为坐标原点,logo 区域左上角到 x 轴距离,单位:像素。 |
68 |
| w |
number |
logo 区域宽度,单位:像素。 |
106 |
| h |
number |
logo 区域高度,单位:像素。 |
106 |
| sfaceData |
array<object> |
图片中包含暴恐识涉政内容时,返回识别出来的暴恐涉政信息。 |
|
|
array<object> |
暴恐涉政信息列表。 |
||
| x |
number |
以图片左上角为坐标原点,人脸区域左上角到 y 轴距离,单位:像素。 |
49 |
| y |
number |
以图片左上角为坐标原点,人脸区域左上角到 y 轴距离,单位:像素。 |
39 |
| w |
number |
人脸区域宽度,单位:像素。 |
47 |
| h |
number |
人脸区域高度,单位:像素。 |
121 |
| faces |
array<object> |
识别出的人脸信息。 |
|
|
object |
人脸信息。 |
||
| name |
string |
字符串类型,相似人物的名称。 |
Matched person name |
| re |
number |
浮点数类型,置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。置信度越高表示人物识别结果的可信度越高。 |
91.54 |
| idid |
string |
字符串类型,人脸 ID。 |
AliFace_0001234 |
| ocrData |
array |
ocrData |
|
|
string |
识别到的图片中的完整文字信息。 |
识别结果 |
|
| frames |
array<object> |
如果待检测图片因为过长被截断,该参数返回截断后的每一帧图像的临时访问地址。 |
|
|
object |
frame |
||
| rate |
number |
置信度分数,取值范围:0~100,置信度越高表示检测结果的可信度越高。建议您不要在业务中使用该分数。 |
89.85 |
| url |
string |
被截断的图片的临时访问 URL,地址有效期是 5 分钟。 |
http://example.com/test-01.jpg |
| taskId |
string |
检测任务的 ID。 |
img4wlJcb7p4wH4lAP3111111-12**** |
| url |
string |
检测对象的 URL。 |
http://example.com/example-****.jpg |
| TextResults |
object |
文本审核返回结果。调用成功是(code=200),返回结果中包含一个或多个元素。参数详情请参见图文审核接口返回数据。 |
|
| result |
array<object> |
文本审核结果。 |
|
|
array<object> |
文本审核结果详细信息。 |
||
| code |
integer |
错误码,和 HTTP 状态码一致。更多信息,请参见错误码表。 |
200 |
| content |
string |
被检测文本,和调用请求中的待检测文本对应。 |
This is a test text. |
| dataId |
string |
文字的顺序号。 |
cfd33235-71a4-468b-8137-a5ffe323**** |
| msg |
string |
请求消息的响应消息。 |
OK |
| results |
array<object> |
返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体。 |
|
|
array<object> |
返回结果详细信息。 |
||
| details |
array<object> |
命中风险信息,一条文本可能命中多条风险详情。 |
|
|
array<object> |
命中风险信息详情。 |
||
| Label |
string |
文本命中风险的分类。取值:
|
porn |
| contexts |
array<object> |
命中该风险的上下文信息。 |
|
|
object |
命中该风险的上下文信息。 |
||
| context |
string |
检测文本命中的风险关键词,如果命中了关键词会返回该内容,如果命中了算法模型,则不会返回该字段。 |
Door-to-door service |
| positions |
array |
如果命中关键词,会返回该词在原始文本中的位置。 |
|
|
string |
关键词在原始文本中的位置。 |
{"startPos":1, "endPos":10} |
|
| libName |
string |
命中自定义词库时,才会返回当前字段。取值为创建词库时设置的词库名称。 |
Your custom dictionary name. |
| libCode |
string |
命中您自定义文本库时,才会返回当前字段。取值为创建风险文本库后系统返回的文本库 code。 |
123456 |
| ruleType |
string |
命中行为规则时,才会返回当前字段。取值:
|
ip |
| label |
string |
文本垃圾检测结果的分类。取值:
|
porn |
| rate |
number |
置信度分数,取值范围:0(表示置信度最低)~100(表示置信度最高)。如果 suggestion 为 pass,则置信度越高,表示内容正常的可能性越高;如果 suggestion 为 review 或 block,则置信度越低,表示内容违规的可能性越高。 说明
该值仅作为参考,强烈建议您不要在业务中使用。建议您参考 suggestion 和 label(或者部分接口返回的 sublabel)结果用于内容违规判定。 |
99.90 |
| scene |
string |
检测场景。 |
antispam |
| suggestion |
string |
建议您执行的后续操作。取值:
|
block |
| taskId |
string |
检测任务的 ID。 |
txt6HB8NQoEbU@5fosnj2xVEM-1t**** |
示例
正常返回示例
JSON格式
{
"TextQuotaExceed": false,
"ImageQuotaExceed": false,
"RequestId": "5210DBB0-E327-4D45-ADBC-0B83C8793421",
"ImageResults": {
"result": [
{
"code": 200,
"dataId": "uuid-1234-1234-1234",
"extras": {
"hitLibInfo": [
{
"context": "检测视频",
"libCode": "1234567",
"libName": "相似文本库a"
}
]
},
"msg": "ok",
"results": [
{
"Label": "sexy",
"Rate": 91.54,
"Scene": "porn",
"Suggestion": "block",
"hintWordsInfo": [
{
"context": "Sensitive keyword"
}
],
"qrcodeData": [
"\"http://example.com/01ZZOliO\""
],
"qrcodeLocations": [
{
"x": 11,
"y": 0,
"w": 402,
"h": 413,
"qrcode": "http://xxx"
}
],
"programCodeData": [
{
"x": 11,
"y": 0,
"w": 402,
"h": 413
}
],
"logoData": [
{
"type": "TV",
"name": "Hunan TV",
"x": 140,
"y": 68,
"w": 106,
"h": 106
}
],
"sfaceData": [
{
"x": 49,
"y": 39,
"w": 47,
"h": 121,
"faces": [
{
"name": "Matched person name",
"re": 91.54,
"idid": "AliFace_0001234"
}
]
}
],
"ocrData": [
"识别结果"
],
"frames": [
{
"rate": 89.85,
"url": "http://example.com/test-01.jpg"
}
]
}
],
"taskId": "img4wlJcb7p4wH4lAP3111111-12****",
"url": "http://example.com/example-****.jpg"
}
]
},
"TextResults": {
"result": [
{
"code": 200,
"content": "This is a test text.",
"dataId": "cfd33235-71a4-468b-8137-a5ffe323****",
"msg": "OK",
"results": [
{
"details": [
{
"Label": "porn",
"contexts": [
{
"context": "Door-to-door service",
"positions": [
"{\"startPos\":1, \"endPos\":10}"
],
"libName": "Your custom dictionary name.",
"libCode": "123456",
"ruleType": "ip"
}
]
}
],
"label": "porn",
"rate": 99.9,
"scene": "antispam",
"suggestion": "block"
}
],
"taskId": "txt6HB8NQoEbU@5fosnj2xVEM-1t****"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。