Skip to content

Commit c3c2515

Browse files
authored
Update README (#998)
### 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]>
1 parent 117a173 commit c3c2515

File tree

7 files changed

+20
-19
lines changed

7 files changed

+20
-19
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717
<a href="https://demo.ragflow.io" target="_blank">
1818
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
1919
<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">
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">
2322
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
2423
</a>
2524
</p>
@@ -53,6 +52,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
5352

5453
## 📌 Latest Updates
5554

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.
5656
- 2024-05-28 Supports LLM Baichuan and VolcanoArk.
5757
- 2024-05-23 Supports [RAPTOR](https://arxiv.org/html/2401.18059v1) for better text retrieval.
5858
- 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).
141141
142142
3. Build the pre-built Docker images and start up the server:
143143
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.
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.
145145
146146
```bash
147147
$ cd ragflow/docker

README_ja.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
<a href="https://demo.ragflow.io" target="_blank">
1818
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
1919
<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>
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>
2222
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
2323
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
2424
</a>
@@ -34,6 +34,7 @@
3434

3535
## 📌 最新情報
3636

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 を統合。
3738
- 2024-05-28 LLM BaichuanとVolcanoArkを統合しました。
3839
- 2024-05-23 より良いテキスト検索のために[RAPTOR](https://arxiv.org/html/2401.18059v1)をサポート。
3940
- 2024-05-21 ストリーミング出力とテキストチャンク取得APIをサポート。
@@ -130,7 +131,7 @@
130131
$ docker compose up -d
131132
```
132133

133-
> 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.6.0として、上記のコマンドを実行してください。
134+
> 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.7.0として、上記のコマンドを実行してください。
134135
135136
> コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
136137
@@ -192,7 +193,7 @@
192193
```bash
193194
$ git clone https://github.com/infiniflow/ragflow.git
194195
$ cd ragflow/
195-
$ docker build -t infiniflow/ragflow:v0.6.0 .
196+
$ docker build -t infiniflow/ragflow:v0.7.0 .
196197
$ cd ragflow/docker
197198
$ chmod +x ./entrypoint.sh
198199
$ docker compose up -d

README_zh.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717
<a href="https://demo.ragflow.io" target="_blank">
1818
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
1919
<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">
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">
2322
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=d4eaf7&color=2e6cc4" alt="license">
2423
</a>
2524
</p>
@@ -34,6 +33,7 @@
3433

3534
## 📌 近期更新
3635

36+
- 2024-05-30 集成 [BCE](https://github.com/netease-youdao/BCEmbedding), [BGE](https://github.com/FlagOpen/FlagEmbedding)[Colbert](https://github.com/stanford-futuredata/ColBERT) 重排序模型。
3737
- 2024-05-28 集成大模型 Baichuan 和火山方舟。
3838
- 2024-05-23 实现 [RAPTOR](https://arxiv.org/html/2401.18059v1) 提供更好的文本检索。
3939
- 2024-05-21 支持流式结果输出和文本块获取API。
@@ -128,7 +128,7 @@
128128
$ docker compose -f docker-compose-CN.yml up -d
129129
```
130130

131-
> 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.6.0,然后运行上述命令。
131+
> 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.7.0,然后运行上述命令。
132132
133133
> 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
134134
@@ -190,7 +190,7 @@
190190
```bash
191191
$ git clone https://github.com/infiniflow/ragflow.git
192192
$ cd ragflow/
193-
$ docker build -t infiniflow/ragflow:v0.6.0 .
193+
$ docker build -t infiniflow/ragflow:v0.7.0 .
194194
$ cd ragflow/docker
195195
$ chmod +x ./entrypoint.sh
196196
$ docker compose up -d

docker/.env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ REDIS_PASSWORD=infini_rag_flow
2929

3030
SVR_HTTP_PORT=9380
3131

32-
RAGFLOW_VERSION=v0.6.0
32+
RAGFLOW_VERSION=v0.7.0
3333

3434
TIMEZONE='Asia/Shanghai'
3535

docs/guides/configure_knowledge_base.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ RAGFlow uses multiple recall of both full-text search and vector search in its c
124124

125125
## Search for knowledge base
126126

127-
As of RAGFlow v0.6.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
127+
As of RAGFlow v0.7.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

docs/guides/manage_files.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ You can link your file to one knowledge base or multiple knowledge bases at one
4545

4646
## Move file to specified folder
4747

48-
As of RAGFlow v0.6.0, this feature is *not* available.
48+
As of RAGFlow v0.7.0, this feature is *not* available.
4949

5050
## Search files or folders
5151

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).
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).
5353

5454
![search file](https://github.com/infiniflow/ragflow/assets/93570324/77ffc2e5-bd80-4ed1-841f-068e664efffe)
5555

@@ -81,4 +81,4 @@ RAGFlow's file management allows you to download an uploaded file:
8181

8282
![download_file](https://github.com/infiniflow/ragflow/assets/93570324/cf3b297f-7d9b-4522-bf5f-4f45743e4ed5)
8383

84-
> As of RAGFlow v0.6.0, bulk download is not supported, nor can you download an entire folder.
84+
> As of RAGFlow v0.7.0, bulk download is not supported, nor can you download an entire folder.

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
5757
5858
3. Build the pre-built Docker images and start up the server:
5959
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.
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.
6161
6262
```bash
6363
$ cd ragflow/docker

0 commit comments

Comments
 (0)