Skip to main content

LangChain data loaders based on Markdown by @untrueaxioms.

Project description

Markitdown LangChain Integration

This project provides document loaders that seamlessly integrate the Markitdown library with LangChain. Markitdown excels at converting various document types (DOCX, PPTX, XLSX, and more) into Markdown format. These loaders empower you to effortlessly load, process, and analyze these documents within your LangChain pipelines.

MarkItDown is a lightweight Python utility designed for converting diverse file formats into Markdown, optimized for use with Large Language Models (LLMs) and related text analysis workflows. It shares similarities with textract but distinguishes itself by prioritizing the preservation of crucial document structure and content as Markdown. This includes headings, lists, tables, links, and more. While the output is generally readable, its primary purpose is to be consumed by text analysis tools, rather than serving as a high-fidelity document conversion solution for human readers.

Explore the MarkItDown project on GitHub: https://github.com/microsoft/markitdown

Currently, MarkItDown supports:

  • PDF
  • PowerPoint
  • Word
  • Excel
  • Images (EXIF metadata and OCR)
  • Audio (EXIF metadata and speech transcription)
  • HTML
  • Text-based formats (CSV, JSON, XML)
  • ZIP files (iterates over contents)
  • YouTube URLs
  • EPUBs
  • ...and many more!

While this project borrows liberally from the amazing LangChain and Markitdown projects, it is not affiliated with either in any way.

Installation

Install the package using pip:

pip install markitdown-langchain

Usage

Specific Examples

DOCX

from markitdown_langchain import DocxLoader

loader = DocxLoader("path/to/your/document.docx")
documents = loader.load()

PPTX

from markitdown_langchain import PptxLoader

loader = PptxLoader("path/to/your/presentation.pptx")
documents = loader.load()

XLSX

from markitdown_langchain import XlsxLoader

loader = XlsxLoader("path/to/your/spreadsheet.xlsx")
documents = loader.load()

Metadata

The Document objects returned by the loaders include the following metadata:

  • source: The path to the source file.
  • file_name: The name of the source file.
  • file_size: The size of the source file in bytes.
  • conversion_success: A boolean indicating whether the conversion to Markdown was successful.
  • author: The author of the document (if available in the document metadata).
  • page_number: The page number (if splitting by page). Header information: When splitting by headers, the metadata will also include the header levels and values for each split.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

License

MIT License

Trademarks

Markitdown, and so this project by extension, may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langchain_markitdown-0.1.1.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langchain_markitdown-0.1.1-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file langchain_markitdown-0.1.1.tar.gz.

File metadata

  • Download URL: langchain_markitdown-0.1.1.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for langchain_markitdown-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8a5312dbb903603ff4129ebfff278667afa10d503c063e041b1cbdd01277ef09
MD5 0561b8a20659e133b97e07b5f0566a41
BLAKE2b-256 a8a3352e94548261e5265b2c1e69c52f32b9de86d5ec21e71833f86a44970eff

See more details on using hashes here.

File details

Details for the file langchain_markitdown-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_markitdown-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3123bde424340b9022d578c28022317058dcf7c605253c2ecec6d553b5c1f69e
MD5 9f926aa1fad37c2601778e1311bc70c2
BLAKE2b-256 cdcafc963c77a0899a5bfea83a7bf28433756f0e2b09c0e229dc369e6ded5199

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page