com.tencentcloudapi.ims.v20201229.models

Class ImageModerationRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ims.v20201229.models.ImageModerationRequest

public class ImageModerationRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ImageModerationRequest()
ImageModerationRequest(ImageModerationRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getBizType() Get This field indicates the specific number of the policy, which is used for API scheduling and can be configured in the CMS console.
String	getDataId() Get This field indicates the data ID assigned by you to the object to be detected for easier file identification and management. It **can contain up to 64 letters, digits, and special symbols (_-@#)**.
Device	getDevice() Get This field indicates the information of the device that corresponds to the object to be detected.
String	getFileContent() Get This field indicates the Base64 encoding of the image to be detected.
String	getFileUrl() Get URL of the image to moderate.
Long	getInterval() Get **For GIF/long image detection only**.
Long	getMaxFrames() Get **For GIF/long image detection only**.
User	getUser() Get This field indicates the information of the user that corresponds to the object to be detected.
void	setBizType(String BizType) Set This field indicates the specific number of the policy, which is used for API scheduling and can be configured in the CMS console.
void	setDataId(String DataId) Set This field indicates the data ID assigned by you to the object to be detected for easier file identification and management. It **can contain up to 64 letters, digits, and special symbols (_-@#)**.
void	setDevice(Device Device) Set This field indicates the information of the device that corresponds to the object to be detected.
void	setFileContent(String FileContent) Set This field indicates the Base64 encoding of the image to be detected.
void	setFileUrl(String FileUrl) Set URL of the image to moderate.
void	setInterval(Long Interval) Set **For GIF/long image detection only**.
void	setMaxFrames(Long MaxFrames) Set **For GIF/long image detection only**.
void	setUser(User User) Set This field indicates the information of the user that corresponds to the object to be detected.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageModerationRequest

public ImageModerationRequest()

ImageModerationRequest

public ImageModerationRequest(ImageModerationRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getBizType

public String getBizType()

Get 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.
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.

Returns:

BizType 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.
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.

setBizType

public void setBizType(String BizType)

Set 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.
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.

Parameters:

BizType - 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.
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.

getDataId

public String getDataId()

Get This field indicates the data ID assigned by you to the object to be detected for easier file identification and management.
It **can contain up to 64 letters, digits, and special symbols (_-@#)**.

Returns:

DataId This field indicates the data ID assigned by you to the object to be detected for easier file identification and management.
It **can contain up to 64 letters, digits, and special symbols (_-@#)**.

setDataId

public void setDataId(String DataId)

Set This field indicates the data ID assigned by you to the object to be detected for easier file identification and management.
It **can contain up to 64 letters, digits, and special symbols (_-@#)**.

Parameters:

DataId - This field indicates the data ID assigned by you to the object to be detected for easier file identification and management.
It **can contain up to 64 letters, digits, and special symbols (_-@#)**.

getFileContent

public String getFileContent()

Get This field indicates the Base64 encoding of the image to be detected. The image **size cannot exceed 5 MB**. **A resolution of 256x256 or higher is recommended**; otherwise, the recognition effect may be affected.
Note: **you must enter a value for either this field or `FileUrl`**.

Returns:

FileContent This field indicates the Base64 encoding of the image to be detected. The image **size cannot exceed 5 MB**. **A resolution of 256x256 or higher is recommended**; otherwise, the recognition effect may be affected.
Note: **you must enter a value for either this field or `FileUrl`**.

setFileContent

public void setFileContent(String FileContent)

Set This field indicates the Base64 encoding of the image to be detected. The image **size cannot exceed 5 MB**. **A resolution of 256x256 or higher is recommended**; otherwise, the recognition effect may be affected.
Note: **you must enter a value for either this field or `FileUrl`**.

Parameters:

FileContent - This field indicates the Base64 encoding of the image to be detected. The image **size cannot exceed 5 MB**. **A resolution of 256x256 or higher is recommended**; otherwise, the recognition effect may be affected.
Note: **you must enter a value for either this field or `FileUrl`**.

getFileUrl

public String getFileUrl()

Get URL of the image to moderate. It supports PNG, JPG, JPEG, BMP, GIF AND WEBP files. The file **cannot exceed 5 MB** and the resolution should not below **256*246**. The default timeout period is 3 seconds. Note that **redirection URLs may be blocked by security policies**. In this case, an error message will return. For example, if an HTTP request gets the 302 code, the error `ResourceUnavailable.ImageDownloadError` is returned.
**Either `FileUrl` or `FileContent` must be specified.

Returns:

FileUrl URL of the image to moderate. It supports PNG, JPG, JPEG, BMP, GIF AND WEBP files. The file **cannot exceed 5 MB** and the resolution should not below **256*246**. The default timeout period is 3 seconds. Note that **redirection URLs may be blocked by security policies**. In this case, an error message will return. For example, if an HTTP request gets the 302 code, the error `ResourceUnavailable.ImageDownloadError` is returned.
**Either `FileUrl` or `FileContent` must be specified.

setFileUrl

public void setFileUrl(String FileUrl)

Set URL of the image to moderate. It supports PNG, JPG, JPEG, BMP, GIF AND WEBP files. The file **cannot exceed 5 MB** and the resolution should not below **256*246**. The default timeout period is 3 seconds. Note that **redirection URLs may be blocked by security policies**. In this case, an error message will return. For example, if an HTTP request gets the 302 code, the error `ResourceUnavailable.ImageDownloadError` is returned.
**Either `FileUrl` or `FileContent` must be specified.

Parameters:

FileUrl - URL of the image to moderate. It supports PNG, JPG, JPEG, BMP, GIF AND WEBP files. The file **cannot exceed 5 MB** and the resolution should not below **256*246**. The default timeout period is 3 seconds. Note that **redirection URLs may be blocked by security policies**. In this case, an error message will return. For example, if an HTTP request gets the 302 code, the error `ResourceUnavailable.ImageDownloadError` is returned.
**Either `FileUrl` or `FileContent` must be specified.

getInterval

public Long getInterval()

Get **For GIF/long image detection only**. This field indicates the GIF frame capturing frequency (the image interval for capturing a frame for detection). For long images, you should round the width:height ratio as the total number of images to be split. The default value is 0, where only the first frame of the GIF image will be detected, and the long image will not be split.
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

Returns:

Interval **For GIF/long image detection only**. This field indicates the GIF frame capturing frequency (the image interval for capturing a frame for detection). For long images, you should round the width:height ratio as the total number of images to be split. The default value is 0, where only the first frame of the GIF image will be detected, and the long image will not be split.
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

setInterval

public void setInterval(Long Interval)

Set **For GIF/long image detection only**. This field indicates the GIF frame capturing frequency (the image interval for capturing a frame for detection). For long images, you should round the width:height ratio as the total number of images to be split. The default value is 0, where only the first frame of the GIF image will be detected, and the long image will not be split.
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

Parameters:

Interval - **For GIF/long image detection only**. This field indicates the GIF frame capturing frequency (the image interval for capturing a frame for detection). For long images, you should round the width:height ratio as the total number of images to be split. The default value is 0, where only the first frame of the GIF image will be detected, and the long image will not be split.
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

getMaxFrames

public Long getMaxFrames()

Get **For GIF/long image detection only**. This field indicates the maximum number of frames that can be captured. The default value is 1, where only the first frame of the input GIF image will be detected, and the long image will not be split (which may cause a processing timeout).
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

Returns:

MaxFrames **For GIF/long image detection only**. This field indicates the maximum number of frames that can be captured. The default value is 1, where only the first frame of the input GIF image will be detected, and the long image will not be split (which may cause a processing timeout).
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

setMaxFrames

public void setMaxFrames(Long MaxFrames)

Set **For GIF/long image detection only**. This field indicates the maximum number of frames that can be captured. The default value is 1, where only the first frame of the input GIF image will be detected, and the long image will not be split (which may cause a processing timeout).
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

Parameters:

MaxFrames - **For GIF/long image detection only**. This field indicates the maximum number of frames that can be captured. The default value is 1, where only the first frame of the input GIF image will be detected, and the long image will not be split (which may cause a processing timeout).
Note: the `Interval` and `MaxFrames` parameters need to be used in combination; for example, if `Interval` is `3` and `MaxFrames` is `400`, the GIF/long image will be detected once every two frames for up to 400 frames.

getUser

public User getUser()

Get This field indicates the information of the user that corresponds to the object to be detected. It can be passed in to identify the user involved in the violation.

Returns:

User This field indicates the information of the user that corresponds to the object to be detected. It can be passed in to identify the user involved in the violation.

setUser

public void setUser(User User)

Set This field indicates the information of the user that corresponds to the object to be detected. It can be passed in to identify the user involved in the violation.

Parameters:

User - This field indicates the information of the user that corresponds to the object to be detected. It can be passed in to identify the user involved in the violation.

getDevice

public Device getDevice()

Get This field indicates the information of the device that corresponds to the object to be detected. It can be passed in to identify the device involved in the violation.

Returns:

Device This field indicates the information of the device that corresponds to the object to be detected. It can be passed in to identify the device involved in the violation.

setDevice

public void setDevice(Device Device)

Set This field indicates the information of the device that corresponds to the object to be detected. It can be passed in to identify the device involved in the violation.

Parameters:

Device - This field indicates the information of the device that corresponds to the object to be detected. It can be passed in to identify the device involved in the violation.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel