com.tencentcloudapi.ims.v20201229.models

Class OcrTextDetail

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ims.v20201229.models.OcrTextDetail

public class OcrTextDetail
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
OcrTextDetail()
OcrTextDetail(OcrTextDetail 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[]	getKeywords() Get This parameter is used to return the hit keyword under the current tag (label).
String	getLabel() Get This field is used to return the maliciousness tag in the detection result. 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.
String	getLibId() Get This field is **valid only when `Label` is `Custom` (custom keyword)**.
String	getLibName() Get This field is **valid only when `Label` is `Custom` (custom keyword)**.
Location	getLocation() Get This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text.
Long	getRate() Get This parameter is used to return the confidence of the text OCR result.
Long	getScore() Get This parameter is used to return the model hit score of the current maliciousness tag.
String	getSubLabel() Get This field is used to return the maliciousness subtag that corresponds to the detection result.
String	getText() Get This field is used to return the text content recognized by OCR. Note: OCR can recognize text of **up to 5,000 bytes**.
void	setKeywords(String[] Keywords) Set This parameter is used to return the hit keyword under the current tag (label).
void	setLabel(String Label) Set This field is used to return the maliciousness tag in the detection result. 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.
void	setLibId(String LibId) Set This field is **valid only when `Label` is `Custom` (custom keyword)**.
void	setLibName(String LibName) Set This field is **valid only when `Label` is `Custom` (custom keyword)**.
void	setLocation(Location Location) Set This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text.
void	setRate(Long Rate) Set This parameter is used to return the confidence of the text OCR result.
void	setScore(Long Score) Set This parameter is used to return the model hit score of the current maliciousness tag.
void	setSubLabel(String SubLabel) Set This field is used to return the maliciousness subtag that corresponds to the detection result.
void	setText(String Text) Set This field is used to return the text content recognized by OCR. Note: OCR can recognize text of **up to 5,000 bytes**.
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

OcrTextDetail

public OcrTextDetail()

OcrTextDetail

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

getText

public String getText()

Get This field is used to return the text content recognized by OCR.
Note: OCR can recognize text of **up to 5,000 bytes**.

Returns:

Text This field is used to return the text content recognized by OCR.
Note: OCR can recognize text of **up to 5,000 bytes**.

setText

public void setText(String Text)

Set This field is used to return the text content recognized by OCR.
Note: OCR can recognize text of **up to 5,000 bytes**.

Parameters:

Text - This field is used to return the text content recognized by OCR.
Note: OCR can recognize text of **up to 5,000 bytes**.

getLabel

public String getLabel()

Get This field is used to return the maliciousness tag in the detection result.
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 in the detection result.
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 in the detection result.
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 in the detection result.
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.

getLibId

public String getLibId()

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

Returns:

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

setLibId

public void setLibId(String LibId)

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

Parameters:

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

getLibName

public String getLibName()

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

Returns:

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

setLibName

public void setLibName(String LibName)

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

Parameters:

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

getKeywords

public String[] getKeywords()

Get This parameter is used to return the hit keyword under the current tag (label).

Returns:

Keywords This parameter is used to return the hit keyword under the current tag (label).

setKeywords

public void setKeywords(String[] Keywords)

Set This parameter is used to return the hit keyword under the current tag (label).

Parameters:

Keywords - This parameter is used to return the hit keyword under the current tag (label).

getScore

public Long getScore()

Get This parameter is used to return the model hit score of the current maliciousness tag. Value range: **0–100**, where a higher value indicates that the current scenario agrees more with the scenario represented by the maliciousness tag.

Returns:

Score This parameter is used to return the model hit score of the current maliciousness tag. Value range: **0–100**, where a higher value indicates that the current scenario agrees more with the scenario represented by the maliciousness tag.

setScore

public void setScore(Long Score)

Set This parameter is used to return the model hit score of the current maliciousness tag. Value range: **0–100**, where a higher value indicates that the current scenario agrees more with the scenario represented by the maliciousness tag.

Parameters:

Score - This parameter is used to return the model hit score of the current maliciousness tag. Value range: **0–100**, where a higher value indicates that the current scenario agrees more with the scenario represented by the maliciousness tag.

getLocation

public Location getLocation()

Get This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text.

Returns:

Location This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text.

setLocation

public void setLocation(Location Location)

Set This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text.

Parameters:

Location - This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text.

getRate

public Long getRate()

Get This parameter is used to return the confidence of the text OCR result. Valid values: **0** (**the lowest confidence**)–**100** (**the highest confidence**), where a higher value indicates that it is more likely that the image contains the recognized text; for example, *Hello 99* indicates that it is highly likely that the text in the OCR recognition frame is "Hello".

Returns:

Rate This parameter is used to return the confidence of the text OCR result. Valid values: **0** (**the lowest confidence**)–**100** (**the highest confidence**), where a higher value indicates that it is more likely that the image contains the recognized text; for example, *Hello 99* indicates that it is highly likely that the text in the OCR recognition frame is "Hello".

setRate

public void setRate(Long Rate)

Set This parameter is used to return the confidence of the text OCR result. Valid values: **0** (**the lowest confidence**)–**100** (**the highest confidence**), where a higher value indicates that it is more likely that the image contains the recognized text; for example, *Hello 99* indicates that it is highly likely that the text in the OCR recognition frame is "Hello".

Parameters:

Rate - This parameter is used to return the confidence of the text OCR result. Valid values: **0** (**the lowest confidence**)–**100** (**the highest confidence**), where a higher value indicates that it is more likely that the image contains the recognized text; for example, *Hello 99* indicates that it is highly likely that the text in the OCR recognition frame is "Hello".

getSubLabel

public String getSubLabel()

Get This field is used to return the maliciousness subtag that corresponds to the detection result.

Returns:

SubLabel This field is used to return the maliciousness subtag that corresponds to the detection result.

setSubLabel

public void setSubLabel(String SubLabel)

Set This field is used to return the maliciousness subtag that corresponds to the detection result.

Parameters:

SubLabel - This field is used to return the maliciousness subtag that corresponds to the detection result.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel