tencent cloud

All product documents
Cloud Infinite
DocumentationCloud InfiniteSDK DocumentationPython SDKContent ModerationFile Moderation
File Moderation
Download PDF
Last updated: 2024-03-01 14:57:12
File Moderation
Last updated: 2024-03-01 14:57:12
Download PDF

Overview

This document describes how to use the content moderation feature provided by Cloud Infinite (CI). CI fully integrates the processing capabilities with the COS SDK.
Note:
To use the content moderation service, you need to have the permission to use CI:
For root accounts, click here for role authorization.
For sub-accounts, see Authorizing Sub-Accounts to Access CI Services.
This document provides an overview of APIs and SDK code samples for file moderation.
Note:
COS Python SDK v5.1.9.10 or later is required. Earlier versions may contain bugs and need to be upgraded to the latest version when being used.
API
Description
Submits a file moderation job.
Queries the result of a specified file moderation job.

Submitting a File Moderation Job

Feature description

This API is used to submit a file moderation job. The file moderation feature is async. You can submit a job to moderate your files, and then use the API for querying file moderation job result to query the moderation results.

Sample code

    """Test the CI's API for moderating file content"""
    # Create a COS client
    # Recognize a file in COS
    response = client.ci_auditing_document_submit(
        Bucket=bucket_name,
        DetectType=CiDetectType.PORN | CiDetectType.ADS,
        Url='https://www.test.com/sss.docx',
        Type='docx',
    )
    print response

Parameter description

The ci_auditing_document_submit function is called. Specific request parameters are as follows:
Parameter
Description
Type
Required
Bucket
Bucket name.
String
Yes
Key
Object name, such as picture.jpg.
String
No
DetectType
Moderation type. Valid values: CiDetectType.PORN (pornography), CiDetectType.ADS (advertising). You can select multiple types. For example, CiDetectType.PORN | CiDetectType.ADS indicates to moderate the file for pornographic and advertising information. If you need more moderation scenes, use the BizType parameter.
enum
Yes
Url
A file URL that is not in COS can be directly used for moderation.
String
No
Type
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
Callback
Callback address, which must start with http:// or https://.
String
No
BizType
Unique identifier of the moderation policy. You can configure the scenes you want to moderate on the moderation policy page in the console, such as pornographic, adverting, and illegal information. For configuration guidelines, see Setting Public Moderation Policy. You can get BizType in the console. If BizType is specified, the moderation request will perform moderation based on the scenes configured in the moderation policy. If BizType is not specified, the default moderation policy will be used automatically.
String
No
UserInfo
Business field. For details on parameters that can be passed in, see the UserInfo field in Submitting File Moderation Job.
Dict
No
DataId
This field will return the original content in the moderation result, which can contain up to 512 bytes. You can use this field to uniquely identify the data to be moderated in your business.
String
No

Response parameters

Calling the ci_auditing_document_submit function will convert the XML returned in the API into a dict value. For specific response parameters, see Submitting File Moderation Job.

Querying File Moderation Job Result

Feature description

This API is used to query the result of a specified file moderation job. The file moderation feature is async. You can submit a job to moderate your files, and then use the API for querying file moderation job result to query the moderation results.

Sample code

    """Test the CI's API for querying moderation job result"""
    # Create a COS client
    # Query the moderation result
    response = client.ci_auditing_document_query(
        Bucket='bucket',
        JobID='v11122zxxxazzz'
    )
    print response

Parameter description

The ci_auditing_document_query function is called. Specific request parameters are as follows:
Parameter
Description
Type
Required
Bucket
Bucket name.
String
Yes
JobID
Moderation job ID.
String
Yes

Response parameters

Calling the ci_auditing_document_query function will convert the XML returned in the API into a dict value. For specific response parameters, see Querying File Moderation Job Result.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon