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.
ExtractDocMultiResponse	ExtractDocMulti(ExtractDocMultiRequest req) This API supports identifying and extracting field information in structured scenarios such as complex scenarios and multiple formats.
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.
HmtResidentPermitOCRResponse	HmtResidentPermitOCR(HmtResidentPermitOCRRequest req) This API is used to recognize key fields on the front and back sides of a residence permit for Hong Kong, Macao, or Taiwan residents, including name, gender, date of birth, address, ID number, issuing authority, validity period, number of issues, and permit number.
IDCardOCRResponse	IDCardOCR(IDCardOCRRequest req) This API is used to recognize all fields on the front and back sides of a second-generation resident identity card for the Chinese mainland: name, gender, ethnicity, date of birth, domicile, identification number, issuing authority, and validity period, with a recognition accuracy of over 99%.
LicensePlateOCRResponse	LicensePlateOCR(LicensePlateOCRRequest req) This API is used to recognize a license plate attached to a motor vehicle in the Chinese mainland and return the regional code, license plate number, and license plate color.
MainlandPermitOCRResponse	MainlandPermitOCR(MainlandPermitOCRRequest req) This API is used to recognize all fields on the front of a mainland travel permit for Hong Kong, Macao, or Taiwan residents: name in Chinese, name in English, gender, date of birth, issuing authority, validity period, document number, place of issuance, number of issues, and document type.
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.
PermitOCRResponse	PermitOCR(PermitOCRRequest req) This API is used to recognize the fields on an exit/entry permit (card) for traveling to and from Hong Kong, Macao, or Taiwan, including place of issuance, issuing authority, validity period, gender, date of birth, name in English, name in Chinese, and document number.
RecognizeBrazilCommonOCRResponse	RecognizeBrazilCommonOCR(RecognizeBrazilCommonOCRRequest req) This API is used to identify Brazil common documents.
RecognizeBrazilDriverLicenseOCRResponse	RecognizeBrazilDriverLicenseOCR(RecognizeBrazilDriverLicenseOCRRequest req) This interface supports identification of the front and back of Brazilian driver's license.
RecognizeBrazilIDCardOCRResponse	RecognizeBrazilIDCardOCR(RecognizeBrazilIDCardOCRRequest req) This interface supports identification of the front and back of Brazilian ID license.
RecognizeBrazilRNEOCRResponse	RecognizeBrazilRNEOCR(RecognizeBrazilRNEOCRRequest req) Brazil RNE document recognition Default interface request frequency limit: 5 times/second
RecognizeBrazilRNMOCRResponse	RecognizeBrazilRNMOCR(RecognizeBrazilRNMOCRRequest req) This interface supports identification of the front and back of Brazilian RNM license.
RecognizeGeneralInvoiceResponse	RecognizeGeneralInvoice(RecognizeGeneralInvoiceRequest req) This API is used to recognize various types of invoices or tickets in an image or PDF file.
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.
RecognizeMacaoIDCardOCRResponse	RecognizeMacaoIDCardOCR(RecognizeMacaoIDCardOCRRequest req) This API is used to recognize key fields on the photo side of a Macao (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.
RecognizeMainlandIDCardOCRResponse	RecognizeMainlandIDCardOCR(RecognizeMainlandIDCardOCRRequest req) This interface supports the identification of all fields on the front and back of the second-generation ID card for mainland Chinese residents.Including name, gender, ethnicity, date of birth, address, citizen ID number, issuing authority, and validity period, the identification accuracy reaches more than 99%.In addition, this interface also supports a variety of value-added capabilities to meet the needs of different scenarios.
RecognizeMexicoVTIDResponse	RecognizeMexicoVTID(RecognizeMexicoVTIDRequest req) This interface supports identification of the front and back of Mexican Voter 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.
RecognizeSingaporeIDCardOCRResponse	RecognizeSingaporeIDCardOCR(RecognizeSingaporeIDCardOCRRequest req) This interface supports the identification of all fields on the front side of ID card for Singapore residents.The identification accuracy reaches more than 99%.In addition, this interface also supports a variety of value-added capabilities to meet the needs of different scenarios.
RecognizeTableAccurateOCRResponse	RecognizeTableAccurateOCR(RecognizeTableAccurateOCRRequest req) This API is used to recognize regular tables, borderless tables, or multi-tables in images or PDF files containing Chinese and English texts.
RecognizeThaiIDCardOCRResponse	RecognizeThaiIDCardOCR(RecognizeThaiIDCardOCRRequest req) This API is used to recognize the fields on a Thai identity card, including name in Thai, name in English, address, date of birth, identification number, date of issue, and date of expiry.
RecognizeThaiPinkCardResponse	RecognizeThaiPinkCard(RecognizeThaiPinkCardRequest req) This API is used to recognize the fields on a Thai identity card, including name in Thai, name in English, address, date of birth, identification number, date of issue, and date of expiry.
SealOCRResponse	SealOCR(SealOCRRequest req) This API is used to recognize various types of seals, including invoice seals and finance seals.
SmartStructuralOCRV2Response	SmartStructuralOCRV2(SmartStructuralOCRV2Request req) This API is used to recognize fields from cards, documents, bills, forms, contracts, and other structured information.
SmartStructuralProResponse	SmartStructuralPro(SmartStructuralProRequest 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.
VinOCRResponse	VinOCR(VinOCRRequest req) This API is used to recognize the vehicle identification number (VIN) in an image.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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

ExtractDocMulti

public ExtractDocMultiResponse ExtractDocMulti(ExtractDocMultiRequest req)
                                        throws TencentCloudSDKException

This API supports identifying and extracting field information in structured scenarios such as complex scenarios and multiple formats. Key scenarios include: finance, health care, transportation, travel, insurance. Click [experience now](https://ocrdemo.cloud.tencent.com/). This API is used to set the alias SmartStructuralPro. The default API request rate limit is 5 requests per second.

Parameters:

req - ExtractDocMultiRequest

Returns:

ExtractDocMultiResponse

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

HmtResidentPermitOCR

public HmtResidentPermitOCRResponse HmtResidentPermitOCR(HmtResidentPermitOCRRequest req)
                                                  throws TencentCloudSDKException

This API is used to recognize key fields on the front and back sides of a residence permit for Hong Kong, Macao, or Taiwan residents, including name, gender, date of birth, address, ID number, issuing authority, validity period, number of issues, and permit number. It can be used for residence permit OCR in scenarios such as bank account opening and user registration. A maximum of 20 requests can be initiated per second for this API.

Parameters:

req - HmtResidentPermitOCRRequest

Returns:

HmtResidentPermitOCRResponse

Throws:

TencentCloudSDKException

IDCardOCR

public IDCardOCRResponse IDCardOCR(IDCardOCRRequest req)
                            throws TencentCloudSDKException

This API is used to recognize all fields on the front and back sides of a second-generation resident identity card for the Chinese mainland: name, gender, ethnicity, date of birth, domicile, identification number, issuing authority, and validity period, with a recognition accuracy of over 99%. In addition, this API supports multiple value-added capabilities to meet the needs of different scenarios. It can crop ID card photos and profile photos, and provide warnings for nine cases, as detailed below.

Capability	Description
Cropping	Crops the ID card photo (by removing extra edges outside the ID card and automatically correcting the shooting angle).
	Crops the profile photo (by automatically cutting out the face area in the ID card).
Warning	Warns about invalid ID card validity periods.
	Warns about incomplete ID card borders.
	Warns about photocopied images.
	Warns about spoofed images.
	Warns about border and frame occlusions.
	Warns about temporary ID cards.
	Warns about photoshopped images.
	Warns about blurry ID card images (blurriness can be determined based on the image quality score).

A maximum of 20 requests can be initiated per second for this API.

Parameters:

req - IDCardOCRRequest

Returns:

IDCardOCRResponse

Throws:

TencentCloudSDKException

LicensePlateOCR

public LicensePlateOCRResponse LicensePlateOCR(LicensePlateOCRRequest req)
                                        throws TencentCloudSDKException

This API is used to recognize a license plate attached to a motor vehicle in the Chinese mainland and return the regional code, license plate number, and license plate color. A maximum of 10 requests can be initiated per second for this API.

Parameters:

req - LicensePlateOCRRequest

Returns:

LicensePlateOCRResponse

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 interface supports regional scope: countries with machine-readable passports

Parameters:

req - MLIDPassportOCRRequest

Returns:

MLIDPassportOCRResponse

Throws:

TencentCloudSDKException

MainlandPermitOCR

public MainlandPermitOCRResponse MainlandPermitOCR(MainlandPermitOCRRequest req)
                                            throws TencentCloudSDKException

This API is used to recognize all fields on the front of a mainland travel permit for Hong Kong, Macao, or Taiwan residents: name in Chinese, name in English, gender, date of birth, issuing authority, validity period, document number, place of issuance, number of issues, and document type. A maximum of 20 requests can be initiated per second for this API.

Parameters:

req - MainlandPermitOCRRequest

Returns:

MainlandPermitOCRResponse

Throws:

TencentCloudSDKException

PermitOCR

public PermitOCRResponse PermitOCR(PermitOCRRequest req)
                            throws TencentCloudSDKException

This API is used to recognize the fields on an exit/entry permit (card) for traveling to and from Hong Kong, Macao, or Taiwan, including place of issuance, issuing authority, validity period, gender, date of birth, name in English, name in Chinese, and document number. A maximum of 10 requests can be initiated per second for this API.

Parameters:

req - PermitOCRRequest

Returns:

PermitOCRResponse

Throws:

TencentCloudSDKException

RecognizeBrazilCommonOCR

public RecognizeBrazilCommonOCRResponse RecognizeBrazilCommonOCR(RecognizeBrazilCommonOCRRequest req)
                                                          throws TencentCloudSDKException

This API is used to identify Brazil common documents. This API is used to set the default request rate limit to 5 requests/second.

Parameters:

req - RecognizeBrazilCommonOCRRequest

Returns:

RecognizeBrazilCommonOCRResponse

Throws:

TencentCloudSDKException

RecognizeBrazilDriverLicenseOCR

public RecognizeBrazilDriverLicenseOCRResponse RecognizeBrazilDriverLicenseOCR(RecognizeBrazilDriverLicenseOCRRequest req)
                                                                        throws TencentCloudSDKException

This interface supports identification of the front and back of Brazilian driver's license. The identification fields include name, driver's license category, number, validity period, etc.

Parameters:

req - RecognizeBrazilDriverLicenseOCRRequest

Returns:

RecognizeBrazilDriverLicenseOCRResponse

Throws:

TencentCloudSDKException

RecognizeBrazilIDCardOCR

public RecognizeBrazilIDCardOCRResponse RecognizeBrazilIDCardOCR(RecognizeBrazilIDCardOCRRequest req)
                                                          throws TencentCloudSDKException

This interface supports identification of the front and back of Brazilian ID license. The identification fields include name, driver's license category, number, validity period, etc.

Parameters:

req - RecognizeBrazilIDCardOCRRequest

Returns:

RecognizeBrazilIDCardOCRResponse

Throws:

TencentCloudSDKException

RecognizeBrazilRNEOCR

public RecognizeBrazilRNEOCRResponse RecognizeBrazilRNEOCR(RecognizeBrazilRNEOCRRequest req)
                                                    throws TencentCloudSDKException

Brazil RNE document recognition Default interface request frequency limit: 5 times/second

Parameters:

req - RecognizeBrazilRNEOCRRequest

Returns:

RecognizeBrazilRNEOCRResponse

Throws:

TencentCloudSDKException

RecognizeBrazilRNMOCR

public RecognizeBrazilRNMOCRResponse RecognizeBrazilRNMOCR(RecognizeBrazilRNMOCRRequest req)
                                                    throws TencentCloudSDKException

This interface supports identification of the front and back of Brazilian RNM license. The default interface request frequency limit is 5 times per second.

Parameters:

req - RecognizeBrazilRNMOCRRequest

Returns:

RecognizeBrazilRNMOCRResponse

Throws:

TencentCloudSDKException

RecognizeGeneralInvoice

public RecognizeGeneralInvoiceResponse RecognizeGeneralInvoice(RecognizeGeneralInvoiceRequest req)
                                                        throws TencentCloudSDKException

This API is used to recognize various types of invoices or tickets in an image or PDF file. You can also specify a type. 14 types of standard expense reimbursement invoices are supported, including value-added tax (VAT) invoice (special, general, roll, blockchain, and toll), fully digitalized electronic invoice (special and general), non-tax revenue invoice (general receipt and general payment voucher), quota invoice, general machine-printed invoice, car sales invoice (motor vehicle sales invoice and used car invoice), train ticket, taxi receipt, itinerary/receipt of e-ticket for air transportation, bus ticket, ship ticket, toll receipt, and medical invoice (inpatient and outpatient). This API can also be used for intelligent recognition of other types of invoices. To try now, click [here](https://intl.cloud.tencent.com/product/ocr?from_cn_redirect=1). A maximum of 5 requests can be initiated per second for this API. The invoice/ticket subtype (SubType), subtype description (TypeDescription), and parent type (Type) can be returned, as described below:

SubType	TypeDescription	Type
VatSpecialInvoice	Special VAT invoice	3
VatCommonInvoice	General VAT invoice	3
VatElectronicCommonInvoice	Electronic general VAT invoice	3
VatElectronicSpecialInvoice	Electronic special VAT invoice	3
VatElectronicInvoiceBlockchain	Blockchain electronic invoice	3
VatElectronicInvoiceToll	Electronic general VAT invoice (toll)	3
VatElectronicSpecialInvoiceFull	Electronic invoice (special)	16
VatElectronicInvoiceFull	Electronic invoice (general)	16
MotorVehicleSaleInvoice	Motor vehicle sales invoice	12
UsedCarPurchaseInvoice	Used car invoice	12
VatInvoiceRoll	General VAT invoice (roll)	11
TaxiTicket	Taxi receipt	0
QuotaInvoice	Quota invoice	1
TrainTicket	Train ticket	2
AirTransport	Itinerary/Receipt of e-ticket for air transportation	5
MachinePrintedInvoice	General machine-printed invoice	8
BusInvoice	Bus ticket	9
ShippingInvoice	Ship ticket	10
NonTaxIncomeGeneralBill	General receipt for non-tax revenue	15
NonTaxIncomeElectronicBill	General payment voucher for non-tax revenue (electronic)	15
TollInvoice	Toll receipt	13
OtherInvoice	Other	-1

Parameters:

req - RecognizeGeneralInvoiceRequest

Returns:

RecognizeGeneralInvoiceResponse

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

RecognizeMacaoIDCardOCR

public RecognizeMacaoIDCardOCRResponse RecognizeMacaoIDCardOCR(RecognizeMacaoIDCardOCRRequest req)
                                                        throws TencentCloudSDKException

This API is used to recognize key fields on the photo side of a Macao (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. 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 - RecognizeMacaoIDCardOCRRequest

Returns:

RecognizeMacaoIDCardOCRResponse

Throws:

TencentCloudSDKException

RecognizeMainlandIDCardOCR

public RecognizeMainlandIDCardOCRResponse RecognizeMainlandIDCardOCR(RecognizeMainlandIDCardOCRRequest req)
                                                              throws TencentCloudSDKException

This interface supports the identification of all fields on the front and back of the second-generation ID card for mainland Chinese residents.Including name, gender, ethnicity, date of birth, address, citizen ID number, issuing authority, and validity period, the identification accuracy reaches more than 99%.In addition, this interface also supports a variety of value-added capabilities to meet the needs of different scenarios. Such as the cropping function of ID card photos and portrait photos, and also has 5 alarm functions. As shown in the table below.

Value-added ability	Ability items
Alarm function
	ID card photocopy warning
	ID card on-screen display warning
	Alarm for occlusion in the ID card frame
	ID card reflective warning
	Blurry picture warning

Default interface request frequency limit: 20 times/second

Parameters:

req - RecognizeMainlandIDCardOCRRequest

Returns:

RecognizeMainlandIDCardOCRResponse

Throws:

TencentCloudSDKException

RecognizeMexicoVTID

public RecognizeMexicoVTIDResponse RecognizeMexicoVTID(RecognizeMexicoVTIDRequest req)
                                                throws TencentCloudSDKException

This interface supports identification of the front and back of Mexican Voter ID Card. The default interface request frequency limit is 5 times per second.

Parameters:

req - RecognizeMexicoVTIDRequest

Returns:

RecognizeMexicoVTIDResponse

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

RecognizeSingaporeIDCardOCR

public RecognizeSingaporeIDCardOCRResponse RecognizeSingaporeIDCardOCR(RecognizeSingaporeIDCardOCRRequest req)
                                                                throws TencentCloudSDKException

This interface supports the identification of all fields on the front side of ID card for Singapore residents.The identification accuracy reaches more than 99%.In addition, this interface also supports a variety of value-added capabilities to meet the needs of different scenarios. Such as the cropping function of ID card photos and portrait photos, and also has 5 alarm functions. As shown in the table below.

Value-added ability	Ability items
Alarm function
	ID card copy warning
	ID card copy warning
	Alarm for occlusion in the ID card frame
	ID card reflective warning
	Blurry picture warning

Default interface request frequency limit: 20 times/second

Parameters:

req - RecognizeSingaporeIDCardOCRRequest

Returns:

RecognizeSingaporeIDCardOCRResponse

Throws:

TencentCloudSDKException

RecognizeTableAccurateOCR

public RecognizeTableAccurateOCRResponse RecognizeTableAccurateOCR(RecognizeTableAccurateOCRRequest req)
                                                            throws TencentCloudSDKException

This API is used to recognize regular tables, borderless tables, or multi-tables in images or PDF files containing Chinese and English texts. It returns the text content of each cell, supports recognition of rotated table images, and can save the recognition results into an Excel document. It delivers higher recognition accuracy than that of table OCR v2 and applies to more scenarios. The recognition accuracy in difficult table scenarios, such as irregular tables and nested tables (borderless tables contained in bordered tables), is better than that of table OCR v2. To try it, click [here](https://intl.cloud.tencent.com/product/smart?from_cn_redirect=1-ocr). A maximum of 2 requests can be initiated per second for this API.

Parameters:

req - RecognizeTableAccurateOCRRequest

Returns:

RecognizeTableAccurateOCRResponse

Throws:

TencentCloudSDKException

RecognizeThaiIDCardOCR

public RecognizeThaiIDCardOCRResponse RecognizeThaiIDCardOCR(RecognizeThaiIDCardOCRRequest req)
                                                      throws TencentCloudSDKException

This API is used to recognize the fields on a Thai identity card, including name in Thai, name in English, address, date of birth, identification number, date of issue, and date of expiry. A maximum of 10 requests can be initiated per second for this API.

Parameters:

req - RecognizeThaiIDCardOCRRequest

Returns:

RecognizeThaiIDCardOCRResponse

Throws:

TencentCloudSDKException

RecognizeThaiPinkCard

public RecognizeThaiPinkCardResponse RecognizeThaiPinkCard(RecognizeThaiPinkCardRequest req)
                                                    throws TencentCloudSDKException

This API is used to recognize the fields on a Thai identity card, including name in Thai, name in English, address, date of birth, identification number, date of issue, and date of expiry. Currently, this API is not generally available. For more information, please [contact your sales rep](https://intl.cloud.tencent.com/about/connect?from_cn_redirect=1). A maximum of 5 requests can be initiated per second for this API.

Parameters:

req - RecognizeThaiPinkCardRequest

Returns:

RecognizeThaiPinkCardResponse

Throws:

TencentCloudSDKException

SealOCR

public SealOCRResponse SealOCR(SealOCRRequest req)
                        throws TencentCloudSDKException

This API is used to recognize various types of seals, including invoice seals and finance seals. It is suitable for scenarios such as official document and invoice/ticket OCR. A maximum of 5 requests can be initiated per second for this API.

Parameters:

req - SealOCRRequest

Returns:

SealOCRResponse

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

SmartStructuralPro

public SmartStructuralProResponse SmartStructuralPro(SmartStructuralProRequest 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 - SmartStructuralProRequest

Returns:

SmartStructuralProResponse

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

VinOCR

public VinOCRResponse VinOCR(VinOCRRequest req)
                      throws TencentCloudSDKException

This API is used to recognize the vehicle identification number (VIN) in an image.

Parameters:

req - VinOCRRequest

Returns:

VinOCRResponse

Throws:

TencentCloudSDKException