121 `llamaindex.core.retrievers` 模块概览

llamaindex.core.retrievers 模块概览

llamaindex.core.retrievers 模块包含了多个用于信息检索的类和方法。这些类和方法提供了从不同类型的索引和数据源中检索信息的功能。以下是该模块中主要类的概览和简要说明：

基础检索器

• BaseRetriever: 所有检索器的基类，定义了检索器的基本接口和行为。
• BaseImageRetriever: 用于图像检索的基类。

空索引检索器

• EmptyIndexRetriever: 用于处理空索引的检索器。

关键词表检索器

• KeywordTableSimpleRetriever: 基于关键词表的简单检索器。

知识图谱检索器

• KGTableRetriever: 基于知识图谱表的检索器。
• KnowledgeGraphRAGRetriever: 基于知识图谱的检索增强生成（RAG）检索器。

列表索引检索器

• ListIndexEmbeddingRetriever: 基于嵌入的列表索引检索器。
• ListIndexRetriever: 列表索引检索器。
• SummaryIndexEmbeddingRetriever: 基于嵌入的摘要索引检索器。
• SummaryIndexLLMRetriever: 基于语言模型的摘要索引检索器。
• SummaryIndexRetriever: 摘要索引检索器。

属性图检索器

• BasePGRetriever: 属性图检索器的基类。
• CustomPGRetriever: 自定义属性图检索器。
• CypherTemplateRetriever: 基于Cypher查询模板的属性图检索器。
• LLMSynonymRetriever: 基于语言模型的同义词检索器。
• PGRetriever: 属性图检索器。
• TextToCypherRetriever: 将文本转换为Cypher查询的检索器。
• VectorContextRetriever: 向量上下文检索器。

SQL检索器

• NLSQLRetriever: 自然语言SQL检索器。
• SQLParserMode: SQL解析模式。
• SQLRetriever: SQL检索器。

树索引检索器

• TreeAllLeafRetriever: 树索引的所有叶子节点检索器。
• TreeSelectLeafEmbeddingRetriever: 基于嵌入的树索引选择叶子节点检索器。
• TreeSelectLeafRetriever: 树索引选择叶子节点检索器。
• TreeRootRetriever: 树索引的根节点检索器。

向量存储检索器

• VectorIndexAutoRetriever: 自动向量索引检索器。
• VectorIndexRetriever: 向量索引检索器。

其他检索器

• AutoMergingRetriever: 自动合并检索器。
• QueryFusionRetriever: 查询融合检索器。
• RecursiveRetriever: 递归检索器。
• RouterRetriever: 路由检索器。
• TransformRetriever: 转换检索器。

总结

llamaindex.core.retrievers 模块提供了多种检索器，涵盖了从简单的关键词检索到复杂的知识图谱和属性图检索等多种场景。这些检索器为构建高效的信息检索系统提供了强大的支持。希望本文能为您的编程实践提供有益的参考和帮助。

from llama_index.core.base.base_retriever import BaseRetriever
from llama_index.core.image_retriever import BaseImageRetriever
from llama_index.core.indices.empty.retrievers import EmptyIndexRetriever
from llama_index.core.indices.keyword_table.retrievers import (
    KeywordTableSimpleRetriever,
)
from llama_index.core.indices.knowledge_graph.retrievers import (
    KGTableRetriever,
    KnowledgeGraphRAGRetriever,
)
from llama_index.core.indices.list.retrievers import (
    ListIndexEmbeddingRetriever,
    ListIndexRetriever,
    SummaryIndexEmbeddingRetriever,
    SummaryIndexLLMRetriever,
    SummaryIndexRetriever,
)
from llama_index.core.indices.property_graph import (
    BasePGRetriever,
    CustomPGRetriever,
    CypherTemplateRetriever,
    LLMSynonymRetriever,
    PGRetriever,
    TextToCypherRetriever,
    VectorContextRetriever,
)
from llama_index.core.indices.struct_store.sql_retriever import (
    NLSQLRetriever,
    SQLParserMode,
    SQLRetriever,
)
from llama_index.core.indices.tree.all_leaf_retriever import TreeAllLeafRetriever
from llama_index.core.indices.tree.select_leaf_embedding_retriever import (
    TreeSelectLeafEmbeddingRetriever,
)
from llama_index.core.indices.tree.select_leaf_retriever import (
    TreeSelectLeafRetriever,
)
from llama_index.core.indices.tree.tree_root_retriever import TreeRootRetriever
from llama_index.core.indices.vector_store.retrievers import (
    VectorIndexAutoRetriever,
    VectorIndexRetriever,
)
from llama_index.core.retrievers.auto_merging_retriever import AutoMergingRetriever
from llama_index.core.retrievers.fusion_retriever import QueryFusionRetriever
from llama_index.core.retrievers.recursive_retriever import RecursiveRetriever
from llama_index.core.retrievers.router_retriever import RouterRetriever
from llama_index.core.retrievers.transform_retriever import TransformRetriever

__all__ = [
    "VectorIndexRetriever",
    "VectorIndexAutoRetriever",
    "SummaryIndexRetriever",
    "SummaryIndexEmbeddingRetriever",
    "SummaryIndexLLMRetriever",
    "KGTableRetriever",
    "KnowledgeGraphRAGRetriever",
    "EmptyIndexRetriever",
    "TreeAllLeafRetriever",
    "TreeSelectLeafEmbeddingRetriever",
    "TreeSelectLeafRetriever",
    "TreeRootRetriever",
    "TransformRetriever",
    "KeywordTableSimpleRetriever",
    "BaseRetriever",
    "RecursiveRetriever",
    "AutoMergingRetriever",
    "RouterRetriever",
    "BM25Retriever",
    "QueryFusionRetriever",
    # property graph
    "BasePGRetriever",
    "PGRetriever",
    "CustomPGRetriever",
    "LLMSynonymRetriever",
    "CypherTemplateRetriever",
    "TextToCypherRetriever",
    "VectorContextRetriever",
    # SQL
    "SQLRetriever",
    "NLSQLRetriever",
    "SQLParserMode",
    # legacy
    "ListIndexEmbeddingRetriever",
    "ListIndexRetriever",
    # image
    "BaseImageRetriever",
]