Kevin Hu commited on
Commit
bb139f2
·
1 Parent(s): 930d161

refine docs for 0.9.0 release (#1812)

Browse files

### What problem does this PR solve?



### Type of change

- [x] Documentation Update

README.md CHANGED
@@ -17,7 +17,7 @@
17
  <a href="https://demo.ragflow.io" target="_blank">
18
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
19
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
20
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.8.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.8.0"></a>
21
  <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
22
  <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
23
  </a>
 
17
  <a href="https://demo.ragflow.io" target="_blank">
18
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
19
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
20
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.9.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.9.0"></a>
21
  <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
22
  <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
23
  </a>
README_ja.md CHANGED
@@ -17,8 +17,8 @@
17
  <a href="https://demo.ragflow.io" target="_blank">
18
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
19
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
20
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.8.0-brightgreen"
21
- alt="docker pull infiniflow/ragflow:v0.8.0"></a>
22
  <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
23
  <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
24
  </a>
@@ -141,7 +141,7 @@
141
  $ docker compose up -d
142
  ```
143
 
144
- > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.8.0として、上記のコマンドを実行してください。
145
 
146
  > コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
147
 
 
17
  <a href="https://demo.ragflow.io" target="_blank">
18
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
19
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
20
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.9.0-brightgreen"
21
+ alt="docker pull infiniflow/ragflow:v0.9.0"></a>
22
  <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
23
  <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
24
  </a>
 
141
  $ docker compose up -d
142
  ```
143
 
144
+ > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.9.0として、上記のコマンドを実行してください。
145
 
146
  > コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
147
 
README_zh.md CHANGED
@@ -17,7 +17,7 @@
17
  <a href="https://demo.ragflow.io" target="_blank">
18
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
19
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
20
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.8.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.8.0"></a>
21
  <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
22
  <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
23
  </a>
@@ -140,7 +140,7 @@
140
  $ docker compose -f docker-compose-CN.yml up -d
141
  ```
142
 
143
- > 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.8.0,然后运行上述命令。
144
 
145
  > 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
146
 
@@ -202,7 +202,7 @@
202
  ```bash
203
  $ git clone https://github.com/infiniflow/ragflow.git
204
  $ cd ragflow/
205
- $ docker build -t infiniflow/ragflow:v0.8.0 .
206
  $ cd ragflow/docker
207
  $ chmod +x ./entrypoint.sh
208
  $ docker compose up -d
 
17
  <a href="https://demo.ragflow.io" target="_blank">
18
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
19
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
20
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.9.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.9.0"></a>
21
  <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
22
  <img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
23
  </a>
 
140
  $ docker compose -f docker-compose-CN.yml up -d
141
  ```
142
 
143
+ > 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.9.0,然后运行上述命令。
144
 
145
  > 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
146
 
 
202
  ```bash
203
  $ git clone https://github.com/infiniflow/ragflow.git
204
  $ cd ragflow/
205
+ $ docker build -t infiniflow/ragflow:v0.9.0 .
206
  $ cd ragflow/docker
207
  $ chmod +x ./entrypoint.sh
208
  $ docker compose up -d
api/db/services/document_service.py CHANGED
@@ -311,7 +311,8 @@ class DocumentService(CommonService):
311
  prg = 0
312
  finished = True
313
  bad = 0
314
- status = d["run"]#TaskStatus.RUNNING.value
 
315
  for t in tsks:
316
  if 0 <= t.progress < 1:
317
  finished = False
 
311
  prg = 0
312
  finished = True
313
  bad = 0
314
+ e, doc = DocumentService.get_by_id(d["id"])
315
+ status = doc.run#TaskStatus.RUNNING.value
316
  for t in tsks:
317
  if 0 <= t.progress < 1:
318
  finished = False
docs/guides/configure_knowledge_base.md CHANGED
@@ -128,7 +128,7 @@ RAGFlow uses multiple recall of both full-text search and vector search in its c
128
 
129
  ## Search for knowledge base
130
 
131
- As of RAGFlow v0.8.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
132
 
133
  ![search knowledge base](https://github.com/infiniflow/ragflow/assets/93570324/836ae94c-2438-42be-879e-c7ad2a59693e)
134
 
 
128
 
129
  ## Search for knowledge base
130
 
131
+ As of RAGFlow v0.9.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
132
 
133
  ![search knowledge base](https://github.com/infiniflow/ragflow/assets/93570324/836ae94c-2438-42be-879e-c7ad2a59693e)
134
 
docs/guides/manage_files.md CHANGED
@@ -45,11 +45,11 @@ You can link your file to one knowledge base or multiple knowledge bases at one
45
 
46
  ## Move file to a specific folder
47
 
48
- As of RAGFlow v0.8.0, this feature is *not* available.
49
 
50
  ## Search files or folders
51
 
52
- As of RAGFlow v0.8.0, the search feature is still in a rudimentary form, supporting only file and folder search in the current directory by name (files or folders in the child directory will not be retrieved).
53
 
54
  ![search file](https://github.com/infiniflow/ragflow/assets/93570324/77ffc2e5-bd80-4ed1-841f-068e664efffe)
55
 
@@ -81,4 +81,4 @@ RAGFlow's file management allows you to download an uploaded file:
81
 
82
  ![download_file](https://github.com/infiniflow/ragflow/assets/93570324/cf3b297f-7d9b-4522-bf5f-4f45743e4ed5)
83
 
84
- > As of RAGFlow v0.8.0, bulk download is not supported, nor can you download an entire folder.
 
45
 
46
  ## Move file to a specific folder
47
 
48
+ As of RAGFlow v0.9.0, this feature is *not* available.
49
 
50
  ## Search files or folders
51
 
52
+ As of RAGFlow v0.9.0, the search feature is still in a rudimentary form, supporting only file and folder search in the current directory by name (files or folders in the child directory will not be retrieved).
53
 
54
  ![search file](https://github.com/infiniflow/ragflow/assets/93570324/77ffc2e5-bd80-4ed1-841f-068e664efffe)
55
 
 
81
 
82
  ![download_file](https://github.com/infiniflow/ragflow/assets/93570324/cf3b297f-7d9b-4522-bf5f-4f45743e4ed5)
83
 
84
+ > As of RAGFlow v0.9.0, bulk download is not supported, nor can you download an entire folder.
docs/quickstart.mdx CHANGED
@@ -34,7 +34,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
34
 
35
  `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 abmornal behaviors, and the system will throw out-of-memory errors when a process reaches the limitation.
36
 
37
- RAGFlow v0.8.0 uses Elasticsearch for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.
38
 
39
  <Tabs
40
  defaultValue="linux"
@@ -132,7 +132,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
132
 
133
  3. Build the pre-built Docker images and start up the server:
134
 
135
- > Running the following commands automatically downloads the *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_VERSION` in **docker/.env** to the intended version, for example `RAGFLOW_VERSION=v0.8.0`, before running the following commands.
136
 
137
  ```bash
138
  $ cd ragflow/docker
 
34
 
35
  `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 abmornal behaviors, and the system will throw out-of-memory errors when a process reaches the limitation.
36
 
37
+ RAGFlow v0.9.0 uses Elasticsearch for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.
38
 
39
  <Tabs
40
  defaultValue="linux"
 
132
 
133
  3. Build the pre-built Docker images and start up the server:
134
 
135
+ > Running the following commands automatically downloads the *dev* version RAGFlow Docker image. To download and run a specified Docker version, update `RAGFLOW_VERSION` in **docker/.env** to the intended version, for example `RAGFLOW_VERSION=v0.9.0`, before running the following commands.
136
 
137
  ```bash
138
  $ cd ragflow/docker