# 文本垃圾内容检测接口
开始使用前,请先创建应用,申请UGC内容安全审核,并成功完成审批。
注意
待检测文本需要满足以下要求:
- 文本内容最长不超过10000个中文字符(包含标点)
# 请求
POST https://apigate.glodon.com/ugc/api/v1/scan/text
1
# header参数
参数名 | 必选 | 类型 | 描述 |
---|---|---|---|
Authorization | 是 | 字符串 | Bearer app_access_token. 注:该 access_token 是应用级别 |
Content-Type | 是 | 字符串 | application/json |
# body参数
参数名 | 必选 | 参数类型 | 参数含义 |
---|---|---|---|
text | 是 | 字符串 | 需检测文本内容 |
client_appkey | 否 | 字符串 | 上层业务调用对应的appkey |
client_name | 否 | 字符串 | 上层调用业务线名称 |
# API请求示例
# 返回参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
code | 字符串 | 是 | 请求成功为0,否则为error code |
message | 字符串 | 是 | 请求成功为success,否则为错误描述信息 |
globalSuggestion | 字符串 | 是 | 本次检测结果,取值: pass:文本正常,可以直接放行 review:文本需要进一步人工审核(只要有一个suggestion为review,即为review) block:文本违规,可以直接删除或者限制公开(只要有一个suggestion为block,即为block) |
dataId | 字符串 | 否 | 检测对象对应的数据ID |
content | 字符串 | 否 | 被检测文本,和调用请求中的待检测文本对应 |
taskId | 字符串 | 是 | 本次检测任务的ID |
scene | 字符串 | 是 | 检测场景,antispam:反垃圾 |
suggestion | 字符串 | 是 | 每个scene的检测结果,可作为规则调整优化的参考,取值: pass:文本正常,可以直接放行 review:文本需要进一步人工审核 block:文本违规,可以直接删除或者限制公开 |
label | 字符串 | 是 | 文本垃圾检测结果的分类,取值: normal:正常文本 spam:含垃圾信息 ad:广告 politics:涉政 terrorism:暴恐 abuse:辱骂 porn:色情 flood:灌水 contraband:违禁 meaningless:无意义 |
# 返回结果示例
# 下一步操作
依据 globalSuggestion 对检测对象进行放行、二次审核或直接删除。根据label参数的返回值判断风险的具体类型。
# 附:错误码说明
code | msg | description |
---|---|---|
0 | success | 请求成功。 |
280 | PROCESSING | 任务正在执行中,建议您等待一段时间(例如5s)后再查询结果。 |
400 | BAD_REQUEST | 请求参数不正确,请仔细检查请求参数。 |
401 | NOT_ALLOWED | 图片、视频、语音链接地址不安全。 |
403 | FORBIDDEN | 图片、视频、语音链接无法访问,请确认公网是否可访问,并且无防盗链策略。 |
404 | NOT_FOUND | 待检测内容未找到,图片、视频、语音内容无法下载导致,请确认内容可通过公网访问到。 |
480 | DOWNLOAD_FAILED | 下载失败,请确认待检测内容的大小、分辨率(如果有)在API的限制范围内。 |
500 | GENERAL_ERROR | 服务端临时出错,请重试。 |
580 | DB_FAILED | 数据库操作失败,请重试。 |
581 | TIMEOUT | 超时,请重试。 |
585 | CACHE_FAILED | 缓存出错,请重试。 |
586 | ALGO_FAILED | 算法出错。 |
587 | MQ_FAILED | 中间件出错。 |
588 | EXCEED_QUOTA | 请求频率超出配额。 |
589 | TOO_LARGE | 待检测内容过大,请确保检测的内容在API的限制范围内,请重试。 |
590 | BAD_FORMAT | 待检测内容格式错误,请确保检测的内容在API的限制范围内。 |
591 | CONNECTION_POOL_FULL | 连接池满。 |
592 | DOWNLOAD_TIMEOUT | 下载超时,下载时间限制为3s,请确保检测的内容大小在API的限制范围内。 |
594 | EXPIRED | 任务过期,如taskId过期。 |
595 | CATCH_FRAME_FAILED | 截帧失败。 |
596 | PERMISSION_DENY | 账号未授权、账号欠费、账号未开通、账号被禁等。 |
← DEMO示例 图片违规内容检测接口 →