Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion docs-website/reference/haystack-api/converters_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,11 @@ Initialize the DocumentToImageContent component.

- **file_path_meta_field** (<code>str</code>) – The metadata field in the Document that contains the file path to the image or PDF.
- **root_path** (<code>str | None</code>) – The root directory path where document files are located. If provided, file paths in
document metadata will be resolved relative to this path. If None, file paths are treated as absolute paths.
document metadata will be resolved relative to this path and are guaranteed to stay within it. If None,
file paths are treated as absolute paths with no containment check.
Security: this component reads the file referenced by `file_path_meta_field` from the host filesystem. If
document metadata may be influenced by untrusted input, set `root_path` to a dedicated data directory so
that path-traversal payloads (e.g. absolute paths or `../`) are rejected instead of read.
- **detail** (<code>Literal['auto', 'high', 'low'] | None</code>) – Optional detail level of the image (only supported by OpenAI). Can be "auto", "high", or "low".
This will be passed to the created ImageContent objects.
- **size** (<code>tuple\[int, int\] | None</code>) – If provided, resizes the image to fit within the specified dimensions (width, height) while
Expand Down
6 changes: 5 additions & 1 deletion docs-website/reference/haystack-api/extractors_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,11 @@ Initialize the LLMDocumentContentExtractor component.
- **prompt** (<code>str</code>) – Prompt for extraction. Must not contain Jinja variables.
- **file_path_meta_field** (<code>str</code>) – The metadata field in the Document that contains the file path to the image or PDF.
- **root_path** (<code>str | None</code>) – The root directory path where document files are located. If provided, file paths in
document metadata will be resolved relative to this path. If None, file paths are treated as absolute paths.
document metadata will be resolved relative to this path and are guaranteed to stay within it. If None,
file paths are treated as absolute paths with no containment check.
Security: this component reads the file referenced by `file_path_meta_field` from the host filesystem. If
document metadata may be influenced by untrusted input, set `root_path` to a dedicated data directory so
that path-traversal payloads (e.g. absolute paths or `../`) are rejected instead of read.
- **detail** (<code>Literal['auto', 'high', 'low'] | None</code>) – Optional detail level of the image (only supported by OpenAI). Can be "auto", "high", or "low".
- **size** (<code>tuple\[int, int\] | None</code>) – If provided, resizes the image to fit within (width, height) while keeping aspect ratio.
- **raise_on_failure** (<code>bool</code>) – If True, exceptions from the LLM are raised. If False, failed documents are returned.
Expand Down
6 changes: 5 additions & 1 deletion docs-website/reference/haystack-api/image_converters_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ Initialize the DocumentToImageContent component.

- **file_path_meta_field** (<code>str</code>) – The metadata field in the Document that contains the file path to the image or PDF.
- **root_path** (<code>str | None</code>) – The root directory path where document files are located. If provided, file paths in
document metadata will be resolved relative to this path. If None, file paths are treated as absolute paths.
document metadata will be resolved relative to this path and are guaranteed to stay within it. If None,
file paths are treated as absolute paths with no containment check.
Security: this component reads the file referenced by `file_path_meta_field` from the host filesystem. If
document metadata may be influenced by untrusted input, set `root_path` to a dedicated data directory so
that path-traversal payloads (e.g. absolute paths or `../`) are rejected instead of read.
- **detail** (<code>Literal['auto', 'high', 'low'] | None</code>) – Optional detail level of the image (only supported by OpenAI). Can be "auto", "high", or "low".
This will be passed to the created ImageContent objects.
- **size** (<code>tuple\[int, int\] | None</code>) – If provided, resizes the image to fit within the specified dimensions (width, height) while
Expand Down