Textual

1. Extract textual information with image URL or pdf URL input

API:

Params:

Demo Python:

import requests

api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"

image_url = 'https://example.com/image.png'

response = requests.get(
  "https://cloud.computervision.com.vn/api/v2/ocr/document/general?img=%s&format_type=url&get_thumb=false"
  % image_url,
  auth=(api_key, api_secret))

print(response.json())

2. Extract textual information with image file or pdf file input

API:

Params:

Body:

Demo Python:

import requests

api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
image_path = '/path/to/your/image.jpg'

response = requests.post(
  "https://cloud.computervision.com.vn/api/v2/ocr/document/general?format_type=file&get_thumb=false",
  auth=(api_key, api_secret),
  files={'img': open(image_path, 'rb')})

print(response.json())

3. Extract textual information with JSON input

API:

Params:

Body:

{
  "img": "iVBORw0KGgoAAAANSU..." // string base64 of the image or pdf to extract
}

Demo Python:

import base64
import io
import requests
from PIL import Image
def get_byte_img(img):
    img_byte_arr = io.BytesIO()
    img.save(img_byte_arr, format='PNG')
    encoded_img = base64.encodebytes(img_byte_arr.getvalue()).decode('ascii')
    return encoded_img
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
img_name = "path_img"
encode_cmt = get_byte_img(Image.open(img_name))
response = requests.post(
    "https://cloud.computervision.com.vn/api/v2/ocr/document/general?format_type=base64&get_thumb=false",
    auth=(api_key, api_secret),
    json={'img' : encode_cmt})
print(response.json())

4. Response

The response will be a JSON with the following format:

{
  "data": [xxxx],
  "errorCode": string,
  "errorMessage": string
}

In case of extracting information from scanned documents, the data field will be a list, each element in the list will correspond to the information of a page in a pdf file or of an image. Each element in this list is represented as follows:

[
  // List of blocks in the same page
  [
    // List of lines in the same block
    [
      // List of texts in the same line (*)
    ],
  ],
];

Each text element (*) includes the following fields:

{
  "text": string,
  "confidence": float,
  "box": {
    "left": int,
    "right": int,
    "top": int,
    "bottom": int
  }
}

Error code table: