图像内容审核_内容审核 Moderation_API参考_API_图像审核_华为云

(1)

内容审核 API 参考

文档版本 01

发布日期 2022-02-21

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

华为技术有限公司

地址：深圳市龙岗区坂田华为总部办公楼邮编：518129

网址：

https://www.huawei.com

客户服务邮箱：

[email protected]

客户服务电话：4008302118

(3)

1 ^{使用前必读}

1.1 概述

内容审核（Content Moderation），是基于图像、文本、音频、视频的检测技术，可自动检测涉黄、广告、涉政涉暴、涉政敏感人物等内容，对用户上传的图片、文字、

音频、视频进行内容审核，并且可识别照片是否清晰及对表单图片扭曲校正，以满足上传要求，帮助客户降低业务违规风险。

内容审核以开放API（Application Programming Interface，应用程序编程接口）的方式提供给用户，用户通过调用API获取推理结果，帮助用户自动采集关键数据，打造智能化业务系统，提升业务效率。

您可以使用本文档提供的内容审核服务API的描述、语法、参数说明及样例等内容，进行相关操作，所支持的全部操作请参见API概览。

1.2 调用说明

内容审核提供了REST（Representational State Transfer）风格API，支持您通过 HTTPS请求调用，调用方法请参见如何调用API。

同时内容审核还提供多种编程语言的SDK供您使用，SDK的使用方法请参见内容审核 SDK。

1.3 终端节点

终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和

终端节点中查询所有服务的终端节点。

内容审核的终端节点如表1-1所示，请您根据业务需要选择对应区域的终端节点。

表1-1 内容审核的终端节点

区域名称区域终端节点（Endpoint）

(6)

区域名称区域终端节点（Endpoint）

华北-北京四 cn-north-4 moderation.cn-north-4.myhuaweicloud.com 华东-上海一 cn-east-3 moderation.cn-east-3.myhuaweicloud.com 中国-香港 ap-southeast-1 moderation.ap-

southeast-1.myhuaweicloud.com 亚太-新加坡 ap-southeast-3 moderation.ap-

southeast-3.myhuaweicloud.com

1.4 约束与限制

更详细的限制请参见具体API的说明和产品介绍使用限制。

1.5 基本概念

● 账号

用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户

由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。

● 区域（Region）

指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。

● 可用区（Availability Zone）

一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

(7)

2 ^{API 概览}

内容审核服务所提供的API为自研API，包括文本审核、图像审核、扭曲校正（不再推

广）、清晰度检测（不再推广）。通过使用内容审核服务的自研API，您可以使用内容

审核服务的接口功能。

文本审核

表2-1 文本审核接口说明

API 说明

文本内容审核

分析并识别用户上传的文本内容是否有敏感内容（如色

情、政治等），并将识别结果返回给用户。

图像审核

表2-2 图像审核接口说明

API 说明

图像内容审核

分析并识别用户上传的图像内容是否有敏感内容（如涉

及政治人物、涉政暴恐元素、涉黄内容等），并将识别结果返回给用户。

扭曲校正

表2-3 扭曲校正接口说明

API 说明

扭曲校正

可识别拍摄的企业表单等原始图片是否扭曲，并进行扭

曲的校正。

(8)

清晰度检测

表2-4 清晰度检测接口说明

API 说明

清晰度检测

可识别拍摄的企业表单等原始图片是清晰还是模糊，并

基于此构建图片审核系统。

(9)

3 ^{如何调用 API}

3.1 申请服务

正式使用服务之前，必须先申请开通服务，下面是相关服务申请的步骤。

说明

● 申请服务前，必须先申请华为云账号，并完成实名认证。

● 用户第一次使用内容审核的具体服务时，需要先申请开通该服务。服务只需要开通一次即可，后面使用时无需再申请。

步骤1 登录华为云产品页，单击右上角的“控制台”，进入“管理控制台”界面。

步骤2 单击“服务列表”，选择“人工智能 > 内容审核”，进入“内容审核”界面。

步骤3 在内容审核管理控制台“服务列表”或“服务管理”页面申请开通服务。

步骤4 以在“服务管理”页面开通服务为例，在“未开通服务”下的“商用服务”和“公测服务”中选择要使用的服务，如果要使用公测服务转到步骤5，否则转到步骤6。

步骤5 单击“申请公测”，进行服务公测申请。

说明

当前是人工审批，一般需要等待1~2天，如遇节假日顺延。

步骤6 单击“开通服务”。

步骤7 完成服务“申请公测”/“开通服务”之后，即完成该服务的开通操作。

----结束

3.2 构造请求

本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token接口说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

您还可以通过这个视频教程了解如何构造请求调用API：https://

(10)

请求 URI

请求URI由如下部分组成。

{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

表3-1 URI 中的参数说明

参数描述

URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。

Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的 Endpoint不同，您可以从终端节点中获取。

例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn- north-1.myhuaweicloud.com”。

resource-

path 资源路径，也即API访问路径。

从具体API的URI模块获取，例如“获取用户Token”API的resource- path为“/v3/auth/tokens”。

query-

string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如

“limit=10”，表示查询不超过10条数据。

例如，您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI 部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

图3-1 URI 示意图

说明

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。

这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分

(11)

表3-2 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，如删除对象等。

HEAD 请求服务器资源头部。

PATCH 请求服务器更新资源的部分内容。当资源不存在的时候，

PATCH可能会去创建一个新的资源。

在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

如下公共消息头需要添加到请求中。

表3-3 公共请求消息头

名称描述是否必选示例

X-Sdk-

Date 请求的发生时间，格式为 (YYYYMMDD'T'HHMMS S'Z')。

取值为当前系统的GMT时间。

否

使用AK/SK认证时必选。

20150907T101459Z

Authoriza

tion 签名认证信息。

该值来源于请求签名结果。

否

SDK-HMAC-SHA256 Credential=ZIRRKMTWPT QFQI1WKNKB/

20150907//ec2/

sdk_request,

SignedHeaders=content- type;host;x-sdk-date, Signature=55741b610f3c 9fa3ae40b5a8021ebf7eb c2a28a603fc62d25cb3bfe 6608e1994

(12)

名称描述是否必选示例 Host 请求的服务器信息，从服

务API的URL中获取。值为 hostname[:port]。端口缺省时使用默认的端口，

https的默认端口为443。

否

code.test.com or

code.test.com:443

Content-

Type 发送的实体的MIME类型。

是 application/json

Content-

Length 请求body长度，单位为

Byte。 POST/PUT请求必填。GET不能包含。

3495

X-Project-

Id project id，用于不同 project取token。

如果是DeC的请求或者多 project的请求则必须传入 project id。

否 e9993fc787d94b6c886cb aa340f9c0f4

X-Auth-

Token 用户Token。否

使用Token认证时必选。

-

说明

公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK 认证的详细说明请参见API签名指南。

其它header属性，请遵照https协议。

例如，对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体

请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

(13)

说明

scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

{ "auth": { "identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope": { "project": {

"name": "xxxxxx"

} } } }

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x- subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

3.3 认证鉴权

调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。

● Token认证：通过Token认证通用请求。

● AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。

Token 认证

说明

Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。

Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。

Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的 Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择 project，如下所示。

(14)

"identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domainname"

} } } }, "scope": { "project": {

"name": "xxxxxxxx"

} } } }

获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，

其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token:

ABCDEFJ....”加到请求消息头即可，如下所示。

GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json

X-Auth-Token: ABCDEFJ....

您还可以通过这个视频教程了解如何使用Token认证：https://

bbs.huaweicloud.com/videos/101333 。

AK/SK 认证

说明

AK/SK签名认证、Token认证方式仅支持消息体大小12M以内的请求使用。

AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。

● AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥 ID和私有访问密钥一起使用，对请求进行加密签名。

● SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，

可标识发送方，并防止请求被修改。

使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。

须知

签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

(15)

3.4 返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

表3-4 响应消息头

名称描述

Content-Length 响应消息体的字节长度，单位为Byte。

Date 系统响应的时间。

Content-Type 响应消息体的MIME类型。

对于获取用户Token接口，返回如图3-2所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

图3-2 获取用户 Token 响应消息头

(16)

响应消息体

响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{ "token": {

"expires_at": "2019-02-13T06:52:13.855000Z", "methods": [

"password"

],

"catalog": [ {

"endpoints": [ {

"region_id": "cn-north-1", ...

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{ "error_msg": "The format of message is error", "error_code": "AS.0001"

}

其中，“error_code”表示错误码，“error_msg”表示错误描述信息。

(17)

4 ^API

4.1 文本审核

4.1.1 文本内容审核

功能介绍

分析并识别用户上传的文本内容是否有敏感内容（如色情、政治等），并将识别结果返回给用户。

前提条件

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

内容审核快速入门。

● 文本内容审核默认API调用最大并发为50，如需调整更高并发限制请联系华为专业工程师为您服务。

● 您可以配置自定义词库，来过滤和检测指定文本内容。自定义词库的创建和使用请参见配置自定义词库。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/moderation/text

表4-1 路径参数

参数是否必选参数类型描述

project_id 是 String 用户的project_id

登陆华为云 -> 用户中心 -> 我的凭证 ->

(18)

请求参数

表4-2 请求 Header 参数

X-Auth-

Token 是 String 用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表4-3 请求 Body 参数

categorie

s 否 Array of

strings 检测场景。

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

● 默认场景为：

– politics：涉政 – porn：涉黄 – ad：广告 – abuse：辱骂

– contraband：违禁品 – flood：灌水

● 用户自定义场景为：自定义黑名单词库。

说明

● 自定义黑名单词库的名称指定给 categories就是设置自定义的场景，自定义词库的创建和使用请参见配置自定义词库。

● flood场景不支持使用自定义白名单词库。

items 是 Array of TextDetecti onItemsRe q objects

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

(19)

表4-4 TextDetectionItemsReq

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

最小长度：1 最大长度：5000

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

响应参数

状态码： 200

表4-5 响应 Body 参数

参数参数类型描述

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

调用失败时无此字段。

表4-6 result

suggestio

n String 检测结果是否通过。

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

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

review：需要人工复查。

detail Object 返回的相关检测结果详细信息：

● politics：涉政敏感词列表。

● porn：涉黄敏感词列表。

● ad：广告敏感词列表。

● abuse：辱骂敏感词列表。

● contraband：违禁品敏感词列表。

● flood：灌水文本（指无意义的文本词语常见于贴吧等灌水帖子）。

说明

● 灌水文本最多显示200个字符。

● 每个场景的返回结果的详细信息是指命中词，不是返回

(20)

状态码： 400

error_cod

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

调用成功时无此字段。

error_ms

g String 调用失败时的错误信息。

fail_categ

ory String 当包含多个场景时，失败场景。

请求示例

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

{ "categories" : [ "ad", "politics", "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."

}

(21)

状态码

状态码描述

200 成功响应示例。

400 失败响应示例。

错误码

请参见错误码。

4.2 图像审核

4.2.1 图像内容审核

功能介绍

分析并识别用户上传的图像内容是否有敏感内容（如涉及政治人物、暴恐元素、涉黄内容等），并将识别结果返回给用户。

调试

URI

POST /v2/{project_id}/moderation/image

表4-8 路径参数

登陆华为云 -> 用户中心 -> 我的凭证 -

> api凭证即可查看对应区域的项目 ID。

(22)

请求参数

X-Auth-

Token 是 String 用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

url 否 String 与image二选一

图片的URL路径，目前支持：

● 公网HTTP/HTTPS URL

● 华为云OBS提供的URL，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权。详请参见配置OBS访问权限。

说明

接口响应时间依赖图片的下载时间，如果图片下载时间过长，会返回接口调用失败。请保证被检测图片所在的存储服务稳定可靠，

建议您使用华为云OBS存储。

image 否 String 与url二选一

图片文件Base64编码字符串。要求 base64编码后大小不超过10M。

政治人物检测人脸部分不小于50*50像素。

支持JPG/PNG/BMP格式。

moderation

_rule 否 String 图像审核规则名称，默认使用default规则。

说明

审核规则的创建和使用请参见配置审核规则。

(23)

参数是否必选参数类型描述 categories 否 Array of

strings 检测场景：

● politics：是否涉及政治人物的检测。

● terrorism：是否包含涉政暴恐元素的检测。

● porn：是否包含涉黄内容元素的检测。

● ad：是否包含广告图文的检测。

● all：包含politics、terrorism和porn 三种场景的检测。

可通过配置上述场景，来完对应场景元素的检测。

为空或无此参数表示politics和

terrorism都检测，但不包含porn场景。

说明

每个检测场景的检测次数会分类统计。

枚举值：

● politics

● terrorism

● porn

● ad

● all ad_glossarie

s 否 Array of

strings 检测场景: ad场景自定义词库，配置方式同文本审核自定义词库配置方式 ad_categori

es 否 Array of

strings 图文审核检测场景。当categories包含 ad时，该参数生效。

当前支持的场景有系统场景和用户自定义场景：

● 系统场景为：

– qr_code：二维码 – politics：涉政 – porn：涉黄 – ad：广告 – abuse：辱骂

– contraband：违禁品

说明

自定义词库的创建和使用请参见配置自定义词库。

(24)

threshold 否 Float 结果过滤门限，只有置信度不低于此门限的结果才会呈现在detail的列表中，

取值范围 0-1，当未设置此值时各个检测场景会使用各自的默认值。

politics检测场景的默认值为0.95。

terrorism检测场景的默认值为0。

ad检测场景的默认值为0。

无特殊需求直接不传此参数或像示例中一样值设为空字符串即可。

说明

● 如果检测场景中的最高置信度也未达到 threshold，则结果列表为空；反之 threshold过小，则会使结果列表中内容过多。

● threshold参数不支持porn场景筛选。

● threshold参数不会对响应中的 suggestion产生影响。

最小值：0 最大值：1

响应参数

状态码： 200

result ImageDetec tionResultB ody object

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

表4-12 ImageDetectionResultBody

detail ImageDetec tionResultD etail object

针对选定的每个检测场景列出结果列表，politics为涉政敏感的人物检测结果，terrorism为涉政暴恐检测结果，porn为涉黄检测结果。如果检测场景中的最高置信度也未达到threshold则结果列表为空。

(25)

suggestion String 审核结果是否通过。

block：包含敏感信息，不通过 pass：不包含敏感信息，通过 review：需要人工复检

说明当同时检测多个场景时，suggestion的值以最可能包含敏感信息的场景为准。即任一场景出现了block则总的

suggestion为block，所有场景都pass时suggestion为 pass，这两种情况之外则一定有场景需要review，此时 suggestion为review。

category_su

ggestions Map<String,

String> 具体每个场景的检测结果。

表4-13 ImageDetectionResultDetail

politics Array of politics objects

涉政敏感人物检测结果。

porn Array of ImageDetecti onResultSim pleDetail objects

涉黄检测结果。

terrorism Array of ImageDetecti onResultSim pleDetail objects

涉政、暴恐检测结果。

ad Array of ImageDetecti onResultAdD etail objects

广告检测结果。

表4-14 politics

confidence Float 置信度，取值范围 0-1。

(26)

label String 对应的政治人物信息。

face_detail face_detail

object 涉政场景中的人物面部信息。

表4-15 face_detail

h Integer 人脸区域高度。

w Integer 人脸区域宽度。

x Integer 人脸区域左上角到y轴距离。

y Integer 人脸区域左上角到x轴距离。

表4-16 ImageDetectionResultSimpleDetail

(27)

label String 每个检测结果的标签化说明：

terrorism：label为对应的涉政暴恐元素信息。

● 涉政暴恐场景当前支持label列表如下：

– normal：正常 – knife：刀 – gun：枪 – fire：火灾 – bloody ：血腥

– terrorist：暴恐组织及标志 – fascist：法西斯组织及标志 – cult：邪教组织及标志

– negative_politics ：涉政负面组织及标志 – negative_political_events：涉政负面事件

及标志

– special_characters ：特殊文字 – kidnap：绑架

– corpse：尸体 – riot：暴乱事件 – parade ：游行示威

– sensitive_landmarks：敏感地标 – military_weapon：军事武器 – army：警察部队

– positive_politics：涉政正面组织及标志 – crowd：人群聚集

porn：label为对应的涉黄分类（涉黄、性感等）

信息。

● 鉴黄场景当前支持label列表如下：

– normal：正常 – porn：色情 – sexy：性感

ad：label为对应的广告识别结果信息。

● 广告场景当前支持label列表如下：

– normal：正常 – ad：广告

● 图文审核场景当前支持label列表如下：

– normal：正常 – qr_code：二维码 – politics：涉政

(28)

– ad：广告 – abuse：辱骂

– contraband：违禁品 – 其他自定义黑库名称

表4-17 ImageDetectionResultAdDetail

label String ad：label为对应的广告识别结果信息

– normal：正常 – qr_code：二维码 – politics：涉政 – porn：涉黄 – ad：广告 – abuse：辱骂

– contraband：违禁品 – 其他自定义黑库名称 hit_contexts Array of

strings 图文审核场景命中的文本列表。

状态码： 400

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

error_msg String 调用失败时的错误信息。

(29)

请求示例

● 方式一：使用图片的BASE64编码

POST https://{endpoint}/v2/{project_id}/moderation/image { "categories" : [ "politics", "terrorism" ],

"moderation_rule" : "default", "url" : "",

"image" : "/9j/4AAQSkZJRgABAgEASABIAAD/

4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAA...", "threshold" : ""

}

● 方式二：使用图片的url

POST https://{endpoint}/v2/{project_id}/moderation/image { "categories" : [ "politics", "terrorism" ],

"moderation_rule" : "default",

"url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName", "image" : "",

"threshold" : ""

}

响应示例

{ "result" : { "detail" : { "politics" : [ {

"confidence" : 0.8915528178215026, "face_detail" : {

"h" : 130, "w" : 103, "x" : 80, "y" : 109 },

"label" : "xxx"

}, {

"h" : 131, "w" : 203, "x" : 423, "y" : 109 },

"label" : "yyy"

} ],

"terrorism" : [ {

"confidence" : 0.7315528178215026, "label" : "xxx"

}, {

"confidence" : 0.26844718217849733, "label" : "yyy"

} ] },

"suggestion" : "block", "category_suggestions" : { "politics" : "block", "terrorism" : "review"

}

(30)

"error_msg" : "The image format is not supported."

}

状态码

状态码描述

错误码

4.2.2 图像内容审核（批量）

功能介绍

分析并识别用户上传的图像内容是否有敏感内容（如涉及政治人物、暴恐元素、涉黄内容等），并将识别结果返回给用户。

调试

URI

POST /v2/{project_id}/moderation/image/batch

表4-19 路径参数

登陆华为云 -> 用户中心 -> 我的凭证 -> api凭证即可查看对应区域的项目ID。

(31)

请求参数

X-Auth-Token 是 String 用户Token。

通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。

urls 是 Array of

strings 图片的URL路径，目前支持：

● 华为云OBS提供的URL，使用OBS数据需要进行授权。

包括对服务授权、临时授权、匿名公开授权。详请参见配置OBS访问权限。

说明图片的URL路径列表最多支持10个 URL地址。接口响应时间依赖图片的下载时间，如果图片下载时间过长，会返回接口调用失败。请保证被审核图片所在的存储服务稳定可靠，建议您使用华为云OBS存储。

(32)

strings 检测场景：

● terrorism：是否包含涉政暴恐元素的检测。

● ad：是否包含广告图文的检测。

● all：包含politics、terrorism 和porn三种场景的检测。

可通过配置上述场景，来完对应场景元素的检测。

为空或无此参数表示politics和 terrorism都检测，但不包含 porn场景。

说明

每个检测场景的检测次数会分类统计。

枚举值：

● politics

● terrorism

● porn

● ad

● all

(33)

threshold 否 Double 结果过滤门限，只有置信度不低于此门限的结果才会呈现在 detail的列表中，取值范围 0-1，当未设置此值时各个检测场景会使用各自的默认值。

politics检测场景的默认值为 0.95。

terrorism检测场景的默认值为 0。

ad检测场景的默认值为0。

无特殊需求直接不传此参数或像示例中一样值设为空字符串即可。

说明

● 如果检测场景中的最高置信度也未达到threshold，则结果列表为空；反之threshold过小，

则会使结果列表中内容过多。

● threshold参数不支持porn场景筛选。

● threshold参数不会对响应中的 suggestion产生影响。

最小值：0 最大值：1

响应参数

状态码： 200

result Array of ImageBatch ModerationR esultBody objects

调用成功时表示调用结果。调用失败时无此字段。

表4-23 ImageBatchModerationResultBody

url String 图片的URL路径。

(34)

suggestion String 请参见suggestion字段说明。

detail ImageDetecti onResultDeta il object

请参见detail字段说明。

category_sug

gestions Object 具体每个场景的检测结果。

face_detail face_detail 涉政场景中的人物面部信息。

(35)

(36)

及标志

porn：label为对应的涉黄分类（涉黄、性感等）

信息。

– normal：正常 – porn：色情 – sexy：性感

ad：label为对应的广告识别结果信息。

– normal：正常

(37)

状态码： 400

fail_category String 当包含多个场景时，失败场景。

(38)

请求示例

图像内容检测（批量）

POST https://{endpoint}/v2/{project_id}/moderation/image/batch

{ "urls" : [ "https://bucketname.obs.myhwclouds.com/ObjectName1", "https://

bucketname.obs.myhwclouds.com/ObjectName2" ], "categories" : [ "politics", "terrorism", "porn" ], "threshold" : ""

}

响应示例

{ "result" : [ {

"url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName1", "suggestion" : "block",

"detail" : { "politics" : [ {

"h" : 131, "w" : 203, "x" : 423, "y" : 109 },

"label" : "yyy"

} ],

"terrorism" : [ {

"confidence" : 0.26844718217849733, "label" : "yyy"

} ], "porn" : [ { "confidence" : 1, "label" : "normal"

}, {

"confidence" : 1, "label" : "porn"

}, {

"confidence" : 0, "label" : "sexy"

} ] } } ] }

}

(39)

状态码

状态码描述

错误码

4.2.3 图像内容审核（异步批量）

4.2.3.1 任务提交

功能介绍

提交批量图像内容审核任务，返回任务标识，任务标识可用于查询任务结果。此接口为异步接口，相对于批量接口，支持更大图片列表批次。

调试

URI

POST /v2/{project_id}/moderation/image/batch/jobs

表4-30 路径参数

(40)

请求参数

urls 是 Array of

strings 图片的URL路径，目前支持：

● 华为云OBS提供的URL，使用OBS数据需要进行授权。

包括对服务授权、临时授权、匿名公开授权。详请参见配置OBS访问权限。

说明图片的URL路径列表最多支持500 个URL地址。接口响应时间依赖图片的下载时间，如果图片下载时间过长，会返回接口调用失败。请保证被检测图片所在的存储服务稳定可靠，建议您使用华为云OBS存储。

(41)

● terrorism：是否包含涉政敏感人物、涉政暴恐元素的检测。

● ad：是否包含广告的检测。

● all：包含politics、terrorism 和porn三种场景的检测。

可通过配置上述场景，来完成对应场景元素的检测。

为空或无此参数表示politics和 terrorism都检测，但不包含 porn场景。

枚举值：

● politics

● porn

● terrorism

响应参数

状态码： 200

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

表4-34 result

job_id String 批量图像内容审核的任务标识，用于后续的结果查询。

(42)

请求示例

图像内容检测（异步批量）- 任务提交

POST https://{endpoint}/v2/{project_id}/moderation/image/batch

{ "urls" : [ "https://bucketname.obs.myhwclouds.com/ObjectName1", "https://

bucketname.obs.myhwclouds.com/ObjectName2" ], "categories" : [ "politics", "terrorism", "porn" ] }

响应示例

{ "result" : {

"job_id" : "44d93b70-db01-4f96-a618-2a79c964c4b2"

}}

}

状态码

状态码描述

(43)

4.2.3.2 处理结果查询

功能介绍

查询批量图片内容审核任务的结果，任务成功执行时会返回每张图片的详细审核结果，单张图片的失败，不会导致任务失败。

说明

任务最长保留时间为30分钟，过期后会被清理掉。建议在任务提交后，每30s进行一次周期查询。

调试

URI

GET /v2/{project_id}/moderation/image/batch

表4-36 路径参数

表4-37 Query 参数

job_id 是 String 任务标识。

请求参数

(44)

响应参数

状态码： 200

result CheckResult ResultBody object

表4-40 CheckResultResultBody

job_id String 任务标识。

status String 任务状态。

created：已创建 running：正在处理 finish：已完成 failed：处理失败

create_time String 任务创建的时间。例如：2018-01-02T15:03:04Z update_time String 任务最近更新的时间。例如：

2018-01-02T15:03:04Z items Array of

CheckResultI temsBody objects

图片内容检测的结果列表。

表4-41 CheckResultItemsBody

url String 图片的URL路径。

suggestion String 请参见suggestion字段说明。

detail ImageDetecti onResultDeta il object

请参见detail字段说明。

category_sug Map<String,St 具体每个场景的检测结果。

(45)

face_detail face_detail

object 涉政场景中的人物面部信息。

(46)

(47)

及标志

– porn：label为对应的涉黄分类（涉黄、性感等）信息。

– normal：正常 – porn：色情

– sexy：性感 ad：label为对应的广告识别结果信息

– normal：正常 – qr_code：二维码 – politics：涉政 – porn：涉黄

(48)

状态码： 400

(49)

请求示例

GET https://{endpoint}/v2/{project_id}/moderation/image/batch?job_id={job_id}

响应示例

{ "result" : {

"job_id" : "44d93b70-db01-4f96-a618-2a79c964c4b2", "status" : "finish",

"create_time" : "2018-01-02T15:03:04Z", "update_time" : "2018-01-02T15:03:04Z", "items" : [ {

"url" : "https://obs-test-llg.obs.myhuaweicloud.com/terrorism", "suggestion" : "pass",

"detail" : { "politics" : [ ], "terrorism" : [ { "confidence" : 0, "label" : "fire"

}, {

"confidence" : 0.0268, "label" : "normal"

} ] } }, {

"url" : "https://obs-test-llg.obs.myhuaweicloud.com/clarity-detect", "suggestion" : "pass",

"detail" : { "politics" : [ ], "terrorism" : [ { "confidence" : 0, "label" : "knife"

}, {

"confidence" : 0, "label" : "terrorist"

}, {

"confidence" : 0.3086, "label" : "bloody"

}, {

} ] } } ] }}

}

状态码

状态码描述

(50)

状态码描述

错误码

4.2.3.3 任务列表查询

功能介绍

查询批量图像内容审核任务列表，可通过指定任务状态查询来对任务列表进行过滤。

调试

URI

GET /v2/{project_id}/moderation/image/batch/jobs

表4-48 路径参数

(51)

表4-49 Query 参数

status 否 String 图像内容审核任务处理状态如

下：

● created 已创建

● running 正在处理

● finish 已完成

● failed 处理失败枚举值：

● created

● running

● finish

● failed

offset 否 Integer 偏移量，默认为0。

limit 否 Integer 指定每一页返回的最大条目数，

默认为符合查询条件的总任务数量。

请求参数

响应参数

状态码： 200

result Array of

CheckTaskJobsI temsBody objects

(52)

表4-52 CheckTaskJobsItemsBody

job_id String 任务标识。

status String 任务状态如下：

● created 已创建

● running 正在处理

● finish 已完成

● failed 处理失败 create_time String 任务创建的时间。例如：

2018-01-02T15:03:04Z。

update_time String 任务最近更新的时间。例如：

2018-01-02T15:03:04Z。

状态码： 400

请求示例

GET https://{endpoint}/v2/{project_id}/moderation/image/batch/jobs?status={status_type}

响应示例

{

(53)

"count" : 1 }

}

状态码

状态码描述

错误码

4.3 短语音内容审核

4.3.1 语音内容审核

功能介绍

分析并识别用户上传的语音内容是否有敏感内容（如色情、政治等），并将识别结果返回给用户。

前提条件

● 在使用语音内容审核之前需要您完成服务申请和认证鉴权.

● 语音内容审核默认API调用最大并发为1，如需调整更高并发限制请联系华为专业工程师为您服务。

调试

URI

POST /v2/{project_id}/moderation/voice

(54)

表4-54 路径参数

project_id 是 String 用户项目id

请求参数

data 否 String 语音文件Base64编码字符串。要求 base64编码后大小不超过4M，语音时长不超过1分钟。

说明参数data和url二选一。

url 否 String 语音的URL路径。

目前支持对服务授权访问华为云上OBS 的URL，华为云上OBS提供的临时授权访问的URL和匿名公开授权的URL。

OBS服务的访问权限设置请参见配置 OBS访问权限。

出于安全的考虑，当前服务不支持从公网上任意URL读取数据。

config 是 config

object 语音文件配置信息 categories 否 Array of

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

● 默认场景为：

– politics：涉政 – porn：涉黄 – ad：广告 – abuse：辱骂

– contraband：违禁品

说明

● 自定义黑名单词库的名称指定给 categories就是设置自定义的场景，

(55)

表4-56 config

format 是 String 支持的语音格式。

枚举值：

● pcm16k16bit

● pcm8k16bit

● ulaw16k8bit

● ulaw8k8bit

● alaw16k8bit

● alaw8k8bit

● mp3

● aac

● wav

● amr

● amrwb

property 是 String 所使用的模型特征串。通常是“语种_采样率_领域”的形式。采样率需要与音频采样率保持一致。当前支持如下模型特征串： chinese_8k_common和 chinese_16k_common。

枚举值：

● chinese_8k_common

● chinese_16k_common

响应参数

状态码： 200

result result object 调用成功时表示调用结果。调用失败时无此字段。

suggestion String 检测结果是否通过。

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

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

● review：需要人工复查。

(56)

表4-58 result

detail detail object 审核结果列表，text为语音转文本后审核结果，

audio为音频审核结果。

表4-59 detail

text Object 返回的语音转文本后审核结果详细信息：

●politics：涉政敏感词列表。

●porn：涉黄敏感词列表。

●ad：广告敏感词列表。

●abuse：辱骂敏感词列表。

●contraband：违禁品敏感词列表。

audio audio object 返回的音频审核结果列表，porn为涉黄场景审核结果，当前仅支持porn场景。

表4-60 audio

porn Array of PornModerat ionResultDet ail objects

涉黄场景审核结果。

表4-61 PornModerationResultDetail

confidence Number 置信度，取值范围0-1。

label String 当前支持label列表如下：

● normal：正常

● porn：色情

状态码： 400

(57)

error_code String 错误码。

最小长度：8 最大长度：36 error_msg String 错误描述。

最小长度：2 最大长度：512

请求示例

使用语音URL

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

{ "url" : "https://BucketName.obs.myhuaweicloud.com/audio/test.aac", "config" : {

"format" : "aac",

"property" : "chinese_8k_common"

}, "categories" : [ "politics", "ad" ] }

响应示例

{ "result" : { "detail" : { "audio" : { "porn" : [ {

}, {

"confidence" : 2.5532800318472937E-9, "label" : "porn"

} ] }, "text" : {

"contraband" : [ "亚砷酸" ] }

},

"suggestion" : "pass"

}}

(58)

状态码

状态码描述

200 Demo Information 400 Error response

错误码

(59)

5 ^{API（废弃）}

5.1 扭曲校正

功能介绍

仅支持识别拍摄的企业表单原始图片是否扭曲，并进行扭曲的校正。

前提条件

扭曲校正默认API调用最大并发为3，如需调整更高并发限制请联系华为专业工程师为您服务。

URI

URI格式

POST /v1.0/moderation/image/distortion-correct

请求消息

请求参数请参见表5-1。

表5-1 请求参数说明

名称是否必选类型说明

image 与url二选一

String 图片文件Base64编码字符串。要求base64编码后大小不超过10M，支持JPG/PNG/BMP格式。

(60)

名称是否必选类型说明 url 与image

二选一 String 图片的URL路径，目前支持：

● 华为云OBS提供的URL，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权。详请参见配置OBS访问权限。

说明

接口响应时间依赖图片的下载时间，如果图片下载时间过长，会返回接口调用失败。请保证被审核图片所在的存储服务稳定可靠，建议您使用华为云OBS存储。

correcti

on 否 Boolea

n 是否要进行图片扭曲校正。

● true：校正。默认校正。

● false：不进行校正。

响应消息

响应参数请参见表5-2。

表5-2 响应参数说明

名称类型说明

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

distortion Boolean 识别结果是否扭曲。

● true：扭曲。

● false：正常。

data String 校正后的图片。格式为图片文件的Base64编码字符串。

如果图片正常，无需校正，或者输出参数中指明无需校正，则此处返回为空串。

图像内容审核_内容审核 Moderation_API参考_API_图像审核_华为云

内容审核 API 参考

华为技术有限公司

https://www.huawei.com

[email protected]

目 录

1 使用前必读... 1

1.1 概述... 1

1.2 调用说明...1

1.3 终端节点...1

1.4 约束与限制... 2

1.5 基本概念...2

2 API 概览... 3

3 如何调用 API...5

3.1 申请服务...5

3.2 构造请求...5

3.3 认证鉴权...9

3.4 返回结果... 11

4 API...13

4.1 文本审核... 13

4.1.1 文本内容审核... 13

4.2 图像审核... 17

4.2.1 图像内容审核... 17

4.2.2 图像内容审核（批量）...26

4.2.3 图像内容审核（异步批量）... 35

4.2.3.1 任务提交... 35

4.2.3.2 处理结果查询...39

4.2.3.3 任务列表查询...46

4.3 短语音内容审核... 49

4.3.1 语音内容审核... 49

5 API（废弃）... 55

5.1 扭曲校正... 55

5.2 清晰度检测... 58

6 应用示例...61

6.1 文本内容审核...61

6.2 图像内容审核...63

A.1 状态码... 66

A.2 错误码... 68

A.3 配置 OBS 访问权限...75

A.4 配置自定义词库... 75

A.5 获取项目 ID 和名称... 78

A.6 获取帐号名和帐号 ID... 79

A.7 配置审核规则... 80

1 使用前必读

1.1 概述

1.2 调用说明

1.3 终端节点

终端节点中查询所有服务的终端节点。

1.4 约束与限制

1.5 基本概念

2 API 概览

广）、清晰度检测（不再推广）。通过使用内容审核服务的自研API，您可以使用内容

文本审核

文本内容审核

图像审核

图像内容审核

扭曲校正

扭曲校正

清晰度检测

清晰度检测

3 如何调用 API

3.1 申请服务

3.2 构造请求

请求 URI

请求消息头

请求消息体

3.3 认证鉴权

Token 认证

AK/SK 认证

3.4 返回结果

状态码

响应消息头

响应消息体

4 API

4.1 文本审核

4.1.1 文本内容审核

功能介绍

前提条件

内容审核快速入门。

调试

目录

1 ^{使用前必读}

2 ^{API 概览}

3 ^{如何调用 API}

4 ^API