1、接口描述
分析并识别上传的文本内容是否有敏感内容,并将识别结果返回。
2、请求方法
POST
3、接口要求
只支持中文文本内容审核。
4、请求URL
广州资源池:https://moderation.cn-gdgz1.ctyun.cn/v3/{project_id}/moderation/text
苏州资源池:https://content-security-analysis.cn-jssz1.ctyun.cn/v3/{project_id}/moderation/text
5、请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
Content-Type | 是 | String | json 格式 | "application/json" | |
X-Auth-Token | 是 | String | 用户Token。用于获取操作API的权限 | ||
project_id | 是 | String | 项目ID。可在天翼云官网,单击“控制中心”,在控制中心页面,鼠标移动至到右上角的用户名上,在下拉列表中单击“我的凭证”,在“我的凭证”页面的项目列表中,可以查看对应区域的项目ID |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
event_type | 是 | String | 事件类型。可选值有:nickname: 昵称、title: 标题、article: 帖子、comment: 评论、barrage: 弹幕、search: 搜索栏、profile: 个人简介 | ||
data | 是 | Object | 检测数据 | data |
表data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
text | 是 | String | 待检测文本,编码格式为“utf-8”,限定1500个字符以内,文本长度超过1500个字符时,只检测前1500个字符 |
6、请求代码示例
curl --location --globoff 'https://moderation.cn-gdgz1.ctyun.cn/v3/{project_id}/moderation/text' \
--header 'X-Auth-Token: XXXXXX' \
--header 'Content-Type: application/json;charset=utf8' \
--data '{
"event_type": "comment",
"data": {
"text": "测试文本"
}
}'
7、返回值说明
请求成功返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
request_id | 是 | String | 本次请求的唯一标识,用于问题排查,建议保存。最小长度2,最大长度64 | ||
result | 是 | Object | 返回内容审核调用结果 | result |
表result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
suggestion | 是 | String | 审核结果是否通过。有三种结果:block:包含敏感信息,不通过、pass:不包含敏感信息,通过、review:需要人工复检 | "block" | |
label | 是 | String | 检测结果的标签。支持label列表有:terrorism: 暴恐、porn: 色情、ban: 违禁、abuse: 辱骂、ad: 广告、ad_law: 广告法 | ||
details | 是 | Array of objects | 检测详情 | details |
表details
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
suggestion | 是 | String | 审核结果是否通过。有三种结果:block:包含敏感信息,不通过、pass:不包含敏感信息,通过、review:需要人工复检 | "block" | |
label | 是 | String | 检测结果的标签。支持label列表有:terrorism: 暴恐、porn: 色情、ban: 违禁、abuse: 辱骂、ad: 广告、ad_law: 广告法 | ||
confidence | 是 | Float | 置信度,取值范围 0-1,值越大,可信度越高 | ||
segments | 是 | Array of objects | 命中的风险片段信息,如果命中了语义算法模型,则会返回一个空的列表 | segment |
表segment
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
segment | 是 | String | 命中的风险片段 |
请求失败返回响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
error_code | 是 | String | 调用失败时的错误码 | ||
error_msg | 是 | String | 调用失败时的错误信息 |
8、返回值示例
请求成功返回值示例
{
"request_id": "58e7d9c7-3456-4ba1-80df-6f25506bc4df",
"result":: {
"suggestion" : "block",
"label" : "porn",
"details" : [ {
"suggestion" : "block",
"label" : "porn",
"confidence" : 1,
"segments" : [ {
"segment" : "xxx",
} ]
} ]
}
}
请求失败返回值示例
{
"error_code" : "AIS.0011",
"error_msg" : "Lack the request parameter, or the request parameter is empty."
}
9、状态码
http状态码 | 描述 |
---|---|
200 | 表示请求成功 |
400 | 表示请求失败 |
10、错误码说明
错误码 | 错误信息 | 错误描述 |
---|---|---|
AIS.0003 | 服务内部错误 | 需要联系管理员处理。 |
AIS.0010 | 缺少Header或者Header为空 | HTTP请求缺少必须的header信息,请检查是否有Content-type等必须字段。 |
AIS.0011 | 缺少请求参数或者参数为空 | 请检查请求body是否缺少必须字段,请参考对应API的请求说明。 |
AIS.0012 | 请求参数不支持 | 请检查请求中的字段不合法,请参考对应API的请求说明。 |
AIS.0014 | 输入数据JSON格式错误 | 请检查输入数据的JSON格式。 |
AIS.0021 | 请求的文件类型不支持 | 请检查请求的文件类型。 |
AIS.0028 | 此任务不属于当前用户 | 请检查当前账户。 |
AIS.0030 | 任务未找到 | 任务已过期被清理了或者传入的job id错误。请检查job id是否正确。 |
AIS.0401 | 输入参数有误 | 请输入正确的参数。 |
AIS.0404 | 内容审核处理错误 | 需要联系管理员处理。 |
AIS.0405 | 文件大小不符合要求 | 需要联系管理员处理。 |
AIS.0501 | 检查请求json是否存在异常 | 请求参数不是json格式。 |
APIG.0101 | 您所访问的API不存在或尚未在环境中发布 | 1.请检查输入的api信息是否正确,是否该服务存在在对应的区域中。2.检查API的URL是否拼写正确,HTTP请求方法(POST,GET等)是否正确。3.请检查服务调用配置的域名和uri信息是否正确。 |
APIG.0201 | 请求体过大 | 请检查请求的body体是否过大。 |
APIG.0301 | 1.IAM身份验证信息不正确:解密令牌失败,检查输入的token是否完整。2.token有效期为24小时,token超时,重新传入获取token值。 | decrypt token fail:发送的HTTP请求header中x-auth-token的token请求认证信息错误,请检查发送的请求和token。token expires:token超时,请重新获取新token传入。verify aksk signature fail:请检查AK、SK是否正确。 |
APIG.0308 | 请求发送太快,超过了服务的默认配置限流 | 请求发送太快,达到了API的限速阈值,请降低请求速度。 |
ModelArts.0203 | 非法Token | 请检查Token是否正确。 |
ModelArts.4101 | Token为空 | 发送的HTTP请求header中没有带x-auth-token的token请求认证信息,请检查发送的请求。 |
ModelArts.4102 | 解析Token失败 | 发送的HTTP请求header中x-auth-token的token请求认证信息错误,请检查发送的请求和token。 |
ModelArts.4103 | Token不合法 | 发送的HTTP请求header中x-auth-token的token请求认证信息错误,请检查发送的请求和token。 |
ModelArts.4104 | 请求body体长度不合法 | 请检查请求body体长度。 |
ModelArts.4105 | 请求body体json格式不对 | 请检查请求body体是否符合json格式。 |
ModelArts.4106 | 用户帐号受限 | 请检查用户资源状态,帐号受限原因请参考帐号中心相关描述。 |
ModelArts.4107 | 获取用户临时AK,SK异常 | 需要联系管理员处理。 |
ModelArts.4201 | 请求url中需要包含服务ID | 请检查请求url中的服务ID。 |
ModelArts.4202 | 请求url格式不合法 | 请检查请求url格式。 |
ModelArts.4203 | 没有权限访问 | 请检查访问权限。 |
ModelArts.4204 | 没有订阅该API | 请订阅该API。如已开通服务,请检查开通服务的区域与服务调用的一致,若一致请检查API的URL是否拼写正确,HTTP请求方法(POST,GET等)是否正确。 |