> ## Documentation Index
> Fetch the complete documentation index at: https://ultrarag.openbmb.cn/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

UltraRAG UI is not just a chat interface, it is a complete RAG development and debugging platform.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/chat_menu.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=027c35cead2850dae9f904ae23762b7e" alt="" width="3320" height="2096" data-path="images/ui/chat_menu.png" />

## Startup Command

Use the following command to start the UI service:

```bash theme={null}
ultrarag show ui [OPTIONS]
```

### Common Options

* `--port <INTEGER>`: Specify service port, default is `5050`.
* `--host <TEXT>`: Specify binding address, default is `127.0.0.1`.
* `--admin`: Enable administrator mode. By default, the UI only displays the chat interface (Chat Only). After enabling this option, Pipeline Builder (visual orchestration), parameter configuration, and online Prompt editing functions will be unlocked. In addition, an AI assistant is built into the administrator interface to help you efficiently complete Pipeline configuration and debugging.

### Examples

**Start Admin Mode with Full Functions:**

```bash theme={null}
ultrarag show ui --admin
```

**Start Chat Only Interface (Suitable for End Users):**

```bash theme={null}
ultrarag show ui
```

After startup, access `http://127.0.0.1:5050` in your browser to enter the system.

## 1. Chat

Entering the system displays the chat page by default. You can directly select a compiled Pipeline to start a conversation.

<Tip>We provide deployment tutorials for several developed Pipelines in [Typical Scenarios](/pages/en/demo/llm). You can also customize Pipelines according to your needs.</Tip>

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/chat_menu.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=027c35cead2850dae9f904ae23762b7e" alt="" width="3320" height="2096" data-path="images/ui/chat_menu.png" />

### Pipeline Switching

You can quickly switch between Pipelines with configured parameters through the dropdown menu in the upper left corner.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/pipeline_select.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=ace519f8dfe024e1ab7d27cfea87cc60" alt="" width="3320" height="2096" data-path="images/ui/pipeline_select.png" />

### Select Knowledge Base

Click the Knowledge Base icon to mount the constructed knowledge base, and you can perform document-based Q\&A.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/kb_select.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=5eeb67c365b8be4e17cd34b1cfcf2de6" alt="" width="3320" height="2096" data-path="images/ui/kb_select.png" />

### Background Running

For time-consuming Pipelines such as Deep Research, background running mode is supported. After the task execution is completed, the results will be automatically loaded into the current chat window.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/background.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=30b22e440a345d6f20e46437d4f50958" alt="" width="3320" height="2096" data-path="images/ui/background.png" />

## 2. Knowledge Base

UltraRAG UI provides full-process knowledge base management functions, supporting file upload, chunking, and embedding management.

<img src="https://mintcdn.com/ultrarag/lIQ_o5B-GgJL-VyH/images/ui/kb_menu.png?fit=max&auto=format&n=lIQ_o5B-GgJL-VyH&q=85&s=f8be8b8e4b163fd340e7c8cfd9b8c165" alt="" width="3360" height="2178" data-path="images/ui/kb_menu.png" />

### Connect Vector Database

<Tip>Don't know how to deploy Milvus vector library? Please refer to [Deployment Guide](/pages/en/ui/prepare).</Tip>

Click Configure DB to establish a connection with the deployed Milvus vector library, and you can use the knowledge base function.

<img src="https://mintcdn.com/ultrarag/lIQ_o5B-GgJL-VyH/images/ui/kb_connect.png?fit=max&auto=format&n=lIQ_o5B-GgJL-VyH&q=85&s=ff107749346f493319474cfe63b241ec" alt="" width="3360" height="2178" data-path="images/ui/kb_connect.png" />

### Build Knowledge Base

Click New Collection to upload documents and create an exclusive knowledge base.

<img src="https://mintcdn.com/ultrarag/lIQ_o5B-GgJL-VyH/images/ui/kb_upload.png?fit=max&auto=format&n=lIQ_o5B-GgJL-VyH&q=85&s=428a7246d815ae4577a900286af98c94" alt="" width="3360" height="2178" data-path="images/ui/kb_upload.png" />

Click the Settings button to customize the slicing strategy (Chunk) and Embedding model parameters.

<Tip>Configuration is usually required for first-time use. If you want to achieve configuration-free deployment (users do not need to set manually), please modify relevant parameters in `examples/parameter/corpus_chunk_parameter.yaml` and `examples/parameter/milvus_index_parameter.yaml` in advance to skip the setting steps below.</Tip>

<img src="https://mintcdn.com/ultrarag/lIQ_o5B-GgJL-VyH/images/ui/kb_chunk.png?fit=max&auto=format&n=lIQ_o5B-GgJL-VyH&q=85&s=896464fef09e17721fe2ef593691b734" alt="" width="3360" height="2178" data-path="images/ui/kb_chunk.png" />

<img src="https://mintcdn.com/ultrarag/lIQ_o5B-GgJL-VyH/images/ui/kb_index.png?fit=max&auto=format&n=lIQ_o5B-GgJL-VyH&q=85&s=e623acf0c5b0bc547660161f7b68c07c" alt="" width="3360" height="2178" data-path="images/ui/kb_index.png" />

## 3. Pipeline Builder

If the `--admin` parameter is specified at startup, the sidebar will display the Settings entry. Click to enter the advanced configuration page.

### Visual Pipeline Construction

Supports bidirectional real-time synchronization between drag-and-drop orchestration on the left canvas and code editor on the right. You can build intuitively like building blocks, or fine-tune in the code editor.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/pipeline_build.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=328d8d337c69e0e793a17b9bc2780385" alt="" width="3320" height="2096" data-path="images/ui/pipeline_build.png" />

### Configure Parameters

After clicking the Build button to parse the Pipeline, you can view and modify running parameters in the parameter panel.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/pipeline_param.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=27e877c1cf3cd5b7d079763d20fd3ba7" alt="" width="3320" height="2096" data-path="images/ui/pipeline_param.png" />

### Prompt Management

Supports online creation, editing, and deletion of Prompts, and one-click application to the Pipeline.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/pipeline_prompt.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=c1bc4da91fa9752445831d8c4c1967f3" alt="" width="3320" height="2096" data-path="images/ui/pipeline_prompt.png" />

### AI Assistant

The system has a built-in AI assistant that can assist you in building Pipelines, adjusting parameters, and writing Prompts.

<Tip>Before using this function for the first time, you need to click Settings to configure the API Key and related model parameters.</Tip>

**Usage Example: Optimize Prompt**

Suppose you have a basic Prompt and want to adjust it to a style suitable for the legal field:

1. Open the AI assistant and enter the original Prompt and modification requirements.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/ai_1.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=67efa2ac19234f698e18d18b66a049f8" alt="" width="3320" height="2096" data-path="images/ui/ai_1.png" />

2. Click Apply, and the AI assistant will automatically generate optimized content and replace the original Prompt.

<img src="https://mintcdn.com/ultrarag/IABOmU0X4dsRK1Rp/images/ui/ai_2.png?fit=max&auto=format&n=IABOmU0X4dsRK1Rp&q=85&s=0b576f11938953652fa3255617591325" alt="" width="3320" height="2096" data-path="images/ui/ai_2.png" />