Class DocMetaData

langroid/mytypes.py:43–103

Metadata for a document.

class DocMetaData(BaseModel):
    """Metadata for a document."""

    source: str = "context"  # just reference
    source_content: str = "context"  # reference and content
    title: str = "Unknown Title"
    published_date: str = "Unknown Date"
    is_chunk: bool = False  # if it is a chunk, don't split
    id: str = Field(default_factory=lambda: str(uuid4()))
    window_ids: List[str] = []  # for RAG: ids of chunks around this one

    @field_validator("id", mode="before")
    @classmethod
    def convert_id_to_string(cls, v: Any) -> str:
        """Convert id to string if it's not already."""
        if v is None:
            return str(uuid4())
        return str(v)

    def dict_bool_int(self, *args: Any, **kwargs: Any) -> Dict[str, Any]:
        """
        Special dict method to convert bool fields to int, to appease some
        downstream libraries,  e.g. Chroma which complains about bool fields in
        metadata.
        """
        original_dict = super().model_dump(*args, **kwargs)

        for key, value in original_dict.items():
            if isinstance(value, bool):
                original_dict[key] = 1 * value

        return original_dict

    def __str__(self) -> str:
        title_str = (
            ""
            if "unknown" in self.title.lower() or self.title.strip() == ""
            else f"Title: {self.title}"
        )
        date_str = ""
        if (
            "unknown" not in self.published_date.lower()
            and self.published_date.strip() != ""
        ):
            try:
                from dateutil import parser

                # Try to parse the date string
                date_obj = parser.parse(self.published_date)
                # Format to include only the date part (year-month-day)
                date_only = date_obj.strftime("%Y-%m-%d")
                date_str = f"Date: {date_only}"
            except (ValueError, ImportError, TypeError):
                # If parsing fails, just use the original date
                date_str = f"Date: {self.published_date}"
        components = [self.source] + (
            [] if title_str + date_str == "" else [title_str, date_str]
        )