API | Description |
Submits file moderation job. | |
Queries the result of specified file moderation job. |
DocumentAuditingResponse createAuditingDocumentJobs(DocumentAuditingRequest request);
//1. Create a job request objectDocumentAuditingRequest request = new DocumentAuditingRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");//2.1.1 Set the object address// request.getInput().setObject("1.txt");//2.1.2 Or, directly set the file addressrequest.getInput().setUrl("https://markjrzhang-1251704708.cos.ap-chongqing.myqcloud.com/%E9%97%AE%E9%A2%98%E6%B1%87%E6%80%BB.pptx");//2.2 Set the moderation type parameterrequest.getConf().setDetectType("all");//3. Call the API to get the job response objectDocumentAuditingResponse response = client.createAuditingDocumentJobs(request);
Request
has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
Input | Request | Content to be moderated. | Container | Yes |
Conf | Request | Moderation rule configuration. | Container | Yes |
Input
has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
Url | Request.Input | Full URL of the file, such as http://www.example.com/doctest.doc . | String | Yes |
Type | Request.Input | File type. If this parameter is not specified, the file extension will be used as the type by default, such as DOC, DOCX, PPT, and PPTX. If the file has no extension, this field must be specified; otherwise, moderation will fail. | String | No |
Conf
has the following sub-nodes:Node Name (Keyword) | Parent Node | Description | Type | Required |
BizType | Request.Conf | Moderation policy. If this parameter is not specified, the default policy will be used. The policy can be configured in the console. For more information, see Setting Moderation Policy. | String | No |
DetectType | Request.Conf | The scene to be moderated, such as Porn (pornography) and Ads (advertising). You can pass in multiple types and separate them by comma, such as Porn,Ads . | String | No |
Callback | Request.Conf | The moderation result can be sent to your callback address in the form of a callback. Addresses starting with http:// or https:// are supported, such as http://www.callback.com . | String | No |
DocumentAuditingResponse
file moderation job result object is returned upon success.CosClientException
or CosServiceException
exception. For more information, see Troubleshooting.DocumentAuditingResponse describeAuditingJob(DocumentAuditingRequest request);
//1. Create a job request objectDocumentAuditingRequest request = new DocumentAuditingRequest();//2. Add request parameters as detailed in the API documentationrequest.setBucketName("examplebucket-1250000000");request.setJobId("sdd5d1cc630fdc11ecb3fa5254009******");//3. Call the API to get the job response objectDocumentAuditingResponse response = client.describeAuditingDocumentJob(request);
Parameter | Description | Type | Required |
bucketName | String | Yes | |
jobId | ID of the job to be queried. | String | Yes |
DocumentAuditingResponse
moderation job result object is returned.CosClientException
or CosServiceException
exception will be reported. For more information, see Troubleshooting.
Was this page helpful?