Quick Start

This section will guide you through a minimal runnable example sayhello to help you quickly understand how to implement a minimal system based on UR-2.0, including:

The basic structure of the Pipeline configuration file
How to modify parameters
How to run the complete process

If you have not installed UR-2.0 yet, please refer to Environment Setup first.

For more advanced RAG practices, please visit Development Guide.

Step 1: Understand the Pipeline Configuration Structure

Make sure the development root directory is under the UltraRAG folder

Below is a minimal example configuration file:

examples/sayhello.yaml

servers:
  sayhello: servers/sayhello

pipeline:
  - sayhello.greet

This configuration file contains two core parts:

servers: Declares all components (Servers) used in the current process. Here, the example sayhello Server is used.
pipeline: Defines the calling order of the functional functions (Tools) in the Server. In this example, the greet tool function of the sayhello Server is called, which outputs a welcome message.

Step 2: Automatically Generate Parameter Configuration File

Before running the code, the primary step is to configure the parameters required for execution. UR-2.0 provides a convenient Build command to automate this process: the system reads the parameter.yaml of each Server, parses all parameter items involved in this process, and aggregates them into a unified configuration file. Run the following command:

ultrarag build examples/sayhello.yaml

Terminal output:

You will get an automatically generated parameter configuration file with a basic format as follows:

examples/parameters/sayhello_parameter.yaml

sayhello:
  name: UltraRAG 2.0  # You can modify this to the name you want to pass in

Fill in the parameters you want to pass to the greet tool here (such as the name in the welcome message).

Step 3: Run the Pipeline

Once everything is ready, run the following command to execute the complete process:

ultrarag run examples/sayhello.yaml

You will see similar output in the terminal and log files:

Getting Started

Developer Guide

Step 1: Understand the Pipeline Configuration Structure

Step 2: Automatically Generate Parameter Configuration File

Step 3: Run the Pipeline

Getting Started

Developer Guide

​Step 1: Understand the Pipeline Configuration Structure

​Step 2: Automatically Generate Parameter Configuration File

​Step 3: Run the Pipeline

Step 1: Understand the Pipeline Configuration Structure

Step 2: Automatically Generate Parameter Configuration File

Step 3: Run the Pipeline