文本内容审核（V3）
功能介绍
分析并识别上传的文本内容是否有敏感内容，并将识别结果返回给您。
- 相比于V2版本，V3版本增强了服务的审核能力，能够给您带来更好的内容审核使用体验。
- 当前仅支持中文内容审核，其他语言的文本审核暂不支持。
- 文本内容审核默认API调用最大并发为50，如需调整更高并发限制请联系华为专业工程师为您服务。
- 您可以配置自定义词库，来过滤和检测指定文本内容。自定义词库的创建和使用请参见配置自定义词库 V3。
前提条件
在使用文本内容审核之前需要您完成服务申请和认证鉴权，具体操作流程请参见内容审核快速入门。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v3/{project_id}/moderation/text
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 |
|
Enterprise-Project-Id |
否 |
String |
企业项目ID。Moderation支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。 获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。 企业项目创建步骤请参见用户指南。 说明： 创建企业项目后，在传参时，有以下三类场景：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
event_type |
否 |
String |
事件类型。可选值如下：
|
|
glossary_names |
否 |
Array of strings |
检测时使用的自定义黑名单词库列表。
说明：
自定义黑名单词库的创建和使用请参见配置自定义词库 V3。 |
|
white_glossary_names |
否 |
Array of strings |
检测时使用的自定义白名单词库列表。
说明：
自定义白名单词库的创建和使用请参见配置自定义词库 V3。 |
|
categories |
否 |
Array of strings |
文本审核场景，可选值如下：
当categories为空时，默认为所有审核场景。 |
|
data |
是 |
TextDetectionDataReq object |
检测数据。 |
|
biz_type |
否 |
String |
用户在控制台界面创建的自定义审核策略名称。
|
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
request_id |
String |
本次请求的唯一标识，用于问题排查，建议保存 最小长度：2 最大长度：64 |
|
result |
TextDetectionResult object |
调用成功时表示调用结果。 调用失败时无此字段。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
suggestion |
String |
审核结果是否通过。 block：包含敏感信息，不通过 pass：不包含敏感信息，通过 review：需要人工复检 |
|
label |
String |
检测结果的标签。支持label列表如下：
|
|
details |
Array of TextDetectionResultDetail objects |
检测详情。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
suggestion |
String |
审核结果是否通过。 block：包含敏感信息，不通过 pass：不包含敏感信息，通过 review：需要人工复检 |
|
label |
String |
检测结果的标签。 支持label列表如下：
|
|
confidence |
Float |
置信度，取值范围 0-1，值越大，可信度越高。 |
|
segments |
Array of Segment objects |
命中的风险片段信息，如果命中了语义算法模型，则会返回一个空的列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
segment |
String |
命中的风险片段。 |
|
glossary_name |
String |
命中的自定义词库名称。 命中自定义词库时，才会返回当前字段。 |
|
position |
Array of integers |
命中的风险片段在文本中的位置，起始位置从0开始。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 |
|
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
- 识别文本内容是否有敏感内容，事件类型为评论，命中的自定义词库名称为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 |
失败响应示例。 |
错误码
请参见错误码。
