feat(experimental): add new DocTags serializer

Signed-off-by: Panos Vagenas <[email protected]>

Author: vagenas

docling_core/experimental/idoctags.py

@@ -0,0 +1,44 @@
+"""Define classes for DocTags serialization."""
+
+from typing import Any, Final
+
+from typing_extensions import override
+
+from docling_core.transforms.serializer.base import SerializationResult
+from docling_core.transforms.serializer.common import create_ser_result
+from docling_core.transforms.serializer.doctags import (
+    DocTagsDocSerializer,
+    DocTagsParams,
+    _get_delim,
+)
+from docling_core.types.doc.tokens import DocumentToken
+
+DOCTAGS_VERSION: Final = "1.0.0"
+
+
+class IDocTagsParams(DocTagsParams):
+    """DocTags-specific serialization parameters."""
+
+
+class IDocTagsDocSerializer(DocTagsDocSerializer):
+    """DocTags document serializer."""
+
+    @override
+    def serialize_doc(
+        self,
+        *,
+        parts: list[SerializationResult],
+        **kwargs: Any,
+    ) -> SerializationResult:
+        """DocTags-specific document serializer."""
+        delim = _get_delim(params=self.params)
+        text_res = delim.join([p.text for p in parts if p.text])
+
+        if self.params.add_page_break:
+            page_sep = f"<{DocumentToken.PAGE_BREAK.value}>"
+            for full_match, _, _ in self._get_page_breaks(text=text_res):
+                text_res = text_res.replace(full_match, page_sep)
+
+        wrap_tag = DocumentToken.DOCUMENT.value
+        text_res = f"<{wrap_tag}><version>{DOCTAGS_VERSION}</version>{text_res}{delim}</{wrap_tag}>"
+        return create_ser_result(text=text_res, span_source=parts)

test/data/doc/dummy_doc.igt.dt

@@ -0,0 +1,4 @@
+<doctag><version>1.0.0</version><title><loc_42><loc_26><loc_406><loc_46>DocLayNet: A Large Human-Annotated Dataset for Document-Layout Analysis</title>
+<chart><loc_297><loc_125><loc_457><loc_499><bar_chart><smiles>CC1=NNC(C2=CN3C=CN=C3C(CC3=CC(F)=CC(F)=C3)=N2)=N1</smiles><caption><loc_210><loc_196><loc_245><loc_213>Figure 1: Four examples of complex page layouts across different document categories</caption></chart>
+<otsl><loc_210><loc_196><loc_245><loc_213></otsl>
+</doctag>

test/test_serialization.py

@@ -5,6 +5,7 @@
 
 from typing_extensions import override
 
+from docling_core.experimental.idoctags import IDocTagsDocSerializer
 from docling_core.transforms.serializer.base import (
     BaseDocSerializer,
     SerializationResult,
@@ -637,3 +638,17 @@ def test_doctags_inline_and_formatting():
     ser = DocTagsDocSerializer(doc=doc)
     actual = ser.serialize().text
     verify(exp_file=src.with_suffix(".gt.dt"), actual=actual)
+
+
+# ===============================
+# IDocTags tests
+# ===============================
+
+
+def test_idoctags_basic():
+    src = Path("./test/data/doc/dummy_doc.yaml")
+    doc = DoclingDocument.load_from_yaml(src)
+
+    ser = IDocTagsDocSerializer(doc=doc)
+    actual = ser.serialize().text
+    verify(exp_file=src.with_suffix(".igt.dt"), actual=actual)