Skip to content

Commit 0ff3696

Browse files
infinityCuratorRAGFlow Curator
and
RAGFlow Curator
authored
Synchronize documentation. (#300)
Co-authored-by: RAGFlow Curator <infinitydocs.curator@users.noreply.github.com>
1 parent 2d4348b commit 0ff3696

Some content is hidden

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

70 files changed

+10246
-38
lines changed

website/docs/configurations.md

+2-2
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.17.2-slim` (default): The RAGFlow Docker image without embedding models.
103-
- `infiniflow/ragflow:v0.17.2`: The RAGFlow Docker image with embedding models including:
102+
- `infiniflow/ragflow:v0.18.0-slim` (default): The RAGFlow Docker image without embedding models.
103+
- `infiniflow/ragflow:v0.18.0`: 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

+1-1
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.17.2-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.18.0-slim` to `infiniflow/ragflow:nightly-slim` to use the pre-built image.
8181

8282

8383
2. Launch the Service

website/docs/develop/mcp.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ ragflow-server | / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
116116
ragflow-server | /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
117117
ragflow-server |
118118
ragflow-server |
119-
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 RAGFlow version: v0.17.2-285-gb2c299fa full
119+
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 RAGFlow version: v0.18.0-285-gb2c299fa full
120120
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 project base: /ragflow
121121
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 Current configs, from /ragflow/conf/service_conf.yaml:
122122
ragflow-server | ragflow: {'host': '0.0.0.0', 'http_port': 9380}
@@ -130,7 +130,7 @@ ragflow-server | / / / __ `/ ___/ //_/ / __/ | |/_/ _ \/ ___/ / / / __/ __ \
130130
ragflow-server | / / / /_/ (__ ) ,< / /____> </ __/ /__/ /_/ / /_/ /_/ / /
131131
ragflow-server | /_/ \__,_/____/_/|_| /_____/_/|_|\___/\___/\__,_/\__/\____/_/
132132
ragflow-server |
133-
ragflow-server | 2025-04-18 15:41:34,501 INFO 32 TaskExecutor: RAGFlow version: v0.17.2-285-gb2c299fa full
133+
ragflow-server | 2025-04-18 15:41:34,501 INFO 32 TaskExecutor: RAGFlow version: v0.18.0-285-gb2c299fa full
134134
ragflow-server | 2025-04-18 15:41:34,501 INFO 32 Use Elasticsearch http://es01:9200 as the doc engine.
135135
...
136136
```

website/docs/faq.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM6
7575

7676
### Which embedding models can be deployed locally?
7777

78-
RAGFlow offers two Docker image editions, `v0.17.2-slim` and `v0.17.2`:
78+
RAGFlow offers two Docker image editions, `v0.18.0-slim` and `v0.18.0`:
7979

80-
- `infiniflow/ragflow:v0.17.2-slim` (default): The RAGFlow Docker image without embedding models.
81-
- `infiniflow/ragflow:v0.17.2`: The RAGFlow Docker image with embedding models including:
80+
- `infiniflow/ragflow:v0.18.0-slim` (default): The RAGFlow Docker image without embedding models.
81+
- `infiniflow/ragflow:v0.18.0`: The RAGFlow Docker image with embedding models including:
8282
- Built-in embedding models:
8383
- `BAAI/bge-large-zh-v1.5`
8484
- `BAAI/bge-reranker-v2-m3`

website/docs/guides/chat/start_chat.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ You start an AI conversation by creating an assistant.
4444
- If **Rerank model** is selected, the hybrid score system uses keyword similarity and reranker score, and the default weight assigned to the reranker score is 1-0.7=0.3.
4545
- **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.
4646
- If you are uncertain about the logic behind **Variable**, leave it *as-is*.
47-
- As of v0.17.2, if you add custom variables here, the only way you can pass in their values is to call:
47+
- As of v0.18.0, if you add custom variables here, the only way you can pass in their values is to call:
4848
- HTTP method [Converse with chat assistant](../../references/http_api_reference.md#converse-with-chat-assistant), or
4949
- Python method [Converse with chat assistant](../../references/python_api_reference.md#converse-with-chat-assistant).
5050

website/docs/guides/dataset/configure_knowledge_base.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ See [Run retrieval test](./run_retrieval_test.md) for details.
124124

125125
## Search for knowledge base
126126

127-
As of RAGFlow v0.17.2, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
127+
As of RAGFlow v0.18.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
128128

129129
![search knowledge base](https://github.com/infiniflow/ragflow/assets/93570324/836ae94c-2438-42be-879e-c7ad2a59693e)
130130

website/docs/guides/manage_files.md

+1-1
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.17.2, bulk download is not supported, nor can you download an entire folder.
90+
> As of RAGFlow v0.18.0, bulk download is not supported, nor can you download an entire folder.

website/docs/guides/upgrade_ragflow.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,16 @@ 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.17.2`:
69+
2. Switch to the latest, officially published release, e.g., `v0.18.0`:
7070

7171
```bash
72-
git checkout -f v0.17.2
72+
git checkout -f v0.18.0
7373
```
7474

7575
3. Update **ragflow/docker/.env** as follows:
7676

7777
```bash
78-
RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.2
78+
RAGFLOW_IMAGE=infiniflow/ragflow:v0.18.0
7979
```
8080

8181
4. Update the RAGFlow image and restart RAGFlow:
@@ -92,10 +92,10 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
9292
1. From an environment with Internet access, pull the required Docker image.
9393
2. Save the Docker image to a **.tar** file.
9494
```bash
95-
docker save -o ragflow.v0.17.2.tar infiniflow/ragflow:v0.17.2
95+
docker save -o ragflow.v0.18.0.tar infiniflow/ragflow:v0.18.0
9696
```
9797
3. Copy the **.tar** file to the target server.
9898
4. Load the **.tar** file into Docker:
9999
```bash
100-
docker load -i ragflow.v0.17.2.tar
100+
docker load -i ragflow.v0.18.0.tar
101101
```

website/docs/quickstart.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
3939

4040
`vm.max_map_count`. This value sets the maximum number of memory map areas a process may have. Its default value is 65530. While most applications require fewer than a thousand maps, reducing this value can result in abnormal behaviors, and the system will throw out-of-memory errors when a process reaches the limitation.
4141

42-
RAGFlow v0.17.2 uses Elasticsearch or [Infinity](https://github.com/infiniflow/infinity) for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.
42+
RAGFlow v0.18.0 uses Elasticsearch or [Infinity](https://github.com/infiniflow/infinity) for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.
4343

4444
<Tabs
4545
defaultValue="linux"
@@ -179,13 +179,13 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
179179
```bash
180180
$ git clone https://github.com/infiniflow/ragflow.git
181181
$ cd ragflow/docker
182-
$ git checkout -f v0.17.2
182+
$ git checkout -f v0.18.0
183183
```
184184

185185
3. Use the pre-built Docker images and start up the server:
186186

187187
:::tip NOTE
188-
The command below downloads the `v0.17.2-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.17.2-slim`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server. For example: set `RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.2` for the full edition `v0.17.2`.
188+
The command below downloads the `v0.18.0-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.18.0-slim`, update the `RAGFLOW_IMAGE` variable accordingly in **docker/.env** before using `docker compose` to start the server. For example: set `RAGFLOW_IMAGE=infiniflow/ragflow:v0.18.0` for the full edition `v0.18.0`.
189189
:::
190190

191191
```bash
@@ -202,8 +202,8 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
202202

203203
| RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
204204
| ------------------- | --------------- | ----------------------------------------- | ------------------------ |
205-
| `v0.17.2` | &approx;9 | :heavy_check_mark: | Stable release |
206-
| `v0.17.2-slim` | &approx;2 || Stable release |
205+
| `v0.18.0` | &approx;9 | :heavy_check_mark: | Stable release |
206+
| `v0.18.0-slim` | &approx;2 || Stable release |
207207
| `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
208208
| `nightly-slim` | &approx;2 || *Unstable* nightly build |
209209

website/docs/references/http_api_reference.md

+1-12
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,6 @@ curl --request POST \
393393
- `"presentation"`: Presentation
394394
- `"picture"`: Picture
395395
- `"one"`: One
396-
- `"knowledge_graph"`: Knowledge Graph
397396
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
398397
- `"email"`: Email
399398

@@ -409,10 +408,6 @@ curl --request POST \
409408
- If `"chunk_method"` is `"qa"`, `"manuel"`, `"paper"`, `"book"`, `"laws"`, or `"presentation"`, the `"parser_config"` object contains the following attribute:
410409
- `"raptor"`: Raptor-specific settings. Defaults to: `{"use_raptor": false}`.
411410
- If `"chunk_method"` is `"table"`, `"picture"`, `"one"`, or `"email"`, `"parser_config"` is an empty JSON object.
412-
- If `"chunk_method"` is `"knowledge_graph"`, the `"parser_config"` object contains the following attributes:
413-
- `"chunk_token_count"`: Defaults to `128`.
414-
- `"delimiter"`: Defaults to `"\n"`.
415-
- `"entity_types"`: Defaults to `["organization","person","location","event","time"]`
416411

417412
#### Response
418413

@@ -573,8 +568,6 @@ curl --request PUT \
573568
- `"picture"`: Picture
574569
- `"one"`:One
575570
- `"email"`: Email
576-
- `"knowledge_graph"`: Knowledge Graph
577-
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
578571

579572
#### Response
580573

@@ -655,7 +648,7 @@ Success:
655648
"id": "6e211ee0723611efa10a0242ac120007",
656649
"language": "English",
657650
"name": "mysql",
658-
"chunk_method": "knowledge_graph",
651+
"chunk_method": "naive",
659652
"parser_config": {
660653
"chunk_token_num": 8192,
661654
"delimiter": "\\n",
@@ -841,10 +834,6 @@ curl --request PUT \
841834
- If `"chunk_method"` is `"qa"`, `"manuel"`, `"paper"`, `"book"`, `"laws"`, or `"presentation"`, the `"parser_config"` object contains the following attribute:
842835
- `"raptor"`: Raptor-specific settings. Defaults to: `{"use_raptor": false}`.
843836
- If `"chunk_method"` is `"table"`, `"picture"`, `"one"`, or `"email"`, `"parser_config"` is an empty JSON object.
844-
- If `"chunk_method"` is `"knowledge_graph"`, the `"parser_config"` object contains the following attributes:
845-
- `"chunk_token_count"`: Defaults to `128`.
846-
- `"delimiter"`: Defaults to `"\n"`.
847-
- `"entity_types"`: Defaults to `["organization","person","location","event","time"]`
848837

849838
#### Response
850839

website/docs/references/python_api_reference.md

-4
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,6 @@ The chunking method of the dataset to create. Available options:
145145
- `"presentation"`: Presentation
146146
- `"picture"`: Picture
147147
- `"one"`: One
148-
- `"knowledge_graph"`: Knowledge Graph
149-
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
150148
- `"email"`: Email
151149

152150
##### parser_config
@@ -398,8 +396,6 @@ A dictionary representing the attributes to update, with the following keys:
398396
- `"presentation"`: Presentation
399397
- `"picture"`: Picture
400398
- `"one"`: One
401-
- `"knowledge_graph"`: Knowledge Graph
402-
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
403399
- `"email"`: Email
404400
- `"parser_config"`: `dict[str, Any]` The parsing configuration for the document. Its attributes vary based on the selected `"chunk_method"`:
405401
- `"chunk_method"`=`"naive"`:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Get Started",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "RAGFlow Quick Start"
7+
}
8+
}

0 commit comments

Comments
 (0)