com.tencentcloudapi.ocr.v20181119

Class OcrClient

java.lang.Object

com.tencentcloudapi.common.AbstractClient

com.tencentcloudapi.ocr.v20181119.OcrClient

public class OcrClient
extends AbstractClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors

Constructor and Description
OcrClient(Credential credential, String region)
OcrClient(Credential credential, String region, ClientProfile profile)

Method Summary

Modifier and Type	Method and Description
BankCardOCRResponse	BankCardOCR(BankCardOCRRequest req) This API is used to detect and recognize key fields such as the card number, bank information, and expiration date on mainstream bank cards in Mainland China.
GeneralBasicOCRResponse	GeneralBasicOCR(GeneralBasicOCRRequest req) This API is used to detect and recognize characters in an image in the following 19 languages: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, and Thai.
HKIDCardOCRResponse	HKIDCardOCR(HKIDCardOCRRequest req) This API is used to recognize key fields on the photo side of a Hong Kong (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute.
MLIDCardOCRResponse	MLIDCardOCR(MLIDCardOCRRequest req) This API is used to recognize a Malaysian identity card.
MLIDPassportOCRResponse	MLIDPassportOCR(MLIDPassportOCRRequest req) This API is used to recognize a passport issued outside Mainland China.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object

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

Constructor Detail

OcrClient

public OcrClient(Credential credential,
                 String region)

OcrClient

public OcrClient(Credential credential,
                 String region,
                 ClientProfile profile)

Method Detail

BankCardOCR

public BankCardOCRResponse BankCardOCR(BankCardOCRRequest req)
                                throws TencentCloudSDKException

This API is used to detect and recognize key fields such as the card number, bank information, and expiration date on mainstream bank cards in Mainland China.

Parameters:

req - BankCardOCRRequest

Returns:

BankCardOCRResponse

Throws:

TencentCloudSDKException

GeneralBasicOCR

public GeneralBasicOCRResponse GeneralBasicOCR(GeneralBasicOCRRequest req)
                                        throws TencentCloudSDKException

This API is used to detect and recognize characters in an image in the following 19 languages: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, and Thai. Mixed characters in English and each supported language can be recognized together. It can recognize printed text in paper documents, online images, ads, signboards, menus, video titles, profile photos, etc. Product strengths: it can automatically recognize the text language, return the text box coordinate information, and automatically rotate tilted text to the upright direction. The differences between different editions of general print recognition are as detailed below:

	**(Recommended)** General Print Recognition	**(Recommended)** General Print Recognition (High-Precision)	General Print Recognition (Simplified)
Use case	It is suitable for recognition of printed text in all general scenarios	It is suitable for content with high recognition difficulty such as a large number of characters, long strings of digits, small characters, blurry characters, and tilted text	It is suitable for fast text recognition, which compromises the accuracy and recall rate but is more cost-effective
Recognition accuracy rate	96%	99%	91%
Price	Medium	High	Low
Supported languages	Chinese, English, Chinese-English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, and Thai	Chinese, English, and Chinese-English	Chinese, English, and Chinese-English
Automatic language detection	Supported	Supported	Supported
Return of text line coordinates	Supported	Supported	Supported
Automatic rotation correction	Rotation recognition is supported, and the angle information can be returned	Rotation recognition is supported, but no angle information can be returned	Rotation recognition is supported, and the angle information can be returned

Parameters:

req - GeneralBasicOCRRequest

Returns:

GeneralBasicOCRResponse

Throws:

TencentCloudSDKException

HKIDCardOCR

public HKIDCardOCRResponse HKIDCardOCR(HKIDCardOCRRequest req)
                                throws TencentCloudSDKException

This API is used to recognize key fields on the photo side of a Hong Kong (China) identity card, including name in Chinese, name in English, telecode for name, date of birth, gender, document symbol, date of the first issue, date of the last receipt, identity card number, and permanent residency attribute. It can check for card authenticity and crop the identity photo. This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://cloud.tencent.com/about/connect).

Parameters:

req - HKIDCardOCRRequest

Returns:

HKIDCardOCRResponse

Throws:

TencentCloudSDKException

MLIDCardOCR

public MLIDCardOCRResponse MLIDCardOCR(MLIDCardOCRRequest req)
                                throws TencentCloudSDKException

This API is used to recognize a Malaysian identity card. Recognizable fields include identity card number, name, gender, and address. It has the features of cropping identity photos and alarming for photographed or photocopied documents. This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://cloud.tencent.com/about/connect).

Parameters:

req - MLIDCardOCRRequest

Returns:

MLIDCardOCRResponse

Throws:

TencentCloudSDKException

MLIDPassportOCR

public MLIDPassportOCRResponse MLIDPassportOCR(MLIDPassportOCRRequest req)
                                        throws TencentCloudSDKException

This API is used to recognize a passport issued outside Mainland China. Recognizable fields include passport ID, name, date of birth, gender, expiration date, issuing country/region, and nationality. It has the features of cropping identity photos and alarming for spoofed or photocopied documents. This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://cloud.tencent.com/about/connect).

Parameters:

req - MLIDPassportOCRRequest

Returns:

MLIDPassportOCRResponse

Throws:

TencentCloudSDKException