Skip to content

fix: make doc metadata keys pure strings #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2024
Merged

fix: make doc metadata keys pure strings #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 7 additions & 9 deletions docling_core/transforms/metadata_extractor/simple_metadata_extractor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,18 @@
"""Simple metadata extractor module."""


from enum import Enum
from typing import Any

from docling_core.transforms.metadata_extractor import BaseMetadataExtractor
from docling_core.types import Document as DLDocument

_DL_DOC_HASH = "dl_doc_hash"
_ORIGIN = "origin"


class SimpleMetadataExtractor(BaseMetadataExtractor):
"""Simple metadata extractor class."""

class _Keys(str, Enum):
DL_DOC_HASH = "dl_doc_hash"
ORIGIN = "origin"

include_origin: bool = False

def get_metadata(
Expand All @@ -35,10 +33,10 @@ def get_metadata(
dict[str, Any]: the extracted metadata
"""
meta: dict[str, Any] = {
self._Keys.DL_DOC_HASH: doc.file_info.document_hash,
_DL_DOC_HASH: doc.file_info.document_hash,
}
if self.include_origin:
meta[self._Keys.ORIGIN] = origin
meta[_ORIGIN] = origin
return meta

def get_excluded_embed_metadata_keys(self) -> list[str]:
Expand All @@ -47,9 +45,9 @@ def get_excluded_embed_metadata_keys(self) -> list[str]:
Returns:
list[str]: the metadata to exclude
"""
excl_keys: list[str] = [self._Keys.DL_DOC_HASH]
excl_keys: list[str] = [_DL_DOC_HASH]
if self.include_origin:
excl_keys.append(self._Keys.ORIGIN)
excl_keys.append(_ORIGIN)
return excl_keys

def get_excluded_llm_metadata_keys(self) -> list[str]:
Expand Down
Loading