广告过滤 API 文档
接口说明
广告过滤，用于分析图片是否包含以下广告信息（电话号码，微信号，QQ号，二维码，广告文本等）。
该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。
接口Demo
示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。
接口要求
集成广告过滤API时，需按照以下要求。
| 内容 | 说明 |
|---|---|
| 请求协议 | http[s] (为提高安全性，强烈推荐https) |
| 请求地址 | http[s]: //api.xfyun.cn/v1/service/v1/image_identify/ad_filter 注：服务器IP不固定，为保证您的接口稳定，请勿通过指定IP的方式调用接口，使用域名方式调用 |
| 请求方式 | POST |
| 接口鉴权 | 签名机制，见授权认证 |
| 字符编码 | UTF-8 |
| 响应格式 | 统一采用JSON格式 |
| 开发语言 | 任意，只要可以向讯飞云服务发起HTTP请求的均可 |
| 适用范围 | 任意操作系统，但因不支持跨域不适用于浏览器，请在后端调用接口 |
| 照片属性 | 宽必须大于8px，人脸照高度小于等于4000px，人脸水印照高度小于等于480px |
| 照片格式 | 静态图片：jpg/jpeg/bmp/png，或zip压缩包，或图片URL |
| 照片大小 | 静态图片：大小不超过10M zip 包：大小不超过50M 图片URL：数量不超过20 |
接口调用流程
注： 若需配置IP白名单，请前往控制台。IP白名单规则请参照 IP白名单。
- 通过接口密钥基于MD5计算签名，将签名以及其他参数放在Http Request Header中，详见下方 请求头 。
- 将图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求体 。
- 向服务器端发送Http请求后，接收服务器端的返回结果，返回结果详见各接口的详细说明。
接口地址示例：
POST http[s]://api.xfyun.cn/v1/service/v1/image_identify/ad_filter HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8
白名单
在调用该业务接口时
- 若关闭IP白名单，接口认为IP不限，不会校验IP。
- 若打开IP白名单，则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中，对于没有配置到白名单中的IP发来的请求，服务端会拒绝服务。
IP白名单规则
- IP白名单，在 控制台-我的应用-相应服务的应用管理卡片上 编辑，保存后五分钟左右生效；
- 不同Appid的不同服务都需要分别设置IP白名单；
- IP白名单需设置为外网IP，请勿设置局域网IP。
- 如果服务器返回结果如下所示(illegal client_ip)，则表示由于未配置IP白名单或配置有误，服务端拒绝服务。
{
"code":"10105",
"desc":"illegal access|illegal client_ip",
"data":"",
"sid":"xxxxxx"
}
接口请求参数
请求头
在 Http Request Header 中配置以下参数。
授权认证
以下参数用于授权认证：
| 参数 | 格式 | 说明 | 必须 |
|---|---|---|---|
| X-Appid | string | 讯飞开放平台注册申请应用的应用ID(appid) | 是 |
| X-CurTime | string | 当前UTC时间戳 从1970年1月1日0点0 分0 秒开始到现在的秒数 | 是 |
| X-Param | string | 相关参数JSON串经Base64编码后的字符串，详见业务参数 | 是 |
| X-CheckSum | string | 令牌，计算方法：MD5(APIKey + X-CurTime + X-Param)，三个值拼接的字符串，进行MD5哈希计算（32位小写） | 是 |
注：
- APIKey：接口密钥，在讯飞开放平台控制台添加相应服务后即可获取，调用方注意保管，如泄露，可到控制台提交工单联系技术人员重置；
- X-CheckSum 有效期：出于安全性考虑，每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算)，同时 X-CurTime 要与标准时间同步，否则时间相差太大，服务端会直接认为 X-CurTime 无效；
- BASE64 编码采用 MIME 格式，字符包括大小写字母各26个，加上10个数字，和加号 + ，斜杠 / ，一共64个字符。
*X-CheckSum *生成示例：
String APIKey="abcd1234";
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);
业务参数
X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串，原始 JSON 串各字段说明如下：
| 参数 | 类型 | 必须 | 说明 | 示例 |
|---|---|---|---|---|
| details | bool | 否 | 在上传多张图片时，选择是否输出详细结果，默认为true | false |
| image_url | []string | 否 | file,image_url,image_id必须选择其中的一个，采用抓取网络图片方式时选取此参数,支持的文件类型包括：静态图片或图片压缩包(jpg, jpeg, bmp, png大小不超过10M，zip大小不超过50M)，url数组(数量不超过20) | https://xxxx/xxx/image.jpg |
| image_id | []string | 否 | file,image_url,image_id必须选择其中的一个，上传本站接口已生成的image_id时选取此参数，可在多个接口间共享，减少图片传输的带宽，支持的类型包括：image_id字符串或字符串数组(数量不超过20) | ee93d40ad0a54ab6a78ced96daf75bcf |
请求体
以POST表单的形式提交以下参数：
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| file | string | 是 | file,image_url,image_id必须选择其中的一个，上传本地文件进行检测时选取此参数，base64 编码后进行 urlencode,支持的文件类型包括：静态图片或图片压缩包(jpg, jpeg, bmp, png大小不超过10M，zip大小不超过50M) |
注：
一般基础类库会默认进行urlencode处理，请注意不要重复处理。
接口返回参数
返回值为 json 串，各字段如下：
| 参数 | 类型 | 说明 |
|---|---|---|
| code | string | 结果码(具体见SDK&API错误码查询) |
| data | object[] | 检测结果 |
| desc | string | 描述 |
| sid | string | 会话ID |
其中 sid 字段主要用于追查问题，如果出现问题，可以提供 sid 给讯飞技术人员帮助确认问题。
data中结果字段说明：
| 字段 | 类型 | 描述 |
|---|---|---|
| has_qr | bool | 是否包含二维码，多张图片时，为最严重的结果 |
| has_adtext | bool | 是否包含广告文本，如明确售卖信息、联系方式、微信手机qq号等,多张图片时，为最严重的结果 |
| image_id | string | 图片唯一标识 |
| texts | object[] | 图片中所有识别到的文本内容，每一个block是一段文本 |
| score | float | 置信度，介于0-1，越接近1越确认 |
| vertex | object[] | 文本的坐标，从左上、右上、右下到左下，顺时针方向展示 |
| is_adtext | bool | 该文本是否为广告 |
| has_ptext | bool | 图片中出现色情广告文本 |
| content | string | 文本内容 |
示例如下：
失败：
{
"code": "10106",
"desc": "invalid parameter|invalid X-Appid",
"data": {},
"sid": "wsr0000bb3f@dx3d5c059d83b3477200"
}
成功（单张图片）：
{
"code":"0",
"data":{
"details":[
{
"has_adtext":false,
"has_ptext":false,
"has_qr":false,
"image_id":"6a1acbec9d7a4747863857bdf5888bd5",
"image_name":"https://xxxx.jpg",
"texts":[
{
"content":"NLT",
"is_adtext":false,
"is_ptext":false,
"is_qr":false,
"score":0,
"vertex":[
{
"x":538,
"y":574
},
{
"x":645,
"y":574
},
{
"x":645,
"y":627
},
{
"x":538,
"y":627
}
]
},
{
"content":"Ww.miui.com",
"is_adtext":false,
"is_ptext":false,
"is_qr":false,
"score":0,
"vertex":[
{
"x":541,
"y":624
},
{
"x":641,
"y":624
},
{
"x":641,
"y":637
},
{
"x":541,
"y":637
}
]
}
]
}
],
"has_adtext":false,
"has_ptext":false,
"has_qr":false
},
"desc":"success",
"sid":"wsr00000001@ch297d0eab47ac000100"
}
成功（多张图片）：
{
"code":"0",
"data":{
"details":[
{
"has_adtext":false,
"has_ptext":false,
"has_qr":false,
"image_id":"d5ebc7b9ddfd46c482f565126c7cf3dd",
"image_name":"https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1527694034364&di=d1814ae0196e9ac5da5011a73a40ec99&imgtype=0&src=http%3A%2F%2Fres.dyhjw.com%2Fueditor%2Fphp%2Fupload%2Fimage%2F20161213%2F1481590523864181.jpg",
"texts":[
]
},
{
"has_adtext":false,
"has_ptext":false,
"has_qr":false,
"image_id":"fe9e22c51e7b428382f60a2d4ee3a521",
"image_name":"https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1527694034363&di=c38ee5076bdd334bf1d35730a03e3f56&imgtype=0&src=http%3A%2F%2Fimg1.cache.netease.com%2Fcatchpic%2F4%2F44%2F44AE91B61A60A201A3F5484859515A6F.jpg",
"texts":[
]
}
],
"has_adtext":false,
"has_ptext":false,
"has_qr":false
},
"desc":"success",
"sid":"wsr00000002@ch297d0eab481d000100"
}
调用示例
常见问题
广告过滤主要功能是什么？
答：利用深度神经网络，在超大规模的图片集合上训练，高精准地识别广告图片，帮助用户审核过滤不必要的广告信息。
广告过滤对上传的图片有什么要求？
答：支持的文件类型包括：静态图片或图片压缩包(jpg, jpeg, bmp, png大小不超过10M，zip大小不超过50M)。
广告过滤支持哪些应用平台？
答：目前广告过滤支持Web API应用平台。
广告过滤可以免费使用吗？
答：可以的，登录讯飞开放平台---控制台---我的应用（没有应用先创建一个应用）---内容审核---广告过滤（可免费调用Webapi接口共500次服务量，授权期限1个月）。
在这篇文章中：