API 文档

查询网页审核任务结果

最近更新时间:2021-12-21 11:33:45

功能描述

本接口用于主动查询指定的网页审核任务结果。网页审核功能为异步任务方式,您可以通过提交网页审核任务审核您的网页文件,然后通过查询网页审核任务接口查询审核结果。

请求

请求示例

GET /webpage/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></JobId>
    <State>Success</State>
    <Code>Success</Code>
    <Message>Success</Message>
    <Suggestion>1</Suggestion>
    <CreationTime></CreationTime>
    <Url></Url>
    <PageCount>3</PageCount>
    <Labels>
      <PornInfo>
        <HitFlag>1</HitFlag>
        <Score>96</Score>
      </PornInfo>
    </Labels>
    <ImageResults>
      <Results>
        <Url></Url>
        <Text></Text>
        <PornInfo>
          <HitFlag></HitFlag>
          <SubLabel></SubLabel>
          <Score></Score>
          <OcrResults>
            <Text></Text>
            <Keywords></Keywords>
            <Location>
              <X></X>
              <Y></Y>
              <Width></Width>
              <Height></Height>
              <Rotate></Rotate>
            </Location>
          </OcrResults>
        </PornInfo>
      </Results>
    </ImageResults>
    <TextResults>
      <Results>
        <Text></Text>
        <PornInfo>
          <HitFlag></HitFlag>
          <Score></Score>
          <Keywords></Keywords>
        </PornInfo>
      </Results>
    </TextResults>
  </JobsDetail>
</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
JobId Response.JobsDetail 网页审核任务的 ID。 String
State Response.JobsDetail 网页审核任务的状态,值为 Submitted(已提交审核)、Success(审核成功)、Failed(审核失败)、Auditing(审核中)其中一个。 String
CreationTime Response.JobsDetail 网页审核任务的创建时间。 String
Url Response.JobsDetail 本次审核的文件链接,创建任务使用 Url 时返回。 String
Labels Response.JobsDetail 该字段用于返回检测结果中所对应的恶意标签集合。 Container
Suggestion Response.JobsDetail 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。
有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)
Integer
Label Response.JobsDetail 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告。 String
PageCount Response.JobsDetail 网页审核会将网页中的图片链接和文本分开送审,该字段表示送审的链接和文本总数量。 Integer
ImageResults Response.JobsDetail 网页内图片的审核结果。 Container
TextResults Response.JobsDetail 网页内文字的审核结果。 Container
HighlightHtml Response.JobsDetail 对违规关键字高亮处理的Html网页内容,请求内容指定ReturnHighlightHtml时返回。 String

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 节点 ImageResults 的内容:

节点名称(关键字) 父节点 描述 类型
Results Response.JobsDetail.ImageResults 网页内图片审核的结果,审核多张图片将返回多个Results Container Array

Container 节点 Results 的内容:

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

Container 节点 PornInfo,AdsInfo的内容:

节点名称(关键字) 父节点 描述 类型
HitFlag Response.JobsDetail.ImageResults.Results.*Info 是否命中该审核分类,0表示未命中,1表示命中,2表示疑似。 Integer
Score Response.JobsDetail.ImageResults.Results.*Info 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息。
例如:色情 99,则表明该内容非常有可能属于色情内容。
Integer
SubLabel Response.JobsDetail.ImageResults.Results.*Info 该字段表示审核命中的具体子标签,例如:Porn 下的 SexBehavior 子标签。
注意:该字段可能返回空,表示未命中具体的子标签。
String
OcrResults Response.JobsDetail.ImageResults.Results.*Info 该字段表示 OCR 文本识别的详细检测结果,包括文本坐标信息、文本识别结果等信息,有相关违规内容时返回。 Container Array

Container 节点 OcrResults 的内容:

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

ObjectResults 的具体内容如下:

节点名称(关键字) 父节点 描述 类型
Name Response.JobsDetail.ImageResults.Results.*Info.ObjectResults 该标签用于返回所识别出的实体名称,例如人名。 String
Location Response.JobsDetail.ImageResults.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 节点 TextResults 的内容:

节点名称(关键字) 父节点 描述 类型
Results Response.JobsDetail.TextResults 网页内文本审核的结果,审核多条文本将返回多个Results Container Array

Container 节点 Results 的内容:

节点名称(关键字) 父节点 描述 类型
Text Response.JobsDetail.TextResults.Results 网页文本将进行分段送审,每10000个 utf8 编码字符分一段,该参数返回本段文本内容。 String
Label Response.JobsDetail.TextResults.Results 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告。 String
Suggestion Response.JobsDetail.TextResults.Results 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。
有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)
Integer
PornInfo Response.JobsDetail.TextResults.Results 审核场景为涉黄的审核结果信息。 Container
AdsInfo Response.JobsDetail.TextResults.Results 审核场景为广告引导的审核结果信息。 Container

Container 节点 PornInfo,AdsInfo 的内容:

节点名称(关键字) 父节点 描述 类型
HitFlag Response.JobsDetail.TextResults.Results.*Info 是否命中该审核分类,0表示未命中,1表示命中,2表示疑似。 Integer
Score Response.JobsDetail.TextResults.Results.*Info 该字段表示审核结果命中审核信息的置信度,取值范围:0(置信度最低)-100(置信度最高 ),越高代表该内容越有可能属于当前返回审核信息。 Integer
Keywords Response.JobsDetail.TextResults.Results.*Info 在当前审核场景下命中的关键词,多关键词以

,

分隔。
String

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

实际案例

请求

GET /webpage/auditing/vab1ca9fc8a3ed11ea834c525400863904 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: Tue, 09 Nov 2021 01:56:09 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
  <JobsDetail>
    <CreationTime>2021-11-09T10:03:32+08:00</CreationTime>
    <HighlightHtml>xxxxx</HighlightHtml>
    <ImageResults>
      <Results>
        <AdsInfo>
          <HitFlag>0</HitFlag>
          <Score>0</Score>
          <SubLabel/>
        </AdsInfo>
        <Label>Porn</Label>
        <PornInfo>
          <HitFlag>1</HitFlag>
          <Score>99</Score>
          <SubLabel>ACGPorn</SubLabel>
        </PornInfo>
        <Suggestion>1</Suggestion>
        <Text>xxxxxxx</Text>
        <Url>xxxxxx</Url>
      </Results>
    </ImageResults>
    <JobId>sh3dba0967410111eca1f1525400276c76</JobId>
    <Label>Porn</Label>
    <Labels>
      <AdsInfo>
        <HitFlag>0</HitFlag>
        <Score>0</Score>
      </AdsInfo>
      <PornInfo>
        <HitFlag>1</HitFlag>
        <Score>99</Score>
      </PornInfo>
    </Labels>
    <PageCount>2</PageCount>
    <State>Success</State>
    <Suggestion>1</Suggestion>
    <TextResults>
      <Results>
        <AdsInfo>
          <HitFlag>0</HitFlag>
          <Keywords/>
          <Score>0</Score>
        </AdsInfo>
        <Label>Porn</Label>
        <PornInfo>
          <HitFlag>1</HitFlag>
          <Keywords>xxxx</Keywords>
          <Score>98</Score>
        </PornInfo>
        <Suggestion>1</Suggestion>
        <Text>xxxx</Text>
      </Results>
    </TextResults>
    <Url>https://xxxx</Url>
  </JobsDetail>
  <RequestId>NjE4OWQ3MDNfY****RfMzQ0OF9h</RequestId>
</Response>

目录