retrievers

class datadreamer.retrievers.Retriever(texts, cache_folder_path=None)

Bases: _Cachable

abstract property index

unload_model()

class datadreamer.retrievers.EmbeddingRetriever(texts, embedder, truncate=False, index_batch_size=10, index_instruction=None, query_instruction=None, cache_folder_path=None, devices=None, **kwargs)

Bases: Retriever

property index

run(queries, k=5, batch_size=10, batch_scheduler_buffer_size=None, adaptive_batch_size=False, progress_interval=60, force=False, cache_only=False, verbose=None, log_level=None, total_num_queries=None, return_generator=False, **kwargs)

Return type:

Union[Generator[dict[str, Any], None, None], list[dict[str, Any]]]

class datadreamer.retrievers.ParallelRetriever(*retrievers)

Bases: _ParallelCachable, Retriever

property index

run(queries, *args, **kwargs)

Return type:

Union[Generator[str | list[str], None, None], list[str | list[str]]]