Retrievers

To connect to an Elasticsearch instance that requires login credentials, including Elastic Cloud, use the Elasticsearch URL format https://username:passwor

Class

DriaRetriever

Dria retriever using the DriaAPIWrapper.

Class

ZillizRetriever

Zilliz API retriever.

Class

NanoPQRetriever

`NanoPQ retriever.

Class

RememberizerRetriever

Rememberizer retriever.

It wraps load() to get_relevant_documents(). It uses all RememberizerAPIWrapper arguments without any change.

Class

SearchType

Enumerator of the types of search to perform.

Class

DocArrayRetriever

DocArray Document Indices retriever.

Currently, it supports 5 backends: InMemoryExactNNIndex, HnswDocumentIndex, QdrantDocumentIndex, ElasticDocIndex, and WeaviateDocumentIndex.

Class

SearchQueries

Search queries to research for the user's goal.

Class

QuestionListOutputParser

Output parser for a list of numbered questions.

Class

WebResearchRetriever

Google Search API retriever.

Class

SearchDepth

Search depth as enumerator.

Class

TavilySearchAPIRetriever

Tavily Search API retriever.

Setup: Install langchain-community and set environment variable TAVILY_API_KEY.

.. code-block:: bash

    pip install -U langchain-co

Class

ArxivRetriever

Arxiv retriever.

Class

Highlight

Information that highlights the keywords in the excerpt.

Class

TextWithHighLights

Text with highlights.

Class

AdditionalResultAttributeValue

Value of an additional result attribute.

Class

AdditionalResultAttribute

Additional result attribute.

Class

DocumentAttributeValue

Value of a document attribute.

Class

DocumentAttribute

Document attribute.

Class

ResultItem

Base class of a result item.

Class

QueryResultItem

Query API result item.

Class

RetrieveResultItem

Retrieve API result item.

Class

QueryResult

Amazon Kendra Query API search result.

Class

RetrieveResult

Amazon Kendra Retrieve API search result.

Class

EmbedchainRetriever

Embedchain retriever.

Class

NeuralDBRetriever

Document retriever that uses ThirdAI's NeuralDB.

Class

MetalRetriever

Metal API retriever.

Class

VectorSearchConfig

Configuration for vector search.

Class

RetrievalConfig

Configuration for retrieval.

Class

NeedleRetriever

NeedleRetriever retrieves relevant documents or context from a Needle collection based on a search query.

Class

ZepCloudRetriever

Zep Cloud MemoryStore Retriever.

Search your user's long-term chat history with Zep.

Zep offers both simple semantic search and Maximal Marginal Relevance (MMR) reranking of search results.

Note:

Class

BM25Retriever

BM25 retriever without Elasticsearch.

Class

KNNRetriever

KNN retriever.

Class

BreebsRetriever

A retriever class for Breebs.

See https://www.breebs.com/ for more info. Args: breeb_key: The key to trigger the breeb (specialized knowledge pill on a specific topic).

To retrieve the lis

Class

VespaRetriever

Vespa retriever.

Class

LlamaIndexRetriever

LlamaIndex retriever.

It is used for the question-answering with sources over an LlamaIndex data structure.

Class

LlamaIndexGraphRetriever

LlamaIndex graph data structure retriever.

It is used for question-answering with sources over an LlamaIndex graph data structure.

Class

AzureAISearchRetriever

Azure AI Search service retriever.

Class

AzureCognitiveSearchRetriever

Azure Cognitive Search service retriever. This version of the retriever will soon be depreciated. Please switch to AzureAISearchRetriever

Class

TFIDFRetriever

TF-IDF retriever.

Largely based on https://github.com/asvskartheek/Text-Retrieval/blob/master/TF-IDF%20Search%20Engine%20(SKLEARN).ipynb

Class

DataberryRetriever

Databerry API retriever.

Class

OutlineRetriever

Retriever for Outline API.

It wraps run() to get_relevant_documents(). It uses all OutlineAPIWrapper arguments without any change.

Class

MilvusRetriever

Milvus API retriever.

See detailed instructions here: https://python.langchain.com/docs/integrations/retrievers/milvus_hybrid_search/

Class

ChatGPTPluginRetriever

ChatGPT plugin retriever.

Class

WikipediaRetriever

Wikipedia API retriever.

Class

PubMedRetriever

PubMed API retriever.

It wraps load() to get_relevant_documents(). It uses all PubMedAPIWrapper arguments without any change.

Class

ArceeRetriever

Arcee Domain Adapted Language Models (DALMs) retriever.

To use, set the ARCEE_API_KEY environment variable with your Arcee API key, or pass arcee_api_key as a named parameter.

Class

RemoteLangChainRetriever

LangChain API retriever.

Class

SVMRetriever

SVM retriever.

Largely based on https://github.com/karpathy/randomfun/blob/master/knn_vs_svm.ipynb

Class

ChaindeskRetriever

Chaindesk API retriever.

Class

KayAiRetriever

Retriever for Kay.ai datasets.

To work properly, expects you to have KAY_API_KEY env variable set. You can get one for free at https://kay.ai/.

Class

GoogleVertexAISearchRetriever

deprecated

Google Vertex AI Search retriever.

For a detailed explanation of the Vertex AI Search concepts and configuration parameters, refer to the product documentation. https://cloud.google.com/generative-

Class