Layout Analysis

Note：Before learning how to use different functions, we recommend that read the Request Workflow to know a basic PDF processing process. When using different functions, you can set their own special parameters when uploading files. Other basic steps are consistent. Example

1. Authentication

   You need to replace and with accessToken in the publicKey and secretKey authentication getback values you get from the console.

   curl

   curl --location --request POST 'https://api-server.compdf.com/server/v1/oauth/token' \
   --header 'Content-Type: application/json' \
   --data-raw '{
       "publicKey": "publicKey",
       "secretKey": "secretKey"
   }'

   java

    import java.io.*;
    import okhttp3.*;
    public class main {
      public static void main(String []args) throws IOException{
        OkHttpClient client = new OkHttpClient().newBuilder()
          .build();
        MediaType mediaType = MediaType.parse("text/plain");
        RequestBody body = RequestBody.create(mediaType, "{\n    \"publicKey\": \"{{public_key}}\",\n    \"secretKey\": \"{{secret_key}}\"\n}");
        Request request = new Request.Builder()
          .url("https://api-server.compdf.com/server/v1/oauth/token")
          .method("POST", body)
          .build();
        Response response = client.newCall(request).execute();
      }
    }

2. Create Task

   You need to replace with the accessToken which was obtained from the previous step, and replace with the language type you want to display the error information. After replacing them, you will get the taskId in the response data.

   curl

   curl --location --request GET 'https://api-server.compdf.com/server/v1/task/documentAI/layoutAnalysis' \
   --header 'Authorization: Bearer accessToken'

   java

    import java.io.*;
    import okhttp3.*;
    public class main {
      public static void main(String []args) throws IOException{
        OkHttpClient client = new OkHttpClient().newBuilder()
          .build();
        MediaType mediaType = MediaType.parse("text/plain");
        RequestBody body = RequestBody.create(mediaType, "");
        Request request = new Request.Builder()
          .url("https://api-server.compdf.com/server/v1/task/documentAI/layoutAnalysis?language={{language}}")
          .method("GET", body)
          .addHeader("Authorization", "Bearer {{accessToken}}")
          .build();
        Response response = client.newCall(request).execute();
      }
    }

3. Upload Files

   Replace with the file you want to convert, with the taskId obtained in the previous step, with the language type you want to display the error information, and with the accessToken obtained in the first step.

   -Supported image formats: jpg,jpeg,png,bmp

   curl

   curl --location --request POST 'https://api-server.compdf.com/server/v1/file/upload' \
   --header 'Authorization: Bearer accessToken' \
   --form 'file=@"test.png"' \
   --form 'taskId="taskId"' \
   --form 'password=""'

   java

    import java.io.*;
    import okhttp3.*;
    public class main {
      public static void main(String []args) throws IOException{
        OkHttpClient client = new OkHttpClient().newBuilder()
          .build();
        MediaType mediaType = MediaType.parse("text/plain");
        RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
          .addFormDataPart("file","{{file}}",
                           RequestBody.create(MediaType.parse("application/octet-stream"),
                                              new File("<file>")))
          .addFormDataPart("taskId","{{taskId}}")
          .addFormDataPart("language","{{language}}")
          .build();
        Request request = new Request.Builder()
          .url("https://api-server.compdf.com/server/v1/file/upload")
          .method("POST", body)
          .addHeader("Authorization", "Bearer {{accessToken}}")
          .build();
        Response response = client.newCall(request).execute();
      }
    }

4. Process Files

   Replace with the taskId you obtained from the Create task, and with the accessToken obtained in the first step, and replace with the language type you want to display the error information.

   curl

   curl --location -g --request GET 'https://api-server.compdf.com/server/v1/execute/start?taskId=taskId' \
   --header 'Authorization: Bearer accessToken'

   java

    import java.io.*;
    import okhttp3.*;
    public class main {
     public static void main(String []args) throws IOException{
       OkHttpClient client = new OkHttpClient().newBuilder()
         .build();
       MediaType mediaType = MediaType.parse("text/plain");
       RequestBody body = RequestBody.create(mediaType, "");
       Request request = new Request.Builder()
         .url("https://api-server.compdf.com/server/v1/execute/start?taskId={{taskId}}&language={{language}}")
         .method("GET", body)
         .addHeader("Authorization", "Bearer {{accessToken}}")
         .build();
       Response response = client.newCall(request).execute();
     }
    }

5. Get Task Information

   Replace with you from Create the task obtained in the taskId, replaced by access_token obtained in the first step.

   curl

   curl --location -g --request GET 'https://api-server.compdf.com/server/v1/task/taskInfo?taskId=taskId' \
   --header 'Authorization: Bearer accessToken'

   java

    import java.io.*;
    import okhttp3.*;
    public class main {
      public static void main(String []args) throws IOException{
        OkHttpClient client = new OkHttpClient().newBuilder()
          .build();
        MediaType mediaType = MediaType.parse("text/plain");
        RequestBody body = RequestBody.create(mediaType, "");
        Request request = new Request.Builder()
          .url("https://api-server.compdf.com/server/v1/task/taskInfo?taskId={{taskId}}")
          .method("GET", body)
          .addHeader("Authorization", "Bearer {{accessToken}}")
          .build();
        Response response = client.newCall(request).execute();
      }
    }

Result

File Type	Description
.JSON	OCR recognition results

Content

Parameter	Description
cost	Time spent on form recognition
boxes	Enter the location of all detected object boxes for the image
labels	The labels of the detected objects.
scores	The higher the score, the more reliable the result

{
  "cost": 182,
  "boxes": [
      [
          95.0,
          83.0,
          499.0,
          288.0
      ],
      [
          83.0,
          395.0,
          512.0,
          496.0
      ]
  ],
  "labels": [
      "Figure",
      "Table_std"
  ],
  "scores": [
      0.9789911508560181,
      0.972252368927002
  ]
}