Document Layout Analysis

Convert document images to a Markdown/JSON format output, with table format in Markdown/HTML.

Applicable scenarios

Applicable to a variety of scenarios such as paper documents changed to electronic format, document identification, and content review to improve information processing efficiency.

API reference

• HTTP request method: POST

• Request body parameters

Name	Type	Required	Description
url	String	Choose url or img.	Image URL address, which supports HTTP/HTTPS and S3 protocols. Supported image formats are jpg/jpeg/png/bmp, with the longest side not exceeding 4096px.
img	String	Choose url or img.	Base64 encoded image data.
output_type	String		json or markdown, Whether the result is returned in json or converted to markdown.
table_type	String		html or markdown, Whether the table in the result is returned in html or converted to markdown.

• Example Request

Example 1

{
  "url": "Image URL address",
  "output_type": "json"
}

{
  "img": "Base64-encoded image data",
  "output_type": "json"
}

Example 2

{
  "url": "Image URL address",
  "output_type": "markdown"
}

{
  "img": "Base64-encoded image data",
  "output_type": "markdown"
}

• Response parameters

When output_type is json, a list is returned, and an item in the list is a block in a document.

Name	Type	Description
BlockType	String	These elements correspond to the different portions of the layout, and are: text, title, figure or table
Geometry	Dict	location information about the location of detected items on a document page.
Text	String	The text content of the current block. When BlockType is table, the html or markdown of the table will be returned depending on the table_type.

When output_type is markdown, a dict is returned.

Name	Type	Description
markdown	String	Converted images to markdown result.

• Example JSON response

Example 1 output_type is json response

[
  {
    "BlockType": "text",
    "Geometry": {
      "BoundingBox": {
        "Width": 972,
        "Height": 79,
        "Left": 561,
        "Top": 564
      }
    },
    "Text": "核准日期：xxx年xx月xx日"
  },
  {
    "BlockType": "text",
    "Geometry": {
      "BoundingBox": {
        "Width": 1543,
        "Height": 80,
        "Left": 569,
        "Top": 678
      }
    },
    "Text": "修改日期：xxx年xx月xx日"
  }
    ...
]

Example 2 output_type is markdown response

{
  "Markdown": "核准日期：xxx年xx月xx日 \n\n修改日期：xxx年xx月xx日...."
}

API test

You can use the following tools (API explorer, Postman, cURL, Python, Java) to test calling APIs.

API Explorer

Prerequisites

When deploying the solution, you need to：

• set the parameter API Explorer to yes.
• set the parameter API Gateway Authorization to NONE.

Otherwise, you can only view the API definitions in the API explorer, but cannot test calling API online.

Steps

1. Sign in to the AWS CloudFormation console.

2. On the Stacks page, select the solution’s root stack. Do not select the NESTED stack.

   

3. Choose the Outputs tab, and find the URL for APIExplorer.

4. Click the URL to access the API explorer. The APIs that you have selected during deployment will be displayed.

   

5. For the API you want to test, click the down arrow to display the request method.

6. Choose the Try it out button, and enter the correct Body data to test API and check the test result.
7. Make sure the format is correct, and choose Execute.
8. Check the returned result in JSON format in the Responses body. If needed, copy or download the result.
9. Check the Response headers.
10. (Optional) Choose Clear next to the Execute button to clear the request body and responses.

Postman (AWS_IAM Authentication）

1. Sign in to the AWS CloudFormation console.
2. On the Stacks page, select the solution’s root stack.
3. Choose the Outputs tab, and find the URL with the prefix GeneralOCR.

4. Create a new tab in Postman. Paste the URL into the address bar, and select POST as the HTTP call method.

   

5. Open the Authorization configuration, select Amazon Web Service Signature from the drop-down list, and enter the AccessKey, SecretKey and Amazon Web Service Region of the corresponding account (such as cn-north-1 or cn-northwest-1 ).

   

6. Open the Body configuration item and select the raw and JSON data types.

7. Enter the test data in the Body, and click the Send button to see the corresponding return results.

{
  "url": "Image URL address"
}

cURL

• Windows

curl --location --request POST "https://[API_ID].execute-api.[AWS_REGION].amazonaws.com/[STAGE]/layout_analysis" ^
--header "Content-Type: application/json" ^
--data-raw "{\"url\": \"Image URL address\"}"

• Linux/MacOS

curl --location --request POST 'https://[API_ID].execute-api.[AWS_REGION].amazonaws.com/[STAGE]/layout_analysis' \
--header 'Content-Type: application/json' \
--data-raw '{
  "url":"Image URL address"
}'

Python (AWS_IAM Authentication)

import requests
import json
from aws_requests_auth.boto_utils import BotoAWSRequestsAuth

auth = BotoAWSRequestsAuth(aws_host='[API_ID].execute-api.[AWS_REGION].amazonaws.com',
                           aws_region='[AWS_REGION]',
                           aws_service='execute-api')

url = 'https://[API_ID].execute-api.[AWS_REGION].amazonaws.com/[STAGE]/layout_analysis'
payload = {
    'url': 'Image URL address'
}
response = requests.request("POST", url, data=json.dumps(payload), auth=auth)
print(json.loads(response.text))

Python (NONE Authentication)

import requests
import json

url = "https://[API_ID].execute-api.[AWS_REGION].amazonaws.com/[STAGE]/layout_analysis"

payload = json.dumps({
  "url": "Image URL address"
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"url\":\"Image URL address\"\n}");
Request request = new Request.Builder()
  .url("https://xxxxxxxxxxx.execute-api.xxxxxxxxx.amazonaws.com/[STAGE]/layout_analysis")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Cost estimation

You are responsible for the cost of using each Amazon Web Services service when running the solution. As of this revision, the main cost factors affecting the solution include.

• Amazon API Gateway calls
• Amazon API Gateway data output
• Amazon CloudWatch Logs storage
• Amazon Elastic Container Registry storage

If you choose an Amazon Lambda based deployment, the factors also include:

• Amazon Lambda invocations
• Amazon Lambda running time

If you choose an Amazon SageMaker based deployment, the factors also include:

• Amazon SageMaker endpoint node instance type
• Amazon SageMaker endpoint node data input
• Amazon SageMaker endpoint node data output

Cost estimation example 1

In AWS China (Ningxia) Region operated by NWCD (cn-northwest-1), process an image of 1MB in 1 second

The cost of using this solution to process the image is shown below:

Service	Dimensions	Cost
AWS Lambda	1 million invocations	¥1.36
AWS Lambda	8192MB memory, 1 seconds run each time	¥907.8
Amazon API Gateway	1 million invocations	¥28.94
Amazon API Gateway	100KB data output each time, ¥0.933/GB	¥93.3
Amazon CloudWatch Logs	10KB each time, ¥6.228/GB	¥62.28
Amazon Elastic Container Registry	0.5GB storage, ¥0.69/GB each month	¥0.35
Total		¥1010.06

Cost estimation example 2

In US East (Ohio) Region (us-east-2), process an image of 1MB in 1 seconds

The cost of using this solution to process this image is shown below:

Service	Dimensions	Cost
AWS Lambda	1 million invocations	$0.20
AWS Lambda	8192MB memory, 1 seconds run each time	$133.3
Amazon API Gateway	1 million invocations	$3.5
Amazon API Gateway	100KB data output each time, $0.09/GB	$9
Amazon CloudWatch Logs	10KB each time, $0.50/GB	$5
Amazon Elastic Container Registry	0.5GB存储，$0.1/GB each month	$0.05
Total		$142.95

Uninstall the deployment

You can uninstall the Document Layout Analysis feature via Amazon CloudFormation as described in Add or remove AI features and make sure the DocumentLayoutAnalysis parameter is set to no in the parameters section.

Note

Time to uninstall the deployment is approximately: 15 Minutes