com.tencentcloudapi.ocr.v20181119.models

Class RecognizeGeneralInvoiceRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.RecognizeGeneralInvoiceRequest

public class RecognizeGeneralInvoiceRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
RecognizeGeneralInvoiceRequest()
RecognizeGeneralInvoiceRequest(RecognizeGeneralInvoiceRequest 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
Boolean	getEnableCutImage() Get Whether to return the Base64-encoded value of the cropped image.
Boolean	getEnableMultiplePage() Get Whether to enable multi-page PDF recognition.
Boolean	getEnableOther() Get Whether to enable recognition of other invoices.
Boolean	getEnablePdf() Get Whether to enable PDF recognition.
String	getImageBase64() Get The Base64-encoded value of the image.
String	getImageUrl() Get The URL of the image.
Long	getPdfPageNumber() Get The number of the PDF page that needs to be recognized.
Long[]	getTypes() Get The list of the types of invoices to be recognized.
void	setEnableCutImage(Boolean EnableCutImage) Set Whether to return the Base64-encoded value of the cropped image.
void	setEnableMultiplePage(Boolean EnableMultiplePage) Set Whether to enable multi-page PDF recognition.
void	setEnableOther(Boolean EnableOther) Set Whether to enable recognition of other invoices.
void	setEnablePdf(Boolean EnablePdf) Set Whether to enable PDF recognition.
void	setImageBase64(String ImageBase64) Set The Base64-encoded value of the image.
void	setImageUrl(String ImageUrl) Set The URL of the image.
void	setPdfPageNumber(Long PdfPageNumber) Set The number of the PDF page that needs to be recognized.
void	setTypes(Long[] Types) Set The list of the types of invoices to be recognized.
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

RecognizeGeneralInvoiceRequest

public RecognizeGeneralInvoiceRequest()

RecognizeGeneralInvoiceRequest

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

getImageBase64

public String getImageBase64()

Get The Base64-encoded value of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

Returns:

ImageBase64 The Base64-encoded value of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

setImageBase64

public void setImageBase64(String ImageBase64)

Set The Base64-encoded value of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

Parameters:

ImageBase64 - The Base64-encoded value of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 Either `ImageUrl` or `ImageBase64` of the image must be provided. If both are provided, only `ImageUrl` is used.

getImageUrl

public String getImageUrl()

Get The URL of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Returns:

ImageUrl The URL of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

setImageUrl

public void setImageUrl(String ImageUrl)

Set The URL of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Parameters:

ImageUrl - The URL of the image. Supported image formats: PNG, JPG, JPEG, and PDF. GIF is currently not supported. Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s. Supported image pixels: 20 to 10,000 We recommend that you store the image in Tencent Cloud for higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

getTypes

public Long[] getTypes()

Get The list of the types of invoices to be recognized. If this parameter is left empty, all types of invoices are recognized. 0: Taxi receipt 1: Quota invoice 2: Train ticket 3: VAT invoice 5: Itinerary/Receipt of e-ticket for air transport 8: General machine-printed invoice 9: Bus ticket 10: Ship ticket 11: VAT invoice (roll) 12: Car sales inovice 13: Toll receipt 15: Non-tax revenue invoice 16: Fully digitalized electronic invoice -1: Other By default, this parameter is left empty, which means to recognize all types of invoices. When a single type is passed in, the image is recognized based on this type. You can only specify a singe type or all types, but not some types.

Returns:

Types The list of the types of invoices to be recognized. If this parameter is left empty, all types of invoices are recognized. 0: Taxi receipt 1: Quota invoice 2: Train ticket 3: VAT invoice 5: Itinerary/Receipt of e-ticket for air transport 8: General machine-printed invoice 9: Bus ticket 10: Ship ticket 11: VAT invoice (roll) 12: Car sales inovice 13: Toll receipt 15: Non-tax revenue invoice 16: Fully digitalized electronic invoice -1: Other By default, this parameter is left empty, which means to recognize all types of invoices. When a single type is passed in, the image is recognized based on this type. You can only specify a singe type or all types, but not some types.

setTypes

public void setTypes(Long[] Types)

Set The list of the types of invoices to be recognized. If this parameter is left empty, all types of invoices are recognized. 0: Taxi receipt 1: Quota invoice 2: Train ticket 3: VAT invoice 5: Itinerary/Receipt of e-ticket for air transport 8: General machine-printed invoice 9: Bus ticket 10: Ship ticket 11: VAT invoice (roll) 12: Car sales inovice 13: Toll receipt 15: Non-tax revenue invoice 16: Fully digitalized electronic invoice -1: Other By default, this parameter is left empty, which means to recognize all types of invoices. When a single type is passed in, the image is recognized based on this type. You can only specify a singe type or all types, but not some types.

Parameters:

Types - The list of the types of invoices to be recognized. If this parameter is left empty, all types of invoices are recognized. 0: Taxi receipt 1: Quota invoice 2: Train ticket 3: VAT invoice 5: Itinerary/Receipt of e-ticket for air transport 8: General machine-printed invoice 9: Bus ticket 10: Ship ticket 11: VAT invoice (roll) 12: Car sales inovice 13: Toll receipt 15: Non-tax revenue invoice 16: Fully digitalized electronic invoice -1: Other By default, this parameter is left empty, which means to recognize all types of invoices. When a single type is passed in, the image is recognized based on this type. You can only specify a singe type or all types, but not some types.

getEnableOther

public Boolean getEnableOther()

Get Whether to enable recognition of other invoices. If you enable this feature, other invoices can be recognized. Default value: `true`.

Returns:

EnableOther Whether to enable recognition of other invoices. If you enable this feature, other invoices can be recognized. Default value: `true`.

setEnableOther

public void setEnableOther(Boolean EnableOther)

Set Whether to enable recognition of other invoices. If you enable this feature, other invoices can be recognized. Default value: `true`.

Parameters:

EnableOther - Whether to enable recognition of other invoices. If you enable this feature, other invoices can be recognized. Default value: `true`.

getEnablePdf

public Boolean getEnablePdf()

Get Whether to enable PDF recognition. If you enable this feature, both images and PDF files can be recognized. Default value: `true`.

Returns:

EnablePdf Whether to enable PDF recognition. If you enable this feature, both images and PDF files can be recognized. Default value: `true`.

setEnablePdf

public void setEnablePdf(Boolean EnablePdf)

Set Whether to enable PDF recognition. If you enable this feature, both images and PDF files can be recognized. Default value: `true`.

Parameters:

EnablePdf - Whether to enable PDF recognition. If you enable this feature, both images and PDF files can be recognized. Default value: `true`.

getPdfPageNumber

public Long getPdfPageNumber()

Get The number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of `EnablePdf` is `true`. Default value: 1.

Returns:

PdfPageNumber The number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of `EnablePdf` is `true`. Default value: 1.

setPdfPageNumber

public void setPdfPageNumber(Long PdfPageNumber)

Set The number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of `EnablePdf` is `true`. Default value: 1.

Parameters:

PdfPageNumber - The number of the PDF page that needs to be recognized. Only one single PDF page can be recognized. This parameter is valid if the uploaded file is a PDF and the value of `EnablePdf` is `true`. Default value: 1.

getEnableMultiplePage

public Boolean getEnableMultiplePage()

Get Whether to enable multi-page PDF recognition. If you enable this feature, multiple pages of a PDF file can be recognized, and the recognition results of a maximum of the first 30 pages can be returned. After you enable this feature, input parameters `EnablePdf` and `PdfPageNumber` are invalid. Default value: `false`.

Returns:

EnableMultiplePage Whether to enable multi-page PDF recognition. If you enable this feature, multiple pages of a PDF file can be recognized, and the recognition results of a maximum of the first 30 pages can be returned. After you enable this feature, input parameters `EnablePdf` and `PdfPageNumber` are invalid. Default value: `false`.

setEnableMultiplePage

public void setEnableMultiplePage(Boolean EnableMultiplePage)

Set Whether to enable multi-page PDF recognition. If you enable this feature, multiple pages of a PDF file can be recognized, and the recognition results of a maximum of the first 30 pages can be returned. After you enable this feature, input parameters `EnablePdf` and `PdfPageNumber` are invalid. Default value: `false`.

Parameters:

EnableMultiplePage - Whether to enable multi-page PDF recognition. If you enable this feature, multiple pages of a PDF file can be recognized, and the recognition results of a maximum of the first 30 pages can be returned. After you enable this feature, input parameters `EnablePdf` and `PdfPageNumber` are invalid. Default value: `false`.

getEnableCutImage

public Boolean getEnableCutImage()

Get Whether to return the Base64-encoded value of the cropped image. Default value: `false`.

Returns:

EnableCutImage Whether to return the Base64-encoded value of the cropped image. Default value: `false`.

setEnableCutImage

public void setEnableCutImage(Boolean EnableCutImage)

Set Whether to return the Base64-encoded value of the cropped image. Default value: `false`.

Parameters:

EnableCutImage - Whether to return the Base64-encoded value of the cropped image. Default value: `false`.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel