retrievers
#
Retriever class returns Documents given a text query.
It is more general than a vector store. A retriever does not need to be able to store documents, only to return (or retrieve) it. Vector stores can be used as the backbone of a retriever, but there are other types of retrievers as well.
Class hierarchy:
BaseRetriever --> <name>Retriever # Examples: ArxivRetriever, MergerRetriever
Main helpers:
Document, Serializable, Callbacks,
CallbackManagerForRetrieverRun, AsyncCallbackManagerForRetrieverRun
Classes
|
Retriever that wraps a base retriever and compresses the results. |
|
Document compressor that uses a pipeline of Transformers. |
|
Document compressor that uses an LLM chain to extract the relevant parts of documents. |
|
Parse outputs that could return a null string of some sort. |
Filter that drops documents that aren't relevant to the query. |
|
|
Interface for cross encoder models. |
|
Document compressor that uses CrossEncoder for reranking. |
|
Document compressor that uses embeddings to drop documents unrelated to the query. |
|
Document compressor that uses Zero-Shot Listwise Document Reranking. |
Retriever that ensembles the multiple retrievers. |
|
Retriever that merges the results of multiple retrievers. |
|
Output parser for a list of lines. |
|
Given a query, use an LLM to write a set of queries. |
|
Retrieve from a set of multiple embeddings for the same document. |
|
|
Enumerator of the types of search to perform. |
|
Retrieve small chunks then retrieve their parent documents. |
Given a query, use an LLM to re-phrase it. |
|
Retriever that uses a vector store and an LLM to generate the vector store queries. |
|
|
Retriever that combines embedding similarity with recency in retrieving values. |
Functions
|
Return the compression chain input. |
|
Return the compression chain input. |
|
Yield unique elements of an iterable based on a key function. |
Deprecated classes
Deprecated since version 0.0.30: Use |