chronulus_core.types.attribute

Pdf

Bases: BaseModel

Attribute to upload a PDF from a base64 encoded string

The PDF should be provided as a base64 encoded string

Parameters:

Name	Type	Description	Default
data	str	The base64 encoded PDF	required

Attributes:

Name	Type	Description
data	str	The base64 encoded PDF

Source code in src2/chronulus_core/types/attribute.py

class Pdf(BaseModel):
    """Attribute to upload a PDF from a base64 encoded string

    The PDF should be provided as a base64 encoded string

    Parameters
    ----------
    data : str
        The base64 encoded PDF

    Attributes
    ----------
    data : str
        The base64 encoded PDF

    """
    data: str = Field(description='the contents of the PDF file as a base64 encoded string')

PdfFromFile

Bases: BaseModel

Attribute to upload PDF from a local file

The PDF should be accessible in your local file system by the client

Parameters:

Name	Type	Description	Default
file_path	str	Path to PDF file, e.g., '/path/to/doc.pdf'	required

Attributes:

Name	Type	Description
file_path	str	Path to PDF file, e.g., '/path/to/doc.pdf'
data	Optional[str]	The base64 encoded PDF

Source code in src2/chronulus_core/types/attribute.py

class PdfFromFile(BaseModel):
    """Attribute to upload PDF from a local file

    The PDF should be accessible in your local file system by the client

    Parameters
    ----------
    file_path : str
        Path to PDF file, e.g., '/path/to/doc.pdf'

    Attributes
    ----------
    file_path : str
        Path to PDF file, e.g., '/path/to/doc.pdf'
    data : Optional[str]
        The base64 encoded PDF

    """

    file_path: str = Field(exclude=True, description='path to the PDF file')
    data: Union[str, None] = Field(default=None,
                                   description='the contents of the PDF file as a base64 encoded string')

    def model_post_init(self, __context: Any) -> None:
        if self.data is None:
            if not os.path.exists(self.file_path):
                raise FileNotFoundError(f"PDF file not found at {self.file_path}")

            if not self.file_path.lower().endswith('.pdf'):
                raise ValueError(f"File {self.file_path} does not appear to be a PDF")

            # If text reading fails or binary signature found, read as binary
            with open(self.file_path, 'rb') as f:
                pdf_bytes = f.read()
            self.data = base64.b64encode(pdf_bytes).decode('utf-8')