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