| Name | llama-index-readers-file JSON |
| Version |
0.5.2
JSON |
| download |
| home_page | None |
| Summary | llama-index readers file integration |
| upload_time | 2025-08-16 22:25:52 |
| maintainer | FarisHijazi, Haowjy, ephe-meral, hursh-desai, iamarunbrahma, jon-chuang, mmaatouk, ravi03071991, sangwongenip, thejessezhang |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
10k
10q
chart
eml
figure
html
hwp
image
invoice
ipynb
jupyter
notebook
pdf
pymupdf
receipt
sec
spreadsheet
tabular
unstructured.io
yaml
yml
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LlamaIndex Readers Integration: File
```bash
pip install llama-index-readers-file
```
This is the default integration for different loaders that are used within `SimpleDirectoryReader`.
Provides support for the following loaders:
- DocxReader
- HWPReader
- PDFReader
- EpubReader
- FlatReader
- HTMLTagReader
- ImageCaptionReader
- ImageReader
- ImageVisionLLMReader
- IPYNBReader
- MarkdownReader
- MboxReader
- PptxReader
- PandasCSVReader
- VideoAudioReader
- UnstructuredReader
- PyMuPDFReader
- ImageTabularChartReader
- XMLReader
- PagedCSVReader
- CSVReader
- RTFReader
## Installation
```bash
pip install llama-index-readers-file
```
## Usage
Once installed, You can import any of the loader. Here's an example usage of one of the loader.
```python
from llama_index.core import SimpleDirectoryReader
from llama_index.readers.file import (
DocxReader,
HWPReader,
PDFReader,
EpubReader,
FlatReader,
HTMLTagReader,
ImageCaptionReader,
ImageReader,
ImageVisionLLMReader,
IPYNBReader,
MarkdownReader,
MboxReader,
PptxReader,
PandasCSVReader,
VideoAudioReader,
UnstructuredReader,
PyMuPDFReader,
ImageTabularChartReader,
XMLReader,
PagedCSVReader,
CSVReader,
RTFReader,
)
# PDF Reader with `SimpleDirectoryReader`
parser = PDFReader()
file_extractor = {".pdf": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Docx Reader example
parser = DocxReader()
file_extractor = {".docx": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# HWP Reader example
parser = HWPReader()
file_extractor = {".hwp": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Epub Reader example
parser = EpubReader()
file_extractor = {".epub": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Flat Reader example
parser = FlatReader()
file_extractor = {".txt": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# HTML Tag Reader example
parser = HTMLTagReader()
file_extractor = {".html": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Image Reader example
parser = ImageReader()
file_extractor = {
".jpg": parser,
".jpeg": parser,
".png": parser,
} # Add other image formats as needed
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# IPYNB Reader example
parser = IPYNBReader()
file_extractor = {".ipynb": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Markdown Reader example
parser = MarkdownReader()
file_extractor = {".md": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Mbox Reader example
parser = MboxReader()
file_extractor = {".mbox": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Pptx Reader example
# Basic usage - extracts text, tables, charts, and speaker notes
parser = PptxReader()
# Advanced usage - control parsing behavior
parser = PptxReader(
extract_images=True, # Enable image captioning
context_consolidation_with_llm=True, # Use LLM for content synthesis
num_workers=4, # Parallel processing
batch_size=10, # Slides processed per worker batch
raise_on_error=True, # Raise value error if file_parsing is not successful
)
file_extractor = {".pptx": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Pandas CSV Reader example
parser = PandasCSVReader()
file_extractor = {".csv": parser} # Add other CSV formats as needed
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# PyMuPDF Reader example
parser = PyMuPDFReader()
file_extractor = {".pdf": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# XML Reader example
parser = XMLReader()
file_extractor = {".xml": parser}
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# Paged CSV Reader example
parser = PagedCSVReader()
file_extractor = {".csv": parser} # Add other CSV formats as needed
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
# CSV Reader example
parser = CSVReader()
file_extractor = {".csv": parser} # Add other CSV formats as needed
documents = SimpleDirectoryReader(
"./data", file_extractor=file_extractor
).load_data()
```
This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-file",
"maintainer": "FarisHijazi, Haowjy, ephe-meral, hursh-desai, iamarunbrahma, jon-chuang, mmaatouk, ravi03071991, sangwongenip, thejessezhang",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "10k, 10q, chart, eml, figure, html, hwp, image, invoice, ipynb, jupyter, notebook, pdf, pymupdf, receipt, sec, spreadsheet, tabular, unstructured.io, yaml, yml",
"author": null,
"author_email": "Your Name <you@example.com>",
"download_url": "https://files.pythonhosted.org/packages/e7/9c/d86710937b3d14c51bd02fc67f1f4babd77ac3710817fc230778020cd102/llama_index_readers_file-0.5.2.tar.gz",
"platform": null,
"description": "# LlamaIndex Readers Integration: File\n\n```bash\npip install llama-index-readers-file\n```\n\nThis is the default integration for different loaders that are used within `SimpleDirectoryReader`.\n\nProvides support for the following loaders:\n\n- DocxReader\n- HWPReader\n- PDFReader\n- EpubReader\n- FlatReader\n- HTMLTagReader\n- ImageCaptionReader\n- ImageReader\n- ImageVisionLLMReader\n- IPYNBReader\n- MarkdownReader\n- MboxReader\n- PptxReader\n- PandasCSVReader\n- VideoAudioReader\n- UnstructuredReader\n- PyMuPDFReader\n- ImageTabularChartReader\n- XMLReader\n- PagedCSVReader\n- CSVReader\n- RTFReader\n\n## Installation\n\n```bash\npip install llama-index-readers-file\n```\n\n## Usage\n\nOnce installed, You can import any of the loader. Here's an example usage of one of the loader.\n\n```python\nfrom llama_index.core import SimpleDirectoryReader\nfrom llama_index.readers.file import (\n DocxReader,\n HWPReader,\n PDFReader,\n EpubReader,\n FlatReader,\n HTMLTagReader,\n ImageCaptionReader,\n ImageReader,\n ImageVisionLLMReader,\n IPYNBReader,\n MarkdownReader,\n MboxReader,\n PptxReader,\n PandasCSVReader,\n VideoAudioReader,\n UnstructuredReader,\n PyMuPDFReader,\n ImageTabularChartReader,\n XMLReader,\n PagedCSVReader,\n CSVReader,\n RTFReader,\n)\n\n# PDF Reader with `SimpleDirectoryReader`\nparser = PDFReader()\nfile_extractor = {\".pdf\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Docx Reader example\nparser = DocxReader()\nfile_extractor = {\".docx\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# HWP Reader example\nparser = HWPReader()\nfile_extractor = {\".hwp\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Epub Reader example\nparser = EpubReader()\nfile_extractor = {\".epub\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Flat Reader example\nparser = FlatReader()\nfile_extractor = {\".txt\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# HTML Tag Reader example\nparser = HTMLTagReader()\nfile_extractor = {\".html\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Image Reader example\nparser = ImageReader()\nfile_extractor = {\n \".jpg\": parser,\n \".jpeg\": parser,\n \".png\": parser,\n} # Add other image formats as needed\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# IPYNB Reader example\nparser = IPYNBReader()\nfile_extractor = {\".ipynb\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Markdown Reader example\nparser = MarkdownReader()\nfile_extractor = {\".md\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Mbox Reader example\nparser = MboxReader()\nfile_extractor = {\".mbox\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Pptx Reader example\n# Basic usage - extracts text, tables, charts, and speaker notes\nparser = PptxReader()\n\n# Advanced usage - control parsing behavior\nparser = PptxReader(\n extract_images=True, # Enable image captioning\n context_consolidation_with_llm=True, # Use LLM for content synthesis\n num_workers=4, # Parallel processing\n batch_size=10, # Slides processed per worker batch\n raise_on_error=True, # Raise value error if file_parsing is not successful\n)\n\nfile_extractor = {\".pptx\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n\n# Pandas CSV Reader example\nparser = PandasCSVReader()\nfile_extractor = {\".csv\": parser} # Add other CSV formats as needed\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# PyMuPDF Reader example\nparser = PyMuPDFReader()\nfile_extractor = {\".pdf\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# XML Reader example\nparser = XMLReader()\nfile_extractor = {\".xml\": parser}\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# Paged CSV Reader example\nparser = PagedCSVReader()\nfile_extractor = {\".csv\": parser} # Add other CSV formats as needed\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n\n# CSV Reader example\nparser = CSVReader()\nfile_extractor = {\".csv\": parser} # Add other CSV formats as needed\ndocuments = SimpleDirectoryReader(\n \"./data\", file_extractor=file_extractor\n).load_data()\n```\n\nThis loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/).\n",
"bugtrack_url": null,
"license": null,
"summary": "llama-index readers file integration",
"version": "0.5.2",
"project_urls": null,
"split_keywords": [
"10k",
" 10q",
" chart",
" eml",
" figure",
" html",
" hwp",
" image",
" invoice",
" ipynb",
" jupyter",
" notebook",
" pdf",
" pymupdf",
" receipt",
" sec",
" spreadsheet",
" tabular",
" unstructured.io",
" yaml",
" yml"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "96b98d55b916901df08b55c0e7994363fcea41c02b7fbe8ccba07e4c2ad57f9c",
"md5": "33dcc30006526c50577591bf9f9d5f34",
"sha256": "c85e20022f3da3f635d38401863243c557d4e9ad6872acaafc9281e41a0c9460"
},
"downloads": -1,
"filename": "llama_index_readers_file-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "33dcc30006526c50577591bf9f9d5f34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 51780,
"upload_time": "2025-08-16T22:25:51",
"upload_time_iso_8601": "2025-08-16T22:25:51.635449Z",
"url": "https://files.pythonhosted.org/packages/96/b9/8d55b916901df08b55c0e7994363fcea41c02b7fbe8ccba07e4c2ad57f9c/llama_index_readers_file-0.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e79cd86710937b3d14c51bd02fc67f1f4babd77ac3710817fc230778020cd102",
"md5": "a6d53483ac2fb1d8b68ab37f534def7d",
"sha256": "049d971ac4c936edbf4832915ba7128cfee8f5ead435266792b71edd87f5305c"
},
"downloads": -1,
"filename": "llama_index_readers_file-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "a6d53483ac2fb1d8b68ab37f534def7d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 32517,
"upload_time": "2025-08-16T22:25:52",
"upload_time_iso_8601": "2025-08-16T22:25:52.860972Z",
"url": "https://files.pythonhosted.org/packages/e7/9c/d86710937b3d14c51bd02fc67f1f4babd77ac3710817fc230778020cd102/llama_index_readers_file-0.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-16 22:25:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-file"
}
