简介
本文档提供关于文本审核的相关的 API 概览以及 SDK 示例代码。
创建任务
PutTextAuditingJob 接口用来提交一个文本审核任务。当审核文本内容时，响应体直接返回审核结果，当审核文本对象时，返回任务摘要，您可以通过主动设置回调地址接收审核信息，也可以通过 JobId 进行查询。
方法原型
func (s *CIService) PutTextAuditingJob(ctx context.Context, opt *PutTextAuditingJobOptions) (*PutTextAuditingJobResult, *Response, error)
请求示例
// 将 examplebucket-1250000000 和 COS_REGION修改为真实的信息// CI 任务需要提供CIURLbu, _ := 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{},}res, _, err := c.CI.PutTextAuditingJob(context.Background(), opt)
参数说明
type PutTextAuditingJobOptions struct {InputObject stringInputUrl stringInputContent stringInputDataId stringInputUserInfo *UserExtraInfoConf *TextAuditingJobConf}type UserExtraInfo struct {TokenId stringNickname stringDeviceId stringAppId stringRoom stringIP stringType string}type TextAuditingJobConf struct {Callback stringCallbackVersion stringBizType string}
参数名称 | 参数描述 | 类型 | 是否必填 |
InputObject | 当前 COS 存储桶中的文本文件名称，例如在目录 test 中的文件 test.txt，则文件名称为 test/test.txt，文本文件仅支持 UTF8 编码和 GBK 编码的内容，且文件大小不得超过1MB。Object， Url 和 Content 只能选择其中一种。 | String | 否 |
InputContent | 当传入的内容为纯文本信息，需要先经过 base64 编码，文本编码前的原文长度不能超过10000个 utf8 编码字符。若超出长度限制，接口将会报错。Object， Url 和 Content 只能选择其中一种。 | String | 否 |
InputUrl | 文本文件的链接地址，例如 http://examplebucket-1250000000.cos.ap-shanghai.myqcloud.com/test.txt。Object， Url 和 Content 只能选择其中一种。 | String | 否 |
InputDataId | 文本标识，该字段在结果中返回原始内容，长度限制为512字节。 | String | 否 |
InputUserInfo | 用户业务字段。 | Object | 否 |
Conf | 审核规则配置。 | Struct | 是 |
BizType | String | 否 | |
Callback | 审核结果可以回调形式发送至您的回调地址，支持以 http:// 或者 https:// 开头的地址，例如：http://www.callback.com。当Input使用Content时，该参数不生效，结果会直接返回。 | String | 否 |
CallbackVersion | 回调内容的结构，有效值：Simple（回调内容包含基本信息）、Detail（回调内容包含详细信息）。默认为Simple。 | String | 否 |
结果说明
查询任务
GetTextAuditingJob 接口用来查询指定的文本审核任务。您可以根据文本审核任务的 JobId 来查询文本审核结果。
方法原型
func (s *CIService) GetTextAuditingJob(ctx context.Context, jobid string) (*GetTextAuditingJobResult, *Response, error)
请求示例
// 将 examplebucket-1250000000 和 COS_REGION修改为真实的信息// CI 任务需要提供CIURLbu, _ := 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)
参数说明
参数名称 | 参数描述 | 类型 |
jobId | 任务 ID。 | String |
