jinhai-2012 commited on
Commit
dd8762b
·
1 Parent(s): 12c8841

Update README (#998)

Browse files

### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change

- [x] Documentation Update

---------

Signed-off-by: Jin Hai <[email protected]>

README.md CHANGED
@@ -17,9 +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.6.0-brightgreen"
21
- alt="docker pull infiniflow/ragflow:v0.6.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?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
24
  </a>
25
  </p>
@@ -53,6 +52,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
53
 
54
  ## 📌 Latest Updates
55
 
 
56
  - 2024-05-28 Supports LLM Baichuan and VolcanoArk.
57
  - 2024-05-23 Supports [RAPTOR](https://arxiv.org/html/2401.18059v1) for better text retrieval.
58
  - 2024-05-21 Supports streaming output and text chunk retrieval API.
@@ -141,7 +141,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
141
 
142
  3. Build the pre-built Docker images and start up the server:
143
 
144
- > 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.6.0`, before running the following commands.
145
 
146
  ```bash
147
  $ cd ragflow/docker
 
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.7.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.7.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?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
23
  </a>
24
  </p>
 
52
 
53
  ## 📌 Latest Updates
54
 
55
+ - 2024-05-30 Integrates [BCE](https://github.com/netease-youdao/BCEmbedding), [BGE](https://github.com/FlagOpen/FlagEmbedding), and [Colbert](https://github.com/stanford-futuredata/ColBERT) reranker models.
56
  - 2024-05-28 Supports LLM Baichuan and VolcanoArk.
57
  - 2024-05-23 Supports [RAPTOR](https://arxiv.org/html/2401.18059v1) for better text retrieval.
58
  - 2024-05-21 Supports streaming output and text chunk retrieval API.
 
141
 
142
  3. Build the pre-built Docker images and start up the server:
143
 
144
+ > 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.7.0`, before running the following commands.
145
 
146
  ```bash
147
  $ cd ragflow/docker
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.6.0-brightgreen"
21
- alt="docker pull infiniflow/ragflow:v0.6.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?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
24
  </a>
@@ -34,6 +34,7 @@
34
 
35
  ## 📌 最新情報
36
 
 
37
  - 2024-05-28 LLM BaichuanとVolcanoArkを統合しました。
38
  - 2024-05-23 より良いテキスト検索のために[RAPTOR](https://arxiv.org/html/2401.18059v1)をサポート。
39
  - 2024-05-21 ストリーミング出力とテキストチャンク取得APIをサポート。
@@ -130,7 +131,7 @@
130
  $ docker compose up -d
131
  ```
132
 
133
- > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.6.0として、上記のコマンドを実行してください。
134
 
135
  > コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
136
 
@@ -192,7 +193,7 @@
192
  ```bash
193
  $ git clone https://github.com/infiniflow/ragflow.git
194
  $ cd ragflow/
195
- $ docker build -t infiniflow/ragflow:v0.6.0 .
196
  $ cd ragflow/docker
197
  $ chmod +x ./entrypoint.sh
198
  $ 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.7.0-brightgreen"
21
+ alt="docker pull infiniflow/ragflow:v0.7.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?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
24
  </a>
 
34
 
35
  ## 📌 最新情報
36
 
37
+ - 2024-05-30 [BCE](https://github.com/netease-youdao/BCEmbedding)、[BGE](https://github.com/FlagOpen/FlagEmbedding)、[Colbert](https://github.com/stanford-futuredata/ColBERT) reranker を統合。
38
  - 2024-05-28 LLM BaichuanとVolcanoArkを統合しました。
39
  - 2024-05-23 より良いテキスト検索のために[RAPTOR](https://arxiv.org/html/2401.18059v1)をサポート。
40
  - 2024-05-21 ストリーミング出力とテキストチャンク取得APIをサポート。
 
131
  $ docker compose up -d
132
  ```
133
 
134
+ > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.7.0として、上記のコマンドを実行してください。
135
 
136
  > コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
137
 
 
193
  ```bash
194
  $ git clone https://github.com/infiniflow/ragflow.git
195
  $ cd ragflow/
196
+ $ docker build -t infiniflow/ragflow:v0.7.0 .
197
  $ cd ragflow/docker
198
  $ chmod +x ./entrypoint.sh
199
  $ docker compose up -d
README_zh.md CHANGED
@@ -17,9 +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.6.0-brightgreen"
21
- alt="docker pull infiniflow/ragflow:v0.6.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?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
24
  </a>
25
  </p>
@@ -34,6 +33,7 @@
34
 
35
  ## 📌 近期更新
36
 
 
37
  - 2024-05-28 集成大模型 Baichuan 和火山方舟。
38
  - 2024-05-23 实现 [RAPTOR](https://arxiv.org/html/2401.18059v1) 提供更好的文本检索。
39
  - 2024-05-21 支持流式结果输出和文本块获取API。
@@ -128,7 +128,7 @@
128
  $ docker compose -f docker-compose-CN.yml up -d
129
  ```
130
 
131
- > 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.6.0,然后运行上述命令。
132
 
133
  > 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
134
 
@@ -190,7 +190,7 @@
190
  ```bash
191
  $ git clone https://github.com/infiniflow/ragflow.git
192
  $ cd ragflow/
193
- $ docker build -t infiniflow/ragflow:v0.6.0 .
194
  $ cd ragflow/docker
195
  $ chmod +x ./entrypoint.sh
196
  $ 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.7.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.7.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?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
23
  </a>
24
  </p>
 
33
 
34
  ## 📌 近期更新
35
 
36
+ - 2024-05-30 集成 [BCE](https://github.com/netease-youdao/BCEmbedding), [BGE](https://github.com/FlagOpen/FlagEmbedding) 和 [Colbert](https://github.com/stanford-futuredata/ColBERT) 重排序模型。
37
  - 2024-05-28 集成大模型 Baichuan 和火山方舟。
38
  - 2024-05-23 实现 [RAPTOR](https://arxiv.org/html/2401.18059v1) 提供更好的文本检索。
39
  - 2024-05-21 支持流式结果输出和文本块获取API。
 
128
  $ docker compose -f docker-compose-CN.yml up -d
129
  ```
130
 
131
+ > 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.7.0,然后运行上述命令。
132
 
133
  > 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
134
 
 
190
  ```bash
191
  $ git clone https://github.com/infiniflow/ragflow.git
192
  $ cd ragflow/
193
+ $ docker build -t infiniflow/ragflow:v0.7.0 .
194
  $ cd ragflow/docker
195
  $ chmod +x ./entrypoint.sh
196
  $ docker compose up -d
docker/.env CHANGED
@@ -29,7 +29,7 @@ REDIS_PASSWORD=infini_rag_flow
29
 
30
  SVR_HTTP_PORT=9380
31
 
32
- RAGFLOW_VERSION=v0.6.0
33
 
34
  TIMEZONE='Asia/Shanghai'
35
 
 
29
 
30
  SVR_HTTP_PORT=9380
31
 
32
+ RAGFLOW_VERSION=v0.7.0
33
 
34
  TIMEZONE='Asia/Shanghai'
35
 
docs/guides/configure_knowledge_base.md CHANGED
@@ -124,7 +124,7 @@ RAGFlow uses multiple recall of both full-text search and vector search in its c
124
 
125
  ## Search for knowledge base
126
 
127
- As of RAGFlow v0.6.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
128
 
129
  ![search knowledge base](https://github.com/infiniflow/ragflow/assets/93570324/836ae94c-2438-42be-879e-c7ad2a59693e)
130
 
 
124
 
125
  ## Search for knowledge base
126
 
127
+ As of RAGFlow v0.7.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
128
 
129
  ![search knowledge base](https://github.com/infiniflow/ragflow/assets/93570324/836ae94c-2438-42be-879e-c7ad2a59693e)
130
 
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 specified folder
47
 
48
- As of RAGFlow v0.6.0, this feature is *not* available.
49
 
50
  ## Search files or folders
51
 
52
- As of RAGFlow v0.6.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.6.0, bulk download is not supported, nor can you download an entire folder.
 
45
 
46
  ## Move file to specified folder
47
 
48
+ As of RAGFlow v0.7.0, this feature is *not* available.
49
 
50
  ## Search files or folders
51
 
52
+ As of RAGFlow v0.7.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.7.0, bulk download is not supported, nor can you download an entire folder.
docs/quickstart.md CHANGED
@@ -57,7 +57,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
57
 
58
  3. Build the pre-built Docker images and start up the server:
59
 
60
- > 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.6.0`, before running the following commands.
61
 
62
  ```bash
63
  $ cd ragflow/docker
 
57
 
58
  3. Build the pre-built Docker images and start up the server:
59
 
60
+ > 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.7.0`, before running the following commands.
61
 
62
  ```bash
63
  $ cd ragflow/docker