凯发k8国际娱乐官网入口-k8凯发> 内容审核 moderation> > > > 文本内容审核（v3）
更新时间：2023-11-20 gmt 08:00

文本内容审核（v3）-凯发k8国际娱乐官网入口

功能介绍

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

  1. 相比于v2版本，v3版本增强了服务的审核能力，能够给您带来更好的内容审核使用体验。
  2. 当前仅支持中文内容审核，其他语言的文本审核暂不支持。
  3. 文本内容审核默认api调用最大并发为50，如需调整更高并发限制请联系华为专业工程师为您服务。

前提条件

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

调试

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

uri

post /v3/{project_id}/moderation/text

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

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

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

用户token。

用于获取操作api的权限。获取方法请参见，响应消息头中x-subject-token的值即为token。
表3 请求body参数

参数

是否必选

参数类型

描述

event_type

否

string

事件类型。可选值如下：

  • nickname: 昵称
  • title: 标题
  • article: 帖⼦
  • comment: 评论
  • barrage: 弹幕
  • search: 搜索栏
  • profile: 个⼈简介

glossary_names

否

array of strings

检测时使用的自定义黑名单词库列表。

说明：

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

white_glossary_names

否

array of strings

检测时使用的自定义白名单词库列表。

说明：

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

categories

否

array of strings

文本审核场景，可选值如下：

  • terrorism：暴恐
  • porn：色情
  • ban：违禁
  • abuse: 辱骂
  • ad：广告

当categories为空时，默认为所有审核场景。

data

是

textdetectiondatareq object

检测数据。

biz_type

否

string

用户在控制台界面创建的自定义审核策略名称。

  • 如果请求参数中传了biz_type则优先使用biz_type。
  • 如果用户没传biz_type则event_type必须传。
表4 textdetectiondatareq

参数

是否必选

参数类型

描述

text

是

string

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

最小长度：1

最大长度：1500

language

否

string

支持检测的文本语言。可选值为zh：中文。

不传该参数表示默认为zh。

响应参数

状态码： 200

表5 响应body参数

参数

参数类型

描述

request_id

string

本次请求的唯⼀标识，⽤于问题排查，建议保存

最小长度：2

最大长度：64

result

textdetectionresult object

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

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

参数

参数类型

描述

suggestion

string

审核结果是否通过。

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

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

review：需要人工复检

label

string

检测结果的标签。支持label列表如下：

  • terrorism: 暴恐
  • porn: 色情
  • ban: 违禁
  • abuse: 辱骂
  • ad: 广告
  • customized：自定义（命中自定义词库中的关键词）

details

array of textdetectionresultdetail objects

检测详情。
表7 textdetectionresultdetail

参数

参数类型

描述

suggestion

string

审核结果是否通过。

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

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

review：需要人工复检

label

string

检测结果的标签。

支持label列表如下：

  • terrorism: 暴恐
  • porn: 色情
  • ban: 违禁
  • abuse: 辱骂
  • ad: 广告
  • customized：自定义（命中自定义词库中的关键词）

confidence

float

置信度，取值范围 0-1，值越⼤，可信度越⾼。

segments

array of segment objects

命中的风险片段信息，如果命中了语义算法模型，则会返回一个空的列表。
表8 segment

参数

参数类型

描述

segment

string

命中的风险片段。

glossary_name

string

命中的自定义词库名称。

命中自定义词库时，才会返回当前字段。

position

array of integers

命中的风险片段在文本中的位置，起始位置从0开始。

状态码： 400

表9 响应body参数

参数

参数类型

描述

error_code

string

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

调用成功时无此字段。

error_msg

string

调用失败时的错误信息。

调用成功时无此字段。

请求示例

“endpoint”即调用api的请求地址，不同服务不同区域的endpoint不同，具体请参见。

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

  • 识别文本内容是否有敏感内容，事件类型为评论，命中的自定义词库名称为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"
  }
}
  • 使用biz_type调用
    post https://{endpoint}/v3/{project_id}/moderation/text
{
  "biz_type" : "my_custom_type",
  "data" : {
    "text" : "asdfasdfasdf"
  }
}

响应示例

状态码： 200

成功响应示例 
{
  "request_id" : "58e7d9c7-3456-4ba1-80df-6f25506bc4df",
  "result" : {
     "suggestion" : "block",
     "label" : "customized",
     "details" : [ {
        "suggestion" : "block",
        "label" : "customized",
        "confidence" : 1,
        "segments" : [ {
            "segment" : "xxx",
            "glossary_name" : "zzz"
       } ]
     } ]
   }
}

状态码： 400

失败响应示例 
{
  "error_code" : "ais.0011",
  "error_msg" : "lack the request parameter, or the request parameter is empty."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见。

父主题：
分享：
网站地图