OCR Usage Basics

View as MarkdownMarkdown

Set up your AI agent

Give your coding agent live access to the GroupDocs documentation and API reference through the GroupDocs Docs MCP server — no install, no API key. Learn more

claude mcp add --transport http groupdocs-docs https://docs.groupdocs.com/mcp

Also process documents locally

The GroupDocs.Redaction MCP server lets your agent work with files on your machine; they are never uploaded. It needs the .NET 10 SDK or Docker.

claude mcp add groupdocs-redaction -- dnx GroupDocs.Redaction.Mcp --yes
Folders, licensing and more →

Although GroupDocs.Redaction itself does not contain OCR as a part of its distributable, it allows you to integrate any paid or free OCR solution. You have to implement IOcrConnector interface and its recognize() method, taking a stream with an image as an argument and returning a structured representation of the text, including bounding rectangles.

Note: Connector implementations are Java classes (same contracts as GroupDocs.Redaction for Java). Provide them on the JVM classpath or wrap with java.newProxy, then pass the instance into RedactorSettings from Node.js.

Java (connector skeleton)

public class MyOwnOcrConnector implements IOcrConnector
{
    public MyOwnOcrConnector()
    {
    }

    public RecognizedImage recognize(InputStream imageStream)
    {
	// TODO Create an instance of RecognizedImage class using OCR result returned by your OCR toolkit
    }
}

Once the instance is passed to RedactorSettings constructor, GroupDocs.Redaction will use it for image files and embedded images during an ordinary textual redaction process.

Node.js

const redaction = require('@groupdocs/groupdocs.redaction');
const java = require('java');
const Color = java.import('java.awt.Color');

// MyOwnOcrConnector is a Java class on the classpath (see skeleton above)
const redactor = new redaction.Redactor(
  'Sample.docx',
  new redaction.LoadOptions(),
  new redaction.RedactorSettings(new MyOwnOcrConnector()));
try {
  redactor.apply(new redaction.ExactPhraseRedaction(
    'John Doe',
    new redaction.ReplacementOptions(Color.BLACK)));
  redactor.save();
} finally {
  redactor.close();
}

GroupDocs.Redaction provides examples of the IOcrConnector implementation, free to use and customize for your needs: Aspose.OCR for Cloud SDK, Aspose.OCR for Java on-premise API, and Microsoft Azure Cognitive Services API. Cloud and Azure services propose a trial subscription plan, but you can use any other free or paid OCR solution, web-based or on premise, by creating your own implementation of IOcrConnector.

More resources

GitHub examples

You may easily run the code above and see the feature in action in our GitHub examples:

Free online document redaction App

Along with full featured Java library we provide simple, but powerful free Apps.

You are welcome to perform redactions for various document formats like PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, Emails and more with our free online Free Online Document Redaction App.