Skip to content

Commit b4b2843

Browse files
docs: sync Haystack API reference on Docusaurus (#11882)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent f7fec32 commit b4b2843

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs-website/reference/haystack-api/converters_api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,7 @@ print(documents[0].content)
446446
__init__(
447447
extraction_kwargs: dict[str, Any] | None = None,
448448
store_full_path: bool = False,
449+
encoding: str = "utf-8",
449450
) -> None
450451
```
451452

@@ -458,6 +459,8 @@ Create an HTMLToDocument component.
458459
the [Trafilatura documentation](https://trafilatura.readthedocs.io/en/latest/corefunctions.html#extract).
459460
- **store_full_path** (<code>bool</code>) – If True, the full path of the file is stored in the metadata of the document.
460461
If False, only the file name is stored.
462+
- **encoding** (<code>str</code>) – The default encoding to use when converting HTML files. If the encoding is specified in the metadata of a
463+
source ByteStream, it overrides this value.
461464

462465
#### to_dict
463466

@@ -1060,6 +1063,7 @@ __init__(
10601063
table_to_single_line: bool = False,
10611064
progress_bar: bool = True,
10621065
store_full_path: bool = False,
1066+
encoding: str = "utf-8",
10631067
*,
10641068
extract_frontmatter: bool = False
10651069
) -> None
@@ -1073,6 +1077,8 @@ Create a MarkdownToDocument component.
10731077
- **progress_bar** (<code>bool</code>) – If True shows a progress bar when running.
10741078
- **store_full_path** (<code>bool</code>) – If True, the full path of the file is stored in the metadata of the document.
10751079
If False, only the file name is stored.
1080+
- **encoding** (<code>str</code>) – The default encoding to use when converting Markdown files. If the encoding is specified in the metadata
1081+
of a source ByteStream, it overrides this value.
10761082
- **extract_frontmatter** (<code>bool</code>) – If True, YAML frontmatter at the beginning of the Markdown file is
10771083
removed from the document content and added to the document metadata.
10781084

0 commit comments

Comments
 (0)