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的权限。请参考获取token示例。
project_id	是	String	项目ID。进入内容审核（经典版）管理控制台，在控制中心页面，鼠标移动至到右上角的用户名上，在下拉列表中单击“我的凭证”，在“我的凭证”页面的项目列表中，可以查看对应区域的项目ID

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
event_type	是	String	事件类型。可选值有：nickname: 昵称、title: 标题、article: 帖子、comment: 评论、barrage: 弹幕、search: 搜索栏、profile: 个人简介
glossary_names	否	Array of strings	检测时使用的自定义黑名单词库列表。 说明：自定义黑名单词库的创建和使用请参见配置自定义词库 V3。
white_glossary_names	否	Array of strings	检测时使用的自定义白名单词库列表。 说明：自定义白名单词库的创建和使用请参见配置自定义词库V3。
categories	否	Array of strings	文本审核场景，可选值如下： terrorism：暴恐 porn：色情 ban：违禁 abuse: 辱骂 ad：广告 当categories为空时，默认为所有审核场景。
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	返回内容审核调用结果	success	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

表segments

参数	是否必填	参数类型	说明	示例	下级对象
segment	是	String	命中的风险片段
glossary_name	否	String	命中的自定义词库名称。 命中自定义词库时，才会返回当前字段。
position	否	Array of integers	命中的风险片段在文本中的位置，起始位置从0开始。

请求失败返回响应参数

参数	是否必填	参数类型	说明	示例	下级对象
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."
}

获取token示例

获取用户的AK和SK，作用范围为项目"cn-jssz1"，通过用户名、账号名、密码方式获取Token，用户名、账号名查询路径：进入内容审核（经典版）管理控制台，在控制中心页面，鼠标移动至到右上角的用户名上，在下拉列表中单击“我的凭证”即可查询到。

广州4项目名称：cn-gdgz1

苏州项目名称：cn-jssz1

POST https://iam.cn-jssz1.ctyun.cn/v3/auth/tokens  （所有局点均使用此URL地址）

{
    "auth": {
        "identity": {
            "password": {
                "user": {
                    "name": "IAMUser",          //IAM用户名
                    "password": "IAMPassword",  //IAM用户密码
                    "domain": {
                        "name": "IAMDomain"     //IAM用户所属账号名
                    }
                }
            },
            "methods": [
                "password"
            ]
        },
        "scope": {
            "project": {
                "name": "cn-jssz1"   //根据局点选取相应项目名称
            }
        }
    }
}

状态码为201时：请求成功。

响应Header参数（获取到的Token）：
X-Subject-Token:MIIatAYJKoZIhvcNAQcCoIIapTCCGqECAQExDTALB...

9、状态码

http状态码	描述
200	表示请求成功
400	表示请求失败

10、错误码说明

错误码	错误信息	错误描述
AIS.0004	The request is unauthorized.	服务未开通请开通服务。
AIS.0014	The JSON format of the input data is incorrect.	请检查输入数据的JSON格式。
AIS.0401	The input parameter is incorrect.	请输入正确的参数。
AIS.0011	Lack the request parameter, or the request parameter is empty.	请检查请求body是否缺少必须字段，请参考对应API的请求说明。
AIS.0413	The request reach rate limit.	请求触发流控。

11、配置自定义词库V3

在使用文本审核/图像审核时，支持用户配置自定义白名单词库和自定义黑名单词库，来帮助客户过滤和检测指定文本内容。

说明：配置自定义词库后，需要用户自行维护。

背景信息

• 配置自定义词库需要先开通文本内容审核服务。
• 配置后可以使用自定义词库。
• 一个账户最多支持创建10个自定义词库。

创建自定义词库

说明：白名单词库的处理建议选择“通过”，黑名单词库的处理建议选择“违规”或“疑似”。

1. 登录内容审核（经典版）服务管理控制台。

2. 在左侧菜单栏中选择“设置>自定义词库“，在“自定义词库 V3”页面单击“创建词库“按钮，会弹出“创建词库“窗口。

3. 在窗口中填写参数后单击“确定“，完成词库的创建。

   • 名称：长度小于50个字符，只能包含字母、数字、中划线和下划线。
   • 处理建议：有“通过、违规、疑似”三种选则，选择“通过”则为白名单词库，选择“违规、疑似”则为黑名单词库。
   • 使用场景：选择需要的使用场景，目前包括（涉政、暴恐、色情、违禁、辱骂、广告、自定义、正常）。
   • 匹配方式：原文匹配。
   • 描述：对此词库的描述。

   说明：词库名称不支持修改。

4. 创建好后，在列表页面单击操作列的“管理”，即可增加关键词。

修改或删除自定义词库

1. 登录内容审核（经典版）服务管理控制台。
2. 在左侧菜单栏中选择“设置>自定义词库“，在“自定义词库 V3”页面。
   • 单击目标词库操作列的“管理“，修改目标关键词内容，单击“确定“完成修改。
   • 单击目标词库操作列的“删除“，删除目标关键词内容，单击“确定“完成删除。

说明：删除操作不可恢复，请谨慎操作。