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.
GeneralAccurateOCRResponse	GeneralAccurateOCR(GeneralAccurateOCRRequest req) This API is used to detect and recognize characters in an image.
GeneralBasicOCRResponse	GeneralBasicOCR(GeneralBasicOCRRequest req) This API is used to detect and recognize characters in an image in the following 20 languages: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, Thai, and Arabic.
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, including identity card number, name, gender, and address.
MLIDPassportOCRResponse	MLIDPassportOCR(MLIDPassportOCRRequest req) This API is used to recognize a passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions.
RecognizeIndonesiaIDCardOCRResponse	RecognizeIndonesiaIDCardOCR(RecognizeIndonesiaIDCardOCRRequest req) This API is used to recognize an Indonesian identity card.
RecognizeKoreanDrivingLicenseOCRResponse	RecognizeKoreanDrivingLicenseOCR(RecognizeKoreanDrivingLicenseOCRRequest req) This API is used to recognize a South Korean driver's license.
RecognizeKoreanIDCardOCRResponse	RecognizeKoreanIDCardOCR(RecognizeKoreanIDCardOCRRequest req) This API is used to recognize a South Korean ID card.
RecognizePhilippinesDrivingLicenseOCRResponse	RecognizePhilippinesDrivingLicenseOCR(RecognizePhilippinesDrivingLicenseOCRRequest req) This API is used to recognize a Philippine driver's license.
RecognizePhilippinesSssIDOCRResponse	RecognizePhilippinesSssIDOCR(RecognizePhilippinesSssIDOCRRequest req) This API is used to recognize a Philippine SSSID/UMID card.
RecognizePhilippinesTinIDOCRResponse	RecognizePhilippinesTinIDOCR(RecognizePhilippinesTinIDOCRRequest req) This API is used to recognize a Philippine TIN ID card.
RecognizePhilippinesUMIDOCRResponse	RecognizePhilippinesUMIDOCR(RecognizePhilippinesUMIDOCRRequest req) This API is used to recognize a Philippine Unified Multi-Purpose ID (UMID) card.
RecognizePhilippinesVoteIDOCRResponse	RecognizePhilippinesVoteIDOCR(RecognizePhilippinesVoteIDOCRRequest req) This API is used to recognize a Philippine voters ID card.
SmartStructuralOCRV2Response	SmartStructuralOCRV2(SmartStructuralOCRV2Request req) This API is used to recognize fields from cards, documents, bills, forms, contracts, and other structured information.
TableOCRResponse	TableOCR(TableOCRRequest req) This API is used to detect and recognize Chinese and English forms in images.

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. This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).

Parameters:

req - BankCardOCRRequest

Returns:

BankCardOCRResponse

Throws:

TencentCloudSDKException

GeneralAccurateOCR

public GeneralAccurateOCRResponse GeneralAccurateOCR(GeneralAccurateOCRRequest req)
                                              throws TencentCloudSDKException

This API is used to detect and recognize characters in an image. It can recognize Chinese, English, Chinese-English, digits, and special symbols and return the text box positions and characters. It is suitable for scenarios with a lot of characters in complex layouts and requiring high recognition accuracy, such as examination papers, online images, signboards, and legal documents. Strengths: compared with general print recognition, it provides higher-precision character recognition services. Its accuracy and recall rate are higher in difficult scenarios such as a large number of characters, long strings of digits, small characters, blurry characters, and tilted text. This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).

Parameters:

req - GeneralAccurateOCRRequest

Returns:

GeneralAccurateOCRResponse

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 20 languages: Chinese, English, Japanese, Korean, Spanish, French, German, Portuguese, Vietnamese, Malay, Russian, Italian, Dutch, Swedish, Finnish, Danish, Norwegian, Hungarian, Thai, and Arabic. 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. Strengths: it can automatically recognize the text language, return the text box coordinate information, and automatically rotate tilted text to the upright direction. This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).

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://intl.cloud.tencent.com/contact-sales).

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, including identity card number, name, gender, and address. It is also used to crop identity photos and give alarms for photographed or photocopied certificates. This API is not fully available for the time being. For more information, contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).

Parameters:

req - MLIDCardOCRRequest

Returns:

MLIDCardOCRResponse

Throws:

TencentCloudSDKException

MLIDPassportOCR

public MLIDPassportOCRResponse MLIDPassportOCR(MLIDPassportOCRRequest req)
                                        throws TencentCloudSDKException

This API is used to recognize a passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions. 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 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://intl.cloud.tencent.com/contact-sales).

Parameters:

req - MLIDPassportOCRRequest

Returns:

MLIDPassportOCRResponse

Throws:

TencentCloudSDKException

RecognizeIndonesiaIDCardOCR

public RecognizeIndonesiaIDCardOCRResponse RecognizeIndonesiaIDCardOCR(RecognizeIndonesiaIDCardOCRRequest req)
                                                                throws TencentCloudSDKException

This API is used to recognize an Indonesian identity card. The API request rate is limited to 20 requests/sec by default.

Parameters:

req - RecognizeIndonesiaIDCardOCRRequest

Returns:

RecognizeIndonesiaIDCardOCRResponse

Throws:

TencentCloudSDKException

RecognizeKoreanDrivingLicenseOCR

public RecognizeKoreanDrivingLicenseOCRResponse RecognizeKoreanDrivingLicenseOCR(RecognizeKoreanDrivingLicenseOCRRequest req)
                                                                          throws TencentCloudSDKException

This API is used to recognize a South Korean driver's license.

Parameters:

req - RecognizeKoreanDrivingLicenseOCRRequest

Returns:

RecognizeKoreanDrivingLicenseOCRResponse

Throws:

TencentCloudSDKException

RecognizeKoreanIDCardOCR

public RecognizeKoreanIDCardOCRResponse RecognizeKoreanIDCardOCR(RecognizeKoreanIDCardOCRRequest req)
                                                          throws TencentCloudSDKException

This API is used to recognize a South Korean ID card.

Parameters:

req - RecognizeKoreanIDCardOCRRequest

Returns:

RecognizeKoreanIDCardOCRResponse

Throws:

TencentCloudSDKException

RecognizePhilippinesDrivingLicenseOCR

public RecognizePhilippinesDrivingLicenseOCRResponse RecognizePhilippinesDrivingLicenseOCR(RecognizePhilippinesDrivingLicenseOCRRequest req)
                                                                                    throws TencentCloudSDKException

This API is used to recognize a Philippine driver's license.

Parameters:

req - RecognizePhilippinesDrivingLicenseOCRRequest

Returns:

RecognizePhilippinesDrivingLicenseOCRResponse

Throws:

TencentCloudSDKException

RecognizePhilippinesSssIDOCR

public RecognizePhilippinesSssIDOCRResponse RecognizePhilippinesSssIDOCR(RecognizePhilippinesSssIDOCRRequest req)
                                                                  throws TencentCloudSDKException

This API is used to recognize a Philippine SSSID/UMID card.

Parameters:

req - RecognizePhilippinesSssIDOCRRequest

Returns:

RecognizePhilippinesSssIDOCRResponse

Throws:

TencentCloudSDKException

RecognizePhilippinesTinIDOCR

public RecognizePhilippinesTinIDOCRResponse RecognizePhilippinesTinIDOCR(RecognizePhilippinesTinIDOCRRequest req)
                                                                  throws TencentCloudSDKException

This API is used to recognize a Philippine TIN ID card.

Parameters:

req - RecognizePhilippinesTinIDOCRRequest

Returns:

RecognizePhilippinesTinIDOCRResponse

Throws:

TencentCloudSDKException

RecognizePhilippinesUMIDOCR

public RecognizePhilippinesUMIDOCRResponse RecognizePhilippinesUMIDOCR(RecognizePhilippinesUMIDOCRRequest req)
                                                                throws TencentCloudSDKException

This API is used to recognize a Philippine Unified Multi-Purpose ID (UMID) card.

Parameters:

req - RecognizePhilippinesUMIDOCRRequest

Returns:

RecognizePhilippinesUMIDOCRResponse

Throws:

TencentCloudSDKException

RecognizePhilippinesVoteIDOCR

public RecognizePhilippinesVoteIDOCRResponse RecognizePhilippinesVoteIDOCR(RecognizePhilippinesVoteIDOCRRequest req)
                                                                    throws TencentCloudSDKException

This API is used to recognize a Philippine voters ID card. It can recognize fields such as first name, family name, date of birth, civil status, citizenship, address, precinct, and voter's identification number (VIN). The API request rate is limited to 20 requests/sec by default.

Parameters:

req - RecognizePhilippinesVoteIDOCRRequest

Returns:

RecognizePhilippinesVoteIDOCRResponse

Throws:

TencentCloudSDKException

SmartStructuralOCRV2

public SmartStructuralOCRV2Response SmartStructuralOCRV2(SmartStructuralOCRV2Request req)
                                                  throws TencentCloudSDKException

This API is used to recognize fields from cards, documents, bills, forms, contracts, and other structured information. It is flexible and efficient to use, without any configuration required. This API is suitable for recognizing structured information. A maximum of 10 requests can be initiated per second for this API.

Parameters:

req - SmartStructuralOCRV2Request

Returns:

SmartStructuralOCRV2Response

Throws:

TencentCloudSDKException

TableOCR

public TableOCRResponse TableOCR(TableOCRRequest req)
                          throws TencentCloudSDKException

This API is used to detect and recognize Chinese and English forms in images. It can return the text content of each cell and save the recognition result as Excel. This API is not fully available for the time being. For more information, please contact your [Tencent Cloud sales rep](https://intl.cloud.tencent.com/contact-sales).

Parameters:

req - TableOCRRequest

Returns:

TableOCRResponse

Throws:

TencentCloudSDKException