本文介绍了调用文本审核增强版接口审核文本内容的方法。
使用说明
根据您的接入地域选择合适的业务接口:
- 华东2(上海):
https://green-cip.cn-shanghai.aliyuncs.com
- 华北2(北京):
https://green-cip.cn-beijing.aliyuncs.com
- 华南1(深圳):
https://green-cip.cn-shenzhen.aliyuncs.com
您可以调用该接口创建文本内容检测任务。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK接入指南。
计费信息:
该接口为收费接口。关于计费方式,请参见计费说明。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
请求参数
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
Service | String | 是 | nickname_detection | 审核服务类型,包括:
|
ServiceParameters | JSONString | 是 | 审核服务需要的参数集。JSON字符串格式,关于每个字符串的描述,请参见ServiceParameters。 |
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
content | String | 是 | 检测内容 | 审核的文本内容,限定在600字符以内。 |
accountId | String | 否 | 10123**** | 账户ID,标识一个账户的唯一ID。 |
mobileMd5 | String | 否 | C+5Y0crpO4*****== | 使用MD5加密算法,对以1开头、且11位纯数字手机号码加密,获取到加密后的值。该值为32位小写字母和数字组合的字符串。 |
mobile | String | 否 | 1811234**** | 默认为中国手机号码。如有海外手机,需包含国家地区代码,格式为:地区代码-手机号码。 |
ip | String | 否 | 127.0.XX.XX | 用户使用的真实IP地址。 |
deviceId | String | 否 | t2NInmwxdi****** | 设备的唯一标识。 |
deviceToken | String | 否 | MzQvo1d7scyZ3tl_RcJ****** | 通过风险控制SDK获取到的设备令牌。 |
返回参数
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 200 | 错误码。 更多信息,请参见错误代码。 |
Data | JSONObject | {"labels": "porn","reason": "{\"riskTips\":\"色情_低俗词\",\"riskWords\":\"色情服务\"}"} | 审核结果数据。 |
labels | String | porn | 标签,多个用英文逗号分隔。包括:
说明 标签会持续新增,建议业务对接过程对未知标签忽略处理。
|
reason | String | {\"riskTips\":\"色情_低俗词\",\"riskWords\":\"色情服务\"} | 原因定位的JSON字符串,包含以下字段:
|
Message | String | OK | 请求消息的响应消息。 |
RequestId | String | AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE**** | 请求ID。 |
示例
请求示例
{
"Service":"nickname_detection",
"ServiceParameters":"{\"content\":\"检测内容\",\"accountId\":\"10123****\"}"
}
正常返回示例
{
"Code": 200,
"Data": {
"labels": "porn",
"reason": "{\"riskTips\":\"色情_低俗词\",\"riskWords\":\"色情服务\"}"
},
"Message": "OK",
"RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}
错误代码
错误代码 | HTTP 状态码 | 说明 |
---|---|---|
OK | 200 | 请求成功。 |
BAD_REQUEST | 400 | 请求有误。原因:可能是请求参数不正确导致,请仔细检查请求参数。 |
PERMISSION_DENY | 408 | 原因:可能是您的账号未授权、账号欠费、账号未开通、账号被禁等。 |
GENERAL_ERROR | 500 | 错误。原因:可能是服务端临时出错。建议重试,若持续返回该错误码,请通过在线服务联系我们。 |
TIMEOUT | 581 | 超时。建议重试,若持续返回该错误码,请通过在线服务联系我们。 |
EXCEED_QUOTA | 588 | 请求频率超出配额。 |