OfficeIMO.Reader 0.1.41

OfficeIMO.Reader - document extraction facade

👁 nuget version
👁 nuget downloads

OfficeIMO.Reader is a read-only facade for deterministic document extraction. It normalizes supported source files into ReaderChunk objects for search, indexing, chat, RAG, migration, and review workflows.

Install

dotnet add package OfficeIMO.Reader

Quick start

using OfficeIMO.Reader;

foreach (var chunk in DocumentReader.Read(@"C:\Docs\Policy.docx")) {
 Console.WriteLine(chunk.Id);
 Console.WriteLine(chunk.Location.HeadingPath);
 Console.WriteLine(chunk.Markdown ?? chunk.Text);
}

Streams and folders

using OfficeIMO.Reader;

using var stream = File.OpenRead(@"C:\Docs\Policy.docx");
var chunksFromStream = DocumentReader.Read(stream, "Policy.docx").ToList();

var folderChunks = DocumentReader.ReadFolder(
 folderPath: @"C:\Docs",
 folderOptions: new ReaderFolderOptions {
 Recurse = true,
 MaxFiles = 500,
 MaxTotalBytes = 500L * 1024 * 1024,
 SkipReparsePoints = true,
 DeterministicOrder = true
 },
 options: new ReaderOptions {
 MaxChars = 8_000
 }).ToList();

What it reads

Built-in and modular adapters can extract:

• Word (.docx, .docm) as Markdown chunks.
• Excel (.xlsx, .xlsm) as table chunks and optional Markdown previews.
• PowerPoint (.pptx, .pptm) as slide-aligned chunks, optionally including notes.
• Markdown (.md, .markdown) as parser-aware heading chunks.
• PDF, RTF, Visio, HTML, CSV/TSV, JSON, XML, YAML, EPUB, ZIP, and structured text through modular adapter packages.

Modular adapters

Install and register only the adapters you need:

using OfficeIMO.Reader.Csv;
using OfficeIMO.Reader.Epub;
using OfficeIMO.Reader.Html;
using OfficeIMO.Reader.Json;
using OfficeIMO.Reader.Pdf;
using OfficeIMO.Reader.Rtf;
using OfficeIMO.Reader.Visio;
using OfficeIMO.Reader.Xml;
using OfficeIMO.Reader.Yaml;
using OfficeIMO.Reader.Zip;

DocumentReaderCsvRegistrationExtensions.RegisterCsvHandler();
DocumentReaderEpubRegistrationExtensions.RegisterEpubHandler();
DocumentReaderHtmlRegistrationExtensions.RegisterHtmlHandler();
DocumentReaderJsonRegistrationExtensions.RegisterJsonHandler();
DocumentReaderPdfRegistrationExtensions.RegisterPdfHandler();
DocumentReaderRtfRegistrationExtensions.RegisterRtfHandler();
DocumentReaderVisioRegistrationExtensions.RegisterVisioHandler();
DocumentReaderXmlRegistrationExtensions.RegisterXmlHandler();
DocumentReaderYamlRegistrationExtensions.RegisterYamlHandler();
DocumentReaderZipRegistrationExtensions.RegisterZipHandler();

Host examples

Capability discovery

using OfficeIMO.Reader;

var capabilities = DocumentReader.GetCapabilities();
foreach (var capability in capabilities) {
 Console.WriteLine($"{capability.Id}: {string.Join(", ", capability.Extensions)}");
}

string manifestJson = DocumentReader.GetCapabilityManifestJson();

Register a custom handler

using OfficeIMO.Reader;

DocumentReader.RegisterHandler(new ReaderHandlerRegistration {
 Id = "custom-audit",
 DisplayName = "Custom audit reader",
 Kind = ReaderInputKind.Text,
 Extensions = new[] { ".auditx" },
 ReadPath = (path, options, cancellationToken) => {
 string text = File.ReadAllText(path);
 return new[] {
 new ReaderChunk {
 Id = "audit:1",
 Kind = ReaderInputKind.Text,
 Text = text,
 Location = new ReaderLocation { Path = path }
 }
 };
 }
});

Host contracts

• ReaderOptions controls chunk size, table row limits, footnotes/notes, Excel ranges, Markdown heading chunking, hashes, and input budgets.
• ReaderFolderOptions controls recursion, file limits, byte limits, reparse-point handling, and deterministic folder order.
• DocumentReader.GetCapabilities() and GetCapabilityManifestJson() expose a stable host-discovery surface.
• Custom handlers can be registered with DocumentReader.RegisterHandler(...).

Boundaries

• OfficeIMO.Reader owns the shared extraction contract and built-in facade.
• Source-specific parsing belongs in the source package or modular adapter.
• Adapters should use ReaderInputLimits so input size and stream behavior stays consistent.
• AI or database storage belongs in the consuming application.

Related packages

Targets and license

• Targets: netstandard2.0, net8.0, net10.0.
• License: MIT.
• Repository: EvotecIT/OfficeIMO