fix: referenced artifacts relative to the document location (#361)

* fix relative references

Signed-off-by: Michele Dolfi <[email protected]>

* Apply suggestions from code review

Co-authored-by: Cesar Berrospi Ramis <[email protected]>
Signed-off-by: Michele Dolfi <[email protected]>

---------

Signed-off-by: Michele Dolfi <[email protected]>
Signed-off-by: Michele Dolfi <[email protected]>
Co-authored-by: Cesar Berrospi Ramis <[email protected]>

Author: dolfim-ibm

docling_core/types/doc/document.py

@@ -1373,11 +1373,12 @@ def _image_to_base64(self, pil_image, format="PNG"):
         )  # Encode to Base64 and decode to string
         return img_base64
 
-    def _image_to_hexhash(self) -> Optional[str]:
+    @staticmethod
+    def _image_to_hexhash(img: Optional[PILImage.Image]) -> Optional[str]:
         """Hexash from the image."""
-        if self.image is not None and self.image._pil is not None:
+        if img is not None:
             # Convert the image to raw bytes
-            image_bytes = self.image._pil.tobytes()
+            image_bytes = img.tobytes()
 
             # Create a hash object (e.g., SHA-256)
             hasher = hashlib.sha256(usedforsecurity=False)
@@ -4116,16 +4117,10 @@ def _with_pictures_refs(
         if image_dir.is_dir():
             for item, level in result.iterate_items(page_no=page_no, with_groups=False):
                 if isinstance(item, PictureItem):
+                    img = item.get_image(doc=self)
+                    if img is not None:
 
-                    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
-
-                        hexhash = item._image_to_hexhash()
+                        hexhash = PictureItem._image_to_hexhash(img)
 
                         # loc_path = image_dir / f"image_{img_count:06}.png"
                         if hexhash is not None:
@@ -4140,6 +4135,11 @@ def _with_pictures_refs(
                             else:
                                 obj_path = loc_path
 
+                            if item.image is None:
+                                scale = img.size[0] / item.prov[0].bbox.width
+                                item.image = ImageRef.from_pil(
+                                    image=img, dpi=round(72 * scale)
+                                )
                             item.image.uri = Path(obj_path)
 
                         # if item.image._pil is not None:
@@ -4539,6 +4539,8 @@ def _get_output_paths(
             reference_path = None
         else:
             reference_path = filename.parent
+            artifacts_dir = reference_path / artifacts_dir
+
         return artifacts_dir, reference_path
 
     def _make_copy_with_refmode(

test/test_docling_doc.py

@@ -1442,10 +1442,11 @@ def test_save_to_disk():
 
     doc: DoclingDocument = _construct_doc()
 
-    image_dir = Path("./test/data/doc/constructed_images/")
+    test_dir = Path("./test/data/doc")
+    image_dir = Path("constructed_images/")  # will be relative to test_dir
 
     doc_with_references = doc._with_pictures_refs(
-        image_dir=image_dir,  # Path("./test/data/constructed_images/")
+        image_dir=(test_dir / image_dir),
         page_no=None,
     )
 
@@ -1455,53 +1456,53 @@ def test_save_to_disk():
 
     ### MarkDown
 
-    filename = Path("test/data/doc/constructed_doc.placeholder.md")
+    filename = test_dir / "constructed_doc.placeholder.md"
     doc.save_as_markdown(
         filename=filename, artifacts_dir=image_dir, image_mode=ImageRefMode.PLACEHOLDER
     )
     _verify_saved_output(filename=filename, paths=paths)
 
-    filename = Path("test/data/doc/constructed_doc.embedded.md")
+    filename = test_dir / "constructed_doc.embedded.md"
     doc.save_as_markdown(
         filename=filename, artifacts_dir=image_dir, image_mode=ImageRefMode.EMBEDDED
     )
     _verify_saved_output(filename=filename, paths=paths)
 
-    filename = Path("test/data/doc/constructed_doc.referenced.md")
+    filename = test_dir / "constructed_doc.referenced.md"
     doc.save_as_markdown(
         filename=filename, artifacts_dir=image_dir, image_mode=ImageRefMode.REFERENCED
     )
     _verify_saved_output(filename=filename, paths=paths)
 
     ### HTML
 
-    filename = Path("test/data/doc/constructed_doc.placeholder.html")
+    filename = test_dir / "constructed_doc.placeholder.html"
     doc.save_as_html(
         filename=filename, artifacts_dir=image_dir, image_mode=ImageRefMode.PLACEHOLDER
     )
     _verify_saved_output(filename=filename, paths=paths)
 
-    filename = Path("test/data/doc/constructed_doc.embedded.html")
+    filename = test_dir / "constructed_doc.embedded.html"
     doc.save_as_html(
         filename=filename, artifacts_dir=image_dir, image_mode=ImageRefMode.EMBEDDED
     )
     _verify_saved_output(filename=filename, paths=paths)
 
-    filename = Path("test/data/doc/constructed_doc.referenced.html")
+    filename = test_dir / "constructed_doc.referenced.html"
     doc.save_as_html(
         filename=filename, artifacts_dir=image_dir, image_mode=ImageRefMode.REFERENCED
     )
     _verify_saved_output(filename=filename, paths=paths)
 
     ### Document Tokens
 
-    filename = Path("test/data/doc/constructed_doc.dt")
+    filename = test_dir / "constructed_doc.dt"
     doc.save_as_doctags(filename=filename)
     _verify_saved_output(filename=filename, paths=paths)
 
     ### JSON
 
-    filename = Path("test/data/doc/constructed_doc.embedded.json")
+    filename = test_dir / "constructed_doc.embedded.json"
     doc.save_as_json(
         filename=filename,
         artifacts_dir=image_dir,
@@ -1512,7 +1513,7 @@ def test_save_to_disk():
     doc_emb_loaded = DoclingDocument.load_from_json(filename)
     _verify_loaded_output(filename=filename, pred=doc_emb_loaded)
 
-    filename = Path("test/data/doc/constructed_doc.referenced.json")
+    filename = test_dir / "constructed_doc.referenced.json"
     doc.save_as_json(
         filename=filename,
         artifacts_dir=image_dir,
@@ -1525,15 +1526,15 @@ def test_save_to_disk():
 
     ### YAML
 
-    filename = Path("test/data/doc/constructed_doc.embedded.yaml")
+    filename = test_dir / "constructed_doc.embedded.yaml"
     doc.save_as_yaml(
         filename=filename,
         artifacts_dir=image_dir,
         image_mode=ImageRefMode.EMBEDDED,
     )
     _verify_saved_output(filename=filename, paths=paths)
 
-    filename = Path("test/data/doc/constructed_doc.referenced.yaml")
+    filename = test_dir / "constructed_doc.referenced.yaml"
     doc.save_as_yaml(
         filename=filename,
         artifacts_dir=image_dir,