同步单条检测
更新时间:
请求规范
- 请求 URL:
https://isafe.ilivedata.com/api/v2/image/check
-
图片要求:
- 图片支持类型:URL, BASE64
- 图片支持格式:jpg, png, bmp, gif, webp, tiff, heic
- 图片大小:单张 < 10M
- gif 图、长图说明:自动将 gif 图、长图(长宽比大于 5 的图片)截帧过检,最多 5 张,gif 图、长图均按照实际截图张数进行计费
-
HTTP 请求 Header:
Header
值
描述
Content-Type
application/json;charset=UTF-8
请求体类型
Accept
application/json;charset=UTF-8
接受的返回类型
X-AppId
项目的唯一标识,此值是 <控制台-服务配置> 中的项目编号
X-TimeStamp
请求的 UTC 时间戳。需要把时间戳按 W3C 标准格式化,例如: 2010-01-31T23:59:59Z。 (http://www.w3.org/TR/xmlschema-2/#dateTime)。
Authorization
签名值
-
请求方法:POST
-
请求体 JSON 对象:
参数
是否必需
类型
描述
type
必需
Number
图片内容类型:1:图片 URL;2:图片 BASE64 值。
注:如果图片资源和请求审核的服务不在同一区域,推荐使用 BASE64 方式调用,图片 URL 在网络不佳时可能会造成图片下载缓慢或下载失败等问题
image
必需
String
图片内容。type=1 时为图片 URL;type=2 时为图片 BASE64 值。
strategyId
可选
String
策略编号;不传时使用默认策略 DEFAULT
checkTags
可选
List<Number>
限定检测类别。支持传入策略中开启的一级类别,当传入的某一类别在策略配置中未开启时,忽略该类别
referImage
可选
String
用来做人脸对比的参照图,图片类型需要和 image 一致(image 为 URL 则 referImage 也为 URL)。支持格式:jpg, png;大小 < 10M
userId
可选
String
唯一的终端用户 ID,不超过 32 个字符
extra
可选
json
扩展透传字段,可传多个 key/value。例如:"extra": {"server": "123", "version": "456"}。不得超过 20 个 key/value,单个 key 不得嵌套超过 3 层;若超出限制,后台审核日志将不会记录本次任务的 extra 值,但不影响 extra 透传响应
- 请求体示例:
{
"type": 1,
"image": "http://abc.com/a.jpg",
"strategyId": "DEFAULT",
"userId": "testUser",
"checkTags": [100, 200],
"extra": { "server": "123", "version": "456" }
}
- 请求签名:
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。
HTTP 响应
Content-Type: application/json;charset=UTF-8
结果为 JSON 格式。
- 顶层字段说明:
参数
类型
描述
errorCode
Number
错误码:0 表示成功;100001:图片下载失败;100002:图片格式错误
errorMessage
String
错误消息
result
Number
审核结论:0:通过;1:建议审核;2:不通过
taskId
String
任务 ID
mediaType
String
图片类型,例如:image/jpeg、image/png、image/gif、image/webp、image/bmp、image/heic
snapshotUrl
String
本次审核产生的图片快照地址
imageSpams
json 对象
违规检出明细,见下方 imageSpams(未检出违规信息时,将不返回该字段)
ocr
json 对象
识别文本内容,见下方 ocr(默认不返回该字段,需在控制台开启开关时返回)
personInfo
json 对象
人体/人脸/性别检测结果,见下方 personInfo
labels
json 数组
标签信息,见下方 labels
extra
json
请求中透传的扩展字段
imageSpams
参数
类型
描述
tags
json 数组
命中的分类信息列表,见下方 tags
tags
参数
类型
描述
tag
Number
一级分类信息代码:100:涉政, 110:暴恐, 120:违禁, 130:色情, 140:性感, 150:广告, 160:涉价值观, 180:未成年保护, 200:二维码, 230:无人脸挂机, 232:图片质量, 300:图标, 400:图文, 666:恶心, 800:标签, 888:人脸对比, 900:其他, 999:用户自定义
level
Number
分类级别:0:正常;1:疑似;2:异常
confidence
Number
置信度分数,0-100。100 为置信度最高。若 level 为疑似或异常,置信度越大说明命中的可能性越高
nameZh
String
一级类型名称(中文)
nameEn
String
一级类型名称(英文)
wordList
List<String>
命中图文时返回违规文本(tag=400)
subTags
json 数组
二级分类信息,见下方 subTags
subTags
参数
类型
描述
subTag
Number
二级分类编码,详细编码请参考 分类编码对照表
level
Number
分类级别:0:正常;1:疑似;2:异常
confidence
Number
置信度分数,0-100
nameZh
String
二级类型名称(中文)
nameEn
String
二级类型名称(英文)
wordList
List<String>
命中图文时返回违规文本(tag=400)
terTags
json 数组
三级分类信息,见下方 terTags(需在控制台开启三级标签开关时返回)
terTags
参数
类型
描述
terTag
Number
三级分类编码
level
Number
分类级别:0:正常;1:疑似;2:异常
confidence
Number
置信度分数,0-100
nameZh
String
三级类型名称(中文)
nameEn
String
三级类型名称(英文)
wordList
List<String>
命中图文时返回违规文本(tag=400)
ocr
参数
类型
描述
text
List<String>
OCR 识别出的文本内容列表
personInfo
参数
类型
描述
genders
json 数组
人脸性别及其置信度,见下方 genders
human
json 对象
人体个数结果,示例:{"number": 12}
face
json 对象
人脸个数结果,示例:{"number": 7}
genders
参数
类型
描述
gender
String
性别:male / female
confidence
Number
性别置信度,0-100
labels
参数
类型
描述
id
String
标签唯一标识
score
Number
模型得分,分值越高置信度越高
nameZh
String
标签名称(中文)
nameEn
String
标签名称(英文)
- 返回结果示例:
{
"errorCode": 0,
"result": 2,
"taskId": "ap_634e686ef7e54447af7463f4dd060d6d_1783514588456",
"mediaType": "image/jpeg",
"snapshotUrl": "https://cos.example.com/path/to/dumped-image.jpg",
"imageSpams": {
"tags": [
{
"tag": 100,
"level": 2,
"confidence": 90,
"nameZh": "涉政",
"nameEn": "politics",
"subTags": [
{
"subTag": 100001,
"level": 2,
"confidence": 90,
"nameZh": "政治人物",
"nameEn": "political_figure",
"terTags": [
{
"terTag": 100001001,
"level": 2,
"confidence": 90,
"nameZh": "具体政治人物",
"nameEn": "specific_political_figure"
}
]
}
]
}
]
},
"ocr": {
"text": ["苗华", "赵四"]
},
"personInfo": {
"genders": [
{ "gender": "male", "confidence": 90 }
],
"human": { "number": 12 },
"face": { "number": 7 }
},
"labels": [
{
"id": "800001007",
"score": 31,
"nameZh": "人脸数",
"nameEn": "face_num"
}
],
"extra": {}
}
错误码
详见帮助中心的常见异常码
请求规范
- 请求 URL:
https://isafe.ilivedata.com/api/v2/image/check
-
图片要求:
- 图片支持类型:URL, BASE64
- 图片支持格式:jpg, png, bmp, gif, webp, tiff, heic
- 图片大小:单张 < 10M
- gif 图、长图说明:自动将 gif 图、长图(长宽比大于 5 的图片)截帧过检,最多 5 张,gif 图、长图均按照实际截图张数进行计费
-
HTTP 请求 Header:
| Header | 值 | 描述 |
|---|---|---|
| Content-Type | application/json;charset=UTF-8 | 请求体类型 |
| Accept | application/json;charset=UTF-8 | 接受的返回类型 |
| X-AppId | 项目的唯一标识,此值是 <控制台-服务配置> 中的项目编号 | |
| X-TimeStamp | 请求的 UTC 时间戳。需要把时间戳按 W3C 标准格式化,例如: 2010-01-31T23:59:59Z。 (http://www.w3.org/TR/xmlschema-2/#dateTime)。 | |
| Authorization | 签名值 |
-
请求方法:POST
-
请求体 JSON 对象:
| 参数 | 是否必需 | 类型 | 描述 |
|---|---|---|---|
| type | 必需 | Number | 图片内容类型:1:图片 URL;2:图片 BASE64 值。 注:如果图片资源和请求审核的服务不在同一区域,推荐使用 BASE64 方式调用,图片 URL 在网络不佳时可能会造成图片下载缓慢或下载失败等问题 |
| image | 必需 | String | 图片内容。type=1 时为图片 URL;type=2 时为图片 BASE64 值。 |
| strategyId | 可选 | String | 策略编号;不传时使用默认策略 DEFAULT |
| checkTags | 可选 | List<Number> | 限定检测类别。支持传入策略中开启的一级类别,当传入的某一类别在策略配置中未开启时,忽略该类别 |
| referImage | 可选 | String | 用来做人脸对比的参照图,图片类型需要和 image 一致(image 为 URL 则 referImage 也为 URL)。支持格式:jpg, png;大小 < 10M |
| userId | 可选 | String | 唯一的终端用户 ID,不超过 32 个字符 |
| extra | 可选 | json | 扩展透传字段,可传多个 key/value。例如:"extra": {"server": "123", "version": "456"}。不得超过 20 个 key/value,单个 key 不得嵌套超过 3 层;若超出限制,后台审核日志将不会记录本次任务的 extra 值,但不影响 extra 透传响应 |
- 请求体示例:
{
"type": 1,
"image": "http://abc.com/a.jpg",
"strategyId": "DEFAULT",
"userId": "testUser",
"checkTags": [100, 200],
"extra": { "server": "123", "version": "456" }
}
- 请求签名:
该接口需要在请求 Header 中传入 Authorization 签名。签名计算规则请参考帮助中心的请求签名。
HTTP 响应
Content-Type: application/json;charset=UTF-8
结果为 JSON 格式。
- 顶层字段说明:
| 参数 | 类型 | 描述 |
|---|---|---|
| errorCode | Number | 错误码:0 表示成功;100001:图片下载失败;100002:图片格式错误 |
| errorMessage | String | 错误消息 |
| result | Number | 审核结论:0:通过;1:建议审核;2:不通过 |
| taskId | String | 任务 ID |
| mediaType | String | 图片类型,例如:image/jpeg、image/png、image/gif、image/webp、image/bmp、image/heic |
| snapshotUrl | String | 本次审核产生的图片快照地址 |
| imageSpams | json 对象 | 违规检出明细,见下方 imageSpams(未检出违规信息时,将不返回该字段) |
| ocr | json 对象 | 识别文本内容,见下方 ocr(默认不返回该字段,需在控制台开启开关时返回) |
| personInfo | json 对象 | 人体/人脸/性别检测结果,见下方 personInfo |
| labels | json 数组 | 标签信息,见下方 labels |
| extra | json | 请求中透传的扩展字段 |
imageSpams
| 参数 | 类型 | 描述 |
|---|---|---|
| tags | json 数组 | 命中的分类信息列表,见下方 tags |
tags
| 参数 | 类型 | 描述 |
|---|---|---|
| tag | Number | 一级分类信息代码:100:涉政, 110:暴恐, 120:违禁, 130:色情, 140:性感, 150:广告, 160:涉价值观, 180:未成年保护, 200:二维码, 230:无人脸挂机, 232:图片质量, 300:图标, 400:图文, 666:恶心, 800:标签, 888:人脸对比, 900:其他, 999:用户自定义 |
| level | Number | 分类级别:0:正常;1:疑似;2:异常 |
| confidence | Number | 置信度分数,0-100。100 为置信度最高。若 level 为疑似或异常,置信度越大说明命中的可能性越高 |
| nameZh | String | 一级类型名称(中文) |
| nameEn | String | 一级类型名称(英文) |
| wordList | List<String> | 命中图文时返回违规文本(tag=400) |
| subTags | json 数组 | 二级分类信息,见下方 subTags |
subTags
| 参数 | 类型 | 描述 |
|---|---|---|
| subTag | Number | 二级分类编码,详细编码请参考 分类编码对照表 |
| level | Number | 分类级别:0:正常;1:疑似;2:异常 |
| confidence | Number | 置信度分数,0-100 |
| nameZh | String | 二级类型名称(中文) |
| nameEn | String | 二级类型名称(英文) |
| wordList | List<String> | 命中图文时返回违规文本(tag=400) |
| terTags | json 数组 | 三级分类信息,见下方 terTags(需在控制台开启三级标签开关时返回) |
terTags
| 参数 | 类型 | 描述 |
|---|---|---|
| terTag | Number | 三级分类编码 |
| level | Number | 分类级别:0:正常;1:疑似;2:异常 |
| confidence | Number | 置信度分数,0-100 |
| nameZh | String | 三级类型名称(中文) |
| nameEn | String | 三级类型名称(英文) |
| wordList | List<String> | 命中图文时返回违规文本(tag=400) |
ocr
| 参数 | 类型 | 描述 |
|---|---|---|
| text | List<String> | OCR 识别出的文本内容列表 |
personInfo
| 参数 | 类型 | 描述 |
|---|---|---|
| genders | json 数组 | 人脸性别及其置信度,见下方 genders |
| human | json 对象 | 人体个数结果,示例:{"number": 12} |
| face | json 对象 | 人脸个数结果,示例:{"number": 7} |
genders
| 参数 | 类型 | 描述 |
|---|---|---|
| gender | String | 性别:male / female |
| confidence | Number | 性别置信度,0-100 |
labels
| 参数 | 类型 | 描述 |
|---|---|---|
| id | String | 标签唯一标识 |
| score | Number | 模型得分,分值越高置信度越高 |
| nameZh | String | 标签名称(中文) |
| nameEn | String | 标签名称(英文) |
- 返回结果示例:
{
"errorCode": 0,
"result": 2,
"taskId": "ap_634e686ef7e54447af7463f4dd060d6d_1783514588456",
"mediaType": "image/jpeg",
"snapshotUrl": "https://cos.example.com/path/to/dumped-image.jpg",
"imageSpams": {
"tags": [
{
"tag": 100,
"level": 2,
"confidence": 90,
"nameZh": "涉政",
"nameEn": "politics",
"subTags": [
{
"subTag": 100001,
"level": 2,
"confidence": 90,
"nameZh": "政治人物",
"nameEn": "political_figure",
"terTags": [
{
"terTag": 100001001,
"level": 2,
"confidence": 90,
"nameZh": "具体政治人物",
"nameEn": "specific_political_figure"
}
]
}
]
}
]
},
"ocr": {
"text": ["苗华", "赵四"]
},
"personInfo": {
"genders": [
{ "gender": "male", "confidence": 90 }
],
"human": { "number": 12 },
"face": { "number": 7 }
},
"labels": [
{
"id": "800001007",
"score": 31,
"nameZh": "人脸数",
"nameEn": "face_num"
}
],
"extra": {}
}
错误码
详见帮助中心的常见异常码