xtrace_sdk.integrations.base

Classes

IntegrationBase

Interface for XTrace integrations to be used by retrievers.

Module Contents

class xtrace_sdk.integrations.base.IntegrationBase(*args, **kwargs)

Bases: abc.ABC

Interface for XTrace integrations to be used by retrievers.

Parameters:

  • ABC (class) – Abstract Base Class

  • args (Any)

  • kwargs (Any)

__del__(*args, **kwargs)

Destructor for the IntegrationBase class.

Parameters:

  • args (Any)

  • kwargs (Any)

Return type:

None

abstractmethod get_chunk_by_id(**kwargs)

get a encrypted chunk by its id

Parameters:

kwargs (Any)

Return type:

Any

abstractmethod store_index(**kwargs)
Async:

Parameters:

kwargs (Any)

Return type:

None

Store the index in the storage.

abstractmethod store_db(**kwargs)
Async:

Parameters:

kwargs (Any)

Return type:

None

Store the database in the storage.

abstractmethod load_index(*args, **kwargs)

Load the index from the storage.

Parameters:

  • args (Any)

  • kwargs (Any)

Return type:

Any

abstractmethod load_db(*args, **kwargs)

Load the database from the storage.

Parameters:

  • args (Any)

  • kwargs (Any)

Return type:

Any

abstractmethod compute_hamming_distances(*args, **kwargs)

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

Parameters:

  • args (Any)

  • kwargs (Any)

Return type:

Any