lancedb_haystack.embedding_retriever
====================================

.. py:module:: lancedb_haystack.embedding_retriever


Classes
-------

.. autoapisummary::

   lancedb_haystack.embedding_retriever.LanceDBEmbeddingRetriever


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

.. py:class:: LanceDBEmbeddingRetriever(document_store: lancedb_haystack.document_store.LanceDBDocumentStore, filters: Optional[Dict[str, Any]] = None, top_k: Optional[int] = 10)

   A component for retrieving documents from an LanceDBDocumentStore using embeddings and vector similarity.


   .. py:attribute:: NAME
      :value: 'lancedb_haystack.embedding_retriever.LanceDBEmbeddingRetriever'



   .. py:attribute:: _document_store


   .. py:attribute:: _filters


   .. py:attribute:: _top_k


   .. py:method:: run(query_embedding: List[float], filters: Optional[Dict[str, Any]] = None, top_k: Optional[int] = None)

      Run the LanceDBEmbeddingRetriever on the given input data.

      :param query_embedding: Embedding of the query.
      :param filters: A dictionary with filters to narrow down the search space.
      :param top_k: The maximum number of documents to return.
      :return: The retrieved documents.



   .. py:method:: to_dict() -> Dict[str, Any]

      Serialize this component to a dictionary.



   .. py:method:: from_dict(data: Dict[str, Any]) -> LanceDBEmbeddingRetriever
      :classmethod:


      Deserialize this component from a dictionary.