How Tos

The samples and documentation should get you quickly up and running with PDF Extract capabilities in the PDFServices SDK including:

Extracting PDF as JSON: the content, structure & renditions of table and figure elements along with Character Bounding Boxes

For code examples illustrating other PDF actions including those below, see the PDFServices SDK :

Creating a PDF from multiple formats, including HTML, Microsoft Office documents, and text files
Exporting a PDF to other formats or an image
Combining entire PDFs or specified page ranges
Using OCR to make a PDF file searchable with a custom locale
Compress PDFs with compression level and Linearize PDFs
Protect PDFs with password(s) and Remove password protection from PDFs
Common page operations, including inserting, replacing, deleting, reordering, and rotating
Splitting PDFs into multiple files

How It Works

PDF Extract uses AI/ML technology to identify and categorize the various objects within documents – such as paragraphs, lists, headings, tables, and images – and extract the text, formatting, and associated document structural information which is then delivered in a resulting JSON file. Extracted table data can optionally be delivered within .CSV or .XLSX files, and extracted images are delivered as .PNG files. For additional information, please refer to PDF Extract API white paper

Custom timeout configuration

The APIs use inferred timeout properties and provide defaults. However, the SDK supports custom timeouts for the API calls. You can tailor the timeout settings for your environment and network speed. In addition to the details below, you can refer to working code samples:

Java timeout configuration

Available properties:

connectTimeout: Default: 2000. The maximum allowed time in milliseconds for creating an initial HTTPS connection.
socketTimeout: Default: 10000. The maximum allowed time in milliseconds between two successive HTTP response packets.
processingTimeout: Default: 600000. The maximum allowed time in milliseconds for processing the documents. Any operation taking more time than the specified processingTimeout will result in an operation timeout exception.
- Note : It is advisable to set the processingTimeout to higher values for processing large files.

Override the timeout properties via a custom ClientConfig class:

ClientConfig clientConfig = ClientConfig.builder()
    .withConnectTimeout(3000)
    .withSocketTimeout(20000)
    .build();
Copied to your clipboard
ClientConfig clientConfig = ClientConfig.builder()
    .withConnectTimeout(3000)
    .withSocketTimeout(20000)
    .build();

.NET timeout configuration

Available properties:

timeout: Default: 400000. The maximum allowed time in milliseconds for establishing a connection, sending a request, and getting a response.
readWriteTimeout: Default: 10000. The maximum allowed time in milliseconds to read or write data after connection is established.
processingTimeout: Default: 600000. The maximum allowed time in milliseconds for processing the documents. Any operation taking more time than the specified processingTimeout will result in an operation timeout exception.
- Note : It is advisable to set the processingTimeout to higher values for processing large files.

Override the timeout properties via a custom ClientConfig class:

ClientConfig clientConfig = ClientConfig.ConfigBuilder()
    .timeout(500000)
    .readWriteTimeout(15000)
    .Build();
Copied to your clipboard
ClientConfig clientConfig = ClientConfig.ConfigBuilder()
    .timeout(500000)
    .readWriteTimeout(15000)
    .Build();

Node.js timeout configuration

Available properties:

connectTimeout: Default: 10000. The maximum allowed time in milliseconds for creating an initial HTTPS connection.
readTimeout: Default: 10000. The maximum allowed time in milliseconds between two successive HTTP response packets.
processingTimeout: Default: 600000. The maximum allowed time in milliseconds for processing the documents. Any operation taking more time than the specified processingTimeout will result in an operation timeout exception.
- Note : It is advisable to set the processingTimeout to higher values for processing large files.

Override the timeout properties via a custom ClientConfig class:

const clientConfig = PDFServicesSdk.ClientConfig
  .clientConfigBuilder()
  .withConnectTimeout(15000)
  .withReadTimeout(15000)
  .build();
Copied to your clipboard
const clientConfig = PDFServicesSdk.ClientConfig
  .clientConfigBuilder()
  .withConnectTimeout(15000)
  .withReadTimeout(15000)
  .build();

Python timeout configuration

Available properties:

connectTimeout: Default: 4000. The number of milliseconds Requests will wait for the client to establish a connection to Server.
readTimeout: Default: 10000. The number of milliseconds the client will wait for the server to send a response.

Override the timeout properties via a custom ClientConfig class:

client_config = ClientConfig.builder()
    .with_connect_timeout(10000)
    .with_read_timeout(40000)
    .build()
Copied to your clipboard
client_config = ClientConfig.builder()
    .with_connect_timeout(10000)
    .with_read_timeout(40000)
    .build()