v20201229

package
v3.0.918+incompatible Latest Latest
Warning

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

 Go to latest Published: Mar 19, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// `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"

	// Operation not authorized/Invalid package/Account overdue
	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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"Url"`

	// This field is used to return the length of an audio file in milliseconds.
	Duration *string `json:"Duration,omitnil,omitempty" name:"Duration"`

	// This field is used to return additional information, and the returned information varies by customer or `Biztype`.
	Extra *string `json:"Extra,omitnil,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.
	TextResults []*AudioResultDetailTextResult `json:"TextResults,omitnil,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.
	MoanResults []*AudioResultDetailMoanResult `json:"MoanResults,omitnil,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.
	LanguageResults []*AudioResultDetailLanguageResult `json:"LanguageResults,omitnil,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,omitnil,omitempty" name:"SubLabel"`

	// List of audio recognition results
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	RecognitionResults []*RecognitionResult `json:"RecognitionResults,omitnil,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,omitnil,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,omitnil,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 seconds.
	// Note: this field may return null, indicating that no valid values can be obtained.
	StartTime *float64 `json:"StartTime,omitnil,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 seconds.
	// Note: this field may return null, indicating that no valid values can be obtained.
	EndTime *float64 `json:"EndTime,omitnil,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,omitnil,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,omitnil,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,omitnil,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 seconds.
	StartTime *float64 `json:"StartTime,omitnil,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 seconds.
	EndTime *float64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// *This field is in beta test. Stay tuned*
	SubLabelCode *string `json:"SubLabelCode,omitnil,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,omitnil,omitempty" name:"SubLabel"`

	// This field returns the suggested action according to the check result. <br>Values: `Block`, `Review`, `Pass`.
	Suggestion *string `json:"Suggestion,omitnil,omitempty" name:"Suggestion"`
}

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,omitnil,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"). 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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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).
	LibType *int64 `json:"LibType,omitnil,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,omitnil,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,omitnil,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,omitnil,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).
	// Note: this field may return null, indicating that no valid values can be obtained.
	Bucket *string `json:"Bucket,omitnil,omitempty" name:"Bucket"`

	// This field indicates a region where a Tencent Cloud COS managed data center is deployed. COS data is stored in buckets in these regions.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// This field indicates an object key in Tencent Cloud COS. Object z 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).
	// Note: this field may return null, indicating that no valid values can be obtained.
	Object *string `json:"Object,omitnil,omitempty" name:"Object"`
}

type CancelTaskRequest 

type CancelTaskRequest struct {
	*tchttp.BaseRequest

	// This field indicates the task ID (in the `Results` parameter) returned after an audio moderation task is created. It is used to identify the moderation task to be canceled.
	TaskId *string `json:"TaskId,omitnil,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 an audio moderation task is created. It is used to identify the moderation task to be canceled.
	TaskId *string `json:"TaskId,omitnil,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,omitnil,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. If it returns `RequestId`, the task has been 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. If it returns `RequestId`, the task has been 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) CreateAudioModerationTask 

func (c *Client) CreateAudioModerationTask(request *CreateAudioModerationTaskRequest) (response *CreateAudioModerationTaskResponse, err error)

CreateAudioModerationTask This API is used to submit audio content (such as an audio file or stream URL) for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account to [activate AMS](https://console.cloud.tencent.com/cms) and adjust the business configuration. <br>

### API use instructions

- Go to [CMS console - AMS](https://console.cloud.tencent.com/cms) to activate AMS. For initial activation, you can enjoy **10 hours** of free call of the API within one month.

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

- Default limit of concurrent moderation tasks: 10 for audio on demand and 100 for audio live streaming. When this limit is exceeded, requests will automatically queue up for async moderation tasks (audio on demand), while an error will be reported for sync moderation tasks (audio live streaming).

### API feature description

- This API can detect audio streams or files for non-compliant content.

- You can set the callback address (Callback) to get the detection result (for moderation tasks in progress, the maximum callback time is the configured **segment length + 2s**). You can also call the API for querying the audio detection result to actively poll the detection result.

- This API can recognize various types of non-compliant content, including vulgarity, abuse, porn, and advertising.

- You can submit **up to 10** detection tasks at a time.

### Call description for audio file

- Supported audio file size: **< 500 MB**

- Supported audio file duration: **< 1 hour**

- Supported audio bitrate: 128–256 Kbps

- Supported audio file formats: WAV, MP3, AAC, FLAC, AMR, 3GP, M4A, WMA, OGG, and APE

- **When the input is a video file**, the audio track can be extracted for separate audio content moderation.

### Call description for audio stream

- Supported audio stream duration: **< 3 hours**

- Supported audio bitrate: 128–256 Kbps

- Supported audio stream transfer protocols: RTMP, HTTP, and HTTPS

- Supported audio stream formats: RTP, SRTP, RTMP, RTMPS, MMSH, MMST, HLS, HTTP, TCP, HTTPS, and M3U8

- **When the input is a video stream**, the audio track can be extracted for separate audio content moderation.

### Handling description for live streaming interruption

- Ensure that the [CancelTask API](https://intl.cloud.tencent.com/document/product/1219/53258?from_cn_redirect=1) is connected.

- If the live streaming task is canceled or completed, this API terminates live streaming pulling and exits moderation.

- If the live streaming task is not canceled or completed and audio live streaming pushing is interrupted due to a fault, this API continues to try live streaming pulling within 10 minutes. If audio segment data is detected within 10 minutes, this API restores normal moderation. Otherwise, this API terminates pulling and exits moderation. If you still need moderation after pulling terminates, submit a moderation request again.

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) CreateAudioModerationTaskWithContext 

func (c *Client) CreateAudioModerationTaskWithContext(ctx context.Context, request *CreateAudioModerationTaskRequest) (response *CreateAudioModerationTaskResponse, err error)

CreateAudioModerationTask This API is used to submit audio content (such as an audio file or stream URL) for smart moderation. Before using it, you need to log in to the console with the Tencent Cloud root account to [activate AMS](https://console.cloud.tencent.com/cms) and adjust the business configuration. <br>

### API use instructions

- Go to [CMS console - AMS](https://console.cloud.tencent.com/cms) to activate AMS. For initial activation, you can enjoy **10 hours** of free call of the API within one month.

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

- Default limit of concurrent moderation tasks: 10 for audio on demand and 100 for audio live streaming. When this limit is exceeded, requests will automatically queue up for async moderation tasks (audio on demand), while an error will be reported for sync moderation tasks (audio live streaming).

### API feature description

- This API can detect audio streams or files for non-compliant content.

- You can set the callback address (Callback) to get the detection result (for moderation tasks in progress, the maximum callback time is the configured **segment length + 2s**). You can also call the API for querying the audio detection result to actively poll the detection result.

- This API can recognize various types of non-compliant content, including vulgarity, abuse, porn, and advertising.

- You can submit **up to 10** detection tasks at a time.

### Call description for audio file

- Supported audio file size: **< 500 MB**

- Supported audio file duration: **< 1 hour**

- Supported audio bitrate: 128–256 Kbps

- Supported audio file formats: WAV, MP3, AAC, FLAC, AMR, 3GP, M4A, WMA, OGG, and APE

- **When the input is a video file**, the audio track can be extracted for separate audio content moderation.

### Call description for audio stream

- Supported audio stream duration: **< 3 hours**

- Supported audio bitrate: 128–256 Kbps

- Supported audio stream transfer protocols: RTMP, HTTP, and HTTPS

- Supported audio stream formats: RTP, SRTP, RTMP, RTMPS, MMSH, MMST, HLS, HTTP, TCP, HTTPS, and M3U8

- **When the input is a video stream**, the audio track can be extracted for separate audio content moderation.

### Handling description for live streaming interruption

- Ensure that the [CancelTask API](https://intl.cloud.tencent.com/document/product/1219/53258?from_cn_redirect=1) is connected.

- If the live streaming task is canceled or completed, this API terminates live streaming pulling and exits moderation.

- If the live streaming task is not canceled or completed and audio live streaming pushing is interrupted due to a fault, this API continues to try live streaming pulling within 10 minutes. If audio segment data is detected within 10 minutes, this API restores normal moderation. Otherwise, this API terminates pulling and exits moderation. If you still need moderation after pulling terminates, submit a moderation request again.

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 interface is used to view the detailed information of the audio moderation tasks, including task status, detection results, corresponding text content recognized from the audio file, recommended follow-up operations of the maliciousness tags corresponding to the detection results, and so on. For specific output content, see the output parameter examples.

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 interface is used to view the detailed information of the audio moderation tasks, including task status, detection results, corresponding text content recognized from the audio file, recommended follow-up operations of the maliciousness tags corresponding to the detection results, and so on. For specific output content, see the output parameter examples.

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 view the list of moderation tasks. You can also filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status. The output content of the task list includes the total number of queried tasks, task name, task status, audio moderation type, maliciousness tag of the detection result, and suggested operation. For the specific output content, see the sample output parameters.<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) DescribeTasksWithContext 

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

DescribeTasks This API is used to view the list of moderation tasks. You can also filter moderation tasks by multiple types of business information, such as business type, moderation result, and task status. The output content of the task list includes the total number of queried tasks, task name, task status, audio moderation type, maliciousness tag of the detection result, and suggested operation. For the specific output content, see the sample output parameters.<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"

type CreateAudioModerationTaskRequest 

type CreateAudioModerationTaskRequest struct {
	*tchttp.BaseRequest

	// This field indicates the input audio 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,omitnil,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,omitnil,omitempty" name:"BizType"`

	// This field indicates the input audio moderation type. Valid values: **AUDIO** (audio on demand), **LIVE_AUDIO** (audio live streaming). Default value: AUDIO.
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 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/1219/53263?from_cn_redirect=1).
	Seed *string `json:"Seed,omitnil,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/1219/53257?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)
	CallbackUrl *string `json:"CallbackUrl,omitnil,omitempty" name:"CallbackUrl"`
}

func NewCreateAudioModerationTaskRequest 

func NewCreateAudioModerationTaskRequest() (request *CreateAudioModerationTaskRequest)

func (*CreateAudioModerationTaskRequest) FromJsonString 

func (r *CreateAudioModerationTaskRequest) 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 (*CreateAudioModerationTaskRequest) ToJsonString 

func (r *CreateAudioModerationTaskRequest) ToJsonString() string

type CreateAudioModerationTaskRequestParams 

type CreateAudioModerationTaskRequestParams struct {
	// This field indicates the input audio 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,omitnil,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,omitnil,omitempty" name:"BizType"`

	// This field indicates the input audio moderation type. Valid values: **AUDIO** (audio on demand), **LIVE_AUDIO** (audio live streaming). Default value: AUDIO.
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 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/1219/53263?from_cn_redirect=1).
	Seed *string `json:"Seed,omitnil,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/1219/53257?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)
	CallbackUrl *string `json:"CallbackUrl,omitnil,omitempty" name:"CallbackUrl"`
}

Predefined struct for user

type CreateAudioModerationTaskResponse 

type CreateAudioModerationTaskResponse struct {
	*tchttp.BaseResponse
	Response *CreateAudioModerationTaskResponseParams `json:"Response"`
}

func NewCreateAudioModerationTaskResponse 

func NewCreateAudioModerationTaskResponse() (response *CreateAudioModerationTaskResponse)

func (*CreateAudioModerationTaskResponse) FromJsonString 

func (r *CreateAudioModerationTaskResponse) 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 (*CreateAudioModerationTaskResponse) ToJsonString 

func (r *CreateAudioModerationTaskResponse) ToJsonString() string

type CreateAudioModerationTaskResponseParams 

type CreateAudioModerationTaskResponseParams 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,omitnil,omitempty" name:"Results"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,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 an audio 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,omitnil,omitempty" name:"TaskId"`

	// This boolean field indicates whether to display all audio segments. Valid values: True (yes), False (display only audio segments that hit the moderation rule). Default value: False.
	ShowAllSegments *bool `json:"ShowAllSegments,omitnil,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 an audio 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,omitnil,omitempty" name:"TaskId"`

	// This boolean field indicates whether to display all audio segments. Valid values: True (yes), False (display only audio segments that hit the moderation rule). Default value: False.
	ShowAllSegments *bool `json:"ShowAllSegments,omitnil,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 {
	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	TaskId *string `json:"TaskId,omitnil,omitempty" name:"TaskId"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	DataId *string `json:"DataId,omitnil,omitempty" name:"DataId"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	BizType *string `json:"BizType,omitnil,omitempty" name:"BizType"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	Suggestion *string `json:"Suggestion,omitnil,omitempty" name:"Suggestion"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	Labels []*TaskLabel `json:"Labels,omitnil,omitempty" name:"Labels"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	InputInfo *InputInfo `json:"InputInfo,omitnil,omitempty" name:"InputInfo"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	AudioText *string `json:"AudioText,omitnil,omitempty" name:"AudioText"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	AudioSegments []*AudioSegments `json:"AudioSegments,omitnil,omitempty" name:"AudioSegments"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	ErrorType *string `json:"ErrorType,omitnil,omitempty" name:"ErrorType"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	ErrorDescription *string `json:"ErrorDescription,omitnil,omitempty" name:"ErrorDescription"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	CreatedAt *string `json:"CreatedAt,omitnil,omitempty" name:"CreatedAt"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	UpdatedAt *string `json:"UpdatedAt,omitnil,omitempty" name:"UpdatedAt"`

	//
	// Note: this field may return null, indicating that no valid values can be obtained.
	Label *string `json:"Label,omitnil,omitempty" name:"Label"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,omitempty" name:"PageToken"`

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

Predefined struct for user

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,omitnil,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,omitnil,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 *BucketInfo `json:"BucketInfo,omitnil,omitempty" name:"BucketInfo"`
}

type MediaInfo 

type MediaInfo struct {
	// This field is used to return the codec of the media file passed in, such as WAV, MP3, AAC, FLAC, AMR, 3GP, M4A, WMA, OGG, and APE.
	Codecs *string `json:"Codecs,omitnil,omitempty" name:"Codecs"`

	// This field is used to return the segment length of the input streaming media file in milliseconds.** It is 15 seconds** by default and is customizable.
	Duration *int64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// *This field is in beta test. Stay tuned*
	Width *int64 `json:"Width,omitnil,omitempty" name:"Width"`

	// *This field is in beta test. Stay tuned*
	Height *int64 `json:"Height,omitnil,omitempty" name:"Height"`

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

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,omitnil,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,omitnil,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,omitnil,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,omitnil,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,omitnil,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 was found.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// Confidence score. Value: 1 to 100.
	// Note: This field may return `null`, indicating that no valid value was found.
	Score *int64 `json:"Score,omitnil,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,omitnil,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,omitnil,omitempty" name:"EndTime"`
}

type TaskData 

type TaskData struct {
	// This field is used to return the ID of the audio 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,omitnil,omitempty" name:"DataId"`

	// This field is used to return the ID of an audio moderation task for identification, query, and management of moderation tasks.
	TaskId *string `json:"TaskId,omitnil,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,omitnil,omitempty" name:"Status"`

	// This field is used to return the name of an audio 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,omitnil,omitempty" name:"Name"`

	// This field is used to return the `BizType` parameter passed in when the audio 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,omitnil,omitempty" name:"BizType"`

	// This field is used to return the audio moderation type passed in when the audio moderation API is called. Valid values: **AUDIO** (audio on demand), **LIVE_AUDIO** (audio live streaming). Default value: AUDIO.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Type *string `json:"Type,omitnil,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,omitnil,omitempty" name:"Suggestion"`

	// Input information
	// Note: this field may return null, indicating that no valid values can be obtained.
	MediaInfo *MediaInfo `json:"MediaInfo,omitnil,omitempty" name:"MediaInfo"`

	// 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.
	Labels []*TaskLabel `json:"Labels,omitnil,omitempty" name:"Labels"`

	// This field is used to return the creation time of the queried task in ISO 8601 format.
	CreatedAt *string `json:"CreatedAt,omitnil,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,omitnil,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.
	BizType *string `json:"BizType,omitnil,omitempty" name:"BizType"`

	// This field is used to pass in the type of an audio 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,omitnil,omitempty" name:"Type"`

	// This field is used to pass in the operation suggestion of an audio 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,omitnil,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,omitnil,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,omitnil,omitempty" name:"DataId"`

	// This field is optional and indicates the name of an audio moderation task for subsequent query and management of moderation tasks.
	Name *string `json:"Name,omitnil,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,omitnil,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,omitnil,omitempty" name:"Label"`

	// This field is used to return the operation suggestion for the current 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,omitnil,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,omitnil,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,omitnil,omitempty" name:"SubLabel"`
}

type TaskResult 

type TaskResult struct {
	// This field is used to return the `DataId` passed in within the `TaskInput` structure when an audio 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,omitnil,omitempty" name:"DataId"`

	// This field is used to return the ID of an audio 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,omitnil,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,omitnil,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,omitnil,omitempty" name:"Message"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.