com.tencentcloudapi.ims.v20201229.models

Class ImageModerationResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ims.v20201229.models.ImageModerationResponse

public class ImageModerationResponse
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ImageModerationResponse()
ImageModerationResponse(ImageModerationResponse 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 is used to return the `BizType` in the request parameters that correspond to the detected object.
String	getDataId() Get This field is used to return the `DataId` in the request parameters that correspond to the detected object.
String	getExtra() Get This field is used to return the additional information (Extra) configured based on your needs.
String	getFileMD5() Get This field is used to return the MD5 checksum of the detected object for easier verification of the file integrity.
String	getLabel() Get This field is used to return the **maliciousness tag with the highest priority** in the detection result (LabelResults), which represents the moderation result suggested by the model.
LabelResult[]	getLabelResults() Get This field is used to return the detailed recognition result for the maliciousness tag hit by the categorization model, such as porn, advertising, or any other offensive, unsafe, or inappropriate type of content.
LibResult[]	getLibResults() Get This field is used to return the result of recognition based on image risk libraries (blocklist and allowlist).
ObjectResult[]	getObjectResults() Get This field is used to return the detailed detection result of the object detection model, including the tag name hit by the content such as object, advertising logo, or QR code, tag score, coordinate information, scenario recognition result, and operation suggestion.
OcrResult[]	getOcrResults() Get This field is used to return the detailed text OCR result, including the text coordinate information, text recognition result, and operation suggestion.
RecognitionResult[]	getRecognitionResults() Get Image recognition result, including the hit tags, confidence and location.
String	getRequestId() Get The unique request ID, which is returned for each request.
Long	getScore() Get Confidence score of the under the current label.
String	getSubLabel() Get This field is used to return the subtag name under the maliciousness tag with the highest priority hit by the detection result, such as *Porn-SexBehavior*.
String	getSuggestion() Get This field is used to return the operation suggestion for the `Label` tag.
void	setBizType(String BizType) Set This field is used to return the `BizType` in the request parameters that correspond to the detected object.
void	setDataId(String DataId) Set This field is used to return the `DataId` in the request parameters that correspond to the detected object.
void	setExtra(String Extra) Set This field is used to return the additional information (Extra) configured based on your needs.
void	setFileMD5(String FileMD5) Set This field is used to return the MD5 checksum of the detected object for easier verification of the file integrity.
void	setLabel(String Label) Set This field is used to return the **maliciousness tag with the highest priority** in the detection result (LabelResults), which represents the moderation result suggested by the model.
void	setLabelResults(LabelResult[] LabelResults) Set This field is used to return the detailed recognition result for the maliciousness tag hit by the categorization model, such as porn, advertising, or any other offensive, unsafe, or inappropriate type of content.
void	setLibResults(LibResult[] LibResults) Set This field is used to return the result of recognition based on image risk libraries (blocklist and allowlist).
void	setObjectResults(ObjectResult[] ObjectResults) Set This field is used to return the detailed detection result of the object detection model, including the tag name hit by the content such as object, advertising logo, or QR code, tag score, coordinate information, scenario recognition result, and operation suggestion.
void	setOcrResults(OcrResult[] OcrResults) Set This field is used to return the detailed text OCR result, including the text coordinate information, text recognition result, and operation suggestion.
void	setRecognitionResults(RecognitionResult[] RecognitionResults) Set Image recognition result, including the hit tags, confidence and location.
void	setRequestId(String RequestId) Set The unique request ID, which is returned for each request.
void	setScore(Long Score) Set Confidence score of the under the current label.
void	setSubLabel(String SubLabel) Set This field is used to return the subtag name under the maliciousness tag with the highest priority hit by the detection result, such as *Porn-SexBehavior*.
void	setSuggestion(String Suggestion) Set This field is used to return the operation suggestion for the `Label` tag.
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

ImageModerationResponse

public ImageModerationResponse()

ImageModerationResponse

public ImageModerationResponse(ImageModerationResponse 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

getSuggestion

public String getSuggestion()

Get This field is used to return the operation suggestion for the `Label` 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.
Returned values: **Block**, **Review**, **Pass**.

Returns:

Suggestion This field is used to return the operation suggestion for the `Label` 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.
Returned values: **Block**, **Review**, **Pass**.

setSuggestion

public void setSuggestion(String Suggestion)

Set This field is used to return the operation suggestion for the `Label` 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.
Returned values: **Block**, **Review**, **Pass**.

Parameters:

Suggestion - This field is used to return the operation suggestion for the `Label` 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.
Returned values: **Block**, **Review**, **Pass**.

getLabel

public String getLabel()

Get This field is used to return the **maliciousness tag with the highest priority** in the detection result (LabelResults), which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
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.

Returns:

Label This field is used to return the **maliciousness tag with the highest priority** in the detection result (LabelResults), which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
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.

setLabel

public void setLabel(String Label)

Set This field is used to return the **maliciousness tag with the highest priority** in the detection result (LabelResults), which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
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.

Parameters:

Label - This field is used to return the **maliciousness tag with the highest priority** in the detection result (LabelResults), which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions according to your business needs.
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.

getSubLabel

public String getSubLabel()

Get This field is used to return the subtag name under the maliciousness tag with the highest priority hit by the detection result, such as *Porn-SexBehavior*. If no subtag is hit, an empty string will be returned.

Returns:

SubLabel This field is used to return the subtag name under the maliciousness tag with the highest priority hit by the detection result, such as *Porn-SexBehavior*. If no subtag is hit, an empty string will be returned.

setSubLabel

public void setSubLabel(String SubLabel)

Set This field is used to return the subtag name under the maliciousness tag with the highest priority hit by the detection result, such as *Porn-SexBehavior*. If no subtag is hit, an empty string will be returned.

Parameters:

SubLabel - This field is used to return the subtag name under the maliciousness tag with the highest priority hit by the detection result, such as *Porn-SexBehavior*. If no subtag is hit, an empty string will be returned.

getScore

public Long getScore()

Get Confidence score of the under the current label. Value range: 0 (**the lowest confidence**) to 100 (**the highest confidence**). For example, *Porn 99* indicates that the image is highly likely to be pornographic, while *Porn 0* indicates that the image is not pornographic.

Returns:

Score Confidence score of the under the current label. Value range: 0 (**the lowest confidence**) to 100 (**the highest confidence**). For example, *Porn 99* indicates that the image is highly likely to be pornographic, while *Porn 0* indicates that the image is not pornographic.

setScore

public void setScore(Long Score)

Set Confidence score of the under the current label. Value range: 0 (**the lowest confidence**) to 100 (**the highest confidence**). For example, *Porn 99* indicates that the image is highly likely to be pornographic, while *Porn 0* indicates that the image is not pornographic.

Parameters:

Score - Confidence score of the under the current label. Value range: 0 (**the lowest confidence**) to 100 (**the highest confidence**). For example, *Porn 99* indicates that the image is highly likely to be pornographic, while *Porn 0* indicates that the image is not pornographic.

getLabelResults

public LabelResult[] getLabelResults()

Get This field is used to return the detailed recognition result for the maliciousness tag hit by the categorization model, such as porn, advertising, or any other offensive, unsafe, or inappropriate type of content. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

LabelResults This field is used to return the detailed recognition result for the maliciousness tag hit by the categorization model, such as porn, advertising, or any other offensive, unsafe, or inappropriate type of content. Note: this field may return null, indicating that no valid values can be obtained.

setLabelResults

public void setLabelResults(LabelResult[] LabelResults)

Set This field is used to return the detailed recognition result for the maliciousness tag hit by the categorization model, such as porn, advertising, or any other offensive, unsafe, or inappropriate type of content. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

LabelResults - This field is used to return the detailed recognition result for the maliciousness tag hit by the categorization model, such as porn, advertising, or any other offensive, unsafe, or inappropriate type of content. Note: this field may return null, indicating that no valid values can be obtained.

getObjectResults

public ObjectResult[] getObjectResults()

Get This field is used to return the detailed detection result of the object detection model, including the tag name hit by the content such as object, advertising logo, or QR code, tag score, coordinate information, scenario recognition result, and operation suggestion. For more information on the returned value, see the description of the `ObjectResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

ObjectResults This field is used to return the detailed detection result of the object detection model, including the tag name hit by the content such as object, advertising logo, or QR code, tag score, coordinate information, scenario recognition result, and operation suggestion. For more information on the returned value, see the description of the `ObjectResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

setObjectResults

public void setObjectResults(ObjectResult[] ObjectResults)

Set This field is used to return the detailed detection result of the object detection model, including the tag name hit by the content such as object, advertising logo, or QR code, tag score, coordinate information, scenario recognition result, and operation suggestion. For more information on the returned value, see the description of the `ObjectResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

ObjectResults - This field is used to return the detailed detection result of the object detection model, including the tag name hit by the content such as object, advertising logo, or QR code, tag score, coordinate information, scenario recognition result, and operation suggestion. For more information on the returned value, see the description of the `ObjectResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

getOcrResults

public OcrResult[] getOcrResults()

Get This field is used to return the detailed text OCR result, including the text coordinate information, text recognition result, and operation suggestion. For more information on the returned value, see the description of the `OcrResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

OcrResults This field is used to return the detailed text OCR result, including the text coordinate information, text recognition result, and operation suggestion. For more information on the returned value, see the description of the `OcrResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

setOcrResults

public void setOcrResults(OcrResult[] OcrResults)

Set This field is used to return the detailed text OCR result, including the text coordinate information, text recognition result, and operation suggestion. For more information on the returned value, see the description of the `OcrResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

OcrResults - This field is used to return the detailed text OCR result, including the text coordinate information, text recognition result, and operation suggestion. For more information on the returned value, see the description of the `OcrResults` data structure. Note: this field may return null, indicating that no valid values can be obtained.

getLibResults

public LibResult[] getLibResults()

Get This field is used to return the result of recognition based on image risk libraries (blocklist and allowlist). For more information on the returned value, see the description of the `LibResults` data structure.
Note: currently, **you cannot customize image risk libraries**. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

LibResults This field is used to return the result of recognition based on image risk libraries (blocklist and allowlist). For more information on the returned value, see the description of the `LibResults` data structure.
Note: currently, **you cannot customize image risk libraries**. Note: this field may return null, indicating that no valid values can be obtained.

setLibResults

public void setLibResults(LibResult[] LibResults)

Set This field is used to return the result of recognition based on image risk libraries (blocklist and allowlist). For more information on the returned value, see the description of the `LibResults` data structure.
Note: currently, **you cannot customize image risk libraries**. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

LibResults - This field is used to return the result of recognition based on image risk libraries (blocklist and allowlist). For more information on the returned value, see the description of the `LibResults` data structure.
Note: currently, **you cannot customize image risk libraries**. Note: this field may return null, indicating that no valid values can be obtained.

getDataId

public String getDataId()

Get This field is used to return the `DataId` in the request parameters that correspond to the detected object.

Returns:

DataId This field is used to return the `DataId` in the request parameters that correspond to the detected object.

setDataId

public void setDataId(String DataId)

Set This field is used to return the `DataId` in the request parameters that correspond to the detected object.

Parameters:

DataId - This field is used to return the `DataId` in the request parameters that correspond to the detected object.

getBizType

public String getBizType()

Get This field is used to return the `BizType` in the request parameters that correspond to the detected object.

Returns:

BizType This field is used to return the `BizType` in the request parameters that correspond to the detected object.

setBizType

public void setBizType(String BizType)

Set This field is used to return the `BizType` in the request parameters that correspond to the detected object.

Parameters:

BizType - This field is used to return the `BizType` in the request parameters that correspond to the detected object.

getExtra

public String getExtra()

Get This field is used to return the additional information (Extra) configured based on your needs. If it is not configured, an empty value will be returned by default.
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.

Returns:

Extra This field is used to return the additional information (Extra) configured based on your needs. If it is not configured, an empty value will be returned by default.
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.

setExtra

public void setExtra(String Extra)

Set This field is used to return the additional information (Extra) configured based on your needs. If it is not configured, an empty value will be returned by default.
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.

Parameters:

Extra - This field is used to return the additional information (Extra) configured based on your needs. If it is not configured, an empty value will be returned by default.
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.

getFileMD5

public String getFileMD5()

Get This field is used to return the MD5 checksum of the detected object for easier verification of the file integrity.

Returns:

FileMD5 This field is used to return the MD5 checksum of the detected object for easier verification of the file integrity.

setFileMD5

public void setFileMD5(String FileMD5)

Set This field is used to return the MD5 checksum of the detected object for easier verification of the file integrity.

Parameters:

FileMD5 - This field is used to return the MD5 checksum of the detected object for easier verification of the file integrity.

getRecognitionResults

public RecognitionResult[] getRecognitionResults()

Get Image recognition result, including the hit tags, confidence and location. Note: This field may return `null`, indicating that no valid values can be obtained.

Returns:

RecognitionResults Image recognition result, including the hit tags, confidence and location. Note: This field may return `null`, indicating that no valid values can be obtained.

setRecognitionResults

public void setRecognitionResults(RecognitionResult[] RecognitionResults)

Set Image recognition result, including the hit tags, confidence and location. Note: This field may return `null`, indicating that no valid values can be obtained.

Parameters:

RecognitionResults - Image recognition result, including the hit tags, confidence and location. Note: This field may return `null`, indicating that no valid values can be obtained.

getRequestId

public String getRequestId()

Get The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, which is returned for each request. RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, which is returned for each request. RequestId is required for locating a problem.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel