文档首页/ 内容审核 Moderation/ API参考/ API/ 文档内容审核/ 创建文档内容审核作业
更新时间：2024-05-09 GMT+08:00
查看PDF
分享

创建文档内容审核作业

功能介绍

创建文档内容审核作业，创建成功会将作业ID返回给用户.

调试

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

URI

POST /v3/{project_id}/moderation/document/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

data

是

data object

文档数据输入。

event_type

是

String

事件类型，可选值如下：

  • default：默认事件
  • liberal_arts_education：文科教育
  • sciences_education：理科教育
  • news：新闻
  • forums：论坛
  • novels：小说

image_categories

否

Array of strings

文档中图片需要检测的风险类型，不传或为空时表示不审核图片内容， 可取值如下：

  • porn：涉黄检测
  • terrorism: 暴恐检测
  • bad_scene: 不良场景检测
  • image_text: 图文检测

text_categories

否

Array of strings

文档中文本需要检测的风险类型，不传或为空时表示不审核文本内容， 可取值为default，表示检测暴恐、违禁、色情、辱骂、广告等违规内容。

video_image_categories

否

Array of strings

网页视频中图片需要检测的风险类型，不传或为空时表示不审核网页视频内容， 可取值如下：

  • porn：涉黄检测
  • terrorism: 暴恐检测
  • bad_scene: 不良场景检测
  • image_text: 图文检测

audio_categories

否

Array of strings

网页视频中音频需要检测的风险类型，不传或为空时表示不审核网页视频中音频的内容， 可取值如下：

  • porn：涉黄检测
  • ad：广告检测
  • abuse：辱骂检测
  • moan：娇喘检测

callback

否

String

该字段非空时，检测结果会回调通知您的URL。该字段为空时，您需要定时轮询获取检测结果。

说明：
  1. 您的callback接口需要支持POST方法；
  2. 回调数据格式，请参考查询文档内容审核作业的响应示例；
  3. 您的服务端callback接口收到内容安全发送的结果后，如果在响应超时时间3秒内返回的HTTP状态码为200，则表示接收成功。其他HTTP状态码或响应时间大于3秒后返回状态码均视为接收失败，接收失败时，内容安全将重复发送多次检测结果。

seed

否

String

用于回调通知时校验请求是由华为云内容安全服务发起，您可以自定义。值为随机字符串，由英文字母、数字、下划线组成，不超过64个字符。

说明：

当seed非空时，headers中将包含X-Auth-Signature字段，字段的值使用HmacSHA256算法生成，待加密字符串由create_time、job_id、request_id、seed按照顺序拼接而成，密钥为seed。
表4 data

参数

是否必选

参数类型

描述

url

是

String

文档url。目前支持：公网HTTP/HTTPS URL。

format

是

String

文档格式。可选值： docx/pdf/doc/xls/xlsx/ppt/pptx/pps/ppsx/ xltx/xltm/xlsb/xlsm/txt/csv/epub/webpage，如果format与文档实际格式不一致，则返回结果会报参数错误。

frame_interval

否

Integer

当需要审核网页视频时，视频截帧频率间隔，单位为秒，取值范围为1~60s，如果不传递默认5s截帧一次。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的唯一标识，用于问题排查，建议保存。

job_id

String

作业唯一标识。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

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

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

创建文档内容审核作业。

POST https://{endpoint}/v3/{project_id}/moderation/document/jobs

{
  "data" : {
    "url" : "xxx",
    "format" : "pdf"
  },
  "event_type" : "default",
  "image_categories" : [ "politics", "porn", "image_text", "terrorism" ],
  "text_categories" : [ "default" ],
  "callback" : "http://xxx"
}

响应示例

状态码： 200

成功响应示例

{
  "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48",
  "request_id" : "07490f57ac5e034c077ab25b5f9e1da5"
}

状态码： 400

失败响应示例

{
  "error_code" : "AIS.0401",
  "error_msg" : "The input parameter event_type is incorrect."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。
父主题： 文档内容审核

相关文档