API 文档

SDK 文档

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

功能描述

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

说明:

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

推荐使用 SDK

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

请求

请求示例

GET /text/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>
    <Code>Success</Code>
    <Message>Success</Message>
    <DataId></DataId>
    <JobId></JobId>
    <State></State>
    <CreationTime></CreationTime>
    <Object></Object>
    <SectionCount></SectionCount>
    <Result>1</Result>
    <PornInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </PornInfo>
    <AdsInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </AdsInfo>
    <IllegalInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </IllegalInfo>
    <AbuseInfo>
        <HitFlag></HitFlag>
        <Count></Count>
    </AbuseInfo>
    </Section>
        <StartByte></StartByte>
        <PornInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </PornInfo>
        <AdsInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AdsInfo>
        <IllegalInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </IllegalInfo>
        <AbuseInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AbuseInfo>
    </Section>
    </Section>
        <StartByte></StartByte>
        <PornInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </PornInfo>
        <AdsInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AdsInfo>
        <IllegalInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </IllegalInfo>
        <AbuseInfo>
            <HitFlag></HitFlag>
            <Score></Score>
            <Keywords></Keywords>
        </AbuseInfo>
    </Section>
  </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
CreationTime Response.JobsDetail 任务的创建时间。 String
Object Response.JobsDetail 审核的对象名称,当创建任务使用 Object 时返回。 String
Content Response.JobsDetail 文本内容的 Base64 编码。当创建任务使用 Content 时返回。 String
SectionCount Response.JobsDetail 文本审核会将文本进行分段送审,每10000个 utf8 编码字符分一段,该参数表示分段的数量。 Integer
Label Response.JobsDetail 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告,以及其他不安全或不适宜的类型。 String
Result Response.JobsDetail 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 Integer
PornInfo Response.JobsDetail 审核场景为涉黄的审核结果信息。 Container
AdsInfo Response.JobsDetail 审核场景为广告引导的审核结果信息。 Container
IllegalInfo Response.JobsDetail 审核场景为违法的审核结果信息。 Container
AbuseInfo Response.JobsDetail 审核场景为谩骂的审核结果信息。 Container
Section Response.JobsDetail 具体文本分片的审核结果信息。 Container Array
UserInfo Response.JobsDetail 用户业务字段。 Container
ListInfo Response.JobsDetail 账号黑白名单结果。 Container

Container 节点 PornInfo,AdsInfo 的内容:

节点名称(关键字) 父节点 描述 类型
HitFlag Response.JobsDetail.*Info Response.JobsDetail.*Info 用于返回该审核场景的审核结果,返回值:0:正常。1:确认为当前场景的违规内容。2:疑似为当前场景的违规内容。
Count Response.JobsDetail.*Info 命中该审核分类的分片数。 Integer

Container 节点 Section 的内容:

节点名称(关键字) 父节点 描述 类型
StartByte Response.JobsDetail.Section 该分片位于文本中的起始位置信息(即10代表第11个utf8文字)。从0开始。 Integer
Label Response.JobsDetail.Section 该字段用于返回检测结果中所对应的优先级最高的恶意标签,表示模型推荐的审核结果,建议您按照业务所需,对不同违规类型与建议值进行处理。 返回值:Normal:正常,Porn:色情,Ads:广告,以及其他不安全或不适宜的类型。 String
Result Response.JobsDetail.Section 该字段表示本次判定的审核结果,您可以根据该结果,进行后续的操作;建议您按照业务所需,对不同的审核结果进行相应处理。有效值:0(审核正常),1 (判定为违规敏感文件),2(疑似敏感,建议人工复核)。 Integer
PornInfo Response.JobsDetail.Section 审核场景为涉黄的审核结果信息。 Container
AdsInfo Response.JobsDetail.Section 审核场景为广告引导的审核结果信息。 Container
IllegalInfo Response.JobsDetail.Section 审核场景为违法的审核结果信息。 Container
AbuseInfo Response.JobsDetail.Section 审核场景为谩骂的审核结果信息。 Container

Container 节点 PornInfo,AdsInfo,IllegalInfo,AbuseInfo 的内容:

节点名称(关键字) 父节点 描述 类型
HitFlag Response.JobsDetail.Section.*Info Response.JobsDetail.*Info 用于返回该审核场景的审核结果,返回值:0:正常。1:确认为当前场景的违规内容。2:疑似为当前场景的违规内容。
Score Response.JobsDetail.Section.*Info 该分片中审核的结果分数,分数越高表示越敏感。 Integer
Keywords Response.JobsDetail.Section.*Info 在当前审核场景下命中的关键词,多关键词以,分隔。 String
LibResults Response.JobsDetail.Section.*Info 该字段用于返回基于风险库识别的结果。
注意:未命中风险库中样本时,此字段不返回。
Container Array
SubLabel Response.JobsDetail.Section.*Info 该字段表示审核命中的具体子标签,例如:Porn 下的 SexBehavior 子标签。
注意:该字段可能返回空,表示未命中具体的子标签。
String

Container 节点 LibResults 的内容:

节点名称(关键字) 父节点 描述 类型
LibType Response.JobsDetail.Section.*Info.LibResults 命中的风险库类型,取值为1(预设黑白库)和2(自定义风险库)。 Integer
LibName Response.JobsDetail.Section.*Info.LibResults 命中的风险库名称。 String
Keywords Response.JobsDetail.Section.*Info.LibResults 命中的库中关键词。该参数可能会有多个返回值,代表命中的多个关键词。 String Array

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 /text/auditing/stb1ca9fc8a3ed11ea834c525400863904 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>st78925397b9de11eba532525400946f76</JobId>
    <State>Success</State>
    <CreationTime>2021-05-21T10:44:32+08:00</CreationTime>
    <Object>test.txt</Object>
    <SectionCount>1</SectionCount>
    <Label>Illegal</Label>
    <Result>1</Result>
    <PornInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </PornInfo>
    <AdsInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </AdsInfo>
    <IllegalInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </IllegalInfo>
    <AbuseInfo>
        <HitFlag>0</HitFlag>
        <Count>0</Count>
    </AbuseInfo>
    <Section>
        <StartByte>0</StartByte>
        <Label>Illegal</Label>
        <Result>1</Result>
        <PornInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </PornInfo>
        <AdsInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </AdsInfo>
        <IllegalInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </IllegalInfo>
        <AbuseInfo>
            <HitFlag>0</HitFlag>
            <Score>0</Score>
            <Keywords></Keywords>
        </AbuseInfo>
    </Section>
  </JobsDetail>
  <RequestId>xxxxxxxxxxxxxx</RequestId>
</Response>

目录