tencent cloud

APIs

DokumentasiAPIsOptical Character RecognitionData Types

Data Types

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-07-02 16:22:06

AddressInfo

Overseas document recognition address information.

Used by actions: GetCardVerificationExternalResult.

Name Type Description
Country String Country.
Note: This field may return null, indicating that no valid values can be obtained.
PostalCode String Postal code.
Note: This field may return null, indicating that no valid values can be obtained.
Subdivision String Sub-region or state/province.
Note: This field may return null, indicating that no valid values can be obtained.
District String District or county.
Note: This field may return null, indicating that no valid values can be obtained.
City String City name.
Note: This field may return null, indicating that no valid values can be obtained.
Subdistrict String Subdistrict or township.
Note: This field may return null, indicating that no valid values can be obtained.
FormattedAddress String Formatted complete address.
Note: This field may return null, indicating that no valid values can be obtained.
LineOne String First line of the address bar.
Note: This field may return null, indicating that no valid values can be obtained.
LineTwo String Second line of the address bar.
Note: This field may return null, indicating that no valid values can be obtained.
LineThree String Specifies the third line of the address bar.
Note: This field may return null, indicating that no valid values can be obtained.
LineFour String Specifies the fourth line of the address bar.
Note: This field may return null, indicating that no valid values can be obtained.
LineFive String Specifies the fifth line of the address bar.
Note: This field may return null, indicating that no valid values can be obtained.

AnalyzedLog

Intelligent review log

Used by actions: PODAuditAI.

Name Type Description
StepKey String

Indexes of the procedure.

Enumeration value:

  • L1_IMAGE_QUALITY: Image quality detection
  • L2_RULE_ENGINE: Rule verification
  • L3_LLM_JUDGE: Large model judgment
Decision String

Compliant and non-compliant are final states; to be determined is an intermediate state. Judgment status of each layer: Compliant Non-Compliant Pending.
DecisionMessage String

Reason for the current layer judgment
CostTime Integer

Time taken by the current layer

Unit: ms

BrazilCardInfo

Type of document in brazil.

Used by actions: RecognizeBrazilCommonOCR.

Name Type Description
RNE BrazilRNEInfo RNE document.
Note: This field may return null, indicating that no valid values can be obtained.
RNM BrazilRNMInfo Specifies the document.
Note: This field may return null, indicating that no valid values can be obtained.
DriverLicense BrazilDriverLicenseInfo Driver license document.
Note: This field may return null, indicating that no valid values can be obtained.
IDCard BrazilIDCardInfo ID card document.
Note: This field may return null, indicating that no valid values can be obtained.

BrazilDriverLicenseInfo

Driver'S license type in brazil.

Used by actions: RecognizeBrazilCommonOCR.

Name Type Description
NOME String Name.
CatHab String Specifies the driver's license type.
CNHNumber String Driver’s license id.
VALIDADE String Expiration date.
QUALIFICATION String Indicates the qualification.
IDENTIDADE String Identity card number.
CPF String Tax number of the person.
NASCIMENTO String Date of birth.
MEMBERSHIP String Membership status.
REGISTRO String Registration number.
OBSERVATIONS String Remarks.
IssueDate String Issue date.
LOCAL String Issuing location.
BackNumber String Record number.
PortraitImage String Specifies the avatar in base64 format.

BrazilIDCardInfo

Specifies the identity card type in brazil.

Used by actions: RecognizeBrazilCommonOCR.

Name Type Description
Nome String Name.
MemberShip String Parent information.
DataNascimento String Date of birth.
IssuingAgency String Issuing organization.
Fatorrh String Specifies the blood type.
NaturalIDade String Birthplace.
Observations String Remarks.
CPF String CPF Type
DNI String DNI Type
RegistroGeral String Common registration.
DispatchDate String Issue date. valid values: dd/mm/yyyy.
Registro String Address.
PortraitImage String Specifies the avatar in Base64 format of the id card.
DocOrigem String Original identity information.

BrazilRNEInfo

BrazilRNEInfo

Used by actions: RecognizeBrazilCommonOCR.

Name Type Description
RNE String RNE
CLASSIFICATION String CLASSIFICAÇÃO(CLASSIFICATION)
VALIDADE String VALIDADE
NOME String NOME
Membership String FILIAÇÃO(MEMBERSHIP)
NACIONALIDADE String NACIONALIDADE
NATURALIDADE String NATURALIDADE(PAÍS)
IssuingAgency String ORGÃO EXPEDIDOR(IssuingAgency)
DateOfBirth String DATA DE NASCIMENTO(DateOfBirth)
Sex String SEXO
EntryDate String DATA DE ENTRADA(EntryDate)
VIA String VIA
DispatchDate String DATA DE EXPEDIÇÃO(DispatchDate)
MRZ String MRZ
PortraitImage String PortraitImage

BrazilRNMInfo

Document type for brazil RNM.

Used by actions: RecognizeBrazilCommonOCR.

Name Type Description
SOBRENOME String SOBRENOME Type
NOME String NOME Type
DATADENASCIMENTO String DATA DE NASCIMENTO
SEXO String SEXO F
MEMBERSHIP String FILIAÇÃO(MEMBERSHIP)
NACIONALIDADE String NACIONALIDADE Type
VALIDADE String VALIDADE Type
RNM String RNM Type
CPF String CPF Type
CLASSIFICATION String CLASSIFICAÇÃO(CLASSIFICATION)
PRAZODERESIDENCIA String PRAZO DE RESIDENCIA
ISSUANCE String EMISSÃO(ISSUANCE)
AMPAROLEGAL String AMPARO LEGAL(LegalHelp)
MRZ String MRZCode
PortraitImage String Portrait Image
PortraitImageBack String PortraitImage(Back)

ConfigAdvanced

Supports single attribute configuration for templates.

Used by actions: ExtractDocMulti.

Name Type Required Description
Scene String No Single attribute configuration of a template.

Coord

Coordinates

Used by actions: ExtractDocMulti, GeneralAccurateOCR, GeneralBasicOCR, RecognizeDetectCardCoords, SmartStructuralOCRV2.

Name Type Description
X Integer Horizontal coordinate
Y Integer Vertical coordinate

CoordsItem

Detected coordinate recognition information.

Used by actions: RecognizeDetectCardCoords.

Name Type Description
Polygon Polygon Coordinates of four points in the image.
Coords ItemCoord Coordinates of two points in the image.

DetectedWordCoordPoint

Coordinates of a word’s four corners in a clockwise order on the input image, starting from the upper-left corner

Used by actions: GeneralAccurateOCR, GeneralBasicOCR.

Name Type Description
WordCoordinate Array of Coord Coordinates of a word’s four corners in a clockwise order on the input image, starting from the upper-left corner

DetectedWords

Information about a character detected, including the character itself and its confidence

Used by actions: GeneralAccurateOCR, GeneralBasicOCR.

Name Type Description
Confidence Integer Confidence. Value range: 0–100
Character String A possible character

GeneralCard

General card certificate information.

Used by actions: GetCardVerificationExternalResult.

Name Type Description
LicenseNumber String ID number.
Note: This field may return null, indicating that no valid values can be obtained.
PersonalNumber String Personal number.
Note: This field may return null, indicating that no valid values can be obtained.
FullName String Full name on the document.
Note: This field may return null, indicating that no valid values can be obtained.
FullNameLocal String Full name in local language.
Note: This field may return null, indicating that no valid values can be obtained.
FirstName String First name or given name.
Note: This field may return null, indicating that no valid values can be obtained.
FirstNameLocal String First name in local language.
Note: This field may return null, indicating that no valid values can be obtained.
MiddleName String Middle name.
Note: This field may return null, indicating that no valid values can be obtained.
MiddleNameLocal String Middle name in local language.
Note: This field may return null, indicating that no valid values can be obtained.
LastName String Last name or surname.
Note: This field may return null, indicating that no valid values can be obtained.
LastNameLocal String Last name in local language.
Note: This field may return null, indicating that no valid values can be obtained.
Sex String Gender on the document.
- M: man.
- F: woman.
- X: other gender identity.
Note: This field may return null, indicating that no valid values can be obtained.
Birthday String Date of birth.
Note: This field may return null, indicating that no valid values can be obtained.
BirthPlace String Birth place.
Note: This field may return null, indicating that no valid values can be obtained.
IssuedDate String Issue date.
Note: This field may return null, indicating that no valid values can be obtained.
IssuedAuthority String Issuing authority.
Note: This field may return null, indicating that no valid values can be obtained.
IssuedPlace String Place of issue.
Note: This field may return null, indicating that no valid values can be obtained.
IssuedCountry String Issuing country.
Note: This field may return null, indicating that no valid values can be obtained.
IssuedCountryCode String Country code of issue, ISO Alpha-3 format.
Note: This field may return null, indicating that no valid values can be obtained.
ExpirationDate String Expiry date.
Note: This field may return null, indicating that no valid values can be obtained.
MRZLine1 String First line of the Machine Readable Zone (MRZ).
Note: This field may return null, indicating that no valid values can be obtained.
MRZLine2 String Second line of the Machine Readable Zone (MRZ).
Note: This field may return null, indicating that no valid values can be obtained.
Nationality String Document nationality, following ISO 3166 country coding specification.
Note: This field may return null, indicating that no valid values can be obtained.
Address AddressInfo Address information on the document.
Note: This field may return null, indicating that no valid values can be obtained.
Religion String Religion (if displayed on the document).
Note: This field may return null, indicating that no valid values can be obtained.
Type String Type of document.
Note: This field may return null, indicating that no valid values can be obtained.
BloodType String Blood type.
Note: This field may return null, indicating that no valid values can be obtained.
Height String Height.
Note: This field may return null, indicating that no valid values can be obtained.
Weight String Weight.
Note: This field may return null, indicating that no valid values can be obtained.
VehicleClass String Vehicle class authorized on the driver license (e.g., A, B, C).
Note: This field may return null, indicating that no valid values can be obtained.
Restrictions String Restrictions on the driver license.
Note: This field may return null, indicating that no valid values can be obtained.
Endorsement String Endorsements or additional records on the driver license.
Note: This field may return null, indicating that no valid values can be obtained.
Others String Supplementary fields (varies by document type).
Note: This field may return null, indicating that no valid values can be obtained.

GroupInfo

The sequence number of an element group in the image

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name Type Description
Groups Array of LineInfo The elements in each line.

ItemCoord

Pixel coordinates of the text line in the image after rotation correction, which is in the format of (X-coordinate of top-left point, Y-coordinate of top-left point, width, height).

Used by actions: GeneralAccurateOCR, GeneralBasicOCR, RecognizeDetectCardCoords.

Name Type Description
X Integer X-coordinate of top-left point.
Y Integer Y-coordinate of top-left point.
Width Integer Width
Height Integer Height

ItemInfo

Structured element group

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name Type Description
Key Key The key information.
Note: This field may return null, indicating that no valid values can be obtained.
Value Value The value information.
Note: This field may return null, indicating that no valid values can be obtained.

Key

Key information

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name Type Description
AutoName String The name of the recognized field.
ConfigName String The name of a defined field (the key passed in).
Note: This field may return null, indicating that no valid values can be obtained.

LineInfo

Line number

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name Type Description
Lines Array of ItemInfo The elements in a line

MainlandTravelPermitBackInfos

Used by actions: MainlandPermitOCR.

Name Type Description
Type String
Name String
IDNumber String
HistoryNumber String

PassportRecognizeInfos

Used by actions: MLIDPassportOCR.

Name Type Description
Type String
IssuingCountry String
PassportID String
Surname String
GivenName String
Name String
Nationality String
DateOfBirth String
Sex String
DateOfIssuance String
DateOfExpiration String
Signature String
IssuePlace String
IssuingAuthority String
BirthPlace String

Polygon

The coordinates of the four vertices of the text
Note: This field may return null, indicating that no valid values can be obtained.

Used by actions: ExtractDocMulti, RecognizeDetectCardCoords, SmartStructuralOCRV2.

Name Type Description
LeftTop Coord The coordinates of the upper-left vertex.
RightTop Coord The coordinates of the upper-right vertex.
RightBottom Coord The coordinates of the lower-left vertex.
LeftBottom Coord The coordinates of the lower-right vertex.

TextDetection

OCR result.

Used by actions: GeneralAccurateOCR, GeneralBasicOCR.

Name Type Description
DetectedText String Recognized text line content.
Confidence Integer Confidence. Value range: 0–100.
Polygon Array of Coord Text line coordinates, which are represented as 4 vertex coordinates.
Note: this field may return null, indicating that no valid values can be obtained.
AdvancedInfo String Extended field.
The paragraph information Parag returned by the GeneralBasicOcr API contains ParagNo.
ItemPolygon ItemCoord Pixel coordinates of the text line in the image after rotation correction, which is in the format of (X-coordinate of top-left point, Y-coordinate of top-left point, width, height).
Words Array of DetectedWords Information about a character, including the character itself and its confidence. Supported APIs: GeneralBasicOCR, GeneralAccurateOCR
WordCoordPoint Array of DetectedWordCoordPoint Coordinates of a word’s four corners on the input image. Supported APIs: GeneralBasicOCR, GeneralAccurateOCR

TextDetectionResult

Recognition result

Used by actions: RecognizePhilippinesDrivingLicenseOCR, RecognizePhilippinesSssIDOCR, RecognizePhilippinesTinIDOCR, RecognizePhilippinesUMIDOCR, RecognizePhilippinesVoteIDOCR.

Name Type Description
Value String The recognized text line content.

Value

Value information

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name Type Description
AutoContent String The value of the recognized field.
Coord Polygon The coordinates of the four vertices.
Note: This field may return null, indicating that no valid values can be obtained.

WordItem

The recognized text information.

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name Type Description
DetectedText String The text content.
Coord Polygon The coordinates of the four vertices.
AdvancedInfo String Description.
WordCoord Array of WordPolygon Specifies the four-point coordinate of the word.

WordPolygon

Word coordinates info.

Used by actions: ExtractDocMulti, SmartStructuralOCRV2.

Name Type Description
DetectedText String The text content.
Coord Polygon The coordinates of the four vertices.
Topik sebelumnya: GeneralAccurateOCRTopik selanjutnya: Error Codes

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan