功能描述
Describe Auditing Text Job 接口用于查询指定的文本审核任务。
请求
请求示例
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>
<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>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</PornInfo>
<AdsInfo>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</AdsInfo>
<IllegalInfo>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</IllegalInfo>
<AbuseInfo>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</AbuseInfo>
</Section>
</Section>
<StartByte></StartByte>
<PornInfo>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</PornInfo>
<AdsInfo>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</AdsInfo>
<IllegalInfo>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</IllegalInfo>
<AbuseInfo>
<Code></Code>
<HitFlag></HitFlag>
<Score></Score>
<Keywords></Keywords>
</AbuseInfo>
</Section>
</JobsDetail>
<NonExistJobIds></NonExistJobIds>
</Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
JobsDetail | Response | 任务的详细信息 | Container |
NonExistJobIds | Response | 查询的 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 |
Object | Response.JobsDetail | 审核的对象名称 | String |
SectionCount | Response.JobsDetail | 文本审核会将文本进行分段送审,每10000个 utf8 编码字符分一段,该参数表示分段的数量 | String |
Result | Response.JobsDetail | 供参考的识别结果,0确认正常,1确认敏感,2疑似敏感 | String |
PornInfo | Response.JobsDetail | 涉黄信息,包含审核的结果信息 | Container |
AdsInfo | Response.JobsDetail | 广告引导信息,包含审核的结果信息 | Container |
IllegalInfo | Response.JobsDetail | 违法信息,包含审核的结果信息 | Container |
AbuseInfo | Response.JobsDetail | 谩骂信息,包含审核的结果信息 | Container |
Section | Response.JobsDetail | 具体文本分片的审核结果信息,只返回带有违规结果的分片 | Container |
Container 节点 PornInfo,AdsInfo 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
HitFlag | Response.JobsDetail.*Info | 是否命中该审核分类,0表示未命中,1表示命中,2表示疑似 | String |
Count | Response.JobsDetail.*Info | 命中该审核分类的分片数 | String |
Container 节点 Section 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
StartByte | Response.JobsDetail.Section | 文本分片开始的字节 | String |
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 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
---|---|---|---|
Code | Response.JobsDetail.Section.*Info | 错误码,0为正确,其他数字对应相应错误 | String |
HitFlag | Response.JobsDetail.Section.*Info | 是否命中该审核分类,0表示未命中,1表示命中,2表示疑似 | String |
Score | Response.JobsDetail.Section.*Info | 该分片中审核的结果分数 | String |
Keywords | Response.JobsDetail.Section.*Info | 违规的关键词 | 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>
<Code>Success</Code>
<Message></Message>
<JobId>st78925397b9de11eba532525400946f76</JobId>
<State>Success</State>
<CreationTime>2021-05-21T10:44:32+08:00</CreationTime>
<Object>test.txt</Object>
<SectionCount>1</SectionCount>
<Result>2</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>
<PornInfo>
<Code>0</Code>
<HitFlag>1</HitFlag>
<Score>0</Score>
<Keywords></Keywords>
</PornInfo>
<AdsInfo>
<Code>0</Code>
<HitFlag>1</HitFlag>
<Score>0</Score>
<Keywords></Keywords>
</AdsInfo>
<IllegalInfo>
<Code>0</Code>
<HitFlag>1</HitFlag>
<Score>0</Score>
<Keywords></Keywords>
</IllegalInfo>
<AbuseInfo>
<Code>0</Code>
<HitFlag>1</HitFlag>
<Score>0</Score>
<Keywords></Keywords>
</AbuseInfo>
</Section>
</JobsDetail>
</Response>