langchain-hexread

A LangChain document loader for HexRead. It converts PDFs and images to Markdown through the HexRead API and returns LangChain Documents. Nothing is processed locally.

API access requires a paid HexRead plan. The free trial is web only, so no API key can be issued for it. Keys are created and revoked in your HexRead dashboard.

Install

pip install langchain-hexread

Python 3.10+. Pulls in hexread and langchain-core.

Quick start

from langchain_hexread import HexReadLoader

docs = HexReadLoader("report.pdf").load()  # one Document per page

Set HEXREAD_API_KEY, or pass api_key= to the loader. Nothing is resolved until a load starts, so building a loader never fails for a missing key.

file_path is a path, raw bytes, or an open binary file, or a sequence of them. A sequence is converted with bounded concurrency and the Documents come back in input order:

docs = HexReadLoader(["a.pdf", "b.pdf", "scan.png"], max_workers=2).load()

Keep max_workers at or below the concurrency your plan allows, or the API answers 429.

Loader options

A loader builds and closes its own client unless you inject one, in which case it is left open for you to reuse and close. Handing load() an AsyncHexRead (or aload() a HexRead) raises TypeError with the fix in the message.

Methods

The four BaseLoader entry points all work:

lazy_load() hands each page over as it is built, so a splitter or a vector store can start before the whole list exists:

for doc in HexReadLoader("report.pdf").lazy_load():
    index(doc)  # your splitter, embedder, or store

Document metadata

source and a zero-based page are the same shape LangChain's own PDF loaders produce, so existing chains and citation code keep working.

License

Licensed under the MIT License, © HexWorld Solutions GmbH.

Source, issues and the core client: github.com/HexWorldEU/hexread-python.