v20201229

package
v3.0.542+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// A CAM signature/authentication error occurred.
	AUTHFAILURE = "AuthFailure"

	// `DryRun` Operation. It means that the request would have succeeded, but the `DryRun` parameter was used.
	DRYRUNOPERATION = "DryRunOperation"

	// The operation failed.
	FAILEDOPERATION = "FailedOperation"

	// An internal error occurred.
	INTERNALERROR = "InternalError"

	// The parameter is incorrect.
	INVALIDPARAMETER = "InvalidParameter"

	// The parameter value is incorrect.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The quota limit is exceeded.
	LIMITEXCEEDED = "LimitExceeded"

	// The parameter is missing.
	MISSINGPARAMETER = "MissingParameter"

	// The operation was denied.
	OPERATIONDENIED = "OperationDenied"

	// The number of requests exceeds the frequency limit.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// The resource is in use.
	RESOURCEINUSE = "ResourceInUse"

	// The resource is insufficient.
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// The resource is unavailable.
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// The resources have been sold out.
	RESOURCESSOLDOUT = "ResourcesSoldOut"

	// The operation is unauthorized.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	//
	UNAUTHORIZEDOPERATION_UNAUTHORIZED = "UnauthorizedOperation.Unauthorized"

	// The parameter is unknown.
	UNKNOWNPARAMETER = "UnknownParameter"

	// The operation is not supported.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source
const APIVersion = "2020-12-29"

Variables

This section is empty.

Functions

This section is empty.

Types

type AudioResult

type AudioResult struct {
	// This field is used to return whether the moderated content hit the moderation model. Valid values: 0 (**no**), 1 (**yes**).
	// Note: this field may return null, indicating that no valid values can be obtained.
	HitFlag *int64 `json:"HitFlag,omitempty" name:"HitFlag"`

	// This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
	// Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This field is used to return the text information generated by recognizing an audio file with ASR. Audio files of up to **5 hours** can be recognized. If this limit is exceeded, an error will be reported by the API.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Text *string `json:"Text,omitempty" name:"Text"`

	// This field is used to return the URL where audio segments are stored, which is valid for 1 day.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Url *string `json:"Url,omitempty" name:"Url"`

	// This field is used to return the length of an audio file in seconds.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Duration *string `json:"Duration,omitempty" name:"Duration"`

	// This field is used to return the additional information (Extra) in the input parameters. If it is not configured, an empty value will be returned by default.<br>Note: the returned information varies by customer or `Biztype`. If you need to configure this field, submit a ticket or contact the aftersales service for assistance.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Extra *string `json:"Extra,omitempty" name:"Extra"`

	// This field is used to return the detailed moderation result of the text generated by recognizing an audio file with ASR. For the specific result, see the detailed description of the `AudioResultDetailLanguageResult` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	TextResults []*AudioResultDetailTextResult `json:"TextResults,omitempty" name:"TextResults"`

	// This field is used to return the detailed moan detection result of an audio file. For the specific result, see the detailed description of the `AudioResultDetailMoanResult` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	MoanResults []*AudioResultDetailMoanResult `json:"MoanResults,omitempty" name:"MoanResults"`

	// This field is used to return the detailed minor language detection result of an audio. For the specific result, see the detailed description of the `AudioResultDetailLanguageResult` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	LanguageResults []*AudioResultDetailLanguageResult `json:"LanguageResults,omitempty" name:"LanguageResults"`

	// This field is used to return a subtag under the current tag (Lable).
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabel *string `json:"SubLabel,omitempty" name:"SubLabel"`

	// List of recognized category labels
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	RecognitionResults []*RecognitionResult `json:"RecognitionResults,omitempty" name:"RecognitionResults"`
}

type AudioResultDetailLanguageResult

type AudioResultDetailLanguageResult struct {
	// This field is used to return the language information.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This parameter is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the audio is more likely to fall into the category of the current returned language tag;
	// Note: this field may return null, indicating that no valid values can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This parameter is used to return the start time of the segment of an audio file under the corresponding language tag in milliseconds.
	// Note: this field may return null, indicating that no valid values can be obtained.
	StartTime *float64 `json:"StartTime,omitempty" name:"StartTime"`

	// This parameter is used to return the end time of the segment of an audio file under the corresponding language tag in milliseconds.
	// Note: this field may return null, indicating that no valid values can be obtained.
	EndTime *float64 `json:"EndTime,omitempty" name:"EndTime"`

	// *This field is in beta test. Stay tuned*
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabelCode *string `json:"SubLabelCode,omitempty" name:"SubLabelCode"`
}

type AudioResultDetailMoanResult

type AudioResultDetailMoanResult struct {
	// This field is used to return the type of the content to be detected. It is fixed at **Moan** here to call the moan detection feature.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This field is used to return the confidence of moan detection. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the audio is more likely to fall into the category of moan.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This field is used to return the start time of the segment of an audio file under the corresponding moan tag in milliseconds.
	StartTime *float64 `json:"StartTime,omitempty" name:"StartTime"`

	// This field is used to return the end time of the segment of an audio file under the corresponding moan tag in milliseconds.
	EndTime *float64 `json:"EndTime,omitempty" name:"EndTime"`

	// *This field is in beta test. Stay tuned*
	SubLabelCode *string `json:"SubLabelCode,omitempty" name:"SubLabelCode"`

	// This field is used to return a subtag under the current tag (Lable).
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabel *string `json:"SubLabel,omitempty" name:"SubLabel"`
}

type AudioResultDetailTextResult

type AudioResultDetailTextResult struct {
	// This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This field is used to return the keyword information hit by the text content recognized with ASR and indicate the specific cause of content non-compliance (such as "Friend me on WeChat"). This parameter may have multiple returned values representing multiple hit keywords. If the returned value is empty, but `Score` is not empty, the maliciousness tag (Label) that corresponds to the recognition result derives from the returned value determined by the semantic model.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Keywords []*string `json:"Keywords,omitempty" name:"Keywords"`

	// This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the ID of the custom library for easier custom library management and configuration.
	// Note: this field may return null, indicating that no valid values can be obtained.
	LibId *string `json:"LibId,omitempty" name:"LibId"`

	// This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the name of the custom library for easier custom library management and configuration.
	// Note: this field may return null, indicating that no valid values can be obtained.
	LibName *string `json:"LibName,omitempty" name:"LibName"`

	// This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
	// Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the dictionary type of a custom keyword. Valid values: **1** (blocklist/allowlist), **2** (custom keyword dictionary). If no custom keyword dictionary is configured, the default value will be 1 (blocklist/allowlist).
	// Note: this field may return null, indicating that no valid values can be obtained.
	LibType *int64 `json:"LibType,omitempty" name:"LibType"`

	// This field is used to return a subtag under the current tag (Lable).
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabel *string `json:"SubLabel,omitempty" name:"SubLabel"`
}

type AudioSegments

type AudioSegments struct {
	// This field is used to return the start time of an audio segment in seconds. For audio on demand files, this parameter indicates the time offset of the audio from the complete audio track, such as 0 (no offset), 5 (5 seconds after the start of the audio track), and 10 (10 seconds after the start of the audio track). For live audio stream files, this parameter returns the Unix timestamp of the start of the audio segment, such as `1594650717`.
	// Note: this field may return null, indicating that no valid values can be obtained.
	OffsetTime *string `json:"OffsetTime,omitempty" name:"OffsetTime"`

	// This field is used to return the specific moderation result of an audio segment. For details, see the description of the `AudioResult` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Result *AudioResult `json:"Result,omitempty" name:"Result"`
}

type BucketInfo

type BucketInfo struct {
	// This field indicates a bucket name in Tencent Cloud COS. For more information on buckets, see [Basic Concepts](https://intl.cloud.tencent.com/document/product/436/44352?from_cn_redirect=1).
	Bucket *string `json:"Bucket,omitempty" name:"Bucket"`

	// This field indicates a region where a Tencent Cloud managed data center is deployed. COS data is stored in buckets in these regions.
	Region *string `json:"Region,omitempty" name:"Region"`

	// This field indicates an object key in Tencent Cloud COS. An object is stored in a bucket as a basic storage unit. You can manage objects through the Tencent Cloud console, API, or SDK. For more information on objects, see [Object Overview](https://intl.cloud.tencent.com/document/product/436/13324?from_cn_redirect=1).
	Object *string `json:"Object,omitempty" name:"Object"`
}

type CancelTaskRequest

type CancelTaskRequest struct {
	*tchttp.BaseRequest

	// This field indicates the task ID (in the `Results` parameter) returned after a video moderation task is created. It is used to identify the moderation task to be canceled.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

func NewCancelTaskRequest

func NewCancelTaskRequest() (request *CancelTaskRequest)

func (*CancelTaskRequest) FromJsonString

func (r *CancelTaskRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelTaskRequest) ToJsonString

func (r *CancelTaskRequest) ToJsonString() string

type CancelTaskRequestParams

type CancelTaskRequestParams struct {
	// This field indicates the task ID (in the `Results` parameter) returned after a video moderation task is created. It is used to identify the moderation task to be canceled.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`
}

Predefined struct for user

type CancelTaskResponse

type CancelTaskResponse struct {
	*tchttp.BaseResponse
	Response *CancelTaskResponseParams `json:"Response"`
}

func NewCancelTaskResponse

func NewCancelTaskResponse() (response *CancelTaskResponse)

func (*CancelTaskResponse) FromJsonString

func (r *CancelTaskResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelTaskResponse) ToJsonString

func (r *CancelTaskResponse) ToJsonString() string

type CancelTaskResponseParams

type CancelTaskResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CancelTask

func (c *Client) CancelTask(request *CancelTaskRequest) (response *CancelTaskResponse, err error)

CancelTask This API is used to cancel a moderation task. It will return the `TaskId` of the task after the task is canceled successfully.<br>

Default API request rate limit: **20 requests/sec**.

error code that may be returned:

DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CancelTaskWithContext

func (c *Client) CancelTaskWithContext(ctx context.Context, request *CancelTaskRequest) (response *CancelTaskResponse, err error)

CancelTask This API is used to cancel a moderation task. It will return the `TaskId` of the task after the task is canceled successfully.<br>

Default API request rate limit: **20 requests/sec**.

error code that may be returned:

DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateVideoModerationTask

func (c *Client) CreateVideoModerationTask(request *CreateVideoModerationTaskRequest) (response *CreateVideoModerationTaskResponse, err error)

CreateVideoModerationTask This API is used to submit a video file or stream for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account [to activate VM](https://console.cloud.tencent.com/cms/video/package) and adjust the business configuration.<br>

### Feature use instructions

- Go to the "[CMS console - VM](https://console.cloud.tencent.com/cms/video/package)" to activate AMS.

- This API is a paid API. For its billing mode, see [VM Pricing](https://intl.cloud.tencent.com/product/vm/pricing?from_cn_redirect=1).

- Default API request rate limit: **20 requests/sec**. When this limit is exceeded, requests for async moderation tasks (video on demand) will automatically join the queue of requests pending moderation, while an error will be reported for sync moderation tasks (video live streaming).

- Default limit on the number of concurrent moderation channels: 10. When this limit is exceeded, requests for async moderation tasks (video on demand) will automatically join the queue of requests pending moderation, while an error will be reported for sync moderation tasks (video live streaming).

### API feature description

- It can automatically detect video files or streams and recognize non-compliant content in them based on the deep learning technology from the perspectives of OCR-based text recognition, object detection (such as object, advertising logo, and QR code), image recognition, and audio moderation;

- It allows you to set the callback address (Callback) to get the detection result or call the API for viewing task details to get the details of the detection result through polling. For normal video moderation tasks, if non-compliant content is contained, the captured frames will be called back within **3s**, and the audio segments will be called back within the configured **segment duration + 2s**; for queued moderation tasks, the callback time will be equal to the sum of the callback time for normal moderation and waiting time;

- The API for viewing the moderation task list can be called to query the task queue. You can filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status;

- It can recognize various non-compliant scenarios, including vulgarity, abuse, pornography, and advertising;

- It allows you to customize moderation policies based on different business scenarios;

- You can customize blocklist/allowlist dictionaries and image libraries to filter non-compliant content of custom types (currently, only blocklist configuration is supported);

- You can customize the moderation task priority, so that when multiple tasks are queuing, the task priority will be automatically adjusted according to the configuration;

- You can submit detection tasks in batches and **create up to 10 tasks at a time**;

### Call description for video file

- Supported video file size: **< 3 GB**

- Supported video file resolution: **the optimal resolution is 1920x1080 (1080p)**. For video files of less than 300 MB in size, their resolution can be greater than 1080p; for video files of a greater size, you can call [MPS](https://intl.cloud.tencent.com/product/mps/details?from_cn_redirect=1) to transcode them before submitting them for moderation;

- Supported video file formats: FLV, MKV, MP4, RMVB, AVI, WMV, 3GP, TS, MOV, RM, MPEG, and WMF;

- Supported video file access methods: URL (over HTTP/HTTPS) and Tencent Cloud COS;

- If you pass in the access URL of a video file, you need to **limit its header file read time to 3 seconds**. To ensure the stability and reliability of the video to be detected, we recommend you use Tencent Cloud COS for storage or CDN for caching;

- You can configure whether to enable audio moderation, and if it is not enabled, only the image content of video files will be moderated.

### Call description for video stream

- Supported video stream duration: **< 5 hours**

- Supported video stream resolution: **1920x1080 (1080p)**. For videos with a higher resolution, you can call [live transcoding](https://intl.cloud.tencent.com/document/product/267/39889?from_cn_redirect=1) to transcode them before submitting them for moderation;

- Supported video stream formats: mainstream video stream codecs such as RMTP and FLV;

- Supported video transfer protocols: HTTP, HTTPS, and RTMP;

- You can configure whether to enable audio moderation, and if it is not enabled, only the image content of video streams will be moderated.

error code that may be returned:

DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_UNAUTHORIZED = "UnauthorizedOperation.Unauthorized"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateVideoModerationTaskWithContext

func (c *Client) CreateVideoModerationTaskWithContext(ctx context.Context, request *CreateVideoModerationTaskRequest) (response *CreateVideoModerationTaskResponse, err error)

CreateVideoModerationTask This API is used to submit a video file or stream for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account [to activate VM](https://console.cloud.tencent.com/cms/video/package) and adjust the business configuration.<br>

### Feature use instructions

- Go to the "[CMS console - VM](https://console.cloud.tencent.com/cms/video/package)" to activate AMS.

- This API is a paid API. For its billing mode, see [VM Pricing](https://intl.cloud.tencent.com/product/vm/pricing?from_cn_redirect=1).

- Default API request rate limit: **20 requests/sec**. When this limit is exceeded, requests for async moderation tasks (video on demand) will automatically join the queue of requests pending moderation, while an error will be reported for sync moderation tasks (video live streaming).

- Default limit on the number of concurrent moderation channels: 10. When this limit is exceeded, requests for async moderation tasks (video on demand) will automatically join the queue of requests pending moderation, while an error will be reported for sync moderation tasks (video live streaming).

### API feature description

- It can automatically detect video files or streams and recognize non-compliant content in them based on the deep learning technology from the perspectives of OCR-based text recognition, object detection (such as object, advertising logo, and QR code), image recognition, and audio moderation;

- It allows you to set the callback address (Callback) to get the detection result or call the API for viewing task details to get the details of the detection result through polling. For normal video moderation tasks, if non-compliant content is contained, the captured frames will be called back within **3s**, and the audio segments will be called back within the configured **segment duration + 2s**; for queued moderation tasks, the callback time will be equal to the sum of the callback time for normal moderation and waiting time;

- The API for viewing the moderation task list can be called to query the task queue. You can filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status;

- It can recognize various non-compliant scenarios, including vulgarity, abuse, pornography, and advertising;

- It allows you to customize moderation policies based on different business scenarios;

- You can customize blocklist/allowlist dictionaries and image libraries to filter non-compliant content of custom types (currently, only blocklist configuration is supported);

- You can customize the moderation task priority, so that when multiple tasks are queuing, the task priority will be automatically adjusted according to the configuration;

- You can submit detection tasks in batches and **create up to 10 tasks at a time**;

### Call description for video file

- Supported video file size: **< 3 GB**

- Supported video file resolution: **the optimal resolution is 1920x1080 (1080p)**. For video files of less than 300 MB in size, their resolution can be greater than 1080p; for video files of a greater size, you can call [MPS](https://intl.cloud.tencent.com/product/mps/details?from_cn_redirect=1) to transcode them before submitting them for moderation;

- Supported video file formats: FLV, MKV, MP4, RMVB, AVI, WMV, 3GP, TS, MOV, RM, MPEG, and WMF;

- Supported video file access methods: URL (over HTTP/HTTPS) and Tencent Cloud COS;

- If you pass in the access URL of a video file, you need to **limit its header file read time to 3 seconds**. To ensure the stability and reliability of the video to be detected, we recommend you use Tencent Cloud COS for storage or CDN for caching;

- You can configure whether to enable audio moderation, and if it is not enabled, only the image content of video files will be moderated.

### Call description for video stream

- Supported video stream duration: **< 5 hours**

- Supported video stream resolution: **1920x1080 (1080p)**. For videos with a higher resolution, you can call [live transcoding](https://intl.cloud.tencent.com/document/product/267/39889?from_cn_redirect=1) to transcode them before submitting them for moderation;

- Supported video stream formats: mainstream video stream codecs such as RMTP and FLV;

- Supported video transfer protocols: HTTP, HTTPS, and RTMP;

- You can configure whether to enable audio moderation, and if it is not enabled, only the image content of video streams will be moderated.

error code that may be returned:

DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_UNAUTHORIZED = "UnauthorizedOperation.Unauthorized"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTaskDetail

func (c *Client) DescribeTaskDetail(request *DescribeTaskDetailRequest) (response *DescribeTaskDetailResponse, err error)

DescribeTaskDetail This API is used to poll the details of the detection result.<br>

Default API request rate limit: **200 requests/sec**.

error code that may be returned:

DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTaskDetailWithContext

func (c *Client) DescribeTaskDetailWithContext(ctx context.Context, request *DescribeTaskDetailRequest) (response *DescribeTaskDetailResponse, err error)

DescribeTaskDetail This API is used to poll the details of the detection result.<br>

Default API request rate limit: **200 requests/sec**.

error code that may be returned:

DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTasks

func (c *Client) DescribeTasks(request *DescribeTasksRequest) (response *DescribeTasksResponse, err error)

DescribeTasks This API is used to query the task queue. You can filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status.<br>

Default API request rate limit: **20 requests/sec**.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeTasksWithContext

func (c *Client) DescribeTasksWithContext(ctx context.Context, request *DescribeTasksRequest) (response *DescribeTasksResponse, err error)

DescribeTasks This API is used to query the task queue. You can filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status.<br>

Default API request rate limit: **20 requests/sec**.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

type CreateVideoModerationTaskRequest

type CreateVideoModerationTaskRequest struct {
	*tchttp.BaseRequest

	// This parameter is used to pass in the task type of a moderation task. Valid values: **VIDEO** (video on demand), **LIVE_VIDEO** (video live streaming).
	Type *string `json:"Type,omitempty" name:"Type"`

	// This field indicates the input video moderation task information. For the specific input content, see the detailed description of the `TaskInput` data structure.<br>Note: you can create up to **10 tasks** at a time.
	Tasks []*TaskInput `json:"Tasks,omitempty" name:"Tasks"`

	// This field indicates the specific number of the policy, which is used for API scheduling and can be configured in the CMS console. If the `Biztype` parameter is passed in, a moderation policy will be used based on the business scenario; otherwise, the default moderation policy will be used.<br>Note: `Biztype` can contain 3–32 digits, letters, and underscores; different `Biztype` values are associated with different business scenarios and moderation policies, so you need to verify the `Biztype` before calling this API.
	BizType *string `json:"BizType,omitempty" name:"BizType"`

	// This field is optional and indicates the key information of the callback signature, which is used to ensure the data security. The signature algorithm is to add the `X-Signature` field to the returned HTTP header, whose value is the SHA256-encoded hex string of `seed` + `body` . After receiving the callback data, you can calculate `X-Signature` by using **sha256(seed + body)** based on the returned `body` for verification.<br>For specific use cases, see [Signature Algorithm v3](https://intl.cloud.tencent.com/document/product/1265/51885?from_cn_redirect=1).
	Seed *string `json:"Seed,omitempty" name:"Seed"`

	// This field is optional and indicates the address for receiving the moderation information callback in the default format of URL. After it is configured successfully, the non-compliant audio/video segments generated during moderation will be sent through this API. For the format of the returned callback content, see [Sample Callback Signature](https://intl.cloud.tencent.com/document/product/1265/51879?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B2-.E5.9B.9E.E8.B0.83.E7.AD.BE.E5.90.8D.E7.A4.BA.E4.BE.8B) <br>Note: by default, audio segments are captured at intervals of **15 seconds**, and video frames are captured at intervals of **5 seconds**. If you configure the capturing interval, segments will be returned according to the configuration.
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// This parameter is optional and used to pass in the priority of a moderation task. When you have multiple tasks in the queue, you can use this parameter to control their priorities for processing the queue jumping logic. **Default value: 0**.
	Priority *int64 `json:"Priority,omitempty" name:"Priority"`
}

func NewCreateVideoModerationTaskRequest

func NewCreateVideoModerationTaskRequest() (request *CreateVideoModerationTaskRequest)

func (*CreateVideoModerationTaskRequest) FromJsonString

func (r *CreateVideoModerationTaskRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateVideoModerationTaskRequest) ToJsonString

func (r *CreateVideoModerationTaskRequest) ToJsonString() string

type CreateVideoModerationTaskRequestParams

type CreateVideoModerationTaskRequestParams struct {
	// This parameter is used to pass in the task type of a moderation task. Valid values: **VIDEO** (video on demand), **LIVE_VIDEO** (video live streaming).
	Type *string `json:"Type,omitempty" name:"Type"`

	// This field indicates the input video moderation task information. For the specific input content, see the detailed description of the `TaskInput` data structure.<br>Note: you can create up to **10 tasks** at a time.
	Tasks []*TaskInput `json:"Tasks,omitempty" name:"Tasks"`

	// This field indicates the specific number of the policy, which is used for API scheduling and can be configured in the CMS console. If the `Biztype` parameter is passed in, a moderation policy will be used based on the business scenario; otherwise, the default moderation policy will be used.<br>Note: `Biztype` can contain 3–32 digits, letters, and underscores; different `Biztype` values are associated with different business scenarios and moderation policies, so you need to verify the `Biztype` before calling this API.
	BizType *string `json:"BizType,omitempty" name:"BizType"`

	// This field is optional and indicates the key information of the callback signature, which is used to ensure the data security. The signature algorithm is to add the `X-Signature` field to the returned HTTP header, whose value is the SHA256-encoded hex string of `seed` + `body` . After receiving the callback data, you can calculate `X-Signature` by using **sha256(seed + body)** based on the returned `body` for verification.<br>For specific use cases, see [Signature Algorithm v3](https://intl.cloud.tencent.com/document/product/1265/51885?from_cn_redirect=1).
	Seed *string `json:"Seed,omitempty" name:"Seed"`

	// This field is optional and indicates the address for receiving the moderation information callback in the default format of URL. After it is configured successfully, the non-compliant audio/video segments generated during moderation will be sent through this API. For the format of the returned callback content, see [Sample Callback Signature](https://intl.cloud.tencent.com/document/product/1265/51879?from_cn_redirect=1#.E7.A4.BA.E4.BE.8B2-.E5.9B.9E.E8.B0.83.E7.AD.BE.E5.90.8D.E7.A4.BA.E4.BE.8B) <br>Note: by default, audio segments are captured at intervals of **15 seconds**, and video frames are captured at intervals of **5 seconds**. If you configure the capturing interval, segments will be returned according to the configuration.
	CallbackUrl *string `json:"CallbackUrl,omitempty" name:"CallbackUrl"`

	// This parameter is optional and used to pass in the priority of a moderation task. When you have multiple tasks in the queue, you can use this parameter to control their priorities for processing the queue jumping logic. **Default value: 0**.
	Priority *int64 `json:"Priority,omitempty" name:"Priority"`
}

Predefined struct for user

type CreateVideoModerationTaskResponse

type CreateVideoModerationTaskResponse struct {
	*tchttp.BaseResponse
	Response *CreateVideoModerationTaskResponseParams `json:"Response"`
}

func NewCreateVideoModerationTaskResponse

func NewCreateVideoModerationTaskResponse() (response *CreateVideoModerationTaskResponse)

func (*CreateVideoModerationTaskResponse) FromJsonString

func (r *CreateVideoModerationTaskResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateVideoModerationTaskResponse) ToJsonString

func (r *CreateVideoModerationTaskResponse) ToJsonString() string

type CreateVideoModerationTaskResponseParams

type CreateVideoModerationTaskResponseParams struct {
	// This field is used to return the task creation result. For the specific output content, see the detailed description of the `TaskResult` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Results []*TaskResult `json:"Results,omitempty" name:"Results"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTaskDetailRequest

type DescribeTaskDetailRequest struct {
	*tchttp.BaseRequest

	// This field indicates the task ID (in the `Results` parameter) returned after a video moderation task is created. It is used to identify the moderation task for which to query the details.
	// <br>Note: the query API can query up to **20 tasks at a time**.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// This boolean field indicates whether to display all video segments. Valid values: True (yes), False (display only video segments that hit the moderation rule). Default value: False.
	ShowAllSegments *bool `json:"ShowAllSegments,omitempty" name:"ShowAllSegments"`
}

func NewDescribeTaskDetailRequest

func NewDescribeTaskDetailRequest() (request *DescribeTaskDetailRequest)

func (*DescribeTaskDetailRequest) FromJsonString

func (r *DescribeTaskDetailRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTaskDetailRequest) ToJsonString

func (r *DescribeTaskDetailRequest) ToJsonString() string

type DescribeTaskDetailRequestParams

type DescribeTaskDetailRequestParams struct {
	// This field indicates the task ID (in the `Results` parameter) returned after a video moderation task is created. It is used to identify the moderation task for which to query the details.
	// <br>Note: the query API can query up to **20 tasks at a time**.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// This boolean field indicates whether to display all video segments. Valid values: True (yes), False (display only video segments that hit the moderation rule). Default value: False.
	ShowAllSegments *bool `json:"ShowAllSegments,omitempty" name:"ShowAllSegments"`
}

Predefined struct for user

type DescribeTaskDetailResponse

type DescribeTaskDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTaskDetailResponseParams `json:"Response"`
}

func NewDescribeTaskDetailResponse

func NewDescribeTaskDetailResponse() (response *DescribeTaskDetailResponse)

func (*DescribeTaskDetailResponse) FromJsonString

func (r *DescribeTaskDetailResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTaskDetailResponse) ToJsonString

func (r *DescribeTaskDetailResponse) ToJsonString() string

type DescribeTaskDetailResponseParams

type DescribeTaskDetailResponseParams struct {
	// This field is used to return the task ID (in the `Results` parameter) after a video moderation task is created. It is used to identify the moderation task for which to query the details.
	// Note: this field may return null, indicating that no valid values can be obtained.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// This field is used to return the data ID parameter passed in when the video moderation API is called for easier data identification and management.
	// Note: this field may return null, indicating that no valid values can be obtained.
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// This field is used to return the `BizType` parameter passed in when the video moderation API is called for easier data identification and management.
	// Note: this field may return null, indicating that no valid values can be obtained.
	BizType *string `json:"BizType,omitempty" name:"BizType"`

	// This field is used to return the task name in the `TaskInput` parameter passed in when the video moderation API is called for easier task identification and management.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitempty" name:"Name"`

	// This field is used to return the task status of the queried content.
	// <br>Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).
	// Note: this field may return null, indicating that no valid values can be obtained.
	Status *string `json:"Status,omitempty" name:"Status"`

	// This field is used to return the type of video for moderation. Valid values: `VIDEO` (video on demand), `LIVE_VIDEO` (video live streaming). Default value: `VIDEO`.
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	Type *string `json:"Type,omitempty" name:"Type"`

	// This field is used to return the operation suggestion for the maliciousness tag. When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. <br>Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the maliciousness tag in the detection result.<br>Values: `Normal`: normal; `Porn`: pornographic; `Abuse`: abusive; `Ad`: advertising; `Custom`: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	Labels []*TaskLabel `json:"Labels,omitempty" name:"Labels"`

	// This field is used to return the details of the input media file, including encoding/decoding formats and segment length. For details, see the description of the `MediaInfo` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	MediaInfo *MediaInfo `json:"MediaInfo,omitempty" name:"MediaInfo"`

	// This field is used to return the media content information of the moderation service, mainly including the input file type and access URL.
	// Note: this field may return null, indicating that no valid values can be obtained.
	InputInfo *InputInfo `json:"InputInfo,omitempty" name:"InputInfo"`

	// This field is used to return the creation time of the queried task in ISO 8601 format.
	// Note: this field may return null, indicating that no valid values can be obtained.
	CreatedAt *string `json:"CreatedAt,omitempty" name:"CreatedAt"`

	// This field is used to return the last update time of the queried task in ISO 8601 format.
	// Note: this field may return null, indicating that no valid values can be obtained.
	UpdatedAt *string `json:"UpdatedAt,omitempty" name:"UpdatedAt"`

	// This field is used to return the moderation result of the frames captured from the video. For the detailed returned content, see the description of the `ImageSegments` data structure.<br>Note: the data is valid for 24 hours. To extend the storage period, set it in the configured COS bucket.
	// Note: this field may return null, indicating that no valid values can be obtained.
	ImageSegments []*ImageSegments `json:"ImageSegments,omitempty" name:"ImageSegments"`

	// This field is used to return the moderation result of the audio in the video. For the detailed returned content, see the description of the `AudioSegments` data structure.<br>Note: the data is valid for 24 hours. To extend the storage period, set it in the configured COS bucket.
	// Note: this field may return null, indicating that no valid values can be obtained.
	AudioSegments []*AudioSegments `json:"AudioSegments,omitempty" name:"AudioSegments"`

	// When the task status is `Error`, the type of the error will be returned. Valid values: **DECODE_ERROR**: decoding failed (the input resource may contain video that cannot be decoded).
	// **URL_ERROR**: download address verification failed.
	// **TIMEOUT_ERROR**: processing timed out. When the task status is not `Error`, null will be returned by default.
	// Note: this field may return null, indicating that no valid values can be obtained.
	ErrorType *string `json:"ErrorType,omitempty" name:"ErrorType"`

	// If the task status is `Error`, this field will return the error message; otherwise, null will be returned by default.
	// Note: this field may return null, indicating that no valid values can be obtained.
	ErrorDescription *string `json:"ErrorDescription,omitempty" name:"ErrorDescription"`

	// If the recognition result is normal, this parameter is returned with the value `Normal`. If malicious content is recognized, the tag with the highest priority in the result of `Labels` is returned.
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeTasksRequest

type DescribeTasksRequest struct {
	*tchttp.BaseRequest

	// This parameter indicates the number of tasks to be displayed on each page of the task list. **Default value: 10**.
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// This parameter indicates the input parameter of the task filter. You can filter tasks by business type, file type, processing suggestion, and task status. For the specific parameter content, see the detailed description of the `TaskFilter` data structure.
	Filter *TaskFilter `json:"Filter,omitempty" name:"Filter"`

	// This parameter indicates the `Token` information used during pagination. It is automatically generated by the system and will be passed to the next generated page for easy and fast pagination. When you turn to the last page, this field will be empty.
	PageToken *string `json:"PageToken,omitempty" name:"PageToken"`

	// This parameter indicates the start time of the task list in ISO 8601 timestamp format. **Default value: 3 days ago**. If this parameter is passed in, tasks between this time point and `EndTime` will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// This parameter indicates the end time of the task list in ISO 8601 timestamp format. **Default value: empty**. If this parameter is passed in, tasks between `StartTime` and this time point will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`
}

func NewDescribeTasksRequest

func NewDescribeTasksRequest() (request *DescribeTasksRequest)

func (*DescribeTasksRequest) FromJsonString

func (r *DescribeTasksRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTasksRequest) ToJsonString

func (r *DescribeTasksRequest) ToJsonString() string

type DescribeTasksRequestParams

type DescribeTasksRequestParams struct {
	// This parameter indicates the number of tasks to be displayed on each page of the task list. **Default value: 10**.
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// This parameter indicates the input parameter of the task filter. You can filter tasks by business type, file type, processing suggestion, and task status. For the specific parameter content, see the detailed description of the `TaskFilter` data structure.
	Filter *TaskFilter `json:"Filter,omitempty" name:"Filter"`

	// This parameter indicates the `Token` information used during pagination. It is automatically generated by the system and will be passed to the next generated page for easy and fast pagination. When you turn to the last page, this field will be empty.
	PageToken *string `json:"PageToken,omitempty" name:"PageToken"`

	// This parameter indicates the start time of the task list in ISO 8601 timestamp format. **Default value: 3 days ago**. If this parameter is passed in, tasks between this time point and `EndTime` will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// This parameter indicates the end time of the task list in ISO 8601 timestamp format. **Default value: empty**. If this parameter is passed in, tasks between `StartTime` and this time point will be filtered out.<br>Note: this parameter is used together with `Filter` to filter tasks in no particular order.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`
}

Predefined struct for user

type DescribeTasksResponse

type DescribeTasksResponse struct {
	*tchttp.BaseResponse
	Response *DescribeTasksResponseParams `json:"Response"`
}

func NewDescribeTasksResponse

func NewDescribeTasksResponse() (response *DescribeTasksResponse)

func (*DescribeTasksResponse) FromJsonString

func (r *DescribeTasksResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeTasksResponse) ToJsonString

func (r *DescribeTasksResponse) ToJsonString() string

type DescribeTasksResponseParams

type DescribeTasksResponseParams struct {
	// This field is used to return the total number of queried tasks in the format of `int` string.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Total *string `json:"Total,omitempty" name:"Total"`

	// This field is used to return the detailed data of the tasks on the current page. For the specific output content, see the detailed description of the `TaskData` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Data []*TaskData `json:"Data,omitempty" name:"Data"`

	// This field is used to return the `Token` information used during pagination. It is automatically generated by the system and will be passed to the next generated page for easy and fast pagination. When you turn to the last page, this field will be empty.
	// Note: this field may return null, indicating that no valid values can be obtained.
	PageToken *string `json:"PageToken,omitempty" name:"PageToken"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type ImageResult

type ImageResult struct {
	// This parameter indicates whether the moderated content hit a maliciousness tag. Valid values: 0 (**no**), 1 (**yes**).
	// Note: this field may return null, indicating that no valid values can be obtained.
	HitFlag *int64 `json:"HitFlag,omitempty" name:"HitFlag"`

	// This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
	// Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn-SexBehavior 99* indicates that the text is highly likely to fall into the category of content involving sexual behaviors.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This field is used to return the sub-result of the image moderation result. For details, see the description of the `ImageResultResult` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Results []*ImageResultResult `json:"Results,omitempty" name:"Results"`

	// This field is used to return the access URL of the moderation result. Supported image formats include PNG, JPG, JPEG, BMP, GIF, and WEBP.<br>Note: the data **is valid for 12 hours by default**. If you need a longer storage period, configure it in the COS bucket where the data is stored.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Url *string `json:"Url,omitempty" name:"Url"`

	// This field is used to return the additional information (Extra) in the input parameters. If it is not configured, an empty value will be returned by default.<br>Note: the returned information varies by customer or `Biztype`. If you need to configure this field, submit a ticket or contact the aftersales service for assistance.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Extra *string `json:"Extra,omitempty" name:"Extra"`

	// This field is used to return a subtag under the current tag (Lable).
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabel *string `json:"SubLabel,omitempty" name:"SubLabel"`
}

type ImageResultResult

type ImageResultResult struct {
	// This field is used to return the maliciousness scenario in the detection result. Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **AppLogo**: advertising logo; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Scene *string `json:"Scene,omitempty" name:"Scene"`

	// This parameter indicates whether the moderated content hit a maliciousness tag. Valid values: 0 (**no**), 1 (**yes**).
	// Note: this field may return null, indicating that no valid values can be obtained.
	HitFlag *int64 `json:"HitFlag,omitempty" name:"HitFlag"`

	// This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
	// Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This field is used to return the detection result for a subtag under the maliciousness tag, such as *Porn-SexBehavior*.
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabel *string `json:"SubLabel,omitempty" name:"SubLabel"`

	// This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn-SexBehavior 99* indicates that the text is highly likely to fall into the category of content involving sexual behaviors.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This field is used to return the list of specific object names hit by the moderated image in a sensitive scenario.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Names []*string `json:"Names,omitempty" name:"Names"`

	// This field is used to return the OCR result of an image. OCR can recognize text of **up to 5,000 bytes**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Text *string `json:"Text,omitempty" name:"Text"`

	// This field is used to return other detailed information of the image moderation sub-result, such as text position and custom library. For the detailed returned content, see the description of the `ImageResultsResultDetail` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Details []*ImageResultsResultDetail `json:"Details,omitempty" name:"Details"`
}

type ImageResultsResultDetail

type ImageResultsResultDetail struct {
	// This field is used to return the task name in the `TaskInput` parameter passed in when the video moderation API is called for easier task identification and management.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitempty" name:"Name"`

	// This field is used to return the OCR result of an image. OCR can recognize text of **up to 5,000 bytes**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Text *string `json:"Text,omitempty" name:"Text"`

	// This field is used to return the detailed position information of the image moderation sub-result, such as coordinates, size, and rotation angle. For the detailed returned content, see the description of the `ImageResultsResultDetailLocation` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Location *ImageResultsResultDetailLocation `json:"Location,omitempty" name:"Location"`

	// This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the ID of the custom library for easier custom library management and configuration.
	// Note: this field may return null, indicating that no valid values can be obtained.
	LibId *string `json:"LibId,omitempty" name:"LibId"`

	// This field is **valid only when `Label` is `Custom` (custom keyword)**. It is used to return the name of the custom library for easier custom library management and configuration.
	// Note: this field may return null, indicating that no valid values can be obtained.
	LibName *string `json:"LibName,omitempty" name:"LibName"`

	// This field is used to return the keyword information hit by the detected text and indicate the specific cause of text non-compliance (such as *Friend me*). This parameter may have multiple returned values representing multiple hit keywords. If the returned value is empty, but `Score` is not empty, the maliciousness tag (Label) that corresponds to the recognition result derives from the returned value determined by the semantic model.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Keywords []*string `json:"Keywords,omitempty" name:"Keywords"`

	// This field is used to return the operation suggestion. When you get the determination result, the returned value indicates the suggested operation.<br>
	// Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the confidence under the current tag. Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This field is used to return the detection result for a subtag under the maliciousness tag, such as *Porn-SexBehavior*.
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabelCode *string `json:"SubLabelCode,omitempty" name:"SubLabelCode"`
}

type ImageResultsResultDetailLocation

type ImageResultsResultDetailLocation struct {
	// This parameter is used to indicate the pixel position of the **abscissa (X)** of the top-left corner of the OCR detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame.
	// Note: this field may return null, indicating that no valid values can be obtained.
	X *float64 `json:"X,omitempty" name:"X"`

	// This parameter is used to indicate the pixel position of the **ordinate (Y)** of the top-left corner of the OCR detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Y *float64 `json:"Y,omitempty" name:"Y"`

	// This parameter is used to indicate the **width of the OCR detection frame** (the length starting from the top-left corner and extending to the right on the X axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Width *int64 `json:"Width,omitempty" name:"Width"`

	// This parameter is used to indicate the **height of the OCR detection frame** (the length starting from the top-left corner and extending down the Y axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Height *int64 `json:"Height,omitempty" name:"Height"`

	// This parameter is used to indicate the **rotation angle of the OCR detection frame**. Valid values: **0–360** (**degrees**), and the direction is **counterclockwise rotation**. This parameter can be combined with the `X` and `Y` coordinate parameters to uniquely determine the specific position of the detection frame.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Rotate *float64 `json:"Rotate,omitempty" name:"Rotate"`
}

type ImageSegments

type ImageSegments struct {
	// This field is used to return the frame capturing time of a video segment in seconds. For video on demand files, this parameter indicates the time offset of the captured image from the video, such as 0 (no offset), 5 (5 seconds after the start of the video), and 10 (10 seconds after the start of the video). For live video stream files, this parameter returns the Unix timestamp of the image, such as `1594650717`.
	OffsetTime *string `json:"OffsetTime,omitempty" name:"OffsetTime"`

	// This field is used to return the specific moderation result of a frame captured from a video segment. For details, see the description of the `ImageResult` data structure.
	Result *ImageResult `json:"Result,omitempty" name:"Result"`
}

type InputInfo

type InputInfo struct {
	// This field indicates the file access type. Valid values: **URL** (resource link), **COS** (Tencent Cloud COS).
	// Note: this field may return null, indicating that no valid values can be obtained.
	Type *string `json:"Type,omitempty" name:"Type"`

	// This field indicates the link address for file access in standard URL format.<br>Note: when `Type` is `URL`, this field will not be empty.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Url *string `json:"Url,omitempty" name:"Url"`

	// This field indicates the Tencent Cloud bucket information for file access.<br>Note: when `Type` is `COS`, this field will not be empty.
	// Note: this field may return null, indicating that no valid values can be obtained.
	BucketInfo *string `json:"BucketInfo,omitempty" name:"BucketInfo"`
}

type MediaInfo

type MediaInfo struct {
	// This field is used to return the segment length of the input video stream in seconds. It is **5 seconds by default** and is customizable.<br>Note: this field will take effect only when the moderated file is streaming media. If it returns 0, no valid value has been obtained.
	Duration *int64 `json:"Duration,omitempty" name:"Duration"`
}

type RecognitionResult

type RecognitionResult struct {
	// Values: `Teenager`, `Gender`
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// List of recognized category labels
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	Tags []*Tag `json:"Tags,omitempty" name:"Tags"`
}

type StorageInfo

type StorageInfo struct {
	// This field indicates the file access type. Valid values: **URL** (resource link), **COS** (Tencent Cloud COS). It should correspond to the access type passed in and can be used for strict verification and quick identification of the access address. If you don't pass in this parameter, the default value will be `URL`, and the system will automatically determine the access address type.
	Type *string `json:"Type,omitempty" name:"Type"`

	// This field indicates the link address for file access in standard URL format.<br>Note: when `Type` is `URL`, this field will not be empty. You must pass in either this parameter or the `BucketInfo` parameter.
	Url *string `json:"Url,omitempty" name:"Url"`

	// This field indicates the Tencent Cloud bucket information for file access.<br>Note: when `Type` is `COS`, this field will not be empty. You must pass in either this parameter or the `Url` parameter.
	BucketInfo *BucketInfo `json:"BucketInfo,omitempty" name:"BucketInfo"`
}

type Tag

type Tag struct {
	// The value of this parameter varies by `Label`.
	// When `Label` is `Teenager`, `Name` can be `Teenager`.
	// When `Label` is `Gender`, `Name` can be `Male` and `Female`.
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	Name *string `json:"Name,omitempty" name:"Name"`

	// Confidence rate. Value: 1 to 100.
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// Start time for the recognition (ms)
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	StartTime *float64 `json:"StartTime,omitempty" name:"StartTime"`

	// End time for the recognition (ms)
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	EndTime *float64 `json:"EndTime,omitempty" name:"EndTime"`
}

type TaskData

type TaskData struct {
	// This field is used to return the ID of the video moderation task data for subsequent query and management of moderation tasks.
	// Note: this field may return null, indicating that no valid values can be obtained.
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// This field is used to return the ID of a video moderation task for identification, query, and management of moderation tasks.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// This field is used to return the task status of the queried content.
	// <br>Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).
	Status *string `json:"Status,omitempty" name:"Status"`

	// This field is used to return the name of a video moderation task for subsequent query and management of moderation tasks.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitempty" name:"Name"`

	// This field is used to return the `BizType` parameter passed in when the video moderation API is called for easier data identification and management.
	// Note: this field may return null, indicating that no valid values can be obtained.
	BizType *string `json:"BizType,omitempty" name:"BizType"`

	// This field is used to return the audio moderation type passed in when the audio moderation API is called. Valid values: **VIDEO** (video on demand), **LIVE_VIDEO** (video live streaming). Default value: VIDEO.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Type *string `json:"Type,omitempty" name:"Type"`

	// This field is used to return the operation suggestion for the maliciousness tag. When you get the determination result, the returned value indicates the suggested operation.<br>
	// Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	Labels []*TaskLabel `json:"Labels,omitempty" name:"Labels"`

	// This field is used to return the details of the input media file, including codec and segment length. For details, see the description of the `MediaInfo` data structure.
	// Note: this field may return null, indicating that no valid values can be obtained.
	MediaInfo *MediaInfo `json:"MediaInfo,omitempty" name:"MediaInfo"`

	// This field is used to return the creation time of the queried task in ISO 8601 format.
	CreatedAt *string `json:"CreatedAt,omitempty" name:"CreatedAt"`

	// This field is used to return the last update time of the queried task in ISO 8601 format.
	// Note: this field may return null, indicating that no valid values can be obtained.
	UpdatedAt *string `json:"UpdatedAt,omitempty" name:"UpdatedAt"`
}

type TaskFilter

type TaskFilter struct {
	// This field is used to pass in the business type of a task as a filter. `Biztype` is the specific number of the policy, which is used for API scheduling and can be configured in the CMS console. Different `Biztype` values are associated with different business scenarios and moderation policies, so you need to verify the `Biztype` before calling this API. `Biztype` can contain 3–32 digits, letters, and underscores.<br>Note: when this parameter is not passed in, tasks will not be filtered by business type by default.
	// Note: this field may return null, indicating that no valid values can be obtained.
	BizType []*string `json:"BizType,omitempty" name:"BizType"`

	// This field is used to pass in the type of a video moderation task as a filter. Valid values: **VIDEO** (video on demand moderation), **AUDIO** (audio on demand moderation), **LIVE_VIDEO** (video live streaming moderation), **LIVE_AUDIO** (audio live streaming moderation).<br>Note: when this parameter is not passed in, tasks will not be filtered by task type by default.
	Type *string `json:"Type,omitempty" name:"Type"`

	// This field is used to pass in the operation suggestion of a video moderation task as a filter. Valid values: **Block**, **Review**, **Pass**.<br>Note: when this parameter is not passed in, tasks will not be filtered by operation suggestion by default.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to pass in the status of a moderation task as a filter. Valid values: **FINISH** (task completed), **PENDING** (task pending), **RUNNING** (task in progress), **ERROR** (task error), **CANCELLED** (task canceled).<br>Note: when this parameter is not passed in, tasks will not be filtered by task status by default.
	TaskStatus *string `json:"TaskStatus,omitempty" name:"TaskStatus"`
}

type TaskInput

type TaskInput struct {
	// This field is optional and indicates the data ID assigned by you to the object to be detected for easier file identification and management.<br>It **can contain up to 64 letters, digits, and special symbols (_-@#)**.
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// This field is optional and indicates the name of a moderation task for subsequent query and management of moderation tasks.
	Name *string `json:"Name,omitempty" name:"Name"`

	// This field is required and indicates the access parameter of the moderated file, which is used to get the moderated media file and contains the access type and address.
	Input *StorageInfo `json:"Input,omitempty" name:"Input"`
}

type TaskLabel

type TaskLabel struct {
	// This field is used to return the maliciousness tag in the detection result.<br>Returned values: **Normal**: normal; **Porn**: pornographic; **Abuse**: abusive; **Ad**: advertising; **Custom**: custom type of non-compliant content and other offensive, unsafe, or inappropriate types of content.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitempty" name:"Label"`

	// This field is used to return the operation suggestion for the current tag (Label). When you get the determination result, the returned value indicates the operation suggested by the system. We recommend you handle different types of violations and suggestions according to your business needs. <br>Returned values: **Block**, **Review**, **Pass**.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitempty" name:"Suggestion"`

	// This field is used to return the confidence under the current tag (Label). Value range: 0 (**the lowest confidence**)–100 (**the highest confidence**), where a higher value indicates that the text is more likely to fall into the category of the current returned tag; for example, *Porn 99* indicates that the text is highly likely to be pornographic, while *Porn 0* indicates that the text is not pornographic.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Score *int64 `json:"Score,omitempty" name:"Score"`

	// This field is used to return a subtag under the current tag (Lable).
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubLabel *string `json:"SubLabel,omitempty" name:"SubLabel"`
}

type TaskResult

type TaskResult struct {
	// This field is used to return the `DataId` passed in within the `TaskInput` structure when a video moderation task is created. It is used to identify the specific moderation task.
	// Note: this field may return null, indicating that no valid values can be obtained.
	DataId *string `json:"DataId,omitempty" name:"DataId"`

	// This field is used to return the ID of a video moderation task for identification, query, and management of moderation tasks.
	// Note: this field may return null, indicating that no valid values can be obtained.
	TaskId *string `json:"TaskId,omitempty" name:"TaskId"`

	// This field is used to return the task creation status. If `OK` is returned, the task has been created successfully; if another value is returned, refer to the common error codes.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Code *string `json:"Code,omitempty" name:"Code"`

	// **This field will take effect only when the returned value of `Code` is an error code**. It is used to return the error message.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Message *string `json:"Message,omitempty" name:"Message"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL