简介
本文档提供关于文档审核的相关的 API 概览以及 SDK 示例代码。
API | 操作描述 |
用于提交一个文档审核任务 | |
用于查询指定的文档审核任务 |
SDK API 参考
创建任务
功能说明
QCloudPostDocRecognitionRequest 接口用于提交一个文档审核任务。您可以通过主动设置回调地址接收审核信息,也可以通过 JobId 进行查询。
注意
COS iOS SDK 版本需要大于等于 v6.0.9。
请求示例
Objective-C
QCloudPostDocRecognitionRequest * request = [[QCloudPostDocRecognitionRequest alloc]init];// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"request.object = @"exampleobject";// 文件所在地域request.regionName = @"regionName";// 存储桶名称,格式为 BucketName-APPIDrequest.bucket = @"examplebucket-1250000000";request.type = @"doc";// 审核策略,不带审核策略时使用默认策略。具体查看 https://cloud.tencent.com/document/product/460/56345request.bizType = BizType;request.finishBlock = ^(QCloudPostDocRecognitionResult * outputObject, NSError *error) {// outputObject 提交审核反馈信息 包含用于查询的job id,详细字段请查看api文档或者SDK源码// QCloudPostDocRecognitionResult 类;};[[QCloudCOSXMLService defaultCOSXML] PostDocRecognition:request];
说明
Swift
let request = QCloudPostDocRecognitionRequest();// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"request.object = "exampleobject";// 文件所在地域request.regionName = "regionName";// 存储桶名称,格式为 BucketName-APPIDrequest.bucket = "examplebucket-1250000000";// 审核策略,不带审核策略时使用默认策略。具体查看 https://cloud.tencent.com/document/product/460/56345request.bizType = BizType;request.type = "doc";// 审核策略,不带审核策略时使用默认策略。具体查看 https://cloud.tencent.com/document/product/460/56345request.setFinish { outputObject, error in// outputObject 提交审核反馈信息 包含用于查询的job id,详细字段请查看api文档或者SDK源码// QCloudPostDocRecognitionResult 类;}QCloudCOSXMLService.defaultCOSXML().postDocRecognition(request);
说明
查询任务
功能说明
QCloudGetDocRecognitionRequest 接口用于查询指定的文档审核任务。您可以根据文档审核任务的 JobId 来查询文档审核结果。
注意
COS iOS SDK 版本需要大于等于 v6.0.9。
请求示例
Objective-C
QCloudGetDocRecognitionRequest * request = [[QCloudGetDocRecognitionRequest alloc]init];// 存储桶名称,格式为 BucketName-APPIDrequest.bucket = @"examplebucket-1250000000";// 文件所在地域request.regionName = @"regionName";// QCloudPostDocRecognitionRequest接口返回的jobidrequest.jobId = @"jobid";request.finishBlock = ^(QCloudDocRecognitionResult * outputObject, NSError *error) {// outputObject 审核结果 包含用于查询的job id,详细字段请查看api文档或者SDK源码// QCloudDocRecognitionResult 类;};[[QCloudCOSXMLService defaultCOSXML] GetDocRecognition:request];
说明
Swift
let request = QCloudGetDocRecognitionRequest();// 存储桶名称,格式为 BucketName-APPIDrequest.bucket = "examplebucket-1250000000";// 文件所在地域request.regionName = "regionName";// QCloudPostDocRecognitionRequest接口返回的jobidrequest.jobId = "jobid";request.setFinish { outputObject, error in// outputObject 审核结果 包含用于查询的job id,详细字段请查看api文档或者SDK源码// QCloudDocRecognitionResult 类;};QCloudCOSXMLService.defaultCOSXML().getDocRecognition(request);
说明