Skip to content

docs: sync Haystack API reference on Docusaurus #12915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Sep 24, 2026
Merged

docs: sync Haystack API reference on Docusaurus #12915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-website/reference/haystack-api/converters_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,8 +475,8 @@ into ImageContent objects.
- <code>dict\[str, list\[ImageContent | None\]\]</code> – Dictionary containing one key:
- "image_contents": ImageContents created from the processed documents. These contain base64-encoded image
data and metadata. The order corresponds to the order of the input documents. A document that is
missing the required metadata keys, has an invalid file path, or has an unsupported MIME type gets
None in its position and a logged warning with the reason.
missing the required metadata keys, has an invalid file path, has an unsupported MIME type, or points
to a PDF page that cannot be converted gets None in its position and a logged warning with the reason.

## image/file_to_document

Expand Down
4 changes: 2 additions & 2 deletions docs-website/reference/haystack-api/image_converters_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ into ImageContent objects.
- <code>dict\[str, list\[ImageContent | None\]\]</code> – Dictionary containing one key:
- "image_contents": ImageContents created from the processed documents. These contain base64-encoded image
data and metadata. The order corresponds to the order of the input documents. A document that is
missing the required metadata keys, has an invalid file path, or has an unsupported MIME type gets
None in its position and a logged warning with the reason.
missing the required metadata keys, has an invalid file path, has an unsupported MIME type, or points
to a PDF page that cannot be converted gets None in its position and a logged warning with the reason.

## file_to_document

Expand Down