Kevin Hu commited on
Commit
73d9acb
·
1 Parent(s): 7ddda98

docs updates for 0.13 release (#3108)

Browse files

### What problem does this PR solve?



### Type of change

- [x] Documentation Update

README.md CHANGED
@@ -19,7 +19,7 @@
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.12.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.12.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -175,14 +175,14 @@ releases! 🌟
175
  ```
176
 
177
  > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in *
178
- *docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`. After
179
  making this change, rerun the command above to initiate the download.
180
  > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the
181
  `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change,
182
  rerun the command above to initiate the download.
183
  > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update
184
  the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example,
185
- `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`. After making this change, rerun the command above to initiate the
186
  download.
187
 
188
  > **NOTE:** A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size
 
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.13.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.13.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
175
  ```
176
 
177
  > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in *
178
+ *docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0-slim`. After
179
  making this change, rerun the command above to initiate the download.
180
  > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the
181
  `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change,
182
  rerun the command above to initiate the download.
183
  > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update
184
  the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example,
185
+ `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0`. After making this change, rerun the command above to initiate the
186
  download.
187
 
188
  > **NOTE:** A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size
README_ja.md CHANGED
@@ -19,7 +19,7 @@
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.12.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.12.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -147,9 +147,9 @@
147
  $ docker compose -f docker-compose.yml up -d
148
  ```
149
 
150
- > - 特定のバージョンのRAGFlow slim Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
151
  > - RAGFlowの埋め込みモデルとPythonライブラリを含む開発版Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を`RAGFLOW_IMAGE=infiniflow/ragflow:dev`に更新します。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
152
- > - 特定のバージョンのRAGFlow Dockerイメージ(埋め込みモデルとPythonライブラリを含む)をダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
153
 
154
  > **NOTE:** 埋め込みモデルとPythonライブラリを含むRAGFlow Dockerイメージのサイズは約9GBであり、読み込みにかなりの時間がかかる場合があります。
155
 
 
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.13.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.13.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
147
  $ docker compose -f docker-compose.yml up -d
148
  ```
149
 
150
+ > - 特定のバージョンのRAGFlow slim Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
151
  > - RAGFlowの埋め込みモデルとPythonライブラリを含む開発版Dockerイメージをダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を`RAGFLOW_IMAGE=infiniflow/ragflow:dev`に更新します。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
152
+ > - 特定のバージョンのRAGFlow Dockerイメージ(埋め込みモデルとPythonライブラリを含む)をダウンロードするには、**docker/.env**内の`RAGFlow_IMAGE`変数を希望のバージョンに更新します。例えば、`RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0`とします。この変更を行った後、上記のコマンドを再実行してダウンロードを開始してください。
153
 
154
  > **NOTE:** 埋め込みモデルとPythonライブラリを含むRAGFlow Dockerイメージのサイズは約9GBであり、読み込みにかなりの時間がかかる場合があります。
155
 
README_ko.md CHANGED
@@ -19,7 +19,7 @@
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.12.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.12.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -151,9 +151,9 @@
151
  $ docker compose -f docker-compose.yml up -d
152
  ```
153
 
154
- > - 특정 버전의 RAGFlow slim Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`으로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
155
  > - RAGFlow의 임베딩 모델과 Python 라이브러리를 포함한 개발 버전 Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 `RAGFLOW_IMAGE=infiniflow/ragflow:dev`로 업데이트하세요. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
156
- > - 특정 버전의 RAGFlow Docker 이미지를 임베딩 모델과 Python 라이브러리를 포함하여 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0` 로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
157
 
158
  > **NOTE:** 임베딩 모델과 Python 라이브러리를 포함한 RAGFlow Docker 이미지의 크기는 약 9GB이며, 로드하는 데 상당히 오랜 시간이 걸릴 수 있습니다.
159
 
 
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.13.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.13.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
151
  $ docker compose -f docker-compose.yml up -d
152
  ```
153
 
154
+ > - 특정 버전의 RAGFlow slim Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0-slim`으로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
155
  > - RAGFlow의 임베딩 모델과 Python 라이브러리를 포함한 개발 버전 Docker 이미지를 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 `RAGFLOW_IMAGE=infiniflow/ragflow:dev`로 업데이트하세요. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
156
+ > - 특정 버전의 RAGFlow Docker 이미지를 임베딩 모델과 Python 라이브러리를 포함하여 다운로드하려면, **docker/.env**에서 `RAGFlow_IMAGE` 변수를 원하는 버전으로 업데이트하세요. 예를 들어, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0` 로 설정합니다. 이 변경을 완료한 후, 위의 명령을 다시 실행하여 다운로드를 시작하세요.
157
 
158
  > **NOTE:** 임베딩 모델과 Python 라이브러리를 포함한 RAGFlow Docker 이미지의 크기는 약 9GB이며, 로드하는 데 상당히 오랜 시간이 걸릴 수 있습니다.
159
 
README_zh.md CHANGED
@@ -19,7 +19,7 @@
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.12.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.12.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -148,9 +148,9 @@
148
  $ docker compose -f docker-compose.yml up -d
149
  ```
150
 
151
- > - 如果你想下载并运行特定版本的 RAGFlow slim Docker 镜像,请在 **docker/.env** 文件中找到 `RAGFLOW_IMAGE` 变量,将其改为对应版本。例如 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`,然后再运行上述命令。
152
  > - 如果您想安装内置 embedding 模型和 Python 库的 dev 版本的 Docker 镜像,需要将 **docker/.env** 文件中的 `RAGFLOW_IMAGE` 变量修改为: `RAGFLOW_IMAGE=infiniflow/ragflow:dev`。
153
- > - 如果您想安装内置 embedding 模型和 Python 库的指定版本的 RAGFlow Docker 镜像,需要将 **docker/.env** 文件中的 `RAGFLOW_IMAGE` 变量修改为: `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`。修改后,再运行上面的命令。
154
  > **注意:** 安装内置 embedding 模型和 Python 库的指定版本的 RAGFlow Docker 镜像大小约 9 GB,可能需要更长时间下载,请耐心等待。
155
 
156
  4. 服务器启动成功后再次确认服务器状态:
 
19
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
20
  </a>
21
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
22
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.13.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.13.0">
23
  </a>
24
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
25
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
148
  $ docker compose -f docker-compose.yml up -d
149
  ```
150
 
151
+ > - 如果你想下载并运行特定版本的 RAGFlow slim Docker 镜像,请在 **docker/.env** 文件中找到 `RAGFLOW_IMAGE` 变量,将其改为对应版本。例如 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0-slim`,然后再运行上述命令。
152
  > - 如果您想安装内置 embedding 模型和 Python 库的 dev 版本的 Docker 镜像,需要将 **docker/.env** 文件中的 `RAGFLOW_IMAGE` 变量修改为: `RAGFLOW_IMAGE=infiniflow/ragflow:dev`。
153
+ > - 如果您想安装内置 embedding 模型和 Python 库的指定版本的 RAGFlow Docker 镜像,需要将 **docker/.env** 文件中的 `RAGFLOW_IMAGE` 变量修改为: `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0`。修改后,再运行上面的命令。
154
  > **注意:** 安装内置 embedding 模型和 Python 库的指定版本的 RAGFlow Docker 镜像大小约 9 GB,可能需要更长时间下载,请耐心等待。
155
 
156
  4. 服务器启动成功后再次确认服务器状态:
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.12.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.13.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
@@ -49,7 +49,7 @@ You can link your file to one knowledge base or multiple knowledge bases at one
49
 
50
  ## Search files or folders
51
 
52
- As of RAGFlow v0.12.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.12.0, bulk download is not supported, nor can you download an entire folder.
 
49
 
50
  ## Search files or folders
51
 
52
+ As of RAGFlow v0.13.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.13.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.12.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"
@@ -184,9 +184,9 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
184
  $ docker compose -f docker-compose.yml up -d
185
  ```
186
 
187
- > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0-slim`. After making this change, rerun the command above to initiate the download.
188
  > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change, rerun the command above to initiate the download.
189
- > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.12.0`. After making this change, rerun the command above to initiate the download.
190
 
191
  :::tip NOTE
192
  A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.
 
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.13.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"
 
184
  $ docker compose -f docker-compose.yml up -d
185
  ```
186
 
187
+ > - To download a RAGFlow slim Docker image of a specific version, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0-slim`. After making this change, rerun the command above to initiate the download.
188
  > - To download the dev version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to `RAGFLOW_IMAGE=infiniflow/ragflow:dev`. After making this change, rerun the command above to initiate the download.
189
+ > - To download a specific version of RAGFlow Docker image *including* embedding models and Python libraries, update the `RAGFlow_IMAGE` variable in **docker/.env** to your desired version. For example, `RAGFLOW_IMAGE=infiniflow/ragflow:v0.13.0`. After making this change, rerun the command above to initiate the download.
190
 
191
  :::tip NOTE
192
  A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.