API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

功能描述

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

说明:

文档审核任务结果保存时效为3个月,您可通过本接口查询近3个月的审核结果。

推荐使用 SDK

数据万象 SDK 提供了完整的 Demo、自动集成、计算签名等能力。您可通过 SDK 方便快捷地调用接口。点此查看 SDK 文档

请求

请求示例

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>
      <DataId></DataId>
      <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>
    <RequestId></RequestId>
</Response>

具体的数据内容如下:

节点名称(关键字) 父节点 描述 类型
Response 文档审核的全部信息。 Container

Container 节点 Response 的内容:

节点名称(关键字) 父节点 描述 类型
JobsDetail Response 文档审核任务的详细信息。 Container
RequestId Response 每次请求发送时,服务端将会自动为请求生成一个 ID,遇到问题时,该 ID 能更快地协助定位问题。 String

Container 节点 JobsDetail 的内容:

节点名称(关键字) 父节点 描述 类型
Code Response.JobsDetail 错误码,只有 State 为 Failed 时返回,详情请查看 错误码列表 String
Message Response.JobsDetail 错误描述,只有 State 为 Failed 时返回。 String
DataId Response.JobsDetail 该字段在审核结果中会返回原始内容,长度限制为512字节。您可以使用该字段对待审核的数据进行唯一业务标识。 String
JobId Response.JobsDetail 文档审核任务的 ID。 String
State Response.JobsDetail 任务的状态,值为 Submitted(已提交审核)、Success(审核成功)、Failed(审核失败)、Auditing(审核中)其中一个。 String
Suggestion Response.JobsDetail 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 Integer
Label Response.JobsDetail 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告,以及其他不安全或不适宜的类型。 String
CreationTime Response.JobsDetail 任务的创建时间。 String
Object Response.JobsDetail 审核的文件为存储在 COS 中的文件时,该字段表示本次审核的文件名称。 String
Url Response.JobsDetail 审核的文件链接,创建任务使用 Url 时返回。 String
PageCount Response.JobsDetail 文档审核会将文档转换为图片进行审核,该字段表示转换的图片总数量。 Integer
Labels Response.JobsDetail 该字段用于返回命中的审核场景及对应的结果。 Container
PageSegment Response.JobsDetail 文档转换为图片后,具体每张图片的审核结果信息。 Container
UserInfo Response.JobsDetail 用户业务字段。创建任务时未设置 UserInfo 则无此字段。 Container
ListInfo 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:疑似为当前场景的违规内容。 Integer
Score Response.JobsDetail.Labels.*Info 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息。例如:色情 99,表明该内容非常有可能属于色情内容。 Integer

Container 节点 PageSegment 的内容:

节点名称(关键字) 父节点 描述 类型
Results Response.JobsDetail.PageSegment 文档转换为图片后,每张图片的详细审核结果信息。 Container Array

Container 节点 Results 的内容:

节点名称(关键字) 父节点 描述 类型
Url Response.JobsDetail.PageSegment.Results 文档转换成图片后,您可以通过该地址查看该图片内容,地址格式为标准 URL 格式。
注意:每次查看数据的有效期为2小时,2小时后如还需查看,请重新发起查询请求。
String
Text Response.JobsDetail.PageSegment.Results 该字段用于返回当前图片 OCR 文本识别的检测结果,仅在审核策略开启文本内容检测时返回。 String
PageNumber Response.JobsDetail.PageSegment.Results 该图片的页码,通常是文档的页码。 Integer
SheetNumber Response.JobsDetail.PageSegment.Results 如果审核的为表格文件,该字段表示表格内的 Sheet 页码。 Integer
Label Response.JobsDetail.PageSegment.Results 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。返回值:Normal:正常,Porn:色情,Ads:广告,以及其他不安全或不适宜的类型。 String
Suggestion Response.JobsDetail.PageSegment.Results 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 Integer
PornInfo Response.JobsDetail.PageSegment.Results 审核场景为涉黄的审核结果信息。 Container
AdsInfo Response.JobsDetail.PageSegment.Results 审核场景为广告引导的审核结果信息。 Container

Container 节点 PornInfo,AdsInfo 的内容:

节点名称(关键字) 父节点 描述 类型
HitFlag Response.JobsDetail.PageSegment.Results.*Info 用于返回该审核场景的审核结果,返回值:0:正常1:确认为当前场景的违规内容2:疑似为当前场景的违规内容。 Integer
Category Response.JobsDetail.PageSegment.Results.*Info 表示命中的具体审核类别。例如 Sexy,表示色情标签中的性感类别。该字段可能为空,表示未命中或暂无相关的类别。
注意:该字段可能返回空。
String
SubLabel Response.JobsDetail.PageSegment.Results.*Info 该字段表示审核命中的具体子标签,例如:Porn 下的 SexBehavior 子标签。
注意:该字段可能返回空,表示未命中具体的子标签。
String
Score Response.JobsDetail.PageSegment.Results.*Info 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息。例如:色情 99,表明该内容非常有可能属于色情内容。 Integer
OcrResults Response.JobsDetail.PageSegment.Results.*Info 该字段表示 OCR 文本识别的详细检测结果,包括文本坐标信息、文本识别结果等信息,有相关违规内容时返回。 Container Array
LibResults Response.JobsDetail.PageSegment.Results.*Info 该字段用于返回基于风险库识别的结果。
注意:未命中风险库中样本时,此字段不返回。
Container Array

Container 节点 LibResults 的内容:

节点名称(关键字) 父节点 描述 类型
ImageId Response.JobsDetail.PageSegment.Results.*Info.LibResults 该字段表示命中的风险库中的图片样本 ID。 String
Score Response.JobsDetail.PageSegment.Results.*Info.LibResults 该字段用于返回当前标签下的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表当前的图片越有可能命中库中的样本;如:色情 99,则表明该数据非常有可能命中库中的色情样本。 Integer

Container 节点 OcrResults 的内容:

节点名称(关键字) 父节点 描述 类型
Text Response.JobsDetail.PageSegment.Results.*Info.OcrResults 图片 OCR 文本识别出的具体文本内容。 String
Keywords Response.JobsDetail.PageSegment.Results.*Info.OcrResults 在当前审核场景下命中的关键词。 String Array
Location Response.JobsDetail.PageSegment.Results.*Info.OcrResults 该参数用于返回 OCR 检测框在图片中的位置(左上角 xy 坐标、长宽、旋转角度),以方便快速定位识别文字的相关信息。 Container

ObjectResults 的具体内容如下:

节点名称(关键字) 父节点 描述 类型
Name Response.JobsDetail.PageSegment.Results.*Info.ObjectResults 该标签用于返回所识别出的实体名称,例如人名。 String
Location Response.JobsDetail.PageSegment.Results.*Info.ObjectResults 该参数用于返回检测结果在图片中的位置(左上角 xy 坐标、长宽、旋转角度),以方便快速定位相关信息。 Container

Location 的具体内容如下:

节点名称(关键字) 描述 类型
X 该参数用于返回检测框左上角位置的横坐标(x)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 Float
Y 该参数用于返回检测框左上角位置的纵坐标(y)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。 Float
Height 该参数用于返回检测框的高度(由左上角出发在 y 轴向下延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 Float
Width 该参数用于返回检测框的宽度(由左上角出发在 x 轴向右延伸的长度),结合剩余参数可唯一确定检测框的大小和位置。 Float
Rotate 该参数用于返回检测框的旋转角度,该参数结合 X 和 Y 两个坐标参数可唯一确定检测框的具体位置;取值:0-360角度制),方向为逆时针旋转 Float

Container 节点 UserInfo 的内容:

节点名称(关键字) 描述 类型 是否必选
TokenId 一般用于表示账号信息,长度不超过128字节。 String
Nickname 一般用于表示昵称信息,长度不超过128字节。 String
DeviceId 一般用于表示设备信息,长度不超过128字节。 String
AppId 一般用于表示 App 的唯一标识,长度不超过128字节。 String
Room 一般用于表示房间号信息,长度不超过128字节。 String
IP 一般用于表示 IP 地址信息,长度不超过128字节。 String
Type 一般用于表示业务类型,长度不超过128字节。 String
ReceiveTokenId 一般用于表示接收消息的用户账号,长度不超过128字节。 String
Gender 一般用于表示性别信息,长度不超过128字节。 String
Level 一般用于表示等级信息,长度不超过128字节。 String
Role 一般用于表示角色信息,长度不超过128字节。 String

Container 节点 ListInfo 的内容:

节点名称(关键字) 父节点 描述 类型
ListResults Response.JobsDetail.ListInfo 命中的所有名单结果。 Container Array

Container 节点 ListResults 的内容:

节点名称(关键字) 父节点 描述 类型
ListType Response.JobsDetail.ListInfo.ListResults 命中的名单类型,取值为0(白名单)和1(黑名单)。 Integer
ListName Response.JobsDetail.ListInfo.ListResults 命中的名单名称。 String
Entity Response.JobsDetail.ListInfo.ListResults 命中了名单中的哪条内容。 String

错误码

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

实际案例

请求

GET /document/auditing/stb1ca9fc8a34c525400863904**** HTTP/1.1
Accept: */*
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
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>
      <Suggestion>1</Suggestion>
      <CreationTime>2019-07-07T12:12:12+0800</CreationTime>
      <Url>http://www.test.com/123.doc</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>
    <RequestId>xxxxxxxxxxxxxx</RequestId>
</Response>

目录