Kevin Hu commited on
Commit
6a60ab2
·
1 Parent(s): 7f9c7e1

Prepare docs for v0.15.0 release (#4077)

Browse files

### What problem does this PR solve?


### Type of change

- [x] Documentation Update

README.md CHANGED
@@ -20,7 +20,7 @@
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.14.1-brightgreen" alt="docker pull infiniflow/ragflow:v0.14.1">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -167,7 +167,7 @@ releases! 🌟
167
 
168
  3. Start up the server using the pre-built Docker images:
169
 
170
- > The command below downloads the `v0.14.1-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download an RAGFlow edition different from `v0.14.1-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.14.1` for the full edition `v0.14.1`.
171
 
172
  ```bash
173
  $ cd ragflow
@@ -176,10 +176,8 @@ releases! 🌟
176
 
177
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
178
  | ----------------- | --------------- | --------------------- | ------------------------ |
179
- | v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
180
- | v0.14.1-slim | &approx;2 | ❌ | Stable release |
181
- | v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
182
- | v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
183
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
184
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
185
 
 
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.15.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.15.0">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
167
 
168
  3. Start up the server using the pre-built Docker images:
169
 
170
+ > The command below downloads the `v0.15.0-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download an RAGFlow edition different from `v0.14.1-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.14.1` for the full edition `v0.14.1`.
171
 
172
  ```bash
173
  $ cd ragflow
 
176
 
177
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
178
  | ----------------- | --------------- | --------------------- | ------------------------ |
179
+ | v0.15.0 | &approx;9 | :heavy_check_mark: | Stable release |
180
+ | v0.15.0-slim | &approx;2 | ❌ | Stable release |
 
 
181
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
182
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
183
 
README_id.md CHANGED
@@ -20,7 +20,7 @@
20
  <img alt="Lencana Daring" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.14.1-brightgreen" alt="docker pull infiniflow/ragflow:v0.14.1">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Rilis%20Terbaru" alt="Rilis Terbaru">
@@ -160,7 +160,7 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
160
 
161
  3. Bangun image Docker pre-built dan jalankan server:
162
 
163
- > Perintah di bawah ini mengunduh edisi v0.14.1-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.14.1-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1 untuk edisi lengkap v0.14.1.
164
 
165
  ```bash
166
  $ cd ragflow
@@ -169,10 +169,8 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
169
 
170
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
171
  | ----------------- | --------------- | --------------------- | ------------------------ |
172
- | v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
173
- | v0.14.1-slim | &approx;2 | ❌ | Stable release |
174
- | v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
175
- | v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
176
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
177
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
178
 
 
20
  <img alt="Lencana Daring" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.15.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.15.0">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Rilis%20Terbaru" alt="Rilis Terbaru">
 
160
 
161
  3. Bangun image Docker pre-built dan jalankan server:
162
 
163
+ > Perintah di bawah ini mengunduh edisi v0.15.0-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.14.1-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1 untuk edisi lengkap v0.14.1.
164
 
165
  ```bash
166
  $ cd ragflow
 
169
 
170
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
171
  | ----------------- | --------------- | --------------------- | ------------------------ |
172
+ | v0.15.0 | &approx;9 | :heavy_check_mark: | Stable release |
173
+ | v0.15.0-slim | &approx;2 | ❌ | Stable release |
 
 
174
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
175
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
176
 
README_ja.md CHANGED
@@ -20,7 +20,7 @@
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.14.1-brightgreen" alt="docker pull infiniflow/ragflow:v0.14.1">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -141,7 +141,7 @@
141
 
142
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
143
 
144
- > 以下のコマンドは、RAGFlow Dockerイメージの v0.14.1-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.14.1-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.14.1 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1 と設定します。
145
 
146
  ```bash
147
  $ cd ragflow
@@ -150,10 +150,8 @@
150
 
151
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
152
  | ----------------- | --------------- | --------------------- | ------------------------ |
153
- | v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
154
- | v0.14.1-slim | &approx;2 | ❌ | Stable release |
155
- | v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
156
- | v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
157
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
158
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
159
 
 
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.15.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.15.0">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
141
 
142
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
143
 
144
+ > 以下のコマンドは、RAGFlow Dockerイメージの v0.15.0-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.15.0-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.14.1 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1 と設定します。
145
 
146
  ```bash
147
  $ cd ragflow
 
150
 
151
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
152
  | ----------------- | --------------- | --------------------- | ------------------------ |
153
+ | v0.15.0 | &approx;9 | :heavy_check_mark: | Stable release |
154
+ | v0.15.0-slim | &approx;2 | ❌ | Stable release |
 
 
155
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
156
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
157
 
README_ko.md CHANGED
@@ -20,7 +20,7 @@
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.14.1-brightgreen" alt="docker pull infiniflow/ragflow:v0.14.1">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -145,7 +145,7 @@
145
 
146
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
147
 
148
- > 아래 명령어는 RAGFlow Docker 이미지의 v0.14.1-slim 버전을 다운로드합니다. 다양한 RAGFlow 버전에 대한 설명은 다음 표를 참조하십시오. v0.14.1-slim과 다른 RAGFlow 버전을 다운로드하려면, docker/.env 파일에서 RAGFLOW_IMAGE 변수를 적절히 업데이트한 후 docker compose를 사용하여 서버를 시작하십시오. 예를 들어, 전체 버전인 v0.14.1을 다운로드하려면 RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1로 설정합니다.
149
 
150
  ```bash
151
  $ cd ragflow
@@ -154,10 +154,8 @@
154
 
155
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
156
  | ----------------- | --------------- | --------------------- | ------------------------ |
157
- | v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
158
- | v0.14.1-slim | &approx;2 | ❌ | Stable release |
159
- | v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
160
- | v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
161
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
162
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
163
 
 
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.15.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.15.0">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
145
 
146
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
147
 
148
+ > 아래 명령어는 RAGFlow Docker 이미지의 v0.15.0-slim 버전을 다운로드합니다. 다양한 RAGFlow 버전에 대한 설명은 다음 표를 참조하십시오. v0.15.0-slim과 다른 RAGFlow 버전을 다운로드하려면, docker/.env 파일에서 RAGFLOW_IMAGE 변수를 적절히 업데이트한 후 docker compose를 사용하여 서버를 시작하십시오. 예를 들어, 전체 버전인 v0.14.1을 다운로드하려면 RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1로 설정합니다.
149
 
150
  ```bash
151
  $ cd ragflow
 
154
 
155
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
156
  | ----------------- | --------------- | --------------------- | ------------------------ |
157
+ | v0.15.0 | &approx;9 | :heavy_check_mark: | Stable release |
158
+ | v0.15.0-slim | &approx;2 | ❌ | Stable release |
 
 
159
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
160
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
161
 
README_zh.md CHANGED
@@ -20,7 +20,7 @@
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
- <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.14.1-brightgreen" alt="docker pull infiniflow/ragflow:v0.14.1">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
@@ -142,7 +142,7 @@
142
 
143
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
144
 
145
- > 运行以下命令会自动下载 RAGFlow slim Docker 镜像 `v0.14.1-slim`。请参考下表查看不同 Docker 发行版的描述。如需下载不同于 `v0.14.0-slim` 的 Docker 镜像,请在运行 `docker compose` 启动服务之前先更新 **docker/.env** 文件内的 `RAGFLOW_IMAGE` 变量。比如,你可以通过设置 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1` 来下载 RAGFlow 镜像的 `v0.14.1` 完整发行版。
146
 
147
  ```bash
148
  $ cd ragflow
@@ -151,10 +151,8 @@
151
 
152
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
153
  | ----------------- | --------------- | --------------------- | ------------------------ |
154
- | v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
155
- | v0.14.1-slim | &approx;2 | ❌ | Stable release |
156
- | v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
157
- | v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
158
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
159
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
160
 
 
20
  <img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99">
21
  </a>
22
  <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
23
+ <img src="https://img.shields.io/badge/docker_pull-ragflow:v0.15.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.15.0">
24
  </a>
25
  <a href="https://github.com/infiniflow/ragflow/releases/latest">
26
  <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Latest%20Release" alt="Latest Release">
 
142
 
143
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
144
 
145
+ > 运行以下命令会自动下载 RAGFlow slim Docker 镜像 `v0.15.0-slim`。请参考下表查看不同 Docker 发行版的描述。如需下载不同于 `v0.15.0-slim` 的 Docker 镜像,请在运行 `docker compose` 启动服务之前先更新 **docker/.env** 文件内的 `RAGFLOW_IMAGE` 变量。比如,你可以通过设置 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1` 来下载 RAGFlow 镜像的 `v0.14.1` 完整发行版。
146
 
147
  ```bash
148
  $ cd ragflow
 
151
 
152
  | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
153
  | ----------------- | --------------- | --------------------- | ------------------------ |
154
+ | v0.15.0 | &approx;9 | :heavy_check_mark: | Stable release |
155
+ | v0.15.0-slim | &approx;2 | ❌ | Stable release |
 
 
156
  | nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
157
  | nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
158
 
docker/.env CHANGED
@@ -80,13 +80,13 @@ REDIS_PASSWORD=infini_rag_flow
80
  SVR_HTTP_PORT=9380
81
 
82
  # The RAGFlow Docker image to download.
83
- # Defaults to the v0.14.1-slim edition, which is the RAGFlow Docker image without embedding models.
84
- RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1-slim
85
  #
86
  # To download the RAGFlow Docker image with embedding models, uncomment the following line instead:
87
- # RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1
88
  #
89
- # The Docker image of the v0.14.1 edition includes:
90
  # - Built-in embedding models:
91
  # - BAAI/bge-large-zh-v1.5
92
  # - BAAI/bge-reranker-v2-m3
 
80
  SVR_HTTP_PORT=9380
81
 
82
  # The RAGFlow Docker image to download.
83
+ # Defaults to the v0.15.0-slim edition, which is the RAGFlow Docker image without embedding models.
84
+ RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0-slim
85
  #
86
  # To download the RAGFlow Docker image with embedding models, uncomment the following line instead:
87
+ # RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0
88
  #
89
+ # The Docker image of the v0.15.0 edition includes:
90
  # - Built-in embedding models:
91
  # - BAAI/bge-large-zh-v1.5
92
  # - BAAI/bge-reranker-v2-m3
docker/README.md CHANGED
@@ -78,8 +78,8 @@ The [.env](./.env) file contains important environment variables for Docker.
78
  - `RAGFLOW-IMAGE`
79
  The Docker image edition. Available editions:
80
 
81
- - `infiniflow/ragflow:v0.14.1-slim` (default): The RAGFlow Docker image without embedding models.
82
- - `infiniflow/ragflow:v0.14.1`: The RAGFlow Docker image with embedding models including:
83
  - Built-in embedding models:
84
  - `BAAI/bge-large-zh-v1.5`
85
  - `BAAI/bge-reranker-v2-m3`
 
78
  - `RAGFLOW-IMAGE`
79
  The Docker image edition. Available editions:
80
 
81
+ - `infiniflow/ragflow:v0.15.0-slim` (default): The RAGFlow Docker image without embedding models.
82
+ - `infiniflow/ragflow:v0.15.0`: The RAGFlow Docker image with embedding models including:
83
  - Built-in embedding models:
84
  - `BAAI/bge-large-zh-v1.5`
85
  - `BAAI/bge-reranker-v2-m3`
docs/configurations.md CHANGED
@@ -97,8 +97,8 @@ The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file con
97
  - `RAGFLOW-IMAGE`
98
  The Docker image edition. Available editions:
99
 
100
- - `infiniflow/ragflow:v0.14.1-slim` (default): The RAGFlow Docker image without embedding models.
101
- - `infiniflow/ragflow:v0.14.1`: The RAGFlow Docker image with embedding models including:
102
  - Built-in embedding models:
103
  - `BAAI/bge-large-zh-v1.5`
104
  - `BAAI/bge-reranker-v2-m3`
 
97
  - `RAGFLOW-IMAGE`
98
  The Docker image edition. Available editions:
99
 
100
+ - `infiniflow/ragflow:v0.15.0-slim` (default): The RAGFlow Docker image without embedding models.
101
+ - `infiniflow/ragflow:v0.15.0`: The RAGFlow Docker image with embedding models including:
102
  - Built-in embedding models:
103
  - `BAAI/bge-large-zh-v1.5`
104
  - `BAAI/bge-reranker-v2-m3`
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.14.1, 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.15.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
@@ -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.14.1, bulk download is not supported, nor can you download an entire folder.
 
81
 
82
  ![download_file](https://github.com/infiniflow/ragflow/assets/93570324/cf3b297f-7d9b-4522-bf5f-4f45743e4ed5)
83
 
84
+ > As of RAGFlow v0.15.0, bulk download is not supported, nor can you download an entire folder.
docs/guides/upgrade_ragflow.mdx CHANGED
@@ -62,16 +62,16 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
62
  git clone https://github.com/infiniflow/ragflow.git
63
  ```
64
 
65
- 2. Switch to the latest, officially published release, e.g., `v0.14.1`:
66
 
67
  ```bash
68
- git checkout -f v0.14.1
69
  ```
70
 
71
  3. Update **ragflow/docker/.env** as follows:
72
 
73
  ```bash
74
- RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1
75
  ```
76
 
77
  4. Update the RAGFlow image and restart RAGFlow:
 
62
  git clone https://github.com/infiniflow/ragflow.git
63
  ```
64
 
65
+ 2. Switch to the latest, officially published release, e.g., `v0.15.0`:
66
 
67
  ```bash
68
+ git checkout -f v0.15.0
69
  ```
70
 
71
  3. Update **ragflow/docker/.env** as follows:
72
 
73
  ```bash
74
+ RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0
75
  ```
76
 
77
  4. Update the RAGFlow image and restart RAGFlow:
docs/quickstart.mdx CHANGED
@@ -39,7 +39,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
39
 
40
  `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.
41
 
42
- RAGFlow v0.14.1 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.
43
 
44
  <Tabs
45
  defaultValue="linux"
@@ -179,13 +179,13 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
179
  ```bash
180
  $ git clone https://github.com/infiniflow/ragflow.git
181
  $ cd ragflow
182
- $ git checkout -f v0.14.1
183
  ```
184
 
185
  3. Use the pre-built Docker images and start up the server:
186
 
187
  :::tip NOTE
188
- The command below downloads the `v0.14.1-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download an RAGFlow edition different from `v0.14.1-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.14.1` for the full edition `v0.14.1`.
189
  :::
190
 
191
  ```bash
@@ -198,10 +198,8 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
198
 
199
  | RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
200
  | ------------------- | --------------- | ----------------------------------------- | ------------------------ |
201
- | `v0.14.1` | &approx;9 | :heavy_check_mark: | Stable release |
202
- | `v0.14.1-slim` | &approx;2 | ❌ | Stable release |
203
- | `v0.15.0-dev1` | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
204
- | `v0.15.0-dev1-slim` | &approx;2 | ❌ | *Unstable* beta release |
205
  | `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
206
  | `nightly-slim` | &approx;2 | ❌ | *Unstable* nightly build |
207
 
 
39
 
40
  `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.
41
 
42
+ RAGFlow v0.15.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.
43
 
44
  <Tabs
45
  defaultValue="linux"
 
179
  ```bash
180
  $ git clone https://github.com/infiniflow/ragflow.git
181
  $ cd ragflow
182
+ $ git checkout -f v0.15.0
183
  ```
184
 
185
  3. Use the pre-built Docker images and start up the server:
186
 
187
  :::tip NOTE
188
+ The command below downloads the `v0.15.0-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download an RAGFlow edition different from `v0.14.1-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.14.1` for the full edition `v0.14.1`.
189
  :::
190
 
191
  ```bash
 
198
 
199
  | RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
200
  | ------------------- | --------------- | ----------------------------------------- | ------------------------ |
201
+ | `v0.15.0` | &approx;9 | :heavy_check_mark: | Stable release |
202
+ | `v0.15.0-slim` | &approx;2 | ❌ | Stable release |
 
 
203
  | `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
204
  | `nightly-slim` | &approx;2 | ❌ | *Unstable* nightly build |
205
 
docs/references/faq.md CHANGED
@@ -42,10 +42,10 @@ We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM6
42
 
43
  ### Which embedding models can be deployed locally?
44
 
45
- RAGFlow offers two Docker image editions, `v0.14.1-slim` and `v0.14.1`:
46
 
47
- - `infiniflow/ragflow:v0.14.1-slim` (default): The RAGFlow Docker image without embedding models.
48
- - `infiniflow/ragflow:v0.14.1`: The RAGFlow Docker image with embedding models including:
49
  - Built-in embedding models:
50
  - `BAAI/bge-large-zh-v1.5`
51
  - `BAAI/bge-reranker-v2-m3`
 
42
 
43
  ### Which embedding models can be deployed locally?
44
 
45
+ RAGFlow offers two Docker image editions, `v0.15.0-slim` and `v0.15.0`:
46
 
47
+ - `infiniflow/ragflow:v0.15.0-slim` (default): The RAGFlow Docker image without embedding models.
48
+ - `infiniflow/ragflow:v0.15.0`: The RAGFlow Docker image with embedding models including:
49
  - Built-in embedding models:
50
  - `BAAI/bge-large-zh-v1.5`
51
  - `BAAI/bge-reranker-v2-m3`
helm/values.yaml CHANGED
@@ -27,13 +27,13 @@ env:
27
  REDIS_PASSWORD: infini_rag_flow_helm
28
 
29
  # The RAGFlow Docker image to download.
30
- # Defaults to the v0.14.1-slim edition, which is the RAGFlow Docker image without embedding models.
31
- RAGFLOW_IMAGE: infiniflow/ragflow:v0.14.1-slim
32
  #
33
  # To download the RAGFlow Docker image with embedding models, uncomment the following line instead:
34
- # RAGFLOW_IMAGE=infiniflow/ragflow:v0.14.1
35
  #
36
- # The Docker image of the v0.14.1 edition includes:
37
  # - Built-in embedding models:
38
  # - BAAI/bge-large-zh-v1.5
39
  # - BAAI/bge-reranker-v2-m3
 
27
  REDIS_PASSWORD: infini_rag_flow_helm
28
 
29
  # The RAGFlow Docker image to download.
30
+ # Defaults to the v0.15.0-slim edition, which is the RAGFlow Docker image without embedding models.
31
+ RAGFLOW_IMAGE: infiniflow/ragflow:v0.15.0-slim
32
  #
33
  # To download the RAGFlow Docker image with embedding models, uncomment the following line instead:
34
+ # RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0
35
  #
36
+ # The Docker image of the v0.15.0 edition includes:
37
  # - Built-in embedding models:
38
  # - BAAI/bge-large-zh-v1.5
39
  # - BAAI/bge-reranker-v2-m3
poetry.lock CHANGED
@@ -10150,4 +10150,4 @@ cffi = ["cffi (>=1.11)"]
10150
  [metadata]
10151
  lock-version = "2.0"
10152
  python-versions = ">=3.10,<3.13"
10153
- content-hash = "4c592934d67923be94f92704ac2cd646f8f7a7f59c4a94707677f4be29c5a7b1"
 
10150
  [metadata]
10151
  lock-version = "2.0"
10152
  python-versions = ">=3.10,<3.13"
10153
+ content-hash = "4c592934d67923be94f92704ac2cd646f8f7a7f59c4a94707677f4be29c5a7b1"
sdk/python/poetry.lock CHANGED
@@ -20,13 +20,13 @@ test-tox-coverage = ["coverage (>=5.5)"]
20
 
21
  [[package]]
22
  name = "certifi"
23
- version = "2024.8.30"
24
  description = "Python package for providing Mozilla's CA Bundle."
25
  optional = false
26
  python-versions = ">=3.6"
27
  files = [
28
- {file = "certifi-2024.8.30-py3-none-any.whl", hash = "sha256:922820b53db7a7257ffbda3f597266d435245903d80737e34f8a45ff3e3230d8"},
29
- {file = "certifi-2024.8.30.tar.gz", hash = "sha256:bec941d2aa8195e248a60b31ff9f0558284cf01a52591ceda73ea9afffd69fd9"},
30
  ]
31
 
32
  [[package]]
@@ -221,13 +221,13 @@ testing = ["pytest", "pytest-benchmark"]
221
 
222
  [[package]]
223
  name = "pytest"
224
- version = "8.3.3"
225
  description = "pytest: simple powerful testing with Python"
226
  optional = false
227
  python-versions = ">=3.8"
228
  files = [
229
- {file = "pytest-8.3.3-py3-none-any.whl", hash = "sha256:a6853c7375b2663155079443d2e45de913a911a11d669df02a50814944db57b2"},
230
- {file = "pytest-8.3.3.tar.gz", hash = "sha256:70b98107bd648308a7952b06e6ca9a50bc660be218d53c257cc1fc94fda10181"},
231
  ]
232
 
233
  [package.dependencies]
@@ -264,13 +264,43 @@ use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"]
264
 
265
  [[package]]
266
  name = "tomli"
267
- version = "2.1.0"
268
  description = "A lil' TOML parser"
269
  optional = false
270
  python-versions = ">=3.8"
271
  files = [
272
- {file = "tomli-2.1.0-py3-none-any.whl", hash = "sha256:a5c57c3d1c56f5ccdf89f6523458f60ef716e210fc47c4cfb188c5ba473e0391"},
273
- {file = "tomli-2.1.0.tar.gz", hash = "sha256:3f646cae2aec94e17d04973e4249548320197cfabdf130015d023de4b74d8ab8"},
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
274
  ]
275
 
276
  [[package]]
 
20
 
21
  [[package]]
22
  name = "certifi"
23
+ version = "2024.12.14"
24
  description = "Python package for providing Mozilla's CA Bundle."
25
  optional = false
26
  python-versions = ">=3.6"
27
  files = [
28
+ {file = "certifi-2024.12.14-py3-none-any.whl", hash = "sha256:1275f7a45be9464efc1173084eaa30f866fe2e47d389406136d332ed4967ec56"},
29
+ {file = "certifi-2024.12.14.tar.gz", hash = "sha256:b650d30f370c2b724812bee08008be0c4163b163ddaec3f2546c1caf65f191db"},
30
  ]
31
 
32
  [[package]]
 
221
 
222
  [[package]]
223
  name = "pytest"
224
+ version = "8.3.4"
225
  description = "pytest: simple powerful testing with Python"
226
  optional = false
227
  python-versions = ">=3.8"
228
  files = [
229
+ {file = "pytest-8.3.4-py3-none-any.whl", hash = "sha256:50e16d954148559c9a74109af1eaf0c945ba2d8f30f0a3d3335edde19788b6f6"},
230
+ {file = "pytest-8.3.4.tar.gz", hash = "sha256:965370d062bce11e73868e0335abac31b4d3de0e82f4007408d242b4f8610761"},
231
  ]
232
 
233
  [package.dependencies]
 
264
 
265
  [[package]]
266
  name = "tomli"
267
+ version = "2.2.1"
268
  description = "A lil' TOML parser"
269
  optional = false
270
  python-versions = ">=3.8"
271
  files = [
272
+ {file = "tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249"},
273
+ {file = "tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6"},
274
+ {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a"},
275
+ {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee"},
276
+ {file = "tomli-2.2.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e"},
277
+ {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4"},
278
+ {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106"},
279
+ {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8"},
280
+ {file = "tomli-2.2.1-cp311-cp311-win32.whl", hash = "sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff"},
281
+ {file = "tomli-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b"},
282
+ {file = "tomli-2.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea"},
283
+ {file = "tomli-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8"},
284
+ {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192"},
285
+ {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222"},
286
+ {file = "tomli-2.2.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77"},
287
+ {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6"},
288
+ {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd"},
289
+ {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e"},
290
+ {file = "tomli-2.2.1-cp312-cp312-win32.whl", hash = "sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98"},
291
+ {file = "tomli-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4"},
292
+ {file = "tomli-2.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7"},
293
+ {file = "tomli-2.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c"},
294
+ {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13"},
295
+ {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281"},
296
+ {file = "tomli-2.2.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272"},
297
+ {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140"},
298
+ {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2"},
299
+ {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744"},
300
+ {file = "tomli-2.2.1-cp313-cp313-win32.whl", hash = "sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec"},
301
+ {file = "tomli-2.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69"},
302
+ {file = "tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc"},
303
+ {file = "tomli-2.2.1.tar.gz", hash = "sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff"},
304
  ]
305
 
306
  [[package]]
sdk/python/pyproject.toml CHANGED
@@ -1,6 +1,6 @@
1
  [tool.poetry]
2
  name = "ragflow-sdk"
3
- version = "0.14.0"
4
  description = "Python client sdk of [RAGFlow](https://github.com/infiniflow/ragflow). RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding."
5
  authors = ["Zhichang Yu <[email protected]>"]
6
  license = "Apache License, Version 2.0"
 
1
  [tool.poetry]
2
  name = "ragflow-sdk"
3
+ version = "0.15.0"
4
  description = "Python client sdk of [RAGFlow](https://github.com/infiniflow/ragflow). RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding."
5
  authors = ["Zhichang Yu <[email protected]>"]
6
  license = "Apache License, Version 2.0"