UltraRAG UI实战指南：构建标准化检索增强生成(RAG)流程

Introduction

检索增强生成（RAG）已成为利用外部、最新知识增强大语言模型（LLM）能力的核心技术。为了提供对RAG能力的深度实践体验，UltraRAG UI提供了一个标准化的端到端流程。这个集成的工作流无缝结合了文档检索、引用标注和增强文本生成，使开发者和研究人员能够高效地实验和评估RAG系统。本文将引导您了解这个强大流程的结构、配置和执行。

Pipeline Structure Overview

UltraRAG体验的核心由一个YAML配置文件定义。该文件编排了一系列步骤，每个步骤由专用的模型上下文协议（MCP）服务器或客户端组件处理。该流程设计为模块化、透明且可复现的。

以下YAML片段概述了RAG演示流程的主要阶段：

# examples/RAG.yaml
# RAG Demo for UltraRAG UI

# MCP Server
servers:
  benchmark: servers/benchmark
  retriever: servers/retriever
  prompt: servers/prompt
  generation: servers/generation
  evaluation: servers/evaluation
  custom: servers/custom

# MCP Client Pipeline
pipeline:
- benchmark.get_data
- retriever.retriever_init
- generation.generation_init
- retriever.retriever_search
- custom.assign_citation_ids
- prompt.qa_rag_boxed
- generation.generate

Key Stages Explained:

关键阶段解析：

Compiling the Pipeline File

要将声明式的YAML配置转换为可执行的流程，您需要使用UltraRAG命令行工具对其进行编译。

在终端中执行以下命令：

ultrarag build examples/RAG.yaml

此步骤验证配置，解析组件之间的依赖关系，并准备在UltraRAG UI中执行的流程。

Configuring Runtime Parameters

流程中每个组件的行为通过一个单独的参数文件进行精细控制。对于RAG系统，需要配置两个关键后端：嵌入/检索后端和LLM生成后端。

主配置文件是 examples/parameter/RAG_parameter.yaml。以下是其核心部分的解析：

1. Benchmark Configuration (benchmark)

此部分定义了用于演示或评估的数据集。

benchmark:
  benchmark:
    key_map:
      gt_ls: golden_answers # Maps the field containing correct answers
      q_ls: question        # Maps the field containing questions
    limit: -1               # Number of samples to use (-1 for all)
    name: nq                # Benchmark name
    path: data/sample_nq_10.jsonl # Path to the data file
    seed: 42
    shuffle: false

key_map 中的 gt_ls: golden_answers 映射包含正确答案的字段；q_ls: question 映射包含问题的字段。limit: -1 表示使用所有样本。name: nq 是基准测试名称。path: data/sample_nq_10.jsonl 是数据文件路径。

2. Generation Backend Configuration (generation)

在此处配置将生成最终答案的LLM。UltraRAG支持多个后端，如 vllm、openai 和直接的Hugging Face (hf) 模型。

generation:
  backend: vllm # Primary backend choice. Alternatives: 'openai', 'hf'
  backend_configs:
    vllm:
      model_name_or_path: openbmb/MiniCPM4-8B
      gpu_ids: 2,3
      dtype: auto
      gpu_memory_utilization: 0.9
      trust_remote_code: true
    openai:
      model_name: qwen3-32b
      base_url: http://localhost:8000/v1
      api_key: abc
      concurrency: 8
  sampling_params:
    max_tokens: 2048
    temperature: 0.7
    top_p: 0.8
  system_prompt: '你是一个专业的UltraRAG问答助手。请一定记住使用中文回答问题。'

backend: vllm 是主要的后端选择，可选 'openai'、'hf'。backend_configs 下为各后端的详细配置，例如 vllm 后端指定了模型路径、使用的GPU等。sampling_params 控制生成参数。system_prompt 设置了系统角色指令。

3. Retriever Configuration (retriever)

这是RAG配置的核心。它定义了文档如何被嵌入和检索。

retriever:
  backend: sentence_transformers # Embedding model backend
  backend_configs:
    sentence_transformers:
      model_name_or_path: openbmb/MiniCPM-Embedding-Light
      gpu_ids: '1'
      trust_remote_code: true
  index_backend: faiss # Vector database/index backend
  index_backend_configs:
    faiss:
      index_path: index/index.index
      index_use_gpu: true
  collection_name: wiki
  corpus_path: data/corpus_example.jsonl # Path to your knowledge base documents
  top_k: 5 # Number of document chunks to retrieve per query

backend: sentence_transformers 指定嵌入模型后端。backend_configs 配置该后端的具体模型和资源。index_backend: faiss 指定向量数据库/索引后端。index_backend_configs 配置索引路径等。corpus_path 指向知识库文档。top_k: 5 是每个查询检索的文档片段数量。

4. Prompt Template Configuration (prompt)

指定用于将问题和检索到的上下文格式化为发送给LLM的最终提示词的Jinja2模板。

prompt:
  template: prompt/qa_rag_citation.jinja

（注意：提供的输入内容显示某些键存在多个，有时是冲突的值（例如，generation 下有两个 backend，generation.backend_configs.openai 下有两个 model_name）。在生产配置中，每个键应选择一个值。为清晰起见，上面的示例已进行简化。）

Demonstration and Execution

一旦 RAG_parameter.yaml 文件按照您选择的模型、API密钥和数据路径正确配置后，您就可以运行演示了。

1. Start the UltraRAG UI.
   启动 UltraRAG UI。
   在界面中，选择已编译的 "RAG Pipeline"。
   选择相应的知识库（由 retriever.corpus_path 定义）。
   提交查询。UI将直观地展示流程的运行情况：
   检索组件获取相关的文档片段。
   这些片段被注入到提示词模板中。
   LLM生成答案，该答案现在包含指向源文档的引用（例如 [1], [2]）。

这种端到端的可视化不仅让您能看到最终更准确的输出，还能检查和理解其背后的检索和推理过程，这对于调试和改进RAG应用至关重要。

Conclusion

UltraRAG UI 中的标准化 RAG 流程抽象了将检索、提示和生成组件连接在一起的复杂性。通过提供清晰、可配置的 YAML 接口和可视化执行环境，它极大地降低了实验先进 RAG 技术的门槛。开发人员可以快速更换嵌入模型、LLM、向量数据库或提示词模板，以找到适合其特定用例的最佳组合，从而加速开发健壮的、基于知识的 AI 应用。