com.tencentcloudapi.ims.v20201229.models

Class OcrResult

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ims.v20201229.models.OcrResult

public class OcrResult
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
OcrResult()
OcrResult(OcrResult 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
OcrTextDetail[]	getDetails() Get This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position.
String	getLabel() Get This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model.
String	getScene() Get This field indicates the recognition scenario.
Long	getScore() Get This field is used to return the confidence under the current tag (Label).
String	getSubLabel() Get This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.
String	getSuggestion() Get This field is used to return the operation suggestion for the maliciousness tag with the highest priority.
String	getText() Get This field is used to return the text information recognized by OCR.
void	setDetails(OcrTextDetail[] Details) Set This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position.
void	setLabel(String Label) Set This field is used to return the maliciousness tag with the highest priority in the OCR detection result, which represents the moderation result suggested by the model.
void	setScene(String Scene) Set This field indicates the recognition scenario.
void	setScore(Long Score) Set This field is used to return the confidence under the current tag (Label).
void	setSubLabel(String SubLabel) Set This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.
void	setSuggestion(String Suggestion) Set This field is used to return the operation suggestion for the maliciousness tag with the highest priority.
void	setText(String Text) Set This field is used to return the text information recognized by OCR.
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, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrResult

public OcrResult()

OcrResult

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

getScene

public String getScene()

Get This field indicates the recognition scenario. Default value: OCR (image OCR).

Returns:

Scene This field indicates the recognition scenario. Default value: OCR (image OCR).

setScene

public void setScene(String Scene)

Set This field indicates the recognition scenario. Default value: OCR (image OCR).

Parameters:

Scene - This field indicates the recognition scenario. Default value: OCR (image OCR).

getSuggestion

public String getSuggestion()

Get This field is used to return the operation suggestion for the maliciousness tag with the highest priority. 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 maliciousness tag with the highest priority. 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 maliciousness tag with the highest priority. 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 maliciousness tag with the highest priority. 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 OCR detection result, 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 OCR detection result, 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 OCR detection result, 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 OCR detection result, 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 detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.

Returns:

SubLabel This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.

setSubLabel

public void setSubLabel(String SubLabel)

Set This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.

Parameters:

SubLabel - This field is used to return the detection result for a subtag under the current tag (Label), such as *Porn-SexBehavior*.

getScore

public Long getScore()

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

Returns:

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

setScore

public void setScore(Long Score)

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

Parameters:

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

getDetails

public OcrTextDetail[] getDetails()

Get This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

Details This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position. Note: this field may return null, indicating that no valid values can be obtained.

setDetails

public void setDetails(OcrTextDetail[] Details)

Set This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

Details - This field is used to return the details of the OCR recognition result, such as text content, tag, and recognition frame position. Note: this field may return null, indicating that no valid values can be obtained.

getText

public String getText()

Get This field is used to return the text information recognized by OCR.

Returns:

Text This field is used to return the text information recognized by OCR.

setText

public void setText(String Text)

Set This field is used to return the text information recognized by OCR.

Parameters:

Text - This field is used to return the text information recognized by OCR.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel