内容审核-文本

本章节提供了通过Postman调用“内容审核-文本”的样例，帮助您快速体验并熟悉使用本服务，具体步骤如下：

步骤一：开通服务，用户在内容审核控制台，申请开通内容审核-文本服务。

步骤二：配置自定义词库，用户可配置自定义白名单词库和自定义黑名单词库。

步骤三：配置环境，把准备的配置文件导入到开发环境中。

步骤四：Token认证鉴权，用户调用API接口时，需要使用Token进行鉴权。

步骤五：调用服务，调用API接口使用服务，使用过程中可以随时查看状态码与错误码。

步骤六：查看调用次数（可选），在控制台查看调用详情和调用次数统计。

步骤一：开通服务

内容审核-文本服务开通步骤请参考开通服务步骤说明。

步骤二：配置自定义词库

文本内容审核服务可支持用户配置自定义白名单词库和自定义黑名单词库进行文本审核。

创建自定义白名单词库：在使用文本内容审核服务时，您在白名单词库配置的内容可以不被检测出。
具体操作步骤如下：
1. 登录内容审核服务管理控制台，在左侧菜单栏中选择“设置>自定义词库”。
2. 在自定义词库界面，单击“白词库”页签中“创建词库”按钮，进入“创建词库”页面。
  图1 创建词库
3. 填写词库名称，输入新增的白名单关键词。
  - 名称：长度小于40个字符，只能包含字母、数字、中划线和下划线。
  - 新增关键词：长度不大于40个字符，最多支持5000个关键词，每一行一个关键词。
4. 单击“确定”，完成词库的创建。
创建自定义黑名单词库：在使用文本内容审核服务时，您在黑名单词库配置的内容会被检测出。
具体操作步骤如下：
1. 登录内容审核服务管理控制台，在左侧菜单栏中选择“设置>自定义词库”。
2. 在自定义词库界面，单击“黑词库”页签中“创建词库”按钮，进入“创建词库”页面。
3. 填写词库名称，输入新增的黑名单关键词。
  - 名称：长度小于40个字符，只能包含字母、数字、中划线和下划线。
  - 新增关键词：长度不大于40个字符，最多支持5000个关键词，每一行一个关键词。
4. 单击“确定”，完成词库的创建。
- 词库名称不支持修改。
- V2版本的文本审核，可以选择是否勾选“不指定检测场景”，默认不勾选。
  - 勾选：表示使用默认场景和用户自定义场景进行审核。
  - 不勾选：表示使用默认场景进行审核。

步骤三：配置环境

下载并安装Postman。Postman建议使用7.24.0版本。

步骤四：Token认证鉴权

在Postman界面，选择“New > Collection”，设置相应的名称并单击“Create”完成创建。
选择创建的Collection，单击鼠标右键，选择“Add Request”，设置Request name并单击“Save”。
请求方式修改为"POST"，输入URL。
例如，以ap-southeast-1为例，URL为“https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens”。
在“Headers”列表中添加“KEY”为“Content-Type”，“VALUE”为“application/json”。

选中“Body”的配置项，选中“raw”，在空白处添加以下代码。

图2 Token认证鉴权

图中代码红框内加粗的蓝色字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，project name为服务的部署区域，获取方法请登录我的凭证获取。

内容审核服务部署的区域必须与调用的服务所在区域一致，本示例中为ap-southeast-1。

{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",
                    "password": "**********",
                    "domain": {
                        "name": "domainname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "ap-southeast-1"
            }
        }
    }
}

单击右上角“Send”按钮发送请求。获取返回结果中的Token值（Token有效期为24小时）。

步骤五：调用服务

新建请求，请求方式为修改"POST"，按要求填写URL。
例如服务部署在“中国-香港”区域，请求URL为“https://moderation.ap-southeast-1.myhuaweicloud.com/v2/{project_id}/moderation/text”。

选中“Headers”配置项，复制Token值到“X-Auth-Token”。

登录我的凭证，查询隶属于“中国-香港”的项目ID，替换URI中的{project_id}
单击“Body”，将待检测的文本填入到“text”参数中。关于body体中其他参数说明，请参考文本内容审核API。
图3 修改参数
单击右上角“Send”按钮发送请求，查看识别结果。

步骤六：查看调用次数（可选）

登录内容审核服务管理控制台。
在左侧导航栏中选择“服务列表>文本审核”，可以查看识别统计详情。您可以设置时间范围，策略（事件类型）来观察这段时间内的调用次数变化情况。
- 识别结果统计：显示一段时间范围，内容审核的调用总数，拒绝数，疑似数和通过数，帮助您更好了解服务的调用情况和审核情况。
  - 总数：指的是审核调用总次数。
  - 拒绝数：指的是block总数，即文本中包含敏感信息，审核不通过的次数。
  - 疑似数：指的是review总数，即人工复查审核的次数。
  - 通过数：指的是pass总数，即通过审核的次数。
- 数据趋势：显示您设置的这段时间范围内，总数，拒绝数，疑似数和通过数的变化趋势。
- 拒绝数据原因分布：显示您设置的这段时间范围内，审核不通过的检测场景占比数。
- 疑似数据原因分布：显示您设置的这段时间范围内，需要人工复查的检测场景占比数。
查看监控数据。您可以单击“查看监控指标”在云监控控制台查看服务调用成功和失败的次数等历史数据，如图4所示。

图4 监控数据