1、接口描述
用于自动审核指定文本中是否存在涉黄和色情内容，并给出该文本的涉黄指数，表明文本内容的涉黄程度。
2、请求方法
POST
3、接口要求
- 单条文字数量不超过9999字符，批量请求单次不超过50篇
- 仅支持中文文本，文本内容超过50%非中文，返回评分0.5
4、URI
/v1/aiop/api/2f5o7mk00yrk/abc/api/v1/text_porn.json
5、请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | json格式 | application/json | |
| appkey | 是 | String | 平台应用appkey | 562b89493b1a40e1b97ea05e50dd8170 | |
| ctyun-eop-request-id | 是 | String | 用户请求 id，由用户构造，用户可以通过 uuid 等方法自行生成唯一字符串，用于日志请求追踪。 详见文档：Python3调用示例 |
33dfa732-b27b-464f-b15a-21ed6845afd5 | |
| eop-date | 是 | String | 请求时间，由用户构造，形如 yyyymmddTHHMMSSZ。 详见文档：Python3调用示例 |
20211221T163014Z | |
| host | 是 | String | 终端节点域名，固定字段 | ai-global.ctapi.ctyun.cn | |
| Eop-Authorization | 是 | String | 由天翼云官网 accessKey 和 securityKey 经签名后生成，参与签名生成的字段包括天翼云官网 accessKey 、securityKey、平台应用的appkey（非必须），用户请求id（非必须），请求时间，终端节点域名（非必须）以及请求体内容。 签名逻辑详见文档：认证鉴权和Python3调用示例 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| data | 是 | List | 待处理文本列表 | ["测试文本1", "测试文本2"] | / |
6、请求代码示例
Curl -X POST
"https://ai-global.ctapi.ctyun.cn/v1/aiop/api/2f5o7mk00yrk/abc/api/v1/text_porn.json"
-H "Content-Type: application/json"
-H "ctyun-eop-request-id:33dfa732-b27b-464f-b15a-21ed6845afd5"
-H "appkey:XXX"
-H "Eop-Authorization:XXX"
-H "eop-date:20211109T104641Z"
-H "host:ai-global.ctapi.ctyun.cn"
--data '{"data":["AAAAAAAAA...."]}'
7、返回值说明
请求成功返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表。 | 0 | |
| message | 是 | String | 如果statusCode 为 0，返回 success；如果statusCode 非 0，则返回对应的可读错误信息。 | success | |
| returnObj | 是 | Dict | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| porn | 是 | List | 审核场景 | / | porn[] |
表porn
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| label | 是 | Int | 分类标签值 | 0 | / |
| class_name | 是 | String | 分类标签描述 | 违规 | / |
| confidence | 是 | Float | 该段文本违规的置信度 | 0.98 | / |
请求失败返回响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Int | 错误码，放置API对应的错误码 | 4010 | |
| message | 是 | Str | 返回对应的错误信息 | error | |
| details | 是 | Str | 返回对应的错误描述 | 文件大小不符合要求 | |
| error | 是 | String | 返回对应的错误码 | AI_OP_4101 |
8、返回值示例
请求成功返回值示例
{
"statusCode": 0,
"message": {"success":3, "fail":0},
"returnObj": {
"porn": [
{
"label": 0,
"class_name": "正常",
"confidence": 0.315978
},
{
"label": 0,
"class_name": "正常",
"confidence": 0.0000078003
},
{
"label": 1,
"class_name": "违规",
"confidence": 0.985978
}
]
}
}
请求失败返回值示例
{
"statusCode": 4010,
"message": "error",
"details": "文件大小不符合要求"
"error":"AI_OP_4010"
}
9、状态码
| http状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
10、错误码说明
4位错误码。4开头为业务错误码，5开头为服务错误码。
| 错误码 | 错误信息 | 错误描述 |
|---|---|---|
| AI_OP_4010 | 文件大小不符合要求 | 文本字符超过了9999字 |
| AI_OP_4017 | 处理该请求超时 | 该请求内部处理超时，请稍后再试。 |
| AI_OP_4018 | 单次批量请求数量超过限制 | 该批次请求量超过限制，请降低单批次请求量 |
| AI_OP_5000 | 服务内部错误 | 需要联系管理员处理 |
| AI_OP_5001 | 服务接口异常，请联系管理员 | 当前接口无法正常处理请求，需要联系管理员处理。 |
| AI_OP_5003 | 场景接口异常，具体参见返回消息 | 后端服务超时等 |
