|
1 | | -# Haystack Docling integration |
2 | | - |
3 | | -[](https://pypi.org/project/docling-haystack/) |
4 | | -[](https://pypi.org/project/docling-haystack/) |
5 | | -[](https://python-poetry.org/) |
6 | | -[](https://github.com/psf/black) |
7 | | -[](https://pycqa.github.io/isort/) |
8 | | -[](https://pydantic.dev) |
9 | | -[](https://github.com/pre-commit/pre-commit) |
10 | | -[](https://opensource.org/licenses/MIT) |
11 | | - |
12 | | -A [Docling](https://github.com/DS4SD/docling) integration for |
13 | | -[Haystack](https://github.com/deepset-ai/haystack/). |
14 | | - |
15 | | -## Installation |
16 | | - |
17 | | -Simply install `docling-haystack` from your package manager, e.g. pip: |
18 | | -```bash |
19 | | -pip install docling-haystack |
20 | | -``` |
21 | | - |
22 | | -## Usage |
23 | | - |
24 | | -### Basic usage |
25 | | - |
26 | | -Basic usage of `DoclingConverter` looks as follows: |
27 | | - |
28 | | -```python |
29 | | -from haystack import Pipeline |
30 | | -from docling_haystack.converter import DoclingConverter |
31 | | - |
32 | | -idx_pipe = Pipeline() |
33 | | -# ... |
34 | | -converter = DoclingConverter() |
35 | | -idx_pipe.add_component("converter", converter) |
36 | | -# ... |
37 | | -``` |
38 | | -### Advanced usage |
39 | | - |
40 | | -When initializing a `DoclingConverter`, you can use the following parameters: |
41 | | - |
42 | | -- `converter` (optional): any specific Docling `DocumentConverter` instance to use |
43 | | -- `convert_kwargs` (optional): any specific kwargs for conversion execution |
44 | | -- `export_type` (optional): export mode to use: `ExportType.DOC_CHUNKS` (default) or |
45 | | - `ExportType.MARKDOWN` |
46 | | -- `md_export_kwargs` (optional): any specific Markdown export kwargs (for Markdown mode) |
47 | | -- `chunker` (optional): any specific Docling chunker instance to use (for doc-chunk |
48 | | - mode) |
49 | | -- `meta_extractor` (optional): any specific metadata extractor to use |
50 | | - |
51 | | -### Example |
52 | | - |
53 | | -For an end-to-end usage example, check out |
54 | | -[this notebook](https://ds4sd.github.io/docling/examples/rag_haystack/). |
| 1 | +> [!IMPORTANT] |
| 2 | +> # 👉 This has moved to [Haystack Core Integrations](https://github.com/deepset-ai/haystack-core-integrations). |
0 commit comments