:py:mod:`abacusai.document_data`
================================

.. py:module:: abacusai.document_data


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

Classes
~~~~~~~

.. autoapisummary::

   abacusai.document_data.DocumentData




.. py:class:: DocumentData(client, docId=None, mimeType=None, pageCount=None, extractedText=None, embeddedText=None, pages=None, tokens=None)

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

   Data extracted from a docstore document.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param docId: Unique Docstore string identifier for the document.
   :type docId: str
   :param mimeType: The mime type of the document.
   :type mimeType: str
   :param pageCount: The total number of pages in document.
   :type pageCount: int
   :param extractedText: The extracted text in the document obtained from OCR.
   :type extractedText: str
   :param embeddedText: The embedded text in the document. Only available for digital documents.
   :type embeddedText: str
   :param pages: List of embedded text for each page in the document. Only available for digital documents.
   :type pages: list
   :param tokens: List of extracted tokens in the document obtained from OCR.
   :type tokens: list

   .. py:method:: __repr__()

      Return repr(self).


   .. 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



