:py:mod:`abacusai.document_retriever_lookup_result`
===================================================

.. py:module:: abacusai.document_retriever_lookup_result


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

Classes
~~~~~~~

.. autoapisummary::

   abacusai.document_retriever_lookup_result.DocumentRetrieverLookupResult




.. py:class:: DocumentRetrieverLookupResult(client, document=None, score=None, properties=None, pages=None, boundingBoxes=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

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



