From 1d0bf90ede17ef9167a19951fcabadd5cf3ae5e4 Mon Sep 17 00:00:00 2001 From: sjrl <10526848+sjrl@users.noreply.github.com> Date: Wed, 23 Sep 2026 11:59:41 +0000 Subject: [PATCH] Sync Haystack API reference on Docusaurus --- docs-website/reference/haystack-api/converters_api.md | 9 +++------ .../reference/haystack-api/image_converters_api.md | 9 +++------ 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/docs-website/reference/haystack-api/converters_api.md b/docs-website/reference/haystack-api/converters_api.md index aec177f09a0..18b2cc0cc7a 100644 --- a/docs-website/reference/haystack-api/converters_api.md +++ b/docs-website/reference/haystack-api/converters_api.md @@ -474,12 +474,9 @@ into ImageContent objects. - dict\[str, list\[ImageContent | None\]\] – Dictionary containing one key: - "image_contents": ImageContents created from the processed documents. These contain base64-encoded image - data and metadata. The order corresponds to order of input documents. - -**Raises:** - -- ValueError – If any document is missing the required metadata keys, has an invalid file path, or has an unsupported - MIME type. The error message will specify which document and what information is missing or incorrect. + 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. ## image/file_to_document diff --git a/docs-website/reference/haystack-api/image_converters_api.md b/docs-website/reference/haystack-api/image_converters_api.md index 00bb7914f51..5b20a86b703 100644 --- a/docs-website/reference/haystack-api/image_converters_api.md +++ b/docs-website/reference/haystack-api/image_converters_api.md @@ -104,12 +104,9 @@ into ImageContent objects. - dict\[str, list\[ImageContent | None\]\] – Dictionary containing one key: - "image_contents": ImageContents created from the processed documents. These contain base64-encoded image - data and metadata. The order corresponds to order of input documents. - -**Raises:** - -- ValueError – If any document is missing the required metadata keys, has an invalid file path, or has an unsupported - MIME type. The error message will specify which document and what information is missing or incorrect. + 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. ## file_to_document