RAGchain package

Subpackages

• RAGchain.DB package
  • Submodules
  • RAGchain.DB.base module
    • BaseDB
      • BaseDB.InputType
      • BaseDB.OutputType
      • BaseDB.create()
      • BaseDB.create_or_load()
      • BaseDB.db_type
      • BaseDB.fetch()
      • BaseDB.get_db_origin()
      • BaseDB.invoke()
      • BaseDB.load()
      • BaseDB.save()
      • BaseDB.search()
  • RAGchain.DB.mongo_db module
    • MongoDB
      • MongoDB.create()
      • MongoDB.create_or_load()
      • MongoDB.db_type
      • MongoDB.fetch()
      • MongoDB.get_db_origin()
      • MongoDB.load()
      • MongoDB.save()
      • MongoDB.search()
      • MongoDB.set_db()
  • RAGchain.DB.pickle_db module
    • PickleDB
      • PickleDB.create()
      • PickleDB.create_or_load()
      • PickleDB.db_type
      • PickleDB.fetch()
      • PickleDB.get_db_origin()
      • PickleDB.load()
      • PickleDB.save()
      • PickleDB.search()
  • Module contents
• RAGchain.benchmark package
  • Subpackages
    • RAGchain.benchmark.answer package
      • Submodules
      • RAGchain.benchmark.answer.metrics module
      • Module contents
    • RAGchain.benchmark.dataset package
      • Submodules
      • RAGchain.benchmark.dataset.antique module
      • RAGchain.benchmark.dataset.asqa module
      • RAGchain.benchmark.dataset.base module
      • RAGchain.benchmark.dataset.dstc11_track5 module
      • RAGchain.benchmark.dataset.eli5 module
      • RAGchain.benchmark.dataset.ko_strategy_qa module
      • RAGchain.benchmark.dataset.mr_tydi module
      • RAGchain.benchmark.dataset.msmarco module
      • RAGchain.benchmark.dataset.natural_question module
      • RAGchain.benchmark.dataset.nfcorpus module
      • RAGchain.benchmark.dataset.qasper module
      • RAGchain.benchmark.dataset.search_qa module
      • RAGchain.benchmark.dataset.strategy_qa module
      • RAGchain.benchmark.dataset.triviaqa module
      • Module contents
    • RAGchain.benchmark.extra package
      • Submodules
      • RAGchain.benchmark.extra.search_detector_evaluator module
      • Module contents
    • RAGchain.benchmark.retrieval package
      • Submodules
      • RAGchain.benchmark.retrieval.evaluator module
      • RAGchain.benchmark.retrieval.metrics module
      • Module contents
  • Submodules
  • RAGchain.benchmark.auto module
    • AutoEvaluator
      • AutoEvaluator.evaluate()
  • RAGchain.benchmark.base module
    • BaseEvaluator
      • BaseEvaluator.answer_gt_metrics
      • BaseEvaluator.answer_no_gt_ragas_metrics
      • BaseEvaluator.answer_passage_metrics
      • BaseEvaluator.evaluate()
      • BaseEvaluator.retrieval_gt_metrics
      • BaseEvaluator.retrieval_gt_metrics_rank_aware
      • BaseEvaluator.retrieval_gt_ragas_metrics
      • BaseEvaluator.retrieval_no_gt_ragas_metrics
      • BaseEvaluator.uuid_to_str()
    • DummyRetrieval
      • DummyRetrieval.delete()
      • DummyRetrieval.ingest()
      • DummyRetrieval.retrieve()
      • DummyRetrieval.retrieve_id()
      • DummyRetrieval.retrieve_id_with_scores()
  • Module contents
• RAGchain.pipeline package
  • Submodules
  • RAGchain.pipeline.base module
    • BaseIngestPipeline
    • BaseRunPipeline
      • BaseRunPipeline.default_chat_prompt
      • BaseRunPipeline.default_prompt
      • BaseRunPipeline.get_passages_and_run()
  • RAGchain.pipeline.basic module
    • BasicIngestPipeline
    • BasicRunPipeline
      • BasicRunPipeline.get_passages_and_run()
      • BasicRunPipeline.run
  • RAGchain.pipeline.google_search module
    • GoogleSearchRunPipeline
      • GoogleSearchRunPipeline.get_passages_and_run()
      • GoogleSearchRunPipeline.run
  • RAGchain.pipeline.rerank module
    • RerankRunPipeline
      • RerankRunPipeline.get_passages_and_run()
      • RerankRunPipeline.run
  • RAGchain.pipeline.visconde module
    • ViscondeRunPipeline
      • ViscondeRunPipeline.get_passages_and_run()
      • ViscondeRunPipeline.run
      • ViscondeRunPipeline.strategyqa_prompt
  • Module contents
• RAGchain.preprocess package
  • Subpackages
    • RAGchain.preprocess.loader package
      • Submodules
      • RAGchain.preprocess.loader.dataset_loader module
      • RAGchain.preprocess.loader.deepdoctection_loader module
      • RAGchain.preprocess.loader.excel_loader module
      • RAGchain.preprocess.loader.file_loader module
      • RAGchain.preprocess.loader.hwp_loader module
      • RAGchain.preprocess.loader.mathpix_markdown_loader module
      • RAGchain.preprocess.loader.nougat_pdf_loader module
      • RAGchain.preprocess.loader.pdf_link_loader module
      • RAGchain.preprocess.loader.rem_loader module
      • RAGchain.preprocess.loader.rust_hwp_loader module
      • RAGchain.preprocess.loader.win32_hwp_loader module
      • Module contents
    • RAGchain.preprocess.text_splitter package
      • Submodules
      • RAGchain.preprocess.text_splitter.base module
      • RAGchain.preprocess.text_splitter.code_splitter module
      • RAGchain.preprocess.text_splitter.html_header_splitter module
      • RAGchain.preprocess.text_splitter.markdown_header_splitter module
      • RAGchain.preprocess.text_splitter.text_splitter module
      • RAGchain.preprocess.text_splitter.token_splitter module
      • Module contents
  • Module contents
• RAGchain.reranker package
  • Subpackages
    • RAGchain.reranker.importance package
      • Submodules
      • RAGchain.reranker.importance.simple_importance module
      • RAGchain.reranker.importance.weighted_importance module
      • Module contents
    • RAGchain.reranker.llm package
      • Submodules
      • RAGchain.reranker.llm.llm module
      • RAGchain.reranker.llm.rank_gpt module
      • Module contents
    • RAGchain.reranker.pygaggle package
      • Subpackages
      • Submodules
      • RAGchain.reranker.pygaggle.base module
      • RAGchain.reranker.pygaggle.monoT5 module
      • RAGchain.reranker.pygaggle.transformer module
      • Module contents
    • RAGchain.reranker.tart package
      • Submodules
      • RAGchain.reranker.tart.modeling_enc_t5 module
      • RAGchain.reranker.tart.tart module
      • RAGchain.reranker.tart.tokenization_enc_t5 module
      • Module contents
    • RAGchain.reranker.time package
      • Submodules
      • RAGchain.reranker.time.simple_time module
      • RAGchain.reranker.time.weighted_time module
      • Module contents
    • RAGchain.reranker.upr package
      • Submodules
      • RAGchain.reranker.upr.upr module
      • Module contents
  • Submodules
  • RAGchain.reranker.base module
    • BaseReranker
      • BaseReranker.InputType
      • BaseReranker.OutputType
      • BaseReranker.rerank()
  • RAGchain.reranker.bm25 module
    • BM25Reranker
      • BM25Reranker.invoke()
      • BM25Reranker.rerank()
  • Module contents
• RAGchain.retrieval package
  • Submodules
  • RAGchain.retrieval.base module
    • BaseRetrieval
      • BaseRetrieval.InputType
      • BaseRetrieval.OutputType
      • BaseRetrieval.as_ingest()
      • BaseRetrieval.create_db()
      • BaseRetrieval.delete()
      • BaseRetrieval.duplicate_check()
      • BaseRetrieval.fetch_data()
      • BaseRetrieval.fetch_data_from_db_origin()
      • BaseRetrieval.fetch_each_db()
      • BaseRetrieval.ingest()
      • BaseRetrieval.invoke()
      • BaseRetrieval.is_created()
      • BaseRetrieval.retrieve()
      • BaseRetrieval.retrieve_id()
      • BaseRetrieval.retrieve_id_with_scores()
      • BaseRetrieval.retrieve_with_filter()
      • BaseRetrieval.search_data()
      • BaseRetrieval.search_data_from_db_origin()
      • BaseRetrieval.search_each_db()
    • RunnableRetrievalIngest
      • RunnableRetrievalIngest.InputType
      • RunnableRetrievalIngest.OutputType
      • RunnableRetrievalIngest.invoke()
  • RAGchain.retrieval.bm25_retrieval module
    • BM25Retrieval
      • BM25Retrieval.delete()
      • BM25Retrieval.ingest()
      • BM25Retrieval.load_data()
      • BM25Retrieval.persist()
      • BM25Retrieval.retrieve()
      • BM25Retrieval.retrieve_id()
      • BM25Retrieval.retrieve_id_with_scores()
  • RAGchain.retrieval.hybrid module
    • HybridRetrieval
      • HybridRetrieval.delete()
      • HybridRetrieval.ingest()
      • HybridRetrieval.min_max_normalization()
      • HybridRetrieval.retrieve()
      • HybridRetrieval.retrieve_id()
      • HybridRetrieval.retrieve_id_with_scores()
      • HybridRetrieval.retrieve_id_with_scores_parallel()
  • RAGchain.retrieval.hyde module
    • HyDERetrieval
      • HyDERetrieval.BASIC_SYSTEM_PROMPT
      • HyDERetrieval.delete()
      • HyDERetrieval.ingest()
      • HyDERetrieval.retrieve()
      • HyDERetrieval.retrieve_id()
      • HyDERetrieval.retrieve_id_with_scores()
  • RAGchain.retrieval.vectordb_retrieval module
    • VectorDBRetrieval
      • VectorDBRetrieval.delete()
      • VectorDBRetrieval.ingest()
      • VectorDBRetrieval.retrieve()
      • VectorDBRetrieval.retrieve_id()
      • VectorDBRetrieval.retrieve_id_with_scores()
  • Module contents
• RAGchain.schema package
  • Submodules
  • RAGchain.schema.db_origin module
    • DBOrigin
      • DBOrigin.db_path
      • DBOrigin.db_type
      • DBOrigin.to_dict()
  • RAGchain.schema.evaluate_result module
    • EvaluateResult
      • EvaluateResult.each_results
      • EvaluateResult.results
      • EvaluateResult.use_metrics
  • RAGchain.schema.passage module
    • Passage
      • Passage.Config
      • Passage.content
      • Passage.content_datetime
      • Passage.copy()
      • Passage.filepath
      • Passage.from_documents()
      • Passage.from_search()
      • Passage.id
      • Passage.importance
      • Passage.is_exactly_same()
      • Passage.make_prompts()
      • Passage.metadata_etc
      • Passage.next_passage_id
      • Passage.previous_passage_id
      • Passage.reset_id()
      • Passage.to_dict()
      • Passage.to_document()
  • RAGchain.schema.prompt module
    • RAGchainChatPromptTemplate
      • RAGchainChatPromptTemplate.input_variables
      • RAGchainChatPromptTemplate.messages
      • RAGchainChatPromptTemplate.validate_template
    • RAGchainPromptTemplate
      • RAGchainPromptTemplate.input_variables
      • RAGchainPromptTemplate.template
      • RAGchainPromptTemplate.template_format
      • RAGchainPromptTemplate.validate_template
  • RAGchain.schema.retrieval_result module
    • RetrievalResult
      • RetrievalResult.metadata
      • RetrievalResult.passages
      • RetrievalResult.query
      • RetrievalResult.scores
      • RetrievalResult.slice()
      • RetrievalResult.to_dict()
      • RetrievalResult.to_prompt_input()
  • Module contents
• RAGchain.utils package
  • Subpackages
    • RAGchain.utils.compressor package
      • Submodules
      • RAGchain.utils.compressor.base module
      • RAGchain.utils.compressor.cluster_time module
      • RAGchain.utils.compressor.llm_lingua module
      • Module contents
    • RAGchain.utils.embed package
      • Submodules
      • RAGchain.utils.embed.embeddingfactory module
      • Module contents
    • RAGchain.utils.linker package
      • Submodules
      • RAGchain.utils.linker.base module
      • RAGchain.utils.linker.dynamo_linker module
      • RAGchain.utils.linker.json_linker module
      • RAGchain.utils.linker.redis_linker module
      • Module contents
    • RAGchain.utils.vectorstore package
      • Submodules
      • RAGchain.utils.vectorstore.base module
      • RAGchain.utils.vectorstore.chroma module
      • RAGchain.utils.vectorstore.pinecone module
      • Module contents
    • RAGchain.utils.websearch package
      • Submodules
      • RAGchain.utils.websearch.base module
      • RAGchain.utils.websearch.bing_search module
      • RAGchain.utils.websearch.google_search module
      • Module contents
  • Submodules
  • RAGchain.utils.evidence_extractor module
    • EvidenceExtractor
      • EvidenceExtractor.InputType
      • EvidenceExtractor.OutputType
      • EvidenceExtractor.batch()
      • EvidenceExtractor.extract()
      • EvidenceExtractor.invoke()
  • RAGchain.utils.file_cache module
    • FileCache
      • FileCache.InputType
      • FileCache.OutputType
      • FileCache.delete_duplicate()
      • FileCache.invoke()
  • RAGchain.utils.query_decompose module
    • QueryDecomposition
      • QueryDecomposition.decompose()
      • QueryDecomposition.decompose_prompt
      • QueryDecomposition.invoke()
  • RAGchain.utils.rede_search_detector module
    • RedeSearchDetector
      • RedeSearchDetector.detect()
      • RedeSearchDetector.evaluate()
      • RedeSearchDetector.find_representation_transform()
      • RedeSearchDetector.find_threshold()
      • RedeSearchDetector.representation_formation()
      • RedeSearchDetector.train_density_estimation()
  • RAGchain.utils.semantic_clustering module
    • SemanticClustering
      • SemanticClustering.cluster()
  • RAGchain.utils.util module
    • FileChecker
      • FileChecker.check_type()
      • FileChecker.is_exist()
    • set_api_base()
    • slice_stop_words()
    • text_modifier()
  • Module contents

Module contents