1、接口描述

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

2、请求方法

POST

3、接口要求

只支持中文图像内容审核。

4、请求URL

广州资源池：https://moderation.cn-gdgz1.ctyun.cn/v3/{project_id}/moderation/image

苏州资源池：https://content-security-analysis.cn-jssz1.ctyun.cn/v3/{project_id}/moderation/image

5、请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例	下级对象
Content-Type	是	String	json 格式	application/json
X-Auth-Token	是	String	用户Token。用于获取操作API的权限
project_id	是	String	项目ID。进入内容审核（经典版）管理控制台，在控制中心页面，鼠标移动至到右上角的用户名上，在下拉列表中单击“我的凭证”，在“我的凭证”页面的项目列表中，可以查看对应区域的项目ID

请求体body参数

参数	是否必填	参数类型	说明	示例	下级对象
event_type	否	String	事件类型。 可选值有：head_image：头像、album：相册、dynamic：动态、article：帖子、comment：评论、room_cover：房间封面、group_message：群聊图片、message：私聊图片、product：商品图片。 说明： 1.群聊图片是指多人聊天的图片。 2.事件类型是服务提前预置的业务场景（部分场景下存在未拦截情况）。
categories	否	Array of strings	检测场景。 可添加的检测场景有：terrorism：暴恐元素的检测、porn：涉黄元素的检测、image_text：广告图文的检测、可通过配置上述场景，来完对应场景元素的检测。 说明：每个检测场景的检测次数会分类统计。		data
image_text_config	否	Object	图文审核黑白词库配置。		image_text_config
url	否	String	图片url，目前支持：公网HTTP/HTTPS URL。

表image_text_config

参数	是否必填	参数类型	说明	示例	下级对象
black_glossary_names	否	Array of strings	检测时使用的自定义黑名单词库列表。 自定义黑名单词库的创建和使用请参见配置自定义词库 V3。
white_glossary_names	否	Array of strings	检测时使用的自定义白名单词库列表。 自定义白名单词库的创建和使用请参见配置自定义词库 V3。

6、请求代码示例

使用图片的URL编码，分析并识别用户上传的图像内容是否有敏感内容，事件类型为头像，检测场景为涉黄，暴恐。

curl --location --globoff 'https://moderation.cn-gdgz1.ctyun.cn/v3/{project_id}/moderation/image' \
--header 'X-Auth-Token: XXXXXX' \
--header 'Content-Type: application/json;charset=utf8' \
--data'{
"event_type" : "head_image",
"url" : "http://club2.autoimg.cn/album/g26/M05/9D/FF/userphotos/2022/08/08/07/500_ChsEdmLwSaKAO3IGAAUykD3c3jA252.jpg",
"categories" : [ "porn", "terrorism" ],
"image_text_config" : {
"black_glossary_names" : [ "test" ]
}
}'

7、返回值说明

请求成功返回响应参数

参数	是否必填	参数类型	说明	示例	下级对象
request_id	是	String	本次请求的唯一标识，用于问题排查，建议保存。最小长度2，最大长度64。	0
result	是	Object	返回内容审核调用结果。	success	result

表result

参数	是否必填	参数类型	说明	示例	下级对象
suggestion	是	String	审核结果是否通过。有三种结果：block：包含敏感信息，不通过、pass：不包含敏感信息，通过、review：需要人工复检。	block
category	是	String	检测结果的标签。支持category列表有：terrorism: 暴恐、porn: 色情、image_text: 图文审核。
details	是	Array of objects	检测详情		details
ocr_text	否	String	图文审核检测出的文本，只有在category参数配置image_text且检测出文本时展示该字段。

表details

参数	是否必填	参数类型	说明	示例	下级对象
suggestion	是	String	审核结果是否通过。有三种结果：block：包含敏感信息，不通过、pass：不包含敏感信息，通过、review：需要人工复检。	block
category	是	String	检测结果的标签。支持category列表有：terrorism: 暴恐、porn: 色情、image_text: 图文审核。
confidence	是	Float	置信度，取值范围 0-1，值越大，可信度越高。
face_location	否	Object	人物位置信息，该数组有四个值，分别代表左上角的坐标和右下角的坐标。 例如：[207,522,340,567]，207代表的是左上角的横坐标，522代表左上角的纵坐标，340代表的是右下角的横坐标，567代表的是右下角的纵坐标。		face_location
qr_location	否	Object	二维码位置信息，该数组有四个值，分别代表左上角的坐标和右下角的坐标。 例如：[207,522,340,567]，207代表的是左上角的横坐标，522代表左上角的纵坐标，340代表的是右下角的横坐标，567代表的是右下角的纵坐标。		qr_location
qr_content	否	String	图片中二维码指向的链接，当请求参数categories中包含image_text时存在。
segments	否	Array of objects	命中的风险片段信息，如果命中了语义算法模型，则会返回一个空的列表。		segment
label	是	String	识别的详细标签。

表face_location

参数	是否必填	参数类型	说明	示例	下级对象
top_left_x	是	Integer	检测出人脸的左上角横坐标。
top_left_y	是	Integer	检测出人脸的左上角纵坐标。
bottom_right_x	是	Integer	检测出人脸的右下角横坐标。
bottom_right_y	是	Integer	检测出人脸的右下角纵坐标。

表qr_location

参数	是否必填	参数类型	说明	示例	下级对象
top_left_x	是	Integer	检测出的二维码左上角横坐标。
top_left_y	是	Integer	检测出的二维码左上角纵坐标。
bottom_right_x	是	Integer	检测出的二维码右下角横坐标。
bottom_right_y	是	Integer	检测出的二维码右下角纵坐标。

表segments

参数	是否必填	参数类型	说明
segment	是	String	命中的风险片段
glossary_name	是	String	命中的自定义词库名称。 命中自定义词库时，才会返回当前字段。

请求失败返回响应参数

参数	是否必填	参数类型	说明	示例	下级对象
error_code	是	String	调用失败时的错误码
error_msg	是	String	调用失败时的错误信息

8、返回值示例

请求成功返回值示例

{
"request_id" : "53f9719c3730d1169e47403d5c8a9473",
"result" : {
"category" : "porn",
"details" : [ {
"category" : "porn",
"confidence" : 0.9934315,
"label" : "sexy_female",
"suggestion" : "review"
}, {
"category" : "porn",
"confidence" : 0.99798274,
"label" : "intimacy",
"suggestion" : "review"
} ],
"suggestion" : "review"
}
}

请求失败返回值示例

{
"error_code" : "AIS.0402",
"error_msg" : "The image format is not supported."
}

获取token示例：

获取用户的AK和SK，作用范围为项目"cn-jssz1"，通过用户名、账号名、密码方式获取Token，用户名、账号名查询路径：进入内容审核（经典版）管理控制台，在控制中心页面，鼠标移动至到右上角的用户名上，在下拉列表中单击“我的凭证”即可查询到。

广州4项目名称：cn-gdgz1

苏州项目名称：cn-jssz1

POST https://iam.cn-jssz1.ctyun.cn/v3/auth/tokens  （所有局点均使用此URL地址）

{
    "auth": {
        "identity": {
            "password": {
                "user": {
                    "name": "IAMUser",          //IAM用户名
                    "password": "IAMPassword",  //IAM用户密码
                    "domain": {
                        "name": "IAMDomain"     //IAM用户所属账号名
                    }
                }
            },
            "methods": [
                "password"
            ]
        },
        "scope": {
            "project": {
                "name": "cn-jssz1"   //根据局点选取相应项目名称
            }
        }
    }
}

状态码为201时：请求成功。

响应Header参数（获取到的Token）：
X-Subject-Token:MIIatAYJKoZIhvcNAQcCoIIapTCCGqECAQExDTALB...

9、状态码

http状态码	描述
200	表示请求成功
400	表示请求失败

10、错误码说明

错误码	错误信息	错误描述
AIS.0004	The request is unauthorized.	服务未开通请开通服务。
AIS.0014	The JSON format of the input data is incorrect.	请检查输入数据的JSON格式。
AIS.0401	The input parameter is incorrect.	请输入正确的参数。
AIS.0011	Lack the request parameter, or the request parameter is empty.	请检查请求body是否缺少必须字段，请参考对应API的请求说明
AIS.0409	Failed to download the.

11、配置自定义词库V3

在使用文本审核/图像审核时，支持用户配置自定义白名单词库和自定义黑名单词库，来帮助客户过滤和检测指定文本内容。

说明：配置自定义词库后，需要用户自行维护。

背景信息

• 配置自定义词库需要先开通文本内容审核服务。
• 配置后可以使用自定义词库。
• 一个账户最多支持创建10个自定义词库。

创建自定义词库

说明：白名单词库的处理建议选择“通过”，黑名单词库的处理建议选择“违规”或“疑似”。

1. 登录内容审核（经典版）服务管理控制台。

2. 在左侧菜单栏中选择“设置>自定义词库“，在“自定义词库 V3”页面单击“创建词库“按钮，会弹出“创建词库“窗口。

3. 在窗口中填写参数后单击“确定“，完成词库的创建。

   • 名称：长度小于50个字符，只能包含字母、数字、中划线和下划线。
   • 处理建议：有“通过、违规、疑似”三种选则，选择“通过”则为白名单词库，选择“违规、疑似”则为黑名单词库。
   • 使用场景：选择需要的使用场景，目前包括（涉政、暴恐、色情、违禁、辱骂、广告、自定义、正常）。
   • 匹配方式：原文匹配。
   • 描述：对此词库的描述。

   说明：词库名称不支持修改。

4. 创建好后，在列表页面单击操作列的“管理”，即可增加关键词。

修改或删除自定义词库

1. 登录内容审核（经典版）服务管理控制台。
2. 在左侧菜单栏中选择“设置>自定义词库“，在“自定义词库 V3”页面。
   • 单击目标词库操作列的“管理“，修改目标关键词内容，单击“确定“完成修改。
   • 单击目标词库操作列的“删除“，删除目标关键词内容，单击“确定“完成删除。

说明：删除操作不可恢复，请谨慎操作。