OfficeIMO.Reader.Ocr.Process 3.0.0

OfficeIMO.Reader.Ocr.Process - external OCR process provider

OfficeIMO.Reader.Ocr.Process connects OfficeIMO.Reader.Core to a caller-configured executable through a versioned JSON file protocol. The executable runs directly—no command shell is inserted by the provider.

Install

dotnet add package OfficeIMO.Reader.Ocr.Process
dotnet add package OfficeIMO.Reader.Word

Configure an engine

using OfficeIMO.Reader;
using OfficeIMO.Reader.Ocr.Process;
using OfficeIMO.Reader.Word;

var engine = new ProcessOfficeOcrEngine(new ProcessOfficeOcrEngineOptions {
    FileName = "/opt/my-ocr/recognize",
    Arguments = new[] { "--request", "{request}" },
    Id = "my-ocr",
    Timeout = TimeSpan.FromMinutes(1),
    MaxOutputBytes = 8L * 1024L * 1024L
});

OfficeDocumentReader reader = new OfficeDocumentReaderBuilder()
    .AddWordHandler()
    .Build();
OfficeDocumentReadResult source = reader.ReadDocument("scan.docx");
OfficeDocumentOcrExecutionResult execution = await source.ApplyOcrAsync(engine);

Console.WriteLine(execution.Document.Markdown);

Each call receives an isolated request directory. The provider writes the candidate payload and a camel-case request JSON file with schema id officeimo.reader.ocr.process-request, version 1. The request's outputPath identifies where the executable must write a response envelope with schema id officeimo.reader.ocr.process-response, version 1, and an OfficeOcrEngineResult in its result property. Use ProcessOfficeOcrProtocol.SerializeResult(...) when the external bridge is implemented in .NET.

Available argument placeholders are {request}, {input}, {output}, {language}, {candidateId}, and {assetId}. They are substituted as individual process arguments, not shell text.

Operational boundaries

• Candidate count, input bytes, concurrency, engine duration, recognized text, and span counts remain bounded by OfficeDocumentOcrExecutionOptions.
• Process stdout and stderr, response JSON size, and runtime are bounded separately by ProcessOfficeOcrEngineOptions.
• The runner contains descendants in a kill-on-close Windows Job Object, a setsid process group on Linux/Unix, or a POSIX session launched through the system Perl on macOS. It fails closed when the host cannot provide one of those containment boundaries.
• Executable paths, arguments, environment variables, and provider options are trusted host configuration. Do not build them directly from document content.
• Payload bytes are stored in owner-only per-request directories/files on Unix and are deleted by default. Set KeepTemporaryFiles only for controlled diagnostics.

Targets and license

• Targets: netstandard2.0, net8.0, net10.0 (net472 is also included on Windows builds).
• License: MIT.

Dependency footprint

• External: A caller-configured executable plus System.Text.Json for the versioned protocol.
• OfficeIMO: OfficeIMO.Reader.Core owns candidate selection, bounded execution, containment, results, and diagnostics.

See the complete OfficeIMO package map for related formats and conversion paths.