Skip to content

Commit 9a1b872

Browse files
infinityCuratorRAGFlow Curator
andauthored
Synchronize documentation. (#428)
Co-authored-by: RAGFlow Curator <infinitydocs.curator@users.noreply.github.com>
1 parent ee0189c commit 9a1b872

File tree

97 files changed

+13381
-30
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+13381
-30
lines changed

website/docs/configurations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ RAGFlow utilizes MinIO as its object storage solution, leveraging its scalabilit
9999
- `RAGFLOW-IMAGE`
100100
The Docker image edition. Available editions:
101101

102-
- `infiniflow/ragflow:v0.21.0-slim` (default): The RAGFlow Docker image without embedding models.
103-
- `infiniflow/ragflow:v0.21.0`: The RAGFlow Docker image with embedding models including:
102+
- `infiniflow/ragflow:v0.21.1-slim` (default): The RAGFlow Docker image without embedding models.
103+
- `infiniflow/ragflow:v0.21.1`: The RAGFlow Docker image with embedding models including:
104104
- Built-in embedding models:
105105
- `BAAI/bge-large-zh-v1.5`
106106
- `maidalun1020/bce-embedding-base_v1`

website/docs/develop/build_docker_image.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ After building the infiniflow/ragflow:nightly-slim image, you are ready to launc
7777

7878
1. Edit Docker Compose Configuration
7979

80-
Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.21.0-slim` to `infiniflow/ragflow:nightly-slim` to use the pre-built image.
80+
Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.21.1-slim` to `infiniflow/ragflow:nightly-slim` to use the pre-built image.
8181

8282

8383
2. Launch the Service

website/docs/faq.mdx

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,17 @@ The "garbage in garbage out" status quo remains unchanged despite the fact that
3030

3131
Each RAGFlow release is available in two editions:
3232

33-
- **Slim edition**: excludes built-in embedding models and is identified by a **-slim** suffix added to the version name. Example: `infiniflow/ragflow:v0.21.0-slim`
34-
- **Full edition**: includes built-in embedding models and has no suffix added to the version name. Example: `infiniflow/ragflow:v0.21.0`
33+
- **Slim edition**: excludes built-in embedding models and is identified by a **-slim** suffix added to the version name. Example: `infiniflow/ragflow:v0.21.1-slim`
34+
- **Full edition**: includes built-in embedding models and has no suffix added to the version name. Example: `infiniflow/ragflow:v0.21.1`
3535

3636
---
3737

3838
### Which embedding models can be deployed locally?
3939

40-
RAGFlow offers two Docker image editions, `v0.21.0-slim` and `v0.21.0`:
40+
RAGFlow offers two Docker image editions, `v0.21.1-slim` and `v0.21.1`:
4141

42-
- `infiniflow/ragflow:v0.21.0-slim` (default): The RAGFlow Docker image without embedding models.
43-
- `infiniflow/ragflow:v0.21.0`: The RAGFlow Docker image with the following built-in embedding models:
42+
- `infiniflow/ragflow:v0.21.1-slim` (default): The RAGFlow Docker image without embedding models.
43+
- `infiniflow/ragflow:v0.21.1`: The RAGFlow Docker image with the following built-in embedding models:
4444
- `BAAI/bge-large-zh-v1.5`
4545
- `maidalun1020/bce-embedding-base_v1`
4646

@@ -510,3 +510,27 @@ See [here](./guides/agent/best_practices/accelerate_agent_question_answering.md)
510510

511511
---
512512

513+
### How to use MinerU to parse PDF documents?
514+
515+
MinerU PDF document parsing is available starting from v0.21.1. To use this feature, follow these steps:
516+
517+
1. Before deploying ragflow-server, update your **docker/.env** file:
518+
- Enable `HF_ENDPOINT=https://hf-mirror.com`
519+
- Add a MinerU entry: `MINERU_EXECUTABLE=/ragflow/uv_tools/.venv/bin/mineru`
520+
521+
2. Start the ragflow-server and run the following commands inside the container:
522+
523+
```bash
524+
mkdir uv_tools
525+
cd uv_tools
526+
uv venv .venv
527+
source .venv/bin/activate
528+
uv pip install -U "mineru[core]" -i https://mirrors.aliyun.com/pypi/simple
529+
```
530+
531+
3. Restart the ragflow-server.
532+
4. In the web UI, navigate to the **Configuration** page of your dataset. Click **Built-in** in the **Ingestion pipeline** section, select a chunking method from the **Built-in** dropdown, which supports PDF parsing, and slect **MinerU** in **PDF parser**.
533+
5. If you use a custom ingestion pipeline instead, you must also complete the first three steps before selecting **MinerU** in the **Parsing method** section of the **Parser** component.
534+
535+
536+

website/docs/guides/chat/start_chat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You start an AI conversation by creating an assistant.
4848
- If no target language is selected, the system will search only in the language of your query, which may cause relevant information in other languages to be missed.
4949
- **Variable** refers to the variables (keys) to be used in the system prompt. `{knowledge}` is a reserved variable. Click **Add** to add more variables for the system prompt.
5050
- If you are uncertain about the logic behind **Variable**, leave it *as-is*.
51-
- As of v0.21.0, if you add custom variables here, the only way you can pass in their values is to call:
51+
- As of v0.21.1, if you add custom variables here, the only way you can pass in their values is to call:
5252
- HTTP method [Converse with chat assistant](../../references/http_api_reference.md#converse-with-chat-assistant), or
5353
- Python method [Converse with chat assistant](../../references/python_api_reference.md#converse-with-chat-assistant).
5454

website/docs/guides/dataset/configure_knowledge_base.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ You can also change a file's chunking method on the **Files** page.
5959
![change chunking method](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/change_chunking_method.jpg)
6060

6161
<details>
62-
<summary>From v0.21.0 onward, RAGFlow supports ingestion pipeline for customized data ingestion and cleansing workflows.</summary>
62+
<summary>From v0.21.1 onward, RAGFlow supports ingestion pipeline for customized data ingestion and cleansing workflows.</summary>
6363

6464
To use a customized data pipeline:
6565

@@ -138,7 +138,7 @@ See [Run retrieval test](./run_retrieval_test.md) for details.
138138

139139
## Search for dataset
140140

141-
As of RAGFlow v0.21.0, the search feature is still in a rudimentary form, supporting only dataset search by name.
141+
As of RAGFlow v0.21.1, the search feature is still in a rudimentary form, supporting only dataset search by name.
142142

143143
![search dataset](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/search_datasets.jpg)
144144

website/docs/guides/dataset/select_pdf_parser.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,31 @@ RAGFlow isn't one-size-fits-all. It is built for flexibility and supports deeper
3535

3636
- DeepDoc: (Default) The default visual model performing OCR, TSR, and DLR tasks on PDFs, which can be time-consuming.
3737
- Naive: Skip OCR, TSR, and DLR tasks if *all* your PDFs are plain text.
38+
- MinerU: An experimental feature.
3839
- A third-party visual model provided by a specific model provider.
3940

41+
:::danger IMPORTANG
42+
MinerU PDF document parsing is available starting from v0.21.1. To use this feature, follow these steps:
43+
44+
1. Before deploying ragflow-server, update your **docker/.env** file:
45+
- Enable `HF_ENDPOINT=https://hf-mirror.com`
46+
- Add a MinerU entry: `MINERU_EXECUTABLE=/ragflow/uv_tools/.venv/bin/mineru`
47+
48+
2. Start the ragflow-server and run the following commands inside the container:
49+
50+
```bash
51+
mkdir uv_tools
52+
cd uv_tools
53+
uv venv .venv
54+
source .venv/bin/activate
55+
uv pip install -U "mineru[core]" -i https://mirrors.aliyun.com/pypi/simple
56+
```
57+
58+
3. Restart the ragflow-server.
59+
4. In the web UI, navigate to the **Configuration** page of your dataset. Click **Built-in** in the **Ingestion pipeline** section, select a chunking method from the **Built-in** dropdown, which supports PDF parsing, and slect **MinerU** in **PDF parser**.
60+
5. If you use a custom ingestion pipeline instead, you must also complete the first three steps before selecting **MinerU** in the **Parsing method** section of the **Parser** component.
61+
:::
62+
4063
:::caution WARNING
4164
Third-party visual models are marked **Experimental**, because we have not fully tested these models for the aforementioned data extraction tasks.
4265
:::

website/docs/guides/manage_files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ RAGFlow's file management allows you to download an uploaded file:
8787

8888
![download_file](https://github.com/infiniflow/ragflow/assets/93570324/cf3b297f-7d9b-4522-bf5f-4f45743e4ed5)
8989

90-
> As of RAGFlow v0.21.0, bulk download is not supported, nor can you download an entire folder.
90+
> As of RAGFlow v0.21.1, bulk download is not supported, nor can you download an entire folder.

website/docs/guides/manage_users_and_services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The Admin CLI and Admin Service form a client-server architectural suite for RAG
4646
2. Install ragflow-cli.
4747

4848
```bash
49-
pip install ragflow-cli==0.21.0
49+
pip install ragflow-cli==0.21.1
5050
```
5151

5252
3. Launch the CLI client:

website/docs/guides/tracing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ RAGFlow ships with a built-in [Langfuse](https://langfuse.com) integration so th
1818
Langfuse stores traces, spans and prompt payloads in a purpose-built observability backend and offers filtering and visualisations on top.
1919

2020
:::info NOTE
21-
• RAGFlow **≥ 0.21.0** (contains the Langfuse connector)
21+
• RAGFlow **≥ 0.21.1** (contains the Langfuse connector)
2222
• A Langfuse workspace (cloud or self-hosted) with a _Project Public Key_ and _Secret Key_
2323
:::
2424

website/docs/guides/upgrade_ragflow.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
6666
git clone https://github.com/infiniflow/ragflow.git
6767
```
6868

69-
2. Switch to the latest, officially published release, e.g., `v0.21.0`:
69+
2. Switch to the latest, officially published release, e.g., `v0.21.1`:
7070

7171
```bash
72-
git checkout -f v0.21.0
72+
git checkout -f v0.21.1
7373
```
7474

7575
3. Update **ragflow/docker/.env**:
@@ -83,14 +83,14 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
8383
<TabItem value="slim">
8484

8585
```bash
86-
RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.0-slim
86+
RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.1-slim
8787
```
8888

8989
</TabItem>
9090
<TabItem value="full">
9191

9292
```bash
93-
RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.0
93+
RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.1
9494
```
9595

9696
</TabItem>
@@ -114,10 +114,10 @@ No, you do not need to. Upgrading RAGFlow in itself will *not* remove your uploa
114114
1. From an environment with Internet access, pull the required Docker image.
115115
2. Save the Docker image to a **.tar** file.
116116
```bash
117-
docker save -o ragflow.v0.21.0.tar infiniflow/ragflow:v0.21.0
117+
docker save -o ragflow.v0.21.1.tar infiniflow/ragflow:v0.21.1
118118
```
119119
3. Copy the **.tar** file to the target server.
120120
4. Load the **.tar** file into Docker:
121121
```bash
122-
docker load -i ragflow.v0.21.0.tar
122+
docker load -i ragflow.v0.21.1.tar
123123
```

0 commit comments

Comments
 (0)