provenance of images for html export

[geoHeil]

How can the provenance information be kept when exporting to the HTML document? I.e. how can for each image file also a JSON file be created with the relevant provenance details

something like this should be able to achieve it

for element, _level in conv_res.document.iterate_items():
	if isinstance(element, PictureItem):
            picture_counter += 1
            element_image_filename = (
                output_dir / f"{doc_filename}-picture-{picture_counter}.png"
            )
            element_image_provenance_filename = (
                output_dir / f"{doc_filename}-picture-{picture_counter}.json"
            )
            prov = element.prov[0].dict()
            print(prov)
            with element_image_filename.open("wb") as fp:
                element.get_image(conv_res.document).save(fp, "PNG")
            with element_image_provenance_filename.open("w") as fp:
                json.dump(prov, fp, indent=4)

Should I create a PR? If yes:

• where should this option be placed to

Monkey-patching looks like:

import json
import copy
from pathlib import Path
from typing import Optional
from pydantic import AnyUrl
from docling_core.types.doc.utils import relative_path

# These imports assume the structure of docling-core.
# Adjust the import paths if they differ in your environment.
from docling_core.types.doc import DoclingDocument, PictureItem
from docling_core.types.doc.utils import relative_path

def custom_with_pictures_refs(
    self, image_dir: Path, reference_path: Optional[Path] = None
) -> "DoclingDocument":
    """
    Custom version of _with_pictures_refs that, in addition to saving the image,
    also writes a JSON file containing the provenance details for each picture.
    """
    # Make a deep copy of the current document so that we don't modify the original.
    result: DoclingDocument = copy.deepcopy(self)
    img_count = 0
    image_dir.mkdir(parents=True, exist_ok=True)

    if image_dir.is_dir():
        for item, level in result.iterate_items(with_groups=False):
            if isinstance(item, PictureItem):
                # Check that the image exists, is in data URI form and has a PIL image.
                if (
                    item.image is not None
                    and isinstance(item.image.uri, AnyUrl)
                    and item.image.uri.scheme == "data"
                    and item.image.pil_image is not None
                ):
                    img = item.image.pil_image
                    # Compute a hex hash for uniqueness (if available)
                    hexhash = item._image_to_hexhash()
                    if hexhash is not None:
                        # Define the image file path with a unique hash.
                        loc_path = image_dir / f"image_{img_count:06}_{hexhash}.png"
                        img.save(loc_path)

                        # Create a relative path for the image reference if needed.
                        if reference_path is not None:
                            obj_path = relative_path(reference_path.resolve(), loc_path.resolve())
                        else:
                            obj_path = loc_path

                        # Update the image's URI to point to the saved file.
                        item.image.uri = Path(obj_path)

                        # Extract provenance data from the item.
                        # Assuming that item.prov is a list with at least one provenance object.
                        prov_data = item.prov[0].model_dump() if item.prov else {}
                        # Define the provenance JSON file path.
                        prov_path = image_dir / f"image_{img_count:06}_{hexhash}.json"
                        # Write the provenance data to a JSON file.
                        with prov_path.open("w", encoding="utf-8") as fp:
                            json.dump(prov_data, fp, indent=4)
                img_count += 1

    return result

# Monkey-patch the original method with our custom version.
DoclingDocument._with_pictures_refs = custom_with_pictures_refs

[geoHeil]

To me, it looks like I would need to fork/monkey-patch the _with_pictures_refs of docling-core. Is there any neater way?