Efficiently Extract Text from PDFs Using vwtyler/ocr-pdf Cognitive Actions

22 Apr 2025
Efficiently Extract Text from PDFs Using vwtyler/ocr-pdf Cognitive Actions

In the ever-evolving landscape of digital documentation, extracting text from PDF files is a common yet challenging task for developers. The vwtyler/ocr-pdf spec provides a powerful Cognitive Action designed to simplify this process. By leveraging Tesseract OCR technology, developers can easily extract text from PDF documents available online. This blog post will delve into the capabilities of the Extract Text from PDF via URL action, guiding you through its implementation and potential uses.

Prerequisites

Before diving into the integration of Cognitive Actions, ensure you have the following prerequisites:

  • An API key for the Cognitive Actions platform, which you will use for authentication.
  • Basic understanding of making HTTP requests and handling JSON data in your application.

Authentication typically works by including your API key in the request headers. This allows you to securely access the Cognitive Actions service.

Cognitive Actions Overview

Extract Text from PDF via URL

The Extract Text from PDF via URL action extracts text from PDF files by downloading the document from a specified URL, converting each page into an image, and then applying Tesseract OCR to extract the text. This action falls under the document-ocr category, making it a valuable tool for any application that deals with PDFs.

Input

To invoke this action, you need to provide the following input:

  • urlAddress (required): The direct URL of the PDF document from which text extraction will occur.

Here’s an example of the expected input JSON structure:

{
  "urlAddress": "https://www.cdss.ca.gov/Portals/9/Additional-Resources/Letters-and-Notices/ACINs/2024/I-35_24.pdf"
}

Output

Upon successful execution, the action returns the extracted text from the PDF, structured as follows:

--- Page 1 ---
July 19, 2024

CALIFORNIA DEPARTMENT OF SOCIAL SERVICES
EXECUTIVE SUMMARY

ALL COUNTY INFORMATION NOTICE NO. I-35-24

...

The output includes the text extracted from each page, clearly delineated for easy reading. This allows developers to process text data directly from PDF documents without manual intervention.

Conceptual Usage Example (Python)

Below is a conceptual Python code snippet demonstrating how to call the Extract Text from PDF via URL action using a generic Cognitive Actions endpoint:

import requests
import json

# Replace with your Cognitive Actions API key and endpoint
COGNITIVE_ACTIONS_API_KEY = "YOUR_COGNITIVE_ACTIONS_API_KEY"
COGNITIVE_ACTIONS_EXECUTE_URL = "https://api.cognitiveactions.com/actions/execute"  # Hypothetical endpoint

action_id = "c5aa0a49-935a-401d-a178-4d5d7f7c0f88"  # Action ID for Extract Text from PDF via URL

# Construct the input payload based on the action's requirements
payload = {
    "urlAddress": "https://www.cdss.ca.gov/Portals/9/Additional-Resources/Letters-and-Notices/ACINs/2024/I-35_24.pdf"
}

headers = {
    "Authorization": f"Bearer {COGNITIVE_ACTIONS_API_KEY}",
    "Content-Type": "application/json"
}

try:
    response = requests.post(
        COGNITIVE_ACTIONS_EXECUTE_URL,
        headers=headers,
        json={"action_id": action_id, "inputs": payload}
    )
    response.raise_for_status()  # Raise an exception for bad status codes (4xx or 5xx)

    result = response.json()
    print("Action executed successfully:")
    print(json.dumps(result, indent=2))

except requests.exceptions.RequestException as e:
    print(f"Error executing action {action_id}: {e}")
    if e.response is not None:
        print(f"Response status: {e.response.status_code}")
        try:
            print(f"Response body: {e.response.json()}")
        except json.JSONDecodeError:
            print(f"Response body: {e.response.text}")

In this code snippet, replace YOUR_COGNITIVE_ACTIONS_API_KEY with your actual API key. The payload is structured to match the input requirements of the action. The requests.post call executes the action, and the results are printed if successful.

Conclusion

The vwtyler/ocr-pdf Cognitive Action offers a seamless way to extract text from PDF files, enabling developers to automate document processing tasks efficiently. By integrating this action into your applications, you can enhance your workflows and improve data accessibility. Explore further use cases or consider combining this action with other Cognitive Actions to unlock even more powerful capabilities for your applications. Happy coding!

← Back to All Articles