tencent cloud

All product documents
Cloud Object Storage
DocumentationCloud Object StorageSDK DocumentationGo SDKContent ModerationText Moderation
Text Moderation
Download PDF
Last updated: 2024-02-02 15:51:37
Text Moderation
Last updated: 2024-02-02 15:51:37
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 text moderation.
API
Description
Submits text moderation job.
Queries the result of specified text moderation job.

Creating Job

This API (PutTextAuditingJob) is used to submit a text moderation job. If the text content is moderated, the response body will directly return the moderation result. If the text object is moderated, the job summary will be returned. You can receive the moderation result by setting the callback address or querying by JobId.

Method prototype

func (s *CIService) PutTextAuditingJob(ctx context.Context, opt *PutTextAuditingJobOptions) (*PutTextAuditingJobResult, *Response, error)

Sample request

// Replace `examplebucket-1250000000` and `COS_REGION` with your actual information
// For CI jobs, you need to provide the CIURL.
bu, _ := url.Parse("https://examplebucket-1250000000.cos.COS_REGION.myqcloud.com")
cu, _ := url.Parse("https://examplebucket-1250000000.ci.COS_REGION.myqcloud.com")
b := &cos.BaseURL{BucketURL: bu, CIURL: cu}
c := cos.NewClient(b, &http.Client{
        Transport: &cos.AuthorizationTransport{
            SecretID:  os.Getenv("SECRETID"),
            SecretKey: os.Getenv("SECRETKEY"),
        }
})
opt := &cos.PutTextAuditingJobOptions{
    InputObject: "test.txt",
    Conf: &cos.TextAuditingJobConf{
        DetectType: "Porn,Ads",
    },
}
res, _, err := c.CI.PutTextAuditingJob(context.Background(), opt)

Parameter description

type PutTextAuditingJobOptions struct {
    InputObject   string
    InputUrl      string
    InputContent  string
    InputDataId   string
    InputUserInfo *UserExtraInfo
    Conf          *TextAuditingJobConf
}
type UserExtraInfo struct {
    TokenId  string
    Nickname string
    DeviceId string
    AppId    string
    Room     string
    IP       string
    Type     string
}
type TextAuditingJobConf struct {
    DetectType      string
    Callback        string
    CallbackVersion string
    BizType         string
}
Parameter
Description
Type
InputObject
Name of the text file stored in the current COS bucket; for example, if the file is test.txt in the test directory, then the filename is test/test.txt. Only text files in UTF-8 and GBK encodings are supported, and the file size cannot exceed 1 MB. Only one parameter among Object, Url, and Content can be selected at a time.
String
InputContent
When the input content is plain text, it needs to be Base64-encoded first. The length of the original text before encoding cannot exceed 10,000 UTF-8 characters. If the length limit is exceeded, the API will report an error. Only one parameter among Object, Url, and Content can be selected at a time.
String
InputUrl
Full URL of the text file, such as http://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/test.txt. Only one parameter among Object, Url, and Content can be selected at a time.
String
InputDataId
Text ID. This field will return the original content in the result, which can contain up to 512 bytes.
String
InputUserInfo
Business field.
Object
Conf
Moderation rule configuration.
Struct
BizType
Moderation policy. If this parameter is not specified, the default policy will be used. The policy can be configured in the console as instructed in Setting Moderation Policy.
String
DetectType
The scene to be moderated. Valid values: Porn (pornography), Ads (advertising), Illegal (law violation), and Abuse (abuse). You can pass in multiple types and separate them by comma, such as Porn,Ads. If you need to moderate more scenes, use the BizType parameter.
String
Callback
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. If Input is Content, this parameter will not take effect, and the result will be returned directly.
String
CallbackVersion
Structure of the callback content. Valid values: Simple (the callback content contains basic information), Detail (the callback content contains detailed information). Default value: Simple.
String

Response description

Calling the PutTextAuditingJob function will parse the XML content returned by the API into the PutTextAuditingJobResult structure. For specific response parameters, see Submitting Text Moderation Job.

Querying Job

This API (GetTextAuditingJob) is used to query the result of the specified text moderation job by JobId.

Method prototype

func (s *CIService) GetTextAuditingJob(ctx context.Context, jobid string) (*GetTextAuditingJobResult, *Response, error)

Sample request

// Replace `examplebucket-1250000000` and `COS_REGION` with your actual information
// For CI jobs, you need to provide the CIURL.
bu, _ := url.Parse("https://examplebucket-1250000000.cos.COS_REGION.myqcloud.com")
cu, _ := url.Parse("https://examplebucket-1250000000.ci.COS_REGION.myqcloud.com")
b := &cos.BaseURL{BucketURL: bu, CIURL: cu}
c := cos.NewClient(b, &http.Client{
    Transport: &cos.AuthorizationTransport{
        SecretID:  os.Getenv("SECRETID"),
        SecretKey: os.Getenv("SECRETKEY"),
    }
})
jobId := "stce25f391a72e11eb99f********"
res, _, err := c.CI.GetTextAuditingJob(context.Background(), jobId)

Parameter description

Parameter
Description
Type
jobId
Job ID.
String

Response description

Calling the GetTextAuditingJob function will parse the XML content returned by the API into the GetTextAuditingJobResult structure. For specific response parameters, see Querying Text 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 avaliable.

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