文档首页/ 内容审核 Moderation/ API参考/ API/ 文本审核/ 文本内容审核（V2）
更新时间：2023-06-16 GMT+08:00
查看PDF
分享

文本内容审核（V2）

功能介绍

分析并识别上传的文本内容是否有敏感内容，并将识别结果返回给您。

  1. 推荐使用文本内容审核V3版本。
  2. 当前仅支持中文内容审核，其他语言的文本审核暂不支持。
  3. 文本内容审核默认API调用最大并发为50，如需调整更高并发限制请联系华为专业工程师为您服务。
  4. 您可以配置自定义词库，来过滤和检测指定文本内容。自定义词库的创建和使用请参见配置自定义词库。

前提条件

在使用文本内容审核之前需要您完成服务申请和认证鉴权，具体操作流程请参见内容审核快速入门。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/moderation/text

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

categories

否

Array of strings

检测场景。

当前支持的场景有默认场景和用户自定义场景：

  • 默认场景为：
    • porn：涉黄
    • ad：广告
    • abuse：辱骂
    • contraband：违禁品
    • flood：灌水 （单个或多个数字/字符/标点符号大量重复出现在文本中，将被识别为灌水）
  • 用户自定义场景为：自定义黑名单词库。
    说明：
    • 默认场景采用人工智能文本检测技术识别您所上传的文本内容，自定义场景可通过您自行配置黑名单词库来过滤和检测指定文本内容。
    • 自定义黑名单词库的名称指定给categories就是设置自定义的场景，自定义词库的创建和使用请参见配置自定义词库。
    • flood场景不支持使用自定义白名单词库。

white_glossaries

否

Array of strings

启用的白名单列表。不配置该参数，默认使用2022-09-02 16:00:00之前创建的白名单词库。

配置该参数，有如下规则：
  • 当参数为空列表（即为[ ]）时，表示不使用白名单词库。
  • 当参数设置为您创建的白名单词库名称时，表示启用该词库。
    说明：

    如果您有多个白名单词库想要同时使用，例如有三个白名单词库分别为A，B，C。该参数应设置为["A", "B", "C"] 。

白名单词库的创建和使用请参见创建自定义白名单词库。

items

是

Array of TextDetectionItemsReq objects

待检测的文本列表，目前暂时每次只支持传一个item。
表4 TextDetectionItemsReq

参数

是否必选

参数类型

描述

text

是

String

待检测文本。编码格式为“utf-8”，限定1-5000个字符，文本长度超过5000个字符时，只检测前5000个字符。

type

否

String

文本类型。默认为“content”，即正文内容，当前只支持“content”类型，未来会扩大支持类型范围。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

result

result object

调用成功时表示调用结果。

调用失败时无此字段。
表6 result

参数

参数类型

描述

suggestion

String

检测结果是否通过。

block：包含敏感信息，不通过。

pass：不包含敏感信息，通过。

review：需要人工复查。

detail

Object

返回的相关检测结果详细信息。

  • porn：涉黄敏感词列表。
  • ad：广告敏感词列表。
  • abuse：辱骂敏感词列表。
  • contraband：违禁品敏感词列表。
  • flood：灌水文本（指无意义的文本词语常见于贴吧等灌水帖子）。
    说明：
    • 灌水文本最多显示200个字符。
    • 每个场景的返回结果的详细信息是指命中词，不是返回全部文本。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码，具体请参见错误码。

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

fail_category

String

当包含多个场景时，调用失败的场景。

请求示例

识别文本内容是否有敏感内容，检测场景为广告，辱骂，涉黄，违禁品，灌水，检测文本为asdfasdfasdf。

“endpoint”即调用API的请求地址，不同服务不同区域的endpoint不同，具体请参见终端节点。

例如，服务部署在“华北-北京四”区域的“endpoint”为“moderation.cn-north-4.myhuaweicloud.com”，请求URL为“https://moderation.cn-north-4.myhuaweicloud.com/v2/{project_id}/moderation/text”，“project_id”为项目ID，获取方法请参见获取项目ID。

POST https://{endpoint}/v2/{project_id}/moderation/text

{
  "categories" : [ "ad",  "abuse", "porn", "contraband", "flood" ],
  "items" : [ {
    "text" :  "asdfasdfasdf",
    "type" : "content"
  }
 ]
}

响应示例

状态码： 200

成功响应示例

{
  "result" : {
    "detail" : {
      "abuse" : [ "fuck" ]
    },
    "suggestion" : "block"
  }
}

状态码： 400

失败响应示例

{
  "error_code" : "AIS.0005",
  "error_msg" : "The service does not exist."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码。

父主题： 文本审核

相关文档