deepset-ai--haystack
wehub-resource-sync
c56bef871b
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
Docker image release / Build base image (push) Has been cancelled
Sync docs with Docusaurus / sync (push) Has been cancelled
Tests / Check if changed (push) Has been cancelled
Tests / format (push) Has been cancelled
Tests / check-imports (push) Has been cancelled
Tests / Unit / macos-latest (push) Has been cancelled
Tests / Unit / ubuntu-latest (push) Has been cancelled
Tests / Unit / windows-latest (push) Has been cancelled
Tests / mypy (push) Has been cancelled
Tests / Integration / ubuntu-latest (push) Has been cancelled
Tests / Integration / macos-latest (push) Has been cancelled
Tests / Integration / windows-latest (push) Has been cancelled
Tests / notify-slack-on-failure (push) Has been cancelled
Tests / Mark tests as completed (push) Has been cancelled
83 行
2.8 KiB
Plaintext
83 行
2.8 KiB
Plaintext
---
|
||
title: "DOCXToDocument"
|
||
id: docxtodocument
|
||
slug: "/docxtodocument"
|
||
description: "Convert DOCX files to documents."
|
||
---
|
||
|
||
# DOCXToDocument
|
||
|
||
Convert DOCX files to documents.
|
||
|
||
<div className="key-value-table">
|
||
|
||
| | |
|
||
| --- | --- |
|
||
| **Most common position in a pipeline** | Before [PreProcessors](../preprocessors.mdx) or right at the beginning of an indexing pipeline |
|
||
| **Mandatory run variables** | `sources`: DOCX file paths or [`ByteStream`](../../concepts/data-classes.mdx#bytestream) objects |
|
||
| **Output variables** | `documents`: A list of documents |
|
||
| **API reference** | [Converters](/reference/converters-api) |
|
||
| **GitHub link** | https://github.com/deepset-ai/haystack/blob/main/haystack/components/converters/docx.py |
|
||
| **Package name** | `haystack-ai` |
|
||
|
||
</div>
|
||
|
||
## Overview
|
||
|
||
The `DOCXToDocument` component converts DOCX files into documents. It takes a list of file paths or [`ByteStream`](../../concepts/data-classes.mdx#bytestream) objects as input and outputs the converted result as a list of documents. By defining the table format (CSV or Markdown), you can use this component to extract tables in your DOCX files. Optionally, you can attach metadata to the documents through the `meta` input parameter.
|
||
|
||
## Usage
|
||
|
||
First, install the`python-docx` package to start using this converter:
|
||
|
||
```shell
|
||
pip install python-docx
|
||
```
|
||
|
||
### On its own
|
||
|
||
```python
|
||
from haystack.components.converters.docx import DOCXToDocument, DOCXTableFormat
|
||
|
||
converter = DOCXToDocument()
|
||
# or define the table format
|
||
converter = DOCXToDocument(table_format=DOCXTableFormat.CSV)
|
||
|
||
results = converter.run(
|
||
sources=["sample.docx"],
|
||
meta={"date_added": datetime.now().isoformat()},
|
||
)
|
||
documents = results["documents"]
|
||
|
||
print(documents[0].content)
|
||
|
||
# 'This is the text from the DOCX file.'
|
||
```
|
||
|
||
### In a pipeline
|
||
|
||
```python
|
||
from haystack import Pipeline
|
||
from haystack.document_stores.in_memory import InMemoryDocumentStore
|
||
from haystack.components.converters import DOCXToDocument
|
||
from haystack.components.preprocessors import DocumentCleaner
|
||
from haystack.components.preprocessors import DocumentSplitter
|
||
from haystack.components.writers import DocumentWriter
|
||
|
||
document_store = InMemoryDocumentStore()
|
||
|
||
pipeline = Pipeline()
|
||
pipeline.add_component("converter", DOCXToDocument())
|
||
pipeline.add_component("cleaner", DocumentCleaner())
|
||
pipeline.add_component(
|
||
"splitter",
|
||
DocumentSplitter(split_by="sentence", split_length=5),
|
||
)
|
||
pipeline.add_component("writer", DocumentWriter(document_store=document_store))
|
||
pipeline.connect("converter", "cleaner")
|
||
pipeline.connect("cleaner", "splitter")
|
||
pipeline.connect("splitter", "writer")
|
||
|
||
pipeline.run({"converter": {"sources": file_names}})
|
||
```
|