abacusai.document_retriever_lookup_result
=========================================

.. py:module:: abacusai.document_retriever_lookup_result


Classes
-------

.. autoapisummary::

   abacusai.document_retriever_lookup_result.DocumentRetrieverLookupResult


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

.. py:class:: DocumentRetrieverLookupResult(client, document=None, score=None, properties=None, pages=None, boundingBoxes=None, documentSource=None, imageIds=None, metadata=None)

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


   Result of a document retriever lookup.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param document: The document that was looked up.
   :type document: str
   :param score: Score of the document with respect to the query.
   :type score: float
   :param properties: Properties of the retrieved documents.
   :type properties: dict
   :param pages: Pages of the retrieved text from the original document.
   :type pages: list
   :param boundingBoxes: Bounding boxes of the retrieved text from the original document.
   :type boundingBoxes: list
   :param documentSource: Document source name.
   :type documentSource: str
   :param imageIds: List of Image IDs for all the pages.
   :type imageIds: list
   :param metadata: Metadata column values for the retrieved documents.
   :type metadata: dict


   .. py:attribute:: document
      :value: None



   .. py:attribute:: score
      :value: None



   .. py:attribute:: properties
      :value: None



   .. py:attribute:: pages
      :value: None



   .. py:attribute:: bounding_boxes
      :value: None



   .. py:attribute:: document_source
      :value: None



   .. py:attribute:: image_ids
      :value: None



   .. py:attribute:: metadata
      :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