> ## 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.

# 快速开始

UltraRAG UI 不仅仅是一个聊天界面，它是一个完整的 RAG 开发与调试平台。

<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" />

## 启动命令

使用以下命令启动 UI 服务：

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

### 常用选项

* `--port <INTEGER>`: 指定服务端口，默认为 `5050`。
* `--host <TEXT>`: 指定绑定地址，默认为 `127.0.0.1`。
* `--admin`: 启用管理员模式。默认情况下 UI 仅展示对话界面（Chat Only）。开启此选项后，将解锁 Pipeline Builder（可视化编排）、参数配置与在线 Prompt 编辑功能。此外，管理员界面内置了 AI 助手，可辅助您高效完成 Pipeline 的配置与调试。

### 示例

**启动完整功能的 Admin 模式：**

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

**仅启动对话界面（适合最终用户）：**

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

启动后，在浏览器访问 `http://127.0.0.1:5050` 即可进入系统。

## 1. Chat（对话）

进入系统默认展示对话页面，您可以直接选择已编译的 Pipeline 开启对话。

<Tip>我们在[典型场景](/pages/cn/demo/llm)中提供了多个开发好的 Pipeline 的部署教程，您也可以根据需求自定义 Pipeline。</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" />

### Pipline 切换

通过左上角的下拉菜单，可以在已配置好参数的 Pipeline 之间快速切换。

<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" />

### 选择知识库

点击 Knowledge Base 图标，挂载已构建的知识库，即可进行基于文档的问答。

<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" />

### 后台运行

针对 Deep Research 等耗时较长的 Pipeline，支持后台运行模式。任务执行完成后，结果将自动加载至当前聊天窗口。

<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 提供了全流程的知识库管理功能，支持文件的上传、切片（Chunking）及向量化（Embedding）管理。

<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" />

### 连接向量库

<Tip>不知道如何部署 Milvus 向量库？ 请参考[部署指南](/pages/cn/ui/prepare)。</Tip>

点击 Configure DB，与部署好的 Milvus 向量库建立连接，即可使用知识库功能。

<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" />

### 构建知识库

点击 New Collection，上传文档并创建专属知识库。

<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" />

点击 Settings 按钮，可自定义切片策略（Chunk）和 Embedding 模型的相关参数。

<Tip>首次使用通常需要配置参数。若希望实现免配置部署（用户无需手动设置），请预先修改`examples/parameter/corpus_chunk_parameter.yaml`与`examples/parameter/milvus_index_parameter.yaml`中的相关参数，即可跳过下方设置步骤。</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

若启动时指定了 `--admin` 参数，侧边栏将显示 Settings 入口，点击即可进入高级配置页面。

### Pipeline 可视化搭建

支持左侧画布拖拽式编排与右侧代码编辑器的双向实时同步。您既可以像搭积木一样直观构建，也可以在代码编辑器中进行精细微调。

<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" />

### 配置参数

点击 Build 按钮解析 Pipeline 后，您可以在参数面板中查看并修改运行参数。

<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 管理

支持在线新建、编辑及删除 Prompt，并将其一键应用到 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 助手

系统内置了 AI 助手，可辅助您搭建 Pipeline、调整参数及编写 Prompt。

<Tip>首次使用该功能前，需先点击设置配置 API Key 及相关模型参数。</Tip>

**使用示例：优化 Prompt**

假设您已有一个基础 Prompt，希望将其调整为适配法律领域的风格：

1. 打开 AI 助手，输入原始 Prompt 及修改需求。

<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. 点击 Apply，AI 助手将自动生成优化后的内容并替换原有 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" />
