Digital document parsing

How to call the API

The digital document parsing API is a synchronous API. You can submit a sync task by calling the SubmitDigitalDocStructureJob or SubmitDigitalDocStructureJobAdvance operation. The timeout period can be set to 5 minutes.

This API supports two invocation methods: uploading a local document or passing a document URL.

• The following code provides an example of how to upload a local document using the Java SDK. You can call the SubmitDigitalDocStructureJobAdvance operation and use the fileUrlObject parameter to upload the local document.

  Note

  For more information about how to obtain and use AccessKey pairs, see the SDK usage guides for different languages in SDK Overview.

  Java

  import com.aliyun.docmind_api20220711.models.*;
  import com.aliyun.teaopenapi.models.Config;
  import com.aliyun.docmind_api20220711.Client;
  import com.aliyun.teautil.models.RuntimeOptions;
  import java.io.File;
  import java.io.FileInputStream;
  
  public static void main(String[] args) throws Exception {
          submit();
      }
  public static void submit() throws Exception {
      // Initialize the Credentials client using the default credential provider.
      com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
      Config config = new Config()
          // Obtain the AccessKey ID from the credentials.
          .setAccessKeyId(credentialClient.getAccessKeyId())
          // Obtain the AccessKey secret from the credentials.
          .setAccessKeySecret(credentialClient.getAccessKeySecret());
      // The endpoint. Both IPv4 and IPv6 are supported. For IPv6, use docmind-api-dualstack.cn-hangzhou.aliyuncs.com.
      config.endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
      Client client = new Client(config);
      // Create a RuntimeOptions instance and set the runtime parameters.
      RuntimeOptions runtime = new RuntimeOptions();
      SubmitDigitalDocStructureJobAdvanceRequest request = new SubmitDigitalDocStructureJobAdvanceRequest();
      File file = new File("D:\\example.xlsx");
      request.fileUrlObject = new FileInputStream(file);
      request.fileName = "example.xlsx";
      request.revealMarkdown=true;
      // Send the request and handle the response or exceptions.                                    
      SubmitDigitalDocStructureJobResponse response = client.submitDigitalDocStructureJobAdvance(request, runtimeOptions);
      System.out.println(JSON.toJSON(response.getBody()));
  }

  Node.js

  const Client = require('@alicloud/docmind-api20220711');
  const Credential = require('@alicloud/credentials');
  const Util = require('@alicloud/tea-util');
  const fs = require('fs');
  
  const getResult = async () => {
  	// Initialize the Credentials client using the default credential provider.
    const cred = new Credential.default();
    const client = new Client.default({
      // The endpoint. Both IPv4 and IPv6 are supported. For IPv6, use docmind-api-dualstack.cn-hangzhou.aliyuncs.com.
      endpoint: 'docmind-api.cn-hangzhou.aliyuncs.com',
      // Obtain the AccessKey ID from the credentials.
      accessKeyId: cred.credential.accessKeyId,
      // Obtain the AccessKey secret from the credentials.
      accessKeySecret: cred.credential.accessKeySecret,
      type: 'access_key',
      regionId: 'cn-hangzhou'
    });
    
    const advanceRequest = new Client.SubmitDigitalDocStructureJobAdvanceRequest();
    const file = fs.createReadStream('./example.pdf');
    advanceRequest.fileUrlObject = file;
    advanceRequest.fileName = 'example.pdf';
    const runtimeObject = new Util.RuntimeOptions({});
    const response = await client.submitDigitalDocStructureJobAdvance(advanceRequest, runtimeObject);
  	return response.body;
  };

  Python

  from alibabacloud_docmind_api20220711.client import Client as docmind_api20220711Client
  from alibabacloud_tea_openapi import models as open_api_models
  from alibabacloud_docmind_api20220711 import models as docmind_api20220711_models
  from alibabacloud_tea_util.client import Client as UtilClient
  from alibabacloud_credentials.client import Client as CredClient
  
  if __name__ == '__main__':
    	# Initialize the Credentials client using the default credential provider.
      cred=CredClient()
      config = open_api_models.Config(
          # Obtain the AccessKey ID from the credentials.
          access_key_id=cred.get_credential().get_access_key_id(),
          # Obtain the AccessKey secret from the credentials.
          access_key_secret=cred.get_credential().get_access_key_secret()
      )
      # The endpoint.
      config.endpoint = f'docmind-api.cn-hangzhou.aliyuncs.com'
      client = docmind_api20220711Client(config)
      request = docmind_api20220711_models.SubmitDigitalDocStructureJobAdvanceRequest(
          # file_url_object: The local file stream.
          file_url_object=open("./example.xlsx", "rb"),
          # file_name: The name of the file. The name must include the file extension.
          file_name='123.xlsx',
          reveal_markdown=True,
          # file_name_extension: The file extension. Specify either this parameter or file_name.
          # file_name_extension='xlsx'
      )
      runtime = util_models.RuntimeOptions()
      try:
          # If you copy the code to run, print the API return value.
          response = client.submit_digital_doc_structure_job_advance(request, runtime)
          # The format of the API return value is body -> data -> specific properties.
          print(response.body)
      except Exception as error:
          # If necessary, print the error.
          UtilClient.assert_as_string(error.message)  

  Go

  import (
  	"fmt"
  	"os"
    
  	openClient "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  	"github.com/alibabacloud-go/docmind-api-20220711/client"
  	"github.com/alibabacloud-go/tea-utils/v2/service"
    "github.com/aliyun/credentials-go/credentials"
  )
  
  func submit(){
   // Initialize the Credentials client using the default credential provider.
  	credential, err := credentials.NewCredential(nil)
  	// Obtain the AccessKey ID from the credentials.
  	accessKeyId, err := credential.GetAccessKeyId()
  	// Obtain the AccessKey secret from the credentials.
  	accessKeySecret, err := credential.GetAccessKeySecret()
    // The endpoint. Both IPv4 and IPv6 are supported. For IPv6, use docmind-api-dualstack.cn-hangzhou.aliyuncs.com.
    var endpoint string = "docmind-api.cn-hangzhou.aliyuncs.com"
  	config := openClient.Config{AccessKeyId: accessKeyId, AccessKeySecret: accessKeySecret, Endpoint: &endpoint}
  	// Initialize the client.
    cli, err := client.NewClient(&config)
  	if err != nil {
  		panic(err)
  	}
    // Call the operation to upload a local document.
    filename := "D:\\example.pdf"    
    f, err := os.Open(filename)
  	if err != nil {
      panic(err)
  	}
    // Initialize the request for the operation.
    request := client.SubmitDigitalDocStructureJobAdvanceRequest{
  		FileName:      &filename,
  		FileUrlObject: f,
  	}
    // Create a RuntimeOptions instance and set the runtime parameters.
    options := service.RuntimeOptions{}
    response, err := cli.SubmitDigitalDocStructureJobAdvance(&request, &options)
    if err != nil {
  		panic(err)
  	}
    // Print the result.
  	fmt.Println(response.Body.String())
  }

  C#

  using Newtonsoft.Json;
  using System;
  using System.Collections;
  using System.Collections.Generic;
  using System.IO;
  using System.Threading.Tasks;
  
  using Tea;
  using Tea.Utils;
  
    public static void SubmitFile()
          {
              // Initialize the Credentials client using the default credential provider.
            	var akCredential = new Aliyun.Credentials.Client(null);
              AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
              {
                  // Obtain the AccessKey ID from the credentials.
                  AccessKeyId = akCredential.GetAccessKeyId(),
                  // Obtain the AccessKey secret from the credentials.
                  AccessKeySecret = akCredential.GetAccessKeySecret(),
              };
              // The endpoint.
              config.Endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
              AlibabaCloud.SDK.Docmind_api20220711.Client client = new AlibabaCloud.SDK.Docmind_api20220711.Client(config);
                 // You must install the AlibabaCloud.DarabonbaStream dependency library.        
      				Stream bodySyream = AlibabaCloud.DarabonbaStream.StreamUtil.ReadFromFilePath("<YOUR-FILE-PATH>");
              AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitDigitalDocStructureJobAdvanceRequest request = new AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitDigitalDocStructureJobAdvanceRequest
              {
                  FileUrlObject = bodySyream,
                  FileNameExtension = "pdf"
              };
              AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
              try
              {
                  // If you copy the code to run, print the API return value.
                  client.SubmitDigitalDocStructureJobAdvance(request, runtime);
              }
              catch (TeaException error)
              {
                  // If necessary, print the error.
                  AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
              }
              catch (Exception _error)
              {
                  TeaException error = new TeaException(new Dictionary<string, object>
                  {
                      { "message", _error.Message }
                  });
                  // If necessary, print the error.
                  AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
              }
          }

• The following code provides an example of how to pass a document URL using the Java SDK. You can call the SubmitDigitalDocStructureJob operation and use the fileUrl parameter to pass the document URL. Note that the document URL must be a publicly accessible download URL, have no cross-domain restrictions, and contain no special escape characters.

  Note

  For more information about how to obtain and use AccessKey pairs, see the SDK usage guides for different languages in SDK Overview.

  Java

  import com.aliyun.docmind_api20220711.models.*;
  import com.aliyun.teaopenapi.models.Config;
  import com.aliyun.docmind_api20220711.Client;
  
  public static void main(String[] args) throws Exception {
          submit();
      }
  public static void submit() throws Exception {
      // Initialize the Credentials client using the default credential provider.
      com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
      Config config = new Config()
          // Obtain the AccessKey ID from the credentials.
          .setAccessKeyId(credentialClient.getAccessKeyId())
          // Obtain the AccessKey secret from the credentials.
          .setAccessKeySecret(credentialClient.getAccessKeySecret());
      // The endpoint. Both IPv4 and IPv6 are supported. For IPv6, use docmind-api-dualstack.cn-hangzhou.aliyuncs.com.
      config.endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
      Client client = new Client(config);
      SubmitDigitalDocStructureJobRequest request = new SubmitDigitalDocStructureJobRequest();
      request.fileName = "example.xlsx";
      request.fileUrl = "https://example.com/example.xlsx";
      request.revealMarkdown=true;
      SubmitDigitalDocStructureJobResponse response = client.submitDigitalDocStructureJob(request);
      System.out.println(JSON.toJSON(response.getBody()));
  }

  Node.js

  const Client = require('@alicloud/docmind-api20220711');
  const Credential = require('@alicloud/credentials');
  
  const getResult = async () => {
  	// Initialize the Credentials client using the default credential provider.
    const cred = new Credential.default();
    const client = new Client.default({
      // The endpoint. Both IPv4 and IPv6 are supported. For IPv6, use docmind-api-dualstack.cn-hangzhou.aliyuncs.com.
      endpoint: 'docmind-api.cn-hangzhou.aliyuncs.com',
      // Obtain the AccessKey ID from the credentials.
      accessKeyId: cred.credential.accessKeyId,
      // Obtain the AccessKey secret from the credentials.
      accessKeySecret: cred.credential.accessKeySecret,
      type: 'access_key',
      regionId: 'cn-hangzhou'
    });
    
    const request = new Client.SubmitDigitalDocStructureJobRequest();
    request.fileName = 'example.pdf';
    request.fileUrl = 'https://example.com/example.pdf';
    const response = await client.submitDigitalDocStructureJob(request);
    
    return response.body;
  }

  Python

  from alibabacloud_docmind_api20220711.client import Client as docmind_api20220711Client
  from alibabacloud_tea_openapi import models as open_api_models
  from alibabacloud_docmind_api20220711 import models as docmind_api20220711_models
  from alibabacloud_tea_util.client import Client as UtilClient
  from alibabacloud_credentials.client import Client as CredClient
  
  if __name__ == '__main__':
    	# Initialize the Credentials client using the default credential provider.
      cred=CredClient()
      config = open_api_models.Config(
          # Obtain the AccessKey ID from the credentials.
          access_key_id=cred.get_credential().get_access_key_id(),
          # Obtain the AccessKey secret from the credentials.
          access_key_secret=cred.get_credential().get_access_key_secret()
      )
      # The endpoint.
      config.endpoint = f'docmind-api.cn-hangzhou.aliyuncs.com'
      client = docmind_api20220711Client(config)
      request = docmind_api20220711_models.SubmitDigitalDocStructureJobRequest(
          # file_url: The URL of the file.
          file_url='https://example.com/example.xlsx',
          # file_name: The name of the file. The name must include the file extension.
          file_name='123.xlsx',
          reveal_markdown=True,
          # file_name_extension: The file extension. Specify either this parameter or file_name.
          # file_name_extension='xlsx'
      )
      try:
          # If you copy the code to run, print the API return value.
          response = client.submit_digital_doc_structure_job(request)
          # The format of the API return value is body -> data -> specific properties.
          print(response.body)   
      except Exception as error:
          # If necessary, print the error.
          UtilClient.assert_as_string(error.message) 

  Go

  import (
  	"fmt"
  
  	openClient "github.com/alibabacloud-go/darabonba-openapi/v2/client"
    "github.com/alibabacloud-go/docmind-api-20220711/client"
    "github.com/aliyun/credentials-go/credentials"
  )
  
  func submit(){
    // Initialize the Credentials client using the default credential provider.
  	credential, err := credentials.NewCredential(nil)
  	// Obtain the AccessKey ID from the credentials.
  	accessKeyId, err := credential.GetAccessKeyId()
  	// Obtain the AccessKey secret from the credentials.
  	accessKeySecret, err := credential.GetAccessKeySecret()
    // The endpoint. Both IPv4 and IPv6 are supported. For IPv6, use docmind-api-dualstack.cn-hangzhou.aliyuncs.com.
    var endpoint string = "docmind-api.cn-hangzhou.aliyuncs.com"
  	config := openClient.Config{AccessKeyId: accessKeyId, AccessKeySecret: accessKeySecret, Endpoint: &endpoint}
  	// Initialize the client.
    cli, err := client.NewClient(&config)
  	if err != nil {
  		panic(err)
  	}
    // The file URL.
    fileURL := "https://example.com/example.pdf"
    // The filename.
    fileName := "example.pdf"
    // Initialize the request for the operation.
    request := client.SubmitDigitalDocStructureJobRequest{
  		FileUrl:  &fileURL,
  		FileName: &fileName,
  	}
    response, err := cli.SubmitDigitalDocStructureJob(&request)
    if err != nil {
  		panic(err)
  	}
    // Print the result.
  	fmt.Println(response.Body.String())
  }

  C#

  using Newtonsoft.Json;
  using System;
  using System.Collections;
  using System.Collections.Generic;
  using System.IO;
  using System.Threading.Tasks;
  
  using Tea;
  using Tea.Utils;
  
  public static void SubmitUrl()
          {
              // Initialize the Credentials client using the default credential provider.
            	var akCredential = new Aliyun.Credentials.Client(null);
              AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
              {
                  // Obtain the AccessKey ID from the credentials.
                  AccessKeyId = akCredential.GetAccessKeyId(),
                  // Obtain the AccessKey secret from the credentials.
                  AccessKeySecret = akCredential.GetAccessKeySecret(),
              };
              // The endpoint.
              config.Endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
              AlibabaCloud.SDK.Docmind_api20220711.Client client = new AlibabaCloud.SDK.Docmind_api20220711.Client(config);
              AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitDigitalDocStructureJobRequest request = new AlibabaCloud.SDK.Docmind_api20220711.Models.SubmitDigitalDocStructureJobRequest
              {
                  FileUrl = "https://example.pdf",
                  FileNameExtension = "pdf"
              };
              try
              {
                  // If you copy the code to run, print the API return value.
                  client.SubmitDigitalDocStructureJob(request);
              }
              catch (TeaException error)
              {
                  // If necessary, print the error.
                  AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
              }
              catch (Exception _error)
              {
                  TeaException error = new TeaException(new Dictionary<string, object>
                  {
                      { "message", _error.Message }
                  });
                  // If necessary, print the error.
                  AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
              }
          }

  PHP

  use AlibabaCloud\SDK\Docmindapi\V20220711\Docmindapi;
  use AlibabaCloud\SDK\Docmindapi\V20220711\Models\SubmitDocStructureJobRequest;
  use Darabonba\OpenApi\Models\Config;
  use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
  use AlibabaCloud\Tea\Exception\TeaUnableRetryError;
  use AlibabaCloud\Credentials\Credential;
  
  // Initialize the Credentials client using the default credential provider.
  $bearerToken = new Credential();    
  $config = new Config();
  // The endpoint. Both IPv4 and IPv6 are supported. For IPv6, use docmind-api-dualstack.cn-hangzhou.aliyuncs.com.
  $config->endpoint = "docmind-api.cn-hangzhou.aliyuncs.com";
  // Obtain the AccessKey ID from the credentials.
  $config->accessKeyId = $bearerToken->getCredential()->getAccessKeyId();
  // Obtain the AccessKey secret from the credentials.
  $config->accessKeySecret = $bearerToken->getCredential()->getAccessKeySecret();
  $config->type = "access_key";
  $config->regionId = "cn-hangzhou";
  $client = new Docmindapi($config);
  $request = new SubmitDigitalDocStructureJobRequest();
  
  $runtime = new RuntimeOptions();
  $runtime->maxIdleConns = 3;
  $runtime->connectTimeout = 10000;
  $runtime->readTimeout = 10000;
  
  $request->fileName = "example.pdf";
  $request->fileUrl = "https://example.com/example.pdf";
  
  try {
    $response = $client->submitDigitalDocStructureJob($request, $runtime);
    var_dump($response->toMap());
  } catch (TeaUnableRetryError $e) {
    var_dump($e->getMessage());
    var_dump($e->getErrorInfo());
    var_dump($e->getLastException());
    var_dump($e->getLastRequest());
  }

If the task is successful, the value of Status is Success. The following code shows a sample response for a successful request:

{
  "data":{
    "docInfo":{
      "pageCountEstimate":3,
      "docType":"pdf"
    },
    "styles":[ ],
    "layouts":[
      {
        "pos":[
          {
            "x":0,
            "y":0
          },
          {
            "x":1113,
            "y":0
          },
          {
            "x":1113,
            "y":1440
          },
          {
            "x":0,
            "y":1440
          }
        ],
        "index":0,
        "subType":"none",
        "text":"",
        "type":"image",
        "pageNum":[
          0
        ],
        "uniqueId":"31128703ac73c52f05717b3b654de020"
      },
      {
        "pos":[
          {
            "x":0,
            "y":0
          },
          {
            "x":1113,
            "y":0
          },
          {
            "x":1113,
            "y":1440
          },
          {
            "x":0,
            "y":1440
          }
        ],
        "index":0,
        "subType":"none",
        "text":"",
        "type":"image",
        "pageNum":[
          1
        ],
        "uniqueId":"25b2a6f63bdf57f0d7a4f3da67c8616a"
      },
      {
        "pos":[
          {
            "x":0,
            "y":0
          },
          {
            "x":1113,
            "y":0
          },
          {
            "x":1113,
            "y":1440
          },
          {
            "x":0,
            "y":1440
          }
        ],
        "index":0,
        "subType":"none",
        "text":"",
        "type":"image",
        "pageNum":[
          2
        ],
        "uniqueId":"8c651c04c72a029b4be4ed80aa57fbbd"
      }
    ],
    "version":"1.2.0",
    "requestId":"docmind-20240820-6bf3e1bc1f164f0c99b8a12cfbcbeXXX"
  },
  "requestId":"1556A10B-E31C-5B21-8A5E-2179069D2XXX",
  "id":"docmind-20240820-6bf3e1bc1f164f0c99b8a12cfbcbeXXX",
  "status":"Success"
}

The processing result is in the Data node. The following table describes the format of the Data node.

import json
response = json.load(open("demo.json", "r"))
doc_json = response["Data"]

markdown_str = ""
for layout in doc_json["layouts"]:
  markdown_str += layout["markdownContent"] + "\n"
print(markdown_str)

import json
response = json.load(open("demo.json", "r"))
doc_json = response["Data"]
layout_cache: {} = {}
for layout in doc_json["layouts"]:
    layout_cache[layout["uniqueId"]] = layout
    layout["children"] = list()
for layout in doc_json["layouts"]:
    # Child layouts under the current layout
    print(layout["children"])

Appendix