Updated on 2024-12-27 GMT+08:00

API Overview

You can perform the operations described in Table 1 with OCR APIs.

Table 1 API description

API

Description

Deployment Region

Smart Document Analysis

This API detects and extracts key-value pairs, text, and table content from various document layouts, such as certificates, receipts, and forms, and converts the text into a structured format.

CN-Hong Kong (ap-southeast-1)

AP-Singapore (ap-southeast-3)

General Table

This API detects and extracts text from images of general tables and converts the text into JSON format. The returned results include two types of image area (words_region): text area (text) and table area (table). They also include table structures (rows and columns) and text information. For the notes and constraints on using this API, see Notes and Constraints. For how to use this API, see Introduction to OCR.

AP-Singapore (ap-southeast-3)

General Text

This API detects and extracts text from images and converts the text and coordinates into JSON format. It can be used in various scenarios, such as scanned files, electronic documents, books, receipts, and forms.

English and Chinese are supported but support for traditional Chinese characters is limited. For the notes and constraints on using this API, see Notes and Constraints. For how to use this API, see Introduction to OCR.

CN-Hong Kong (ap-southeast-1)

Passport

This API detects and extracts text from the first page of images of passports and converts the text into a structured JSON format.

CN-Hong Kong (ap-southeast-1)

AP-Bangkok (ap-southeast-2)

Web Image

This API detects and extracts text from web images and converts the text into a structured JSON format.

AP-Bangkok (ap-southeast-2)

Thailand ID Card

This API detects and extracts text from images of Thailand-issued national registration cards and converts the text into a structured format.

AP-Bangkok (ap-southeast-2)

Myanmar ID Card

This API detects and extracts text from images of Myanmar-issued national registration cards and converts the text into a structured format.

CN-Hong Kong (ap-southeast-1)

Cambodian ID Card

This API detects and extracts text from images of Cambodia-issued ID cards and converts the text into a structured format.

AP-Singapore (ap-southeast-3)

Myanmar Driving License

This API detects and extracts text from images of Myanmar-issued driver's licenses and converts the text into a structured JSON format.

CN-Hong Kong (ap-southeast-1)

Chile ID Card

This API detects and extracts text from images of Chile-issued ID cards and converts the text into JSON format.

LA-Santiago-(la-south-2)

Vietnam ID Card

This API detects and extracts text from images of Vietnam-issued ID cards and converts the text into a structured format.

CN-Hong Kong (ap-southeast-1)

Peru ID Card

This API detects and extracts text from images of Peru-issued identity cards and converts the text into a structured format.

LA-Santiago-(la-south-2)

Thailand Plate Number

This API detects and extracts license plate information from images of Thailand license plates and returns the license plate number and location.

AP-Bangkok (ap-southeast-2)

ID Document

This API detects and extracts text from images of identity documents issued by multiple countries and regions, such as ID cards, driving licenses, and passports, and converts the text into a structured format.

CN-Hong Kong (ap-southeast-1)