abacusai.page_data
==================

.. py:module:: abacusai.page_data


Classes
-------

.. autoapisummary::

   abacusai.page_data.PageData


Module Contents
---------------

.. py:class:: PageData(client, docId=None, page=None, height=None, width=None, pageCount=None, pageText=None, pageTokenStartOffset=None, tokenCount=None, tokens=None, extractedText=None, rotationAngle=None, pageMarkdown=None, embeddedText=None)

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`


   Data extracted from a docstore page.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param docId: Unique Docstore string identifier for the document.
   :type docId: str
   :param page: The page number. Starts from 0.
   :type page: int
   :param height: The height of the page in pixels.
   :type height: int
   :param width: The width of the page in pixels.
   :type width: int
   :param pageCount: The total number of pages in document.
   :type pageCount: int
   :param pageText: The text extracted from the page.
   :type pageText: str
   :param pageTokenStartOffset: The offset of the first token in the page.
   :type pageTokenStartOffset: int
   :param tokenCount: The number of tokens in the page.
   :type tokenCount: int
   :param tokens: The tokens in the page.
   :type tokens: list
   :param extractedText: The extracted text in the page obtained from OCR.
   :type extractedText: str
   :param rotationAngle: The detected rotation angle of the page in degrees. Positive values indicate clockwise and negative values indicate anti-clockwise rotation from the original orientation.
   :type rotationAngle: float
   :param pageMarkdown: The markdown text for the page.
   :type pageMarkdown: str
   :param embeddedText: The embedded text in the page. Only available for digital documents.
   :type embeddedText: str


   .. py:attribute:: doc_id
      :value: None



   .. py:attribute:: page
      :value: None



   .. py:attribute:: height
      :value: None



   .. py:attribute:: width
      :value: None



   .. py:attribute:: page_count
      :value: None



   .. py:attribute:: page_text
      :value: None



   .. py:attribute:: page_token_start_offset
      :value: None



   .. py:attribute:: token_count
      :value: None



   .. py:attribute:: tokens
      :value: None



   .. py:attribute:: extracted_text
      :value: None



   .. py:attribute:: rotation_angle
      :value: None



   .. py:attribute:: page_markdown
      :value: None



   .. py:attribute:: embedded_text
      :value: None



   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict