API reference

Subpackages

• xrag.data package
  • Submodules
  • xrag.data.loader module
  • xrag.data.qa_loader module
    • build_split()
    • generate_qa_from_folder()
    • get_documents()
    • get_qa_dataset()
    • test_file_loading()
  • Module contents
• xrag.embs package
  • Submodules
  • xrag.embs.chatglmemb module
    • ChatGLMEmbeddings
      • ChatGLMEmbeddings.api_key
      • ChatGLMEmbeddings.class_name()
      • ChatGLMEmbeddings.get_general_text_embedding()
      • ChatGLMEmbeddings.model
      • ChatGLMEmbeddings.model_computed_fields
      • ChatGLMEmbeddings.model_config
      • ChatGLMEmbeddings.model_fields
      • ChatGLMEmbeddings.model_post_init()
      • ChatGLMEmbeddings.reuse_client
  • xrag.embs.embedding module
    • get_embedding()
  • Module contents
• xrag.eval package
  • Submodules
  • xrag.eval.DeepEvalLocalModel module
    • DeepEvalLocalModel
      • DeepEvalLocalModel.a_generate()
      • DeepEvalLocalModel.generate()
      • DeepEvalLocalModel.get_model_name()
      • DeepEvalLocalModel.load_model()
  • xrag.eval.EvalModelAgent module
    • EvalModelAgent
    • qwen_completion_to_prompt()
  • xrag.eval.evaluate_LLM module
    • EvaluationResult_LLM
      • EvaluationResult_LLM.add()
      • EvaluationResult_LLM.print_results()
      • EvaluationResult_LLM.print_results_to_path()
    • UptrainEvaluate()
    • evaluating()
    • get_DeepEval_Metrices()
    • get_llama_evaluator()
    • upTrain_evaluate_self()
  • xrag.eval.evaluate_TGT module
    • NLGEvaluate()
  • xrag.eval.evaluate_TRT module
    • DCG()
    • Em()
    • EvaluationResult_TRT
      • EvaluationResult_TRT.add()
      • EvaluationResult_TRT.print_results()
      • EvaluationResult_TRT.print_results_to_path()
    • F1()
    • Hit()
    • IDCG()
    • MAP()
    • Mrr()
    • NDCG()
    • evaluating_TRT()
  • xrag.eval.evaluate_rag module
    • DCG()
    • Em()
    • EvaluationResult
      • EvaluationResult.add()
      • EvaluationResult.get_results_str()
      • EvaluationResult.print_results()
      • EvaluationResult.print_results_to_path()
    • F1()
    • Hit()
    • IDCG()
    • MAP()
    • Mrr()
    • NDCG()
    • NLGEvaluate()
    • UptrainEvaluate()
    • evaluating()
    • get_DeepEval_Metrices()
    • get_llama_evaluator()
    • upTrain_evaluate_self()
  • Module contents
• xrag.index package
  • Submodules
  • xrag.index.index module
    • get_index()
  • Module contents
• xrag.launcher package
  • Submodules
  • xrag.launcher.launch module
    • build_index()
    • build_query_engine()
    • eval_cli()
    • run()
    • seed_everything()
  • Module contents
• xrag.llms package
  • Submodules
  • xrag.llms.chatglm4 module
    • ChatGLM
      • ChatGLM.api_key
      • ChatGLM.chat()
      • ChatGLM.class_name()
      • ChatGLM.complete()
      • ChatGLM.context_window
      • ChatGLM.metadata
      • ChatGLM.model
      • ChatGLM.model_computed_fields
      • ChatGLM.model_config
      • ChatGLM.model_fields
      • ChatGLM.model_post_init()
      • ChatGLM.num_output
      • ChatGLM.reuse_client
      • ChatGLM.stream_chat()
      • ChatGLM.stream_complete()
    • get_additional_kwargs()
    • to_message_dicts()
  • xrag.llms.huggingface_model module
    • baichuan_completion_to_prompt()
    • baichuan_model_and_tokenizer()
    • chatglm_completion_to_prompt()
    • chatglm_model_and_tokenizer()
    • falcon_completion_to_prompt()
    • falcon_model_and_tokenizer()
    • get_huggingfacellm()
    • llama_completion_to_prompt()
    • llama_model_and_tokenizer()
    • mpt_completion_to_prompt()
    • mpt_model_and_tokenizer()
    • qwen_completion_to_prompt()
    • qwen_model_and_tokenizer()
    • yi_completion_to_prompt()
    • yi_model_and_tokenizer()
  • xrag.llms.llm module
    • get_llm()
    • get_openai()
  • Module contents
• xrag.process package
  • Submodules
  • xrag.process.postprocess_rerank module
    • get_postprocessor()
  • xrag.process.postprocessor module
    • bm25_retriever()
    • gpt_rerank()
    • keyword_node_postprocessor()
    • llm_rerank()
    • long_context_reorder()
    • sentence_embedding_optimizer()
    • similarity_postprocessor()
    • transformer_rerank()
  • xrag.process.query_transform module
    • CustomSubQuestionQueryEngine
    • hyde()
    • hyde_fewshot()
    • hyde_zeroshot()
    • stepback()
    • stepback_fewshot()
    • stepback_zeroshot()
    • subquery()
    • subquery_fewshot()
    • subquery_zeroshot()
    • transform()
    • transform_and_query()
  • Module contents
• xrag.retrievers package
  • Submodules
  • xrag.retrievers.retriever module
    • AllRetriever
      • AllRetriever.get_response_mode()
      • AllRetriever.query_expansion()
    • CustomRetriever
    • auto_merging_retriever()
    • bm25_retriever()
    • custom_retriever()
    • document_summary_retrievers()
    • get_query_engine_by_router()
    • get_retriver()
    • keyword_retriever()
    • query_expansion()
    • query_fusion_retriever()
    • recursive_retriever()
    • response_synthesizer()
    • sentence_window_retriever()
    • summary_retriever()
    • tree_retriever()
    • vector_retriever()
  • Module contents
• xrag.webui package
  • Submodules
  • xrag.webui.app module
    • display_results()
    • get_index()
    • get_qa_dataset_()
    • get_query()
    • get_query_engine()
    • main()
  • xrag.webui.run module
    • run_web_ui()
  • Module contents

Submodules

• xrag.cli module
  • xrag.cli
• xrag.config module
  • xrag.config

Module contents