From c3c251569114902394f0acca0a9dca7f1a86eedb Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Thu, 30 May 2024 18:00:02 +0800 Subject: [PATCH] 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 --- README.md | 8 ++++---- README_ja.md | 9 +++++---- README_zh.md | 10 +++++----- docker/.env | 2 +- docs/guides/configure_knowledge_base.md | 2 +- docs/guides/manage_files.md | 6 +++--- docs/quickstart.md | 2 +- 7 files changed, 20 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 60853e444..bee305cc2 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,8 @@ Static Badge - docker pull infiniflow/ragflow:v0.6.0 - + docker pull infiniflow/ragflow:v0.7.0 + license

@@ -53,6 +52,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io). ## 📌 Latest Updates +- 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. - 2024-05-28 Supports LLM Baichuan and VolcanoArk. - 2024-05-23 Supports [RAPTOR](https://arxiv.org/html/2401.18059v1) for better text retrieval. - 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). 3. Build the pre-built Docker images and start up the server: - > 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. + > 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. ```bash $ cd ragflow/docker diff --git a/README_ja.md b/README_ja.md index 8fe028fe3..b5543df04 100644 --- a/README_ja.md +++ b/README_ja.md @@ -17,8 +17,8 @@ Static Badge - docker pull infiniflow/ragflow:v0.6.0 + docker pull infiniflow/ragflow:v0.7.0 license @@ -34,6 +34,7 @@ ## 📌 最新情報 +- 2024-05-30 [BCE](https://github.com/netease-youdao/BCEmbedding)、[BGE](https://github.com/FlagOpen/FlagEmbedding)、[Colbert](https://github.com/stanford-futuredata/ColBERT) reranker を統合。 - 2024-05-28 LLM BaichuanとVolcanoArkを統合しました。 - 2024-05-23 より良いテキスト検索のために[RAPTOR](https://arxiv.org/html/2401.18059v1)をサポート。 - 2024-05-21 ストリーミング出力とテキストチャンク取得APIをサポート。 @@ -130,7 +131,7 @@ $ docker compose up -d ``` - > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.6.0として、上記のコマンドを実行してください。 + > 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.7.0として、上記のコマンドを実行してください。 > コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。 @@ -192,7 +193,7 @@ ```bash $ git clone https://github.com/infiniflow/ragflow.git $ cd ragflow/ -$ docker build -t infiniflow/ragflow:v0.6.0 . +$ docker build -t infiniflow/ragflow:v0.7.0 . $ cd ragflow/docker $ chmod +x ./entrypoint.sh $ docker compose up -d diff --git a/README_zh.md b/README_zh.md index e4af06213..c0e74980a 100644 --- a/README_zh.md +++ b/README_zh.md @@ -17,9 +17,8 @@ Static Badge - docker pull infiniflow/ragflow:v0.6.0 - + docker pull infiniflow/ragflow:v0.7.0 + license

@@ -34,6 +33,7 @@ ## 📌 近期更新 +- 2024-05-30 集成 [BCE](https://github.com/netease-youdao/BCEmbedding), [BGE](https://github.com/FlagOpen/FlagEmbedding) 和 [Colbert](https://github.com/stanford-futuredata/ColBERT) 重排序模型。 - 2024-05-28 集成大模型 Baichuan 和火山方舟。 - 2024-05-23 实现 [RAPTOR](https://arxiv.org/html/2401.18059v1) 提供更好的文本检索。 - 2024-05-21 支持流式结果输出和文本块获取API。 @@ -128,7 +128,7 @@ $ docker compose -f docker-compose-CN.yml up -d ``` - > 请注意，运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像，请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量，将其改为对应版本。例如 RAGFLOW_VERSION=v0.6.0，然后运行上述命令。 + > 请注意，运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像，请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量，将其改为对应版本。例如 RAGFLOW_VERSION=v0.7.0，然后运行上述命令。 > 核心镜像文件大约 9 GB，可能需要一定时间拉取。请耐心等待。 @@ -190,7 +190,7 @@ ```bash $ git clone https://github.com/infiniflow/ragflow.git $ cd ragflow/ -$ docker build -t infiniflow/ragflow:v0.6.0 . +$ docker build -t infiniflow/ragflow:v0.7.0 . $ cd ragflow/docker $ chmod +x ./entrypoint.sh $ docker compose up -d diff --git a/docker/.env b/docker/.env index 89149d380..47fcd78b9 100644 --- a/docker/.env +++ b/docker/.env @@ -29,7 +29,7 @@ REDIS_PASSWORD=infini_rag_flow SVR_HTTP_PORT=9380 -RAGFLOW_VERSION=v0.6.0 +RAGFLOW_VERSION=v0.7.0 TIMEZONE='Asia/Shanghai' diff --git a/docs/guides/configure_knowledge_base.md b/docs/guides/configure_knowledge_base.md index 536eaca05..f08e1491b 100644 --- a/docs/guides/configure_knowledge_base.md +++ b/docs/guides/configure_knowledge_base.md @@ -124,7 +124,7 @@ RAGFlow uses multiple recall of both full-text search and vector search in its c ## Search for knowledge base -As of RAGFlow v0.6.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name. +As of RAGFlow v0.7.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name. ![search knowledge base](https://github.com/infiniflow/ragflow/assets/93570324/836ae94c-2438-42be-879e-c7ad2a59693e) diff --git a/docs/guides/manage_files.md b/docs/guides/manage_files.md index 704e3b793..f99aee278 100644 --- a/docs/guides/manage_files.md +++ b/docs/guides/manage_files.md @@ -45,11 +45,11 @@ You can link your file to one knowledge base or multiple knowledge bases at one ## Move file to specified folder -As of RAGFlow v0.6.0, this feature is *not* available. +As of RAGFlow v0.7.0, this feature is *not* available. ## Search files or folders -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). +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). ![search file](https://github.com/infiniflow/ragflow/assets/93570324/77ffc2e5-bd80-4ed1-841f-068e664efffe) @@ -81,4 +81,4 @@ RAGFlow's file management allows you to download an uploaded file: ![download_file](https://github.com/infiniflow/ragflow/assets/93570324/cf3b297f-7d9b-4522-bf5f-4f45743e4ed5) -> As of RAGFlow v0.6.0, bulk download is not supported, nor can you download an entire folder. +> As of RAGFlow v0.7.0, bulk download is not supported, nor can you download an entire folder. diff --git a/docs/quickstart.md b/docs/quickstart.md index ecf92c18d..962f3db14 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -57,7 +57,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If 3. Build the pre-built Docker images and start up the server: - > 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. + > 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. ```bash $ cd ragflow/docker