retrievers

Retriever 类根据文本 query 返回文档。

它比向量存储更通用。检索器不需要能够存储文档，只需要返回（或检索）它。向量存储可以用作检索器的骨干，但也有其他类型的检索器。

类层次结构：

BaseRetriever --> <name>Retriever  # Examples: ArxivRetriever, MergerRetriever

主要助手：

Document, Serializable, Callbacks,
CallbackManagerForRetrieverRun, AsyncCallbackManagerForRetrieverRun

类

retrievers.arcee.ArceeRetriever	Arcee 领域适应语言模型 (DALMs) 检索器。
retrievers.arxiv.ArxivRetriever	Arxiv 检索器。
retrievers.asknews.AskNewsRetriever	AskNews 检索器。
retrievers.azure_ai_search.AzureAISearchRetriever	Azure AI Search 服务检索器。
retrievers.azure_ai_search.AzureCognitiveSearchRetriever	Azure Cognitive Search 服务检索器。
retrievers.bedrock.AmazonKnowledgeBasesRetriever	Amazon Bedrock 知识库检索器。
retrievers.bedrock.RetrievalConfig	检索的配置。
retrievers.bedrock.VectorSearchConfig	向量搜索的配置。
retrievers.bm25.BM25Retriever	BM25 检索器，无需 Elasticsearch。
retrievers.breebs.BreebsRetriever	一个用于Breebs的检索器类。
retrievers.chaindesk.ChaindeskRetriever	Chaindesk API 检索器。
retrievers.chatgpt_plugin_retriever.ChatGPTPluginRetriever	ChatGPT 插件 检索器。
retrievers.databerry.DataberryRetriever	Databerry API 检索器。
retrievers.docarray.DocArrayRetriever	DocArray 文档索引 检索器。
retrievers.docarray.SearchType(value[, ...])	执行搜索类型的枚举器。
retrievers.dria_index.DriaRetriever	Dria 检索器使用 DriaAPIWrapper。
retrievers.elastic_search_bm25.ElasticSearchBM25Retriever	Elasticsearch 检索器，使用 BM25。
retrievers.embedchain.EmbedchainRetriever	Embedchain 检索器。
retrievers.google_vertex_ai_search.GoogleCloudEnterpriseSearchRetriever	Google Vertex Search API 检索器别名，用于向后兼容。
retrievers.kay.KayAiRetriever	用于Kay.ai数据集的检索器。
retrievers.kendra.AdditionalResultAttribute	额外的结果属性。
retrievers.kendra.AdditionalResultAttributeValue	附加结果属性的值。
retrievers.kendra.AmazonKendraRetriever	Amazon Kendra Index 检索器。
retrievers.kendra.DocumentAttribute	文档属性。
retrievers.kendra.DocumentAttributeValue	文档属性的值。
retrievers.kendra.Highlight	突出显示摘录中关键字的信息。
retrievers.kendra.QueryResult	Amazon Kendra Query API 搜索结果。
retrievers.kendra.QueryResultItem	查询API结果项。
retrievers.kendra.ResultItem	结果项的基础类。
retrievers.kendra.RetrieveResult	Amazon Kendra Retrieve API 搜索结果。
retrievers.kendra.RetrieveResultItem	检索API结果项。
retrievers.kendra.TextWithHighLights	带有高亮的文本。
retrievers.knn.KNNRetriever	KNN 检索器。
retrievers.llama_index.LlamaIndexGraphRetriever	LlamaIndex 图数据结构检索器。
retrievers.llama_index.LlamaIndexRetriever	LlamaIndex 检索器。
retrievers.metal.MetalRetriever	Metal API 检索器。
retrievers.milvus.MilvusRetriever	Milvus API 检索器。
retrievers.nanopq.NanoPQRetriever	`NanoPQ 检索器。
retrievers.needle.NeedleRetriever	NeedleRetriever 根据搜索查询从 Needle 集合中检索相关文档或上下文。
retrievers.outline.OutlineRetriever	Outline API 的检索器。
retrievers.pinecone_hybrid_search.PineconeHybridSearchRetriever	Pinecone 混合搜索 检索器。
retrievers.pubmed.PubMedRetriever	PubMed API 检索器。
retrievers.rememberizer.RememberizerRetriever	Rememberizer 检索器。
retrievers.remote_retriever.RemoteLangChainRetriever	LangChain API 检索器。
retrievers.svm.SVMRetriever	SVM 检索器。
retrievers.tavily_search_api.SearchDepth(value)	搜索深度作为枚举器。
retrievers.tavily_search_api.TavilySearchAPIRetriever	Tavily 搜索 API 检索器。
retrievers.tfidf.TFIDFRetriever	TF-IDF 检索器。
retrievers.thirdai_neuraldb.NeuralDBRetriever	使用ThirdAI的NeuralDB的文档检索器。
retrievers.vespa_retriever.VespaRetriever	Vespa 检索器。
retrievers.weaviate_hybrid_search.WeaviateHybridSearchRetriever	Weaviate 混合搜索 检索器。
retrievers.web_research.QuestionListOutputParser	用于编号问题列表的输出解析器。
retrievers.web_research.SearchQueries	搜索查询以研究用户的目标。
retrievers.web_research.WebResearchRetriever	Google Search API 检索器。
retrievers.wikipedia.WikipediaRetriever	Wikipedia API 检索器。
retrievers.you.YouRetriever	You.com 搜索 API 检索器。
retrievers.zep.SearchScope(value[, names, ...])	要搜索哪些文档。
retrievers.zep.SearchType(value[, names, ...])	执行搜索类型的枚举器。
retrievers.zep.ZepRetriever	Zep 内存存储检索器。
retrievers.zep_cloud.ZepCloudRetriever	Zep Cloud 内存存储检索器。
retrievers.zilliz.ZillizRetriever	Zilliz API 检索器。

函数

retrievers.bm25.default_preprocessing_func(text)
retrievers.kendra.clean_excerpt(excerpt)	清理来自Kendra的摘录。
retrievers.kendra.combined_text(item)	将ResultItem的标题和摘要合并为一个字符串。
retrievers.knn.create_index(contexts, embeddings)	为上下文列表创建嵌入索引。
retrievers.milvus.MilvusRetreiver(*args, ...)	已弃用的 MilvusRetreiver。
retrievers.nanopq.create_index(contexts, ...)	为上下文列表创建嵌入索引。
retrievers.pinecone_hybrid_search.create_index(...)	从上下文列表中创建一个索引。
retrievers.pinecone_hybrid_search.hash_text(text)	使用SHA256哈希文本。
retrievers.svm.create_index(contexts, embeddings)	为上下文列表创建嵌入索引。
retrievers.zilliz.ZillizRetreiver(*args, ...)	已弃用的 ZillizRetreiver。

已弃用的类

retrievers.cohere_rag_retriever.CohereRagRetriever
retrievers.google_cloud_documentai_warehouse.GoogleDocumentAIWarehouseRetriever
retrievers.google_vertex_ai_search.GoogleVertexAIMultiTurnSearchRetriever
retrievers.google_vertex_ai_search.GoogleVertexAISearchRetriever
retrievers.qdrant_sparse_vector_retriever.QdrantSparseVectorRetriever