xrag.retrievers package#

Submodules#

xrag.retrievers.retriever module#

class xrag.retrievers.retriever.AllRetriever(nodes_, vector_index_, summary_index_, tree_index_, keyword_index_, sentence_index_, mode=0)[source]#

Bases: object

get_response_mode(retriever_, mode=0)[source]#
query_expansion(retriever, query_number, similarity_number)[source]#
class xrag.retrievers.retriever.CustomRetriever(vector_retriever_c, bm25_retriever_c, keyword_retriever_c, mode='AND')[source]#

Bases: BaseRetriever

xrag.retrievers.retriever.auto_merging_retriever(index, hierarchical_storage_context)[source]#
xrag.retrievers.retriever.bm25_retriever(index)[source]#
xrag.retrievers.retriever.custom_retriever(index, mode=0)[source]#
xrag.retrievers.retriever.document_summary_retrievers(index)[source]#
xrag.retrievers.retriever.get_query_engine_by_router(summary_index=None, vector_index=None, keyword_index=None)[source]#
xrag.retrievers.retriever.get_retriver(type, index, mode=0, node=None, hierarchical_storage_context=None)[source]#
xrag.retrievers.retriever.keyword_retriever(index, mode=0)[source]#
xrag.retrievers.retriever.query_expansion(ret, query_number=4, similarity_top_k=10)[source]#
xrag.retrievers.retriever.query_fusion_retriever(index, num_queries=4, similarity_top_k=2, mode=0, retriever_weight=None)[source]#
xrag.retrievers.retriever.recursive_retriever(base_nodes)[source]#
xrag.retrievers.retriever.response_synthesizer(mode=0)[source]#
xrag.retrievers.retriever.sentence_window_retriever(index)[source]#
xrag.retrievers.retriever.summary_retriever(summary_index, mode=0)[source]#
xrag.retrievers.retriever.tree_retriever(index, mode=0)[source]#
xrag.retrievers.retriever.vector_retriever(index)[source]#

Module contents#