lancedb_haystack.fts_retriever
==============================

.. py:module:: lancedb_haystack.fts_retriever


Classes
-------

.. autoapisummary::

   lancedb_haystack.fts_retriever.LanceDBFTSRetriever


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

.. py:class:: LanceDBFTSRetriever(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 the FTS.


   .. py:attribute:: NAME
      :value: 'lancedb_haystack.fts_retriever.LanceDBFTSRetriever'



   .. py:attribute:: _document_store


   .. py:attribute:: _filters


   .. py:attribute:: _top_k


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

      Run the LanceDBFTSRetriever on the given input data.

      :param query: The query string for the Retriever.
      :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.

      :raises ValueError: If the specified DocumentStore is not found or is not a LanceDBFTSRetriever instance.



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

      Serialize this component to a dictionary.



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


      Deserialize this component from a dictionary.