PDF Accessibility Auto-Tag API

PDF Accessibility Auto-Tag API Output Format

The output of PDF Accessibility Auto-Tag API contains the following:

The version 1.7 tagged PDF file with headings shifted if the option of shift headings is set.
A report in XLSX format, which provides information related to tagging of the document. This will be generated if report generation is enabled.

API limitations

File size: Files up to a maximum of 100 MB are supported.
Number of Pages: Non-scanned PDFs up to 200 pages and scanned PDFs up to 100 pages are supported, however limits may be lower for files with a large number of tables.
Rate limits: Keep request rate below 25 requests per minute.
Page Size: The API supports standard page sizes not more than 17.5” or less than 6” in either dimension.
Hidden Objects: PDF files that contain content that is not visible on the page like Javascript, OCG (optional content groups), etc are not supported. Files that contain such hidden information may fail to process. For such cases, removing hidden content prior to processing files again may return a successful result.
Language: The API is currently optimized for English language content. Files containing content in French, German, Spanish, Danish, Dutch, Norwegian (Bokmal), Galician, Catalan, Finnish, Italian, Swedish, Portuguese, and Romanian should return good results most of the time. Files containing content in Afrikaans, Bosnian, Croatian, Czech, Hungarian, Indonesian, Malay, Polish, Russian, Serbian, Turkish, Hindi, Marathi and other similar languages should return good results often. Non-English files may have issues with non-English punctuation. OCR is configured for English content.
OCR and Scan quality: The quality of text extracted from scanned files is dependent on the clarity of content in the input file and is currently configured for English content. Conditions like skewed pages, shadowing, obscured or overlapping fonts, and page resolution less than 200 DPI can all result in lower quality text output.
Form fields: Files containing XFA and other fillable form elements are not supported.
Unprotected files: The API supports files that are unprotected or where security restrictions allow editing of content. Files that are secured and do not allow editing of content will not be processed.
Annotations: Content in PDF files containing annotations such as highlights and sticky notes will be processed, but annotations that obscure text could impact output quality. Text within annotations will not be included in the output.
PDF Producers: The PDF Accessibility Auto-Tag API is designed to add tags to PDF to make it easier to make the file accessible. Files created from applications that produce other types of content like illustrations, CAD drawings or other types of vector art may not return high quality results.
PDF Collections: PDFs that are made from a collection of files including PDF Portfolios are not currently supported.

Error codes

Scenario	Error code	Error message
Unknown error/ failure	ERROR	Unexpected error
Timeout	TIMEOUT	Unexpected error: Processing timeout
Disqualified	DISQUALIFIED	File is not suitable for conversion
Unsupported XFA file	DISQUALIFIED_XFA	File is not suitable for conversion: File contains an XFA form
Page limit violation	DISQUALIFIED_PAGE_LIMIT	File is not suitable for conversion: File exceeds page limit
Scan page limit violation	DISQUALIFIED_SCAN_PAGE_LIMIT	File is not suitable for conversion: Scanned file exceeds page limit
File size violation	DISQUALIFIED_FILE_SIZE	File is not suitable for conversion: File exceeds size limit
Encryption permission	DISQUALIFIED_PERMISSIONS	File is not suitable for conversion: File permissions do not allow conversion
Complex file	DISQUALIFIED_COMPLEX_FILE	File is not suitable for conversion: File content is too complex
Unsupported language	DISQUALIFIED_LANGUAGE	File is not suitable for conversion: File content language is unsupported
Bad PDF	BAD_PDF	The PDF file is damaged or its content is too complex
Bad PDF file type	BAD_PDF_FILE_TYPE	The input file is not a PDF file
Damaged input file	BAD_PDF_DAMAGED	The input file is damaged
Complex table	BAD_PDF_COMPLEX_TABLE	The input file contains a table that is too complex to process
Complex content	BAD_PDF_COMPLEX_INPUT	The input file contains content that is too complex to process
Unsupported font	BAD_PDF_UNSUPPORTED_FONT	The input file contains font data that is corrupted or not supported
Large PDF file	BAD_PDF_LARGE_FILE	The input file size exceeds the maximum allowed
Protected PDF	PROTECTED_PDF	PDF is encrypted or password-protected
Empty or corrupted input	BAD_INPUT	Input is corrupted or empty
Invalid input parameters	BAD_INPUT_PARAMS	Invalid input parameters

Generate tagged PDF with version 1.7 along with an XLSX report and shift the headings in the output PDF file

The sample below generate tagged PDF of version 1.7 along with an XLSX report and shift the headings in the output PDF file.

Java

Python

// Get the samples from https://git.corp.adobe.com/dc/dc-cpf-sdk-java-samples/tree/beta
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDFWithOptions 

public class AutotagPDFWithOptions {

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(AutotagPDFWithOptions.class);

    public static void main(String[] args) {

        try {
            // Initial setup, create credentials instance.
            Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
                    .fromFile("pdfservices-api-credentials.json")
                    .build();

            //Create an ExecutionContext using credentials and create a new operation instance.
            ExecutionContext executionContext = ExecutionContext.create(credentials);

            AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();

            // Provide an input FileRef for the operation
            autotagPDFOperation.setInput(FileRef.createFromLocalFile("src/main/resources/autotagPdfInput.pdf"));

            // Build AutotagPDF options and set them into the operation
            AutotagPDFOptions autotagPDFOptions = AutotagPDFOptions.autotagPDFOptionsBuilder()
                    .shiftHeadings()
                    .generateReport()
                    .build();
            autotagPDFOperation.setOptions(autotagPDFOptions);

            // Execute the operation
            AutotagOutputFiles autotagOutputFiles = autotagPDFOperation.execute(executionContext);

            // Save the output files at the specified location
            autotagOutputFiles.saveTaggedPDF("output/AutotagPDFWithOptions-tagged.pdf");
            autotagOutputFiles.saveReport("output/AutotagPDFWithOptions-report.xlsx");


        } catch (ServiceApiException | IOException | ServiceUsageException e) {
            System.out.println(e);
        }
    }
}
Copied to your clipboard
1// Get the samples from https://git.corp.adobe.com/dc/dc-cpf-sdk-java-samples/tree/beta
2// Run the sample:
3// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDFWithOptions 
4
5public class AutotagPDFWithOptions {
6
7    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(AutotagPDFWithOptions.class);
8
9    public static void main(String[] args) {
10
11        try {
12            // Initial setup, create credentials instance.
13            Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
14                    .fromFile("pdfservices-api-credentials.json")
15                    .build();
16
17            //Create an ExecutionContext using credentials and create a new operation instance.
18            ExecutionContext executionContext = ExecutionContext.create(credentials);
19
20            AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();
21
22            // Provide an input FileRef for the operation
23            autotagPDFOperation.setInput(FileRef.createFromLocalFile("src/main/resources/autotagPdfInput.pdf"));
24
25            // Build AutotagPDF options and set them into the operation
26            AutotagPDFOptions autotagPDFOptions = AutotagPDFOptions.autotagPDFOptionsBuilder()
27                    .shiftHeadings()
28                    .generateReport()
29                    .build();
30            autotagPDFOperation.setOptions(autotagPDFOptions);
31
32            // Execute the operation
33            AutotagOutputFiles autotagOutputFiles = autotagPDFOperation.execute(executionContext);
34
35            // Save the output files at the specified location
36            autotagOutputFiles.saveTaggedPDF("output/AutotagPDFWithOptions-tagged.pdf");
37            autotagOutputFiles.saveReport("output/AutotagPDFWithOptions-report.xlsx");
38
39
40        } catch (ServiceApiException | IOException | ServiceUsageException e) {
41            System.out.println(e);
42        }
43    }
44}

# Get the samples from https://git.corp.adobe.com/dc/dc-cpf-python-sdk-samples/tree/beta
# Run the sample:
# python src/autotagpdf/autotag_pdf_with_options.py

logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO'))

try:
    # get base path.
    base_path = str(Path(__file__).parents[2])

    # Initial setup, create credentials instance.
    credentials = Credentials.service_account_credentials_builder() \
        .from_file(base_path + '/pdfservices-api-credentials.json') \
        .build()

    # Create an ExecutionContext using credentials and create a new operation instance.
    execution_context = ExecutionContext.create(credentials)
    autotag_pdf_operation = AutotagPDFOperation.create_new()

    # Set operation input from a source file.
    input_file_path = 'autotagPdfInput.pdf'
    source = FileRef.create_from_local_file(base_path + '/resources/' + input_file_path)
    autotag_pdf_operation.set_input(source)

    # Build AutotagPDF options and set them into the operation
    autotag_pdf_options: AutotagPDFOptions = AutotagPDFOptions.builder()\
        .with_shift_headings()\
        .with_generate_report()\
        .build()
    autotag_pdf_operation.set_options(autotag_pdf_options)

    # Execute the operation.
    autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context)

    input_file_name = Path(input_file_path).stem
    base_output_path = base_path + '/output/AutotagPDFWithOptions/'

    Path(base_output_path).mkdir(parents=True, exist_ok=True)
    tagged_pdf_path = f'{base_output_path}{input_file_name}-tagged.pdf'
    report_path = f'{base_output_path}{input_file_name}-report.xlsx'

    # Save the result to the specified location.
    autotag_output_files.save_pdf_file(tagged_pdf_path)
    autotag_output_files.save_xls_file(report_path)

except (ServiceApiException, ServiceUsageException, SdkException) as e:
    logging.exception(f'Exception encountered while executing operation: {e}')
Copied to your clipboard
1# Get the samples from https://git.corp.adobe.com/dc/dc-cpf-python-sdk-samples/tree/beta
2# Run the sample:
3# python src/autotagpdf/autotag_pdf_with_options.py
4
5logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO'))
6
7try:
8    # get base path.
9    base_path = str(Path(__file__).parents[2])
10
11    # Initial setup, create credentials instance.
12    credentials = Credentials.service_account_credentials_builder() \
13        .from_file(base_path + '/pdfservices-api-credentials.json') \
14        .build()
15
16    # Create an ExecutionContext using credentials and create a new operation instance.
17    execution_context = ExecutionContext.create(credentials)
18    autotag_pdf_operation = AutotagPDFOperation.create_new()
19
20    # Set operation input from a source file.
21    input_file_path = 'autotagPdfInput.pdf'
22    source = FileRef.create_from_local_file(base_path + '/resources/' + input_file_path)
23    autotag_pdf_operation.set_input(source)
24
25    # Build AutotagPDF options and set them into the operation
26    autotag_pdf_options: AutotagPDFOptions = AutotagPDFOptions.builder()\
27        .with_shift_headings()\
28        .with_generate_report()\
29        .build()
30    autotag_pdf_operation.set_options(autotag_pdf_options)
31
32    # Execute the operation.
33    autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context)
34
35    input_file_name = Path(input_file_path).stem
36    base_output_path = base_path + '/output/AutotagPDFWithOptions/'
37
38    Path(base_output_path).mkdir(parents=True, exist_ok=True)
39    tagged_pdf_path = f'{base_output_path}{input_file_name}-tagged.pdf'
40    report_path = f'{base_output_path}{input_file_name}-report.xlsx'
41
42    # Save the result to the specified location.
43    autotag_output_files.save_pdf_file(tagged_pdf_path)
44    autotag_output_files.save_xls_file(report_path)
45
46except (ServiceApiException, ServiceUsageException, SdkException) as e:
47    logging.exception(f'Exception encountered while executing operation: {e}')

Generate tagged PDF from a PDF

The sample below generates tagged PDF from a PDF.

Java

Python

// Get the samples from https://git.corp.adobe.com/dc/dc-cpf-sdk-java-samples/tree/beta
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDF

public class AutotagPDF {

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(AutotagPDF.class);

    public static void main(String[] args) {

        try {
            // Initial setup, create credentials instance.
            Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
                    .fromFile("pdfservices-api-credentials.json")
                    .build();

            //Create an ExecutionContext using credentials and create a new operation instance.
            ExecutionContext executionContext = ExecutionContext.create(credentials);

            AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();

            // Provide an input FileRef for the operation
            autotagPDFOperation.setInput(FileRef.createFromLocalFile("src/main/resources/autotagPdfInput.pdf"));

            // Execute the operation
            AutotagOutputFiles autotagOutputFiles = autotagPDFOperation.execute(executionContext);

            // Save the output files at the specified location
            autotagOutputFiles.saveTaggedPDF("output/AutotagPDF-tagged.pdf");

        } catch (ServiceApiException | IOException | ServiceUsageException e) {
            System.out.println(e);
        }
    }
}  
Copied to your clipboard
1// Get the samples from https://git.corp.adobe.com/dc/dc-cpf-sdk-java-samples/tree/beta
2// Run the sample:
3// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDF
4
5public class AutotagPDF {
6
7    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(AutotagPDF.class);
8
9    public static void main(String[] args) {
10
11        try {
12            // Initial setup, create credentials instance.
13            Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
14                    .fromFile("pdfservices-api-credentials.json")
15                    .build();
16
17            //Create an ExecutionContext using credentials and create a new operation instance.
18            ExecutionContext executionContext = ExecutionContext.create(credentials);
19
20            AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();
21
22            // Provide an input FileRef for the operation
23            autotagPDFOperation.setInput(FileRef.createFromLocalFile("src/main/resources/autotagPdfInput.pdf"));
24
25            // Execute the operation
26            AutotagOutputFiles autotagOutputFiles = autotagPDFOperation.execute(executionContext);
27
28            // Save the output files at the specified location
29            autotagOutputFiles.saveTaggedPDF("output/AutotagPDF-tagged.pdf");
30
31        } catch (ServiceApiException | IOException | ServiceUsageException e) {
32            System.out.println(e);
33        }
34    }
35}

# Get the samples from https://git.corp.adobe.com/dc/dc-cpf-python-sdk-samples/tree/beta
# Run the sample:
# python src/autotagpdf/autotag_pdf.py

logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO'))

try:
    # get base path.
    base_path = str(Path(__file__).parents[2])

    # Initial setup, create credentials instance.
    credentials = Credentials.service_account_credentials_builder() \
        .from_file(base_path + '/pdfservices-api-credentials.json') \
        .build()

    # Create an ExecutionContext using credentials and create a new operation instance.
    execution_context = ExecutionContext.create(credentials)
    autotag_pdf_operation = AutotagPDFOperation.create_new()

    # Set operation input from a source file.
    input_file_path = 'autotagPdfInput.pdf'
    source = FileRef.create_from_local_file(base_path + '/resources/' + input_file_path)
    autotag_pdf_operation.set_input(source)

    # Execute the operation.
    autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context)

    input_file_name = Path(input_file_path).stem
    base_output_path = base_path + '/output/AutotagPDF/'

    Path(base_output_path).mkdir(parents=True, exist_ok=True)
    tagged_pdf_path = f'{base_output_path}{input_file_name}-tagged.pdf'

    # Save the result to the specified location.
    autotag_output_files.save_pdf_file(tagged_pdf_path)

except (ServiceApiException, ServiceUsageException, SdkException) as e:
    logging.exception(f'Exception encountered while executing operation: {e}')
Copied to your clipboard
1# Get the samples from https://git.corp.adobe.com/dc/dc-cpf-python-sdk-samples/tree/beta
2# Run the sample:
3# python src/autotagpdf/autotag_pdf.py
4
5logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO'))
6
7try:
8    # get base path.
9    base_path = str(Path(__file__).parents[2])
10
11    # Initial setup, create credentials instance.
12    credentials = Credentials.service_account_credentials_builder() \
13        .from_file(base_path + '/pdfservices-api-credentials.json') \
14        .build()
15
16    # Create an ExecutionContext using credentials and create a new operation instance.
17    execution_context = ExecutionContext.create(credentials)
18    autotag_pdf_operation = AutotagPDFOperation.create_new()
19
20    # Set operation input from a source file.
21    input_file_path = 'autotagPdfInput.pdf'
22    source = FileRef.create_from_local_file(base_path + '/resources/' + input_file_path)
23    autotag_pdf_operation.set_input(source)
24
25    # Execute the operation.
26    autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context)
27
28    input_file_name = Path(input_file_path).stem
29    base_output_path = base_path + '/output/AutotagPDF/'
30
31    Path(base_output_path).mkdir(parents=True, exist_ok=True)
32    tagged_pdf_path = f'{base_output_path}{input_file_name}-tagged.pdf'
33
34    # Save the result to the specified location.
35    autotag_output_files.save_pdf_file(tagged_pdf_path)
36
37except (ServiceApiException, ServiceUsageException, SdkException) as e:
38    logging.exception(f'Exception encountered while executing operation: {e}')

Generates tagged PDF by setting options with command line arguments

The sample below generates tagged PDF by setting options through command line arguments.

Here is a sample list of command line arguments and their description:

--input < input file path >
--output < output file path >
--report { If this argument is present then the output will be generated with the report }
--shift_headings { If this argument is present then the headings will be shifted in the output PDF file }

Java

Python

// Get the samples from https://git.corp.adobe.com/dc/dc-cpf-sdk-java-samples/tree/beta
// Run the sample:
// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDFParamaterised -Dexec.args="--report --shift_headings --input src/main/resources/autotagPdfInput.pdf --output output/"

public class AutotagPDFParamaterised {

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(AutotagPDFWithOptions.class);

    public static void main(String[] args) {
        LOGGER.info("--input " + getInputFilePathFromCmdArgs(args));
        LOGGER.info("--output " + getOutputFilePathFromCmdArgs(args));
        LOGGER.info("--report " + getGenerateReportFromCmdArgs(args));
        LOGGER.info("--shift_headings " + getShiftHeadingsFromCmdArgs(args));

        try {
            // Initial setup, create credentials instance.
            Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
                    .fromFile("pdfservices-api-credentials.json")
                    .build();

            //Create an ExecutionContext using credentials and create a new operation instance.
            ExecutionContext executionContext = ExecutionContext.create(credentials);

            AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();

            // Set input for operation from command line args
            autotagPDFOperation.setInput(FileRef.createFromLocalFile(getInputFilePathFromCmdArgs(args)));

            // Get and Build AutotagPDF options from command line args and set them into the operation
            AutotagPDFOptions autotagPDFOptions = getOptionsFromCmdArgs(args);
            autotagPDFOperation.setOptions(autotagPDFOptions);

            // Execute the operation
            AutotagOutputFiles autotagOutputFiles = autotagPDFOperation.execute(executionContext);

            // Save the output files at the specified location
            String outputPath = getOutputFilePathFromCmdArgs(args);
            autotagOutputFiles.saveTaggedPDF(outputPath + "AutotagPDFParameterised-tagged.pdf");
            if (autotagPDFOptions != null && autotagPDFOptions.isGenerateReport())
                autotagOutputFiles.saveReport(outputPath + "AutotagPDFParameterised-report.xlsx");

        } catch (ServiceApiException | IOException | ServiceUsageException e) {
            System.out.println(e);
        }
    }

    private static AutotagPDFOptions getOptionsFromCmdArgs(String[] args) {
        Boolean generateReport = getGenerateReportFromCmdArgs(args);
        Boolean shiftHeadings = getShiftHeadingsFromCmdArgs(args);

        AutotagPDFOptions.Builder builder = AutotagPDFOptions.autotagPDFOptionsBuilder();

        if (generateReport)
            builder.generateReport();
        if (shiftHeadings)
            builder.shiftHeadings();

        return builder.build();
    }

    private static Boolean getShiftHeadingsFromCmdArgs(String[] args) {
        return Arrays.asList(args).contains("--shift_headings");
    }

    private static Boolean getGenerateReportFromCmdArgs(String[] args) {
        return Arrays.asList(args).contains("--report");
    }

    private static String getInputFilePathFromCmdArgs(String[] args) {
        String inputFilePath = "src/main/resources/autotagPdfInput.pdf";
        int inputFilePathIndex = Arrays.asList(args).indexOf("--input");
        if (inputFilePathIndex >= 0 && inputFilePathIndex < args.length - 1) {
            inputFilePath = args[inputFilePathIndex + 1];
        } else
            LOGGER.info("input file not specified, using default value : autotagPdfInput.pdf");

        return inputFilePath;
    }

    private static String getOutputFilePathFromCmdArgs(String[] args) {
        String outputFilePath = "output/";
        int outputFilePathIndex = Arrays.asList(args).indexOf("--output");
        if (outputFilePathIndex >= 0 && outputFilePathIndex < args.length - 1) {
            outputFilePath = args[outputFilePathIndex + 1];
        } else
            LOGGER.info("output path not specified, using default value : output/");

        return outputFilePath;
    }
} 
Copied to your clipboard
1// Get the samples from https://git.corp.adobe.com/dc/dc-cpf-sdk-java-samples/tree/beta
2// Run the sample:
3// mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDFParamaterised -Dexec.args="--report --shift_headings --input src/main/resources/autotagPdfInput.pdf --output output/"
4
5public class AutotagPDFParamaterised {
6
7    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(AutotagPDFWithOptions.class);
8
9    public static void main(String[] args) {
10        LOGGER.info("--input " + getInputFilePathFromCmdArgs(args));
11        LOGGER.info("--output " + getOutputFilePathFromCmdArgs(args));
12        LOGGER.info("--report " + getGenerateReportFromCmdArgs(args));
13        LOGGER.info("--shift_headings " + getShiftHeadingsFromCmdArgs(args));
14
15        try {
16            // Initial setup, create credentials instance.
17            Credentials credentials = Credentials.serviceAccountCredentialsBuilder()
18                    .fromFile("pdfservices-api-credentials.json")
19                    .build();
20
21            //Create an ExecutionContext using credentials and create a new operation instance.
22            ExecutionContext executionContext = ExecutionContext.create(credentials);
23
24            AutotagPDFOperation autotagPDFOperation = AutotagPDFOperation.createNew();
25
26            // Set input for operation from command line args
27            autotagPDFOperation.setInput(FileRef.createFromLocalFile(getInputFilePathFromCmdArgs(args)));
28
29            // Get and Build AutotagPDF options from command line args and set them into the operation
30            AutotagPDFOptions autotagPDFOptions = getOptionsFromCmdArgs(args);
31            autotagPDFOperation.setOptions(autotagPDFOptions);
32
33            // Execute the operation
34            AutotagOutputFiles autotagOutputFiles = autotagPDFOperation.execute(executionContext);
35
36            // Save the output files at the specified location
37            String outputPath = getOutputFilePathFromCmdArgs(args);
38            autotagOutputFiles.saveTaggedPDF(outputPath + "AutotagPDFParameterised-tagged.pdf");
39            if (autotagPDFOptions != null && autotagPDFOptions.isGenerateReport())
40                autotagOutputFiles.saveReport(outputPath + "AutotagPDFParameterised-report.xlsx");
41
42        } catch (ServiceApiException | IOException | ServiceUsageException e) {
43            System.out.println(e);
44        }
45    }
46
47    private static AutotagPDFOptions getOptionsFromCmdArgs(String[] args) {
48        Boolean generateReport = getGenerateReportFromCmdArgs(args);
49        Boolean shiftHeadings = getShiftHeadingsFromCmdArgs(args);
50
51        AutotagPDFOptions.Builder builder = AutotagPDFOptions.autotagPDFOptionsBuilder();
52
53        if (generateReport)
54            builder.generateReport();
55        if (shiftHeadings)
56            builder.shiftHeadings();
57
58        return builder.build();
59    }
60
61    private static Boolean getShiftHeadingsFromCmdArgs(String[] args) {
62        return Arrays.asList(args).contains("--shift_headings");
63    }
64
65    private static Boolean getGenerateReportFromCmdArgs(String[] args) {
66        return Arrays.asList(args).contains("--report");
67    }
68
69    private static String getInputFilePathFromCmdArgs(String[] args) {
70        String inputFilePath = "src/main/resources/autotagPdfInput.pdf";
71        int inputFilePathIndex = Arrays.asList(args).indexOf("--input");
72        if (inputFilePathIndex >= 0 && inputFilePathIndex < args.length - 1) {
73            inputFilePath = args[inputFilePathIndex + 1];
74        } else
75            LOGGER.info("input file not specified, using default value : autotagPdfInput.pdf");
76
77        return inputFilePath;
78    }
79
80    private static String getOutputFilePathFromCmdArgs(String[] args) {
81        String outputFilePath = "output/";
82        int outputFilePathIndex = Arrays.asList(args).indexOf("--output");
83        if (outputFilePathIndex >= 0 && outputFilePathIndex < args.length - 1) {
84            outputFilePath = args[outputFilePathIndex + 1];
85        } else
86            LOGGER.info("output path not specified, using default value : output/");
87
88        return outputFilePath;
89    }
90}

# Get the samples from https://git.corp.adobe.com/dc/dc-cpf-python-sdk-samples/tree/beta
# Run the sample:
# python src/autotagpdf/autotag_pdf_parameterised.py --report --shift_headings --input resources/autotagPdfInput.pdf --output output/

logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO'))


class AutotagPDFParameterised:

    _input_path: str
    _output_path: str
    _generate_report: bool
    _shift_headings: bool

    base_path = str(Path(__file__).parents[2])

    def __init__(self):
        pass

    @staticmethod
    def parse_args(*args: str):
        if not args:
            args = sys.argv[1:]
        parser = argparse.ArgumentParser(description='Autotag PDF')

        parser.add_argument('--input', help='Input file path', type=Path, metavar='input')
        parser.add_argument('--output', help='Output path', type=Path, dest='output')
        parser.add_argument('--report', dest='report', action='store_true', help='Generate report(in XLSX format)',
                            default=False)
        parser.add_argument('--shift_headings', dest='shift_headings', action='store_true', help='Shift headings',
                            default=False)

        return parser.parse_args(args)

    def get_default_input_file_path(self) -> str:
        return self.base_path + '/resources/autotagPdfInput.pdf'

    def get_default_output_file_path(self) -> str:
        return self.base_path + '/output/AutotagPDFParameterised'

    def get_autotag_pdf_options(self) -> AutotagPDFOptions:
        shift_headings = self._shift_headings
        generate_report = self._generate_report

        builder: AutotagPDFOptions.Builder = AutotagPDFOptions.builder()
        if shift_headings:
            builder.with_shift_headings()
        if generate_report:
            builder.with_generate_report()
        return builder.build()

    def execute(self, *args: str) -> None:
        args = self.parse_args(*args)
        self._input_path = args.input if args.input else self.get_default_input_file_path()
        self._output_path = args.output if args.output else self.get_default_output_file_path()
        self._generate_report = args.report
        self._shift_headings = args.shift_headings

        self.autotag_pdf()

    def autotag_pdf(self):
        try:
            # Initial setup, create credentials instance.
            credentials = Credentials.service_account_credentials_builder() \
                .from_file(self.base_path + '/pdfservices-api-credentials.json') \
                .build()

            # Create an ExecutionContext using credentials and create a new operation instance.
            execution_context = ExecutionContext.create(credentials)
            autotag_pdf_operation = AutotagPDFOperation.create_new()

            # Set operation input from a source file.
            source = FileRef.create_from_local_file(self._input_path)
            autotag_pdf_operation.set_input(source)

            # Build AutotagPDF options and set them into the operation
            autotag_pdf_operation.set_options(self.get_autotag_pdf_options())

            # Execute the operation.
            autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context)

            input_file_name = Path(self._input_path).stem
            base_output_path = self._output_path

            Path(base_output_path).mkdir(parents=True, exist_ok=True)

            # Save the result to the specified location.
            tagged_pdf_path = f'{base_output_path}/{input_file_name}-tagged.pdf'
            autotag_output_files.save_pdf_file(tagged_pdf_path)
            if self._generate_report:
                report_path = f'{base_output_path}/{input_file_name}-report.xlsx'
                autotag_output_files.save_xls_file(report_path)

        except (ServiceApiException, ServiceUsageException, SdkException) as e:
            logging.exception(f'Exception encountered while executing operation: {e}')


if __name__ == "__main__":
    autotag_pdf_parameterised = AutotagPDFParameterised()
    autotag_pdf_parameterised.execute()
Copied to your clipboard
1# Get the samples from https://git.corp.adobe.com/dc/dc-cpf-python-sdk-samples/tree/beta
2# Run the sample:
3# python src/autotagpdf/autotag_pdf_parameterised.py --report --shift_headings --input resources/autotagPdfInput.pdf --output output/
4
5logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO'))
6
7
8class AutotagPDFParameterised:
9
10    _input_path: str
11    _output_path: str
12    _generate_report: bool
13    _shift_headings: bool
14
15    base_path = str(Path(__file__).parents[2])
16
17    def __init__(self):
18        pass
19
20    @staticmethod
21    def parse_args(*args: str):
22        if not args:
23            args = sys.argv[1:]
24        parser = argparse.ArgumentParser(description='Autotag PDF')
25
26        parser.add_argument('--input', help='Input file path', type=Path, metavar='input')
27        parser.add_argument('--output', help='Output path', type=Path, dest='output')
28        parser.add_argument('--report', dest='report', action='store_true', help='Generate report(in XLSX format)',
29                            default=False)
30        parser.add_argument('--shift_headings', dest='shift_headings', action='store_true', help='Shift headings',
31                            default=False)
32
33        return parser.parse_args(args)
34
35    def get_default_input_file_path(self) -> str:
36        return self.base_path + '/resources/autotagPdfInput.pdf'
37
38    def get_default_output_file_path(self) -> str:
39        return self.base_path + '/output/AutotagPDFParameterised'
40
41    def get_autotag_pdf_options(self) -> AutotagPDFOptions:
42        shift_headings = self._shift_headings
43        generate_report = self._generate_report
44
45        builder: AutotagPDFOptions.Builder = AutotagPDFOptions.builder()
46        if shift_headings:
47            builder.with_shift_headings()
48        if generate_report:
49            builder.with_generate_report()
50        return builder.build()
51
52    def execute(self, *args: str) -> None:
53        args = self.parse_args(*args)
54        self._input_path = args.input if args.input else self.get_default_input_file_path()
55        self._output_path = args.output if args.output else self.get_default_output_file_path()
56        self._generate_report = args.report
57        self._shift_headings = args.shift_headings
58
59        self.autotag_pdf()
60
61    def autotag_pdf(self):
62        try:
63            # Initial setup, create credentials instance.
64            credentials = Credentials.service_account_credentials_builder() \
65                .from_file(self.base_path + '/pdfservices-api-credentials.json') \
66                .build()
67
68            # Create an ExecutionContext using credentials and create a new operation instance.
69            execution_context = ExecutionContext.create(credentials)
70            autotag_pdf_operation = AutotagPDFOperation.create_new()
71
72            # Set operation input from a source file.
73            source = FileRef.create_from_local_file(self._input_path)
74            autotag_pdf_operation.set_input(source)
75
76            # Build AutotagPDF options and set them into the operation
77            autotag_pdf_operation.set_options(self.get_autotag_pdf_options())
78
79            # Execute the operation.
80            autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context)
81
82            input_file_name = Path(self._input_path).stem
83            base_output_path = self._output_path
84
85            Path(base_output_path).mkdir(parents=True, exist_ok=True)
86
87            # Save the result to the specified location.
88            tagged_pdf_path = f'{base_output_path}/{input_file_name}-tagged.pdf'
89            autotag_output_files.save_pdf_file(tagged_pdf_path)
90            if self._generate_report:
91                report_path = f'{base_output_path}/{input_file_name}-report.xlsx'
92                autotag_output_files.save_xls_file(report_path)
93
94        except (ServiceApiException, ServiceUsageException, SdkException) as e:
95            logging.exception(f'Exception encountered while executing operation: {e}')
96
97
98if __name__ == "__main__":
99    autotag_pdf_parameterised = AutotagPDFParameterised()
100    autotag_pdf_parameterised.execute()

Overview

Release Notes

Was this helpful?

Yes

PDF Accessibility Auto-Tag API

PDF Accessibility Auto-Tag API Output Format.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

API limitations

Error codes

Generate tagged PDF with version 1.7 along with an XLSX report and shift the headings in the output PDF file

Generate tagged PDF from a PDF

Generates tagged PDF by setting options with command line arguments

PDF Accessibility Auto-Tag API Output Format