# 文本内容审核（V3） - Text Moderation #### 功能介绍 分析并识别上传的文本内容是否有敏感内容，并将识别结果返回给您。 ![](https://support.huaweicloud.com/api-moderation/public_sys-resources/note_3.0-zh-cn.png) 1. 当前仅支持中文内容审核，其他语言的文本审核暂不支持。 2. 文本内容审核默认API调用最大并发为40，如需调整更高并发限制请联系华为专业工程师为您服务。 3. 您可以配置自定义词库，来过滤和检测指定文本内容。自定义词库的创建和使用请参见[配置自定义词库](https://support.huaweicloud.com/api-moderation/moderation_03_0097.html)。 #### 前提条件 在使用文本内容审核之前需要您完成服务申请和认证鉴权，具体操作流程请参见[内容审核快速入门](https://support.huaweicloud.com/qs-moderation/moderation_07_0001.html)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=Moderation&api=RunTextModeration&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI POST /v3/{project_id}/moderation/text 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-moderation/moderation_03_0055.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 用于获取操作API的权限。获取方法请参见[获取Token接口](https://support.huaweicloud.com/api-moderation/moderation_03_0003.html)，响应消息头中X-Subject-Token的值即为Token。 | | Enterprise-Project-Id | 否 | String | 企业项目ID。Moderation支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入"企业项目管理"页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景： - 携带正确的ID，正常使用Moderation服务，账单的企业项目会被分类到企业ID对应的企业项目中。 - 携带格式正确但不存在的ID，正常使用Moderation服务，账单的企业项目会显示对应不存在的企业项目ID。 - 不携带ID或格式错误ID（包含特殊字符等），正常使用Moderation服务，账单的企业项目会被分类到"default"中。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | data | 是 | [TextDetectionDataReq] object | 检测数据。 | | event_type | 否 | String | 事件类型。可选值如下： - nickname: 昵称。 - title: 标题。 - article: 帖子。 - comment: 评论。 - barrage: 弹幕。 - search: 搜索栏。 - profile: 个人简介。 | | glossary_names | 否 | Array of strings | 检测时使用的自定义黑名单词库列表。 说明： 自定义黑名单词库的创建和使用请参见[配置自定义词库](https://support.huaweicloud.com/api-moderation/moderation_03_0097.html)。 | | white_glossary_names | 否 | Array of strings | 检测时使用的自定义白名单词库列表。 说明： 自定义白名单词库的创建和使用请参见[配置自定义词库](https://support.huaweicloud.com/api-moderation/moderation_03_0097.html)。 | | categories | 否 | Array of strings | 文本审核场景，可选值如下： - terrorism：暴恐违规内容。 - porn：色情违规内容。 - ban：违禁违规内容。 - abuse: 辱骂违规内容。 - ad：广告违规内容。 - politics：涉政违规内容。 当categories为空时，默认为所有审核场景。 | 表4TextDetectionDataReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | text | 是 | String | 待检测文本，编码格式为"utf-8"，限定10000个字符以内，文本长度超过10000个字符时，只检测前10000个字符。 最小长度：**1** 最大长度：**10000** | | language | 否 | String | 支持检测的文本语言。可选值如下： zh：中文 | #### 响应参数 **状态码： 200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 本次请求的唯一标识，用于问题排查，建议保存 最小长度：**2** 最大长度：**64** | | result | [TextDetectionResult] object | 调用成功时表示调用结果。 调用失败时无此字段。 | 表6TextDetectionResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | suggestion | String | 审核结果是否通过。 block：包含敏感信息，不通过 pass：不包含敏感信息，通过 review：需要人工复检 | | label | String | 检测结果的标签。支持label列表如下： - politics: 涉政违规内容。 - terrorism: 暴恐违规内容。 - porn: 色情违规内容。 - ban: 违禁违规内容。 - abuse: 辱骂违规内容。 - ad: 广告违规内容。 - customized：自定义（命中自定义词库中的关键词） | | details | Array of [TextDetectionResultDetail] objects | 检测详情。 | 表7TextDetectionResultDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | suggestion | String | 审核结果是否通过。 block：包含敏感信息，不通过 pass：不包含敏感信息，通过 review：需要人工复检 | | label | String | 检测结果的标签。 支持label列表如下： - politics: 涉政违规内容。 - terrorism: 暴恐违规内容。 - porn: 色情违规内容。 - ban: 违禁违规内容。 - abuse: 辱骂违规内容。 - ad: 广告违规内容。 - customized：自定义（命中自定义词库中的关键词）。 | | confidence | Float | 置信度，即命中检测结果的标签的可信度，取值范围 0-1，值越大，可信度越高。 说明： 置信度和审核通不通过没有直接关系。 | | segments | Array of [Segment] objects | 命中的风险片段信息，如果命中了语义算法模型，则会返回一个空的列表。 | 表8Segment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | segment | String | 命中的风险片段。 | | glossary_name | String | 命中的自定义词库名称。 命中自定义词库时，才会返回当前字段。 | | position | Array of integers | 命中的风险片段在文本中的位置，起始位置从0开始。 | **状态码： 400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 调用失败时的错误码，具体请参见[错误码](https://support.huaweicloud.com/api-moderation/moderation_03_0010.html)。 调用成功时无此字段。 | | error_msg | String | 调用失败时的错误信息。 调用成功时无此字段。 | #### 请求示例 ![](https://support.huaweicloud.com/api-moderation/public_sys-resources/note_3.0-zh-cn.png) "endpoint"即调用API的请求地址，不同服务不同区域的endpoint不同，具体请参见[终端节点](https://support.huaweicloud.com/api-moderation/moderation_03_0052.html)。 例如，服务部署在"华北-北京四"区域的"endpoint"为"moderation.cn-north-4.myhuaweicloud.com"，请求URL为"https://moderation.cn-north-4.myhuaweicloud.com/v3/{project_id}/moderation/text"，"project_id"为项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-moderation/moderation_03_0055.html)。 - 识别文本内容是否有敏感内容，事件类型为评论，命中的自定义词库名称为custom_xxx，检测时使用的自定义白名单词库列表为custom_xxx，检测文本为asdfasdfasdf。 ``` POST https://{endpoint}/v3/{project_id}/moderation/text { "event_type" : "comment", "glossary_names" : [ "custom_xxx" ], "white_glossary_names" : [ "custom_xxx" ], "data" : { "text" : "asdfasdfasdf" } } ``` #### 响应示例 **状态码： 200** 成功响应示例 ``` { "request_id": "58e7d9c7-3456-4ba1-80df-6f25506bc4df", "result": { "suggestion": "block", "label": "customized", "details": [ { "suggestion": "block", "label": "customized", "confidence": 1, "segments": [ { "position": [ 0, 1, 2 ], "segment": "xxx", "glossary_name": "zzz" } ] } ] ``` **状态码： 400** 失败响应示例 ``` { "error_code" : "AIS.0011", "error_msg" : "Lack the request parameter, or the request parameter is empty." } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功响应示例。 | | 400 | 失败响应示例。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-moderation/moderation_03_0010.html)。