文档审核
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>文档审核>API 文档>查询文档审核任务结果

查询文档审核任务结果

最近更新时间：2024-11-16 14:30:53

我的收藏

本页目录：

功能描述

本接口用于查询指定的文档审核任务结果。

请求

请求示例

GET /document/auditing/<jobId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
说明
Authorization: Auth String（详情请参见 请求签名 文档）。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求无请求体。

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <JobsDetail>
      <JobId>aab1ca9fc8a3ed11ea834c525400863904</JobId>
      <State>Success</State>
      <Code>Success</Code>
      <Message>Success</Message>
      <Suggestion>1</Suggestion>
      <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
      <Url>http://www.test.com/123</Url>
      <PageCount>3</PageCount>
      <Labels>
        <PornInfo>
          <HitFlag>1</HitFlag>
          <Score>96</Score>
        </PornInfo>
      </Labels>
      <PageSegment>
        <Results>
          <Url></Url>
          <Text></Text>
          <PageNumber>1</PageNumber>
          <SheetNumber>1</SheetNumber>
          <PornInfo>
            <HitFlag></HitFlag>
            <SubLabel></SubLabel>
            <Score></Score>
            <OcrResults>
              <Text></Text>
              <Keywords></Keywords>
            </OcrResults>
          </PornInfo>
        </Results>
      </PageSegment>
    </JobsDetail>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
文档审核的全部信息
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
JobsDetail
Response
文档审核任务的详细信息
Container
Container 节点 JobsDetail 的内容：
节点名称（关键字）
父节点
描述
类型
Code
Response.JobsDetail
错误码，只有 State 为 Failed 时有意义
String
Message
Response.JobsDetail
错误描述，只有 State 为 Failed 时有意义
String
JobId
Response.JobsDetail
文档审核任务的 ID
String
State
Response.JobsDetail
任务的状态，值为 Submitted（已提交审核）、Success（审核成功）、Failed（审核失败）、Auditing（审核中）其中一个
String
Suggestion
Response.JobsDetail
该字段表示本次判定的审核结果，您可以根据该结果，进行后续的操作；建议您按照业务所需，对不同的审核结果进行相应处理。
有效值：0（审核正常），1 （判定为违规敏感文件），2（疑似敏感，建议人工复核）
String
CreationTime
Response.JobsDetail
任务的创建时间
String
Url
Response.JobsDetail
审核的文件链接
String
PageCount
Response.JobsDetail
文档审核会将文档转换为图片进行审核，该字段表示转换的图片总数量
String
Labels
Response.JobsDetail
该字段用于返回命中的审核场景及对应的结果
Container
PageSegment
Response.JobsDetail
文档转换为图片后，具体每张图片的审核结果信息，只返回带有违规结果的图片
Container
Container 节点 Labels 的内容：
节点名称（关键字）
父节点
描述
类型
PornInfo
Response.JobsDetail.Labels
涉黄信息，包含审核的结果信息
Container
AdsInfo
Response.JobsDetail.Labels
广告引导信息，包含审核的结果信息
Container
Container 节点 PornInfo，AdsInfo 的内容：
节点名称（关键字）
父节点
描述
类型
HitFlag
Response.JobsDetail.Labels.*Info
是否命中该审核分类，0表示未命中，1表示命中，2表示疑似
String
Score
Response.JobsDetail.Labels.*Info
该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息
例如：色情 99，则表明该内容非常有可能属于色情内容
String
Container 节点 PageSegment 的内容：
节点名称（关键字）
父节点
描述
类型
Results
Response.JobsDetail.PageSegment
文档转换为图片后，每张图片的详细审核结果信息
Container
Container 节点 Results 的内容：
节点名称（关键字）
父节点
描述
类型
Url
Response.JobsDetail.PageSegment.Results
文档转换成图片后，该张图片的 Url
String
Text
Response.JobsDetail.PageSegment.Results
文档审核会使用 OCR 方式进行审核，该字段表示图片 OCR 文本识别出的全部文本内容，识别上限在5000字节内
String
PageNumber
Response.JobsDetail.PageSegment.Results
该图片的页码，通常是文档的页码
String
SheetNumber
Response.JobsDetail.PageSegment.Results
如果审核的为表格文件，该字段表示表格内的 Sheet 页码
String
PornInfo
Response.JobsDetail.PageSegment.Results
涉黄信息，包含审核的结果信息
Container
AdsInfo
Response.JobsDetail.PageSegment.Results
广告引导信息，包含审核的结果信息
Container
Container 节点 PornInfo，AdsInfo 的内容：
节点名称（关键字）
父节点
描述
类型
HitFlag
Response.JobsDetail.PageSegment.Results.*Info
是否命中该审核分类，0表示未命中，1表示命中，2表示疑似
String
SubLabel
Response.JobsDetail.PageSegment.Results.*Info
该字段表示审核命中的具体子标签，例如：Porn 下的 SexBehavior 子标签
注意：该字段可能返回空，表示未命中具体的子标签
String
Score
Response.JobsDetail.PageSegment.Results.*Info
该字段表示审核结果命中审核信息的置信度，取值范围：0（置信度最低）-100（置信度最高 ），越高代表该内容越有可能属于当前返回审核信息
例如：色情 99，则表明该内容非常有可能属于色情内容
String
OcrResults
Response.JobsDetail.PageSegment.Results.*Info
该字段表示 OCR 文本识别的详细检测结果；包括：文本识别结果、命中的关键词等信息
Container
Container 节点 OcrResults 的内容：
节点名称（关键字）
父节点
描述
类型
Text
Response.JobsDetail.PageSegment.Results.*Info.OcrResults
图片 OCR 文本识别出的具体文本内容
String
Keywords
Response.JobsDetail.PageSegment.Results.*Info.OcrResults
在当前审核场景下命中的关键词
String

错误码

此接口遵循统一的错误响应和错误码，详情请参见 错误码 文档。

实际案例

请求

GET /document/auditing/stb1ca9fc8a34c525400863904**** HTTP/1.1
Accept: */*
Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com

响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
    <JobsDetail>
      <JobId>stb1ca9fc8a34c525400863904****</JobId>
      <State>Success</State>
      <Code>Success</Code>
      <Message>Success</Message>
      <Suggestion>1</Suggestion>
      <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
      <Url>http://www.test.com/123</Url>
      <PageCount>3</PageCount>
      <Labels>
        <PornInfo>
          <HitFlag>1</HitFlag>
          <Score>96</Score>
        </PornInfo>
      </Labels>
      <PageSegment>
        <Results>
          <Url>https://examplebucket-1250000000.cos.ap-nanjing.myqcloud.com/audit-1.jpg</Url>
          <Text>哈哈哈，您好</Text>
          <PageNumber>1</PageNumber>
          <PornInfo>
            <HitFlag>0</HitFlag>
            <SubLabel>sex</SubLabel>
            <Score>0</Score>
            <OcrResults>
              <Text>哈哈哈，您好</Text>
              <Keywords>您好</Keywords>
            </OcrResults>
          </PornInfo>
        </Results>
        <Results>
          <Url>https://examplebucket-1250000000.cos.ap-nanjing.myqcloud.com/audit-2.jpg</Url>
          <Text>哈哈哈，您好</Text>
          <PageNumber>1</PageNumber>
          <PornInfo>
            <HitFlag>0</HitFlag>
            <SubLabel>sex</SubLabel>
            <Score>0</Score>
            <OcrResults>
              <Text>哈哈哈，您好</Text>
              <Keywords>您好</Keywords>
            </OcrResults>
          </PornInfo>
        </Results>
      </PageSegment>
    </JobsDetail>
</Response>

中国站
文档活动
message-icon联系我们
目录