更新时间:2024-08-05 GMT+08:00
分享

查询文档审核作业结果

功能介绍

查询文档审核结果。

调试

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

URI

GET /v3/{project_id}/moderation/document/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

job_id

String

创建作业成功时,接口返回的job_id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

作业id。

status

String

作业状态,可取值有:

  • running:正在运行
  • succeeded:运行成功
  • failed:运行失败

result

result object

作业审核结果,当作业状态为succeeded时存在。

request_params

request_params object

作业创建参数。

create_time

String

作业创建时间。

update_time

String

作业更新时间。

request_id

String

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

表4 result

参数

参数类型

描述

suggestion

String

文档审核结果是否通过。

  • block:包含敏感信息,不通过
  • review:需要人工复检
  • pass:不包含敏感信息,通过

details

Array of details objects

审核详情。

表5 details

参数

参数类型

描述

suggestion

String

当前内容片段的处置建议:

  • block:包含敏感信息,不通过
  • review:需要人工复检

type

String

当前内容片段的类型,可取值有:

  • text:文本
  • image:图像
  • video:视频

label

String

当前内容片段的风险类型,可取值为:

  • terrorism:暴恐
  • porn:色情
  • sexy:性感
  • abuse:辱骂
  • ad:广告
  • qr_code:二维码
  • watermark:水印
  • meaningless:无意义
  • ban:违禁
  • bad_scene:不良场景
  • moan:娇喘

index

Integer

当前处理的片段索引。

text

String

当前内容片段中的文本内容,仅当type为text时存在。

start_position

Integer

当前文本内容片段在输入中的起始位置,仅当type为text时存在。

end_position

Integer

当前文本内容片段在输入中的结束位置,仅当type为text时存在。

image_url

String

网页图片url,仅当type为image且文档格式为webpage时存在。

segments

Array of segments objects

命中的风险片段信息列表,仅在有命中敏感词时才返回。

video_image_details

Array of DocumentVideoImageDetail objects

网页视频中截帧部分审核详情。

audio_details

Array of DocumentAudioDetail objects

网页视频中音频部分审核详情。

表6 segments

参数

参数类型

描述

segment

String

命中的敏感词。

表7 DocumentVideoImageDetail

参数

参数类型

描述

time

Float

截帧在视频文件中的时间,单位为秒。

suggestion

String

截帧审核结果是否通过。

  • block:包含敏感信息,不通过
  • review:需要人工复检

ocr_text

String

截帧检测出的文本。

label

String

识别的详细标签。

segments

Array of segments objects

命中的文本风险片段列表。

表8 segments

参数

参数类型

描述

segment

String

命中的风险片段。

表9 DocumentAudioDetail

参数

参数类型

描述

start_time

Float

音频片段开始时间。

end_time

Float

音频片段结束时间。

suggestion

String

音频片段审核处理建议。

  • block:包含敏感信息,不通过
  • review:需要人工复检

audio_text

String

音频片段文本内容。

label

String

音频片段标签。

segments

Array of segments objects

命中的风险片段信息列表。

表10 segments

参数

参数类型

描述

segment

String

命中的风险片段。

表11 request_params

参数

参数类型

描述

data

data object

创建作业时传的data参数。

event_type

String

创建作业时传的event_type参数。

image_categories

Array of strings

创建作业时传的image_categories参数。

text_categories

Array of strings

创建作业时传的text_categories参数。

video_image_categories

Array of strings

创建作业时传的video_image_categories参数。

audio_categories

Array of strings

创建作业时传的audio_categories参数。

callback

String

创建作业时传的callback参数。

表12 data

参数

参数类型

描述

url

String

创建作业时传的url参数。目前支持:公网HTTP/HTTPS URL。

format

String

创建作业时传的format参数。

frame_interval

Integer

创建作业时传的frame_interval参数。

状态码: 400

表13 响应Body参数

参数

参数类型

描述

error_code

String

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

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

查询文档审核作业

GET https://{endpoint}/v3/{project_id}/moderation/document/jobs/{job_id}

响应示例

状态码: 200

成功响应示例

{
  "job_id" : "xxxxxx",
  "status" : "succeeded",
  "result" : {
    "suggestion" : "block",
    "details" : [ {
      "start_position" : 1,
      "end_position" : 10,
      "suggestion" : "block",
      "index" : 12,
      "label" : "porn",
      "type" : "text",
      "text" : "xxxxxxxxx",
      "segments" : [ {
        "segment" : "xxx"
      }, {
        "segment" : "xxx"
      }, {
        "segment" : "xxx"
      } ]
    } ]
  },
  "request_params" : {
    "data" : {
      "url" : "https://xxxxx",
      "format" : "pdf"
    },
    "event_type" : "default",
    "image_categories" : [ "politics", "porn", "image_text", "terrorism" ],
    "text_categories" : [ "default" ],
    "callback" : "http://xxx"
  }
}

状态码: 400

失败响应示例

{
  "error_code" : "AIS.0030",
  "error_msg" : "Job not found"
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码

相关文档