xtrace_sdk.integrations.base
============================

.. py:module:: xtrace_sdk.integrations.base


Classes
-------

.. autoapisummary::

   xtrace_sdk.integrations.base.IntegrationBase


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

.. py:class:: IntegrationBase(*args, **kwargs)

   Bases: :py:obj:`abc.ABC`


   Interface for XTrace integrations to be used by retrievers.

   :param ABC: Abstract Base Class
   :type ABC: class


   .. py:method:: __del__(*args, **kwargs)

      Destructor for the IntegrationBase class.




   .. py:method:: get_chunk_by_id(**kwargs)
      :abstractmethod:


      get a encrypted chunk by its id




   .. py:method:: store_index(**kwargs)
      :abstractmethod:

      :async:


      Store the index in the storage.




   .. py:method:: store_db(**kwargs)
      :abstractmethod:

      :async:


      Store the database in the storage.




   .. py:method:: load_index(*args, **kwargs)
      :abstractmethod:


      Load the index from the storage.




   .. py:method:: load_db(*args, **kwargs)
      :abstractmethod:


      Load the database from the storage.




   .. py:method:: compute_hamming_distances(*args, **kwargs)
      :abstractmethod:


      given a query and key, compute the hamming distances between the query and the data in the database