aiq.retriever.interface

Classes

AIQRetriever

Abstract interface for interacting with data stores.

Module Contents

class AIQRetriever

Bases: abc.ABC

Abstract interface for interacting with data stores.

A Retriever is resposible for retrieving data from a configured data store.

Implemntations may integrate with vector stores or other indexing backends that allow for text-based search.

abstractmethod search(query: str, **kwargs) → aiq.retriever.models.RetrieverOutput

Async:

Retireve max(top_k) items from the data store based on vector similarity search (implementation dependent).