Kevin Hu
commited on
Commit
·
b71a073
1
Parent(s):
d684338
update doc for release (#2071)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
- README.md +4 -2
- README_ja.md +5 -4
- README_ko.md +4 -2
- README_zh.md +4 -3
- docs/guides/configure_knowledge_base.md +1 -1
- docs/guides/manage_files.md +3 -3
- docs/quickstart.mdx +2 -2
README.md
CHANGED
@@ -18,7 +18,7 @@
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
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?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
24 |
</a>
|
@@ -66,6 +66,8 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
|
|
66 |
|
67 |
## 🔥 Latest Updates
|
68 |
|
|
|
|
|
69 |
- 2024-08-02 Supports GraphRAG inspired by [graphrag](https://github.com/microsoft/graphrag) and mind map.
|
70 |
|
71 |
- 2024-07-23 Supports audio file parsing.
|
@@ -158,7 +160,7 @@ Try our demo at [https://demo.ragflow.io](https://demo.ragflow.io).
|
|
158 |
|
159 |
3. Build the pre-built Docker images and start up the server:
|
160 |
|
161 |
-
> 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.
|
162 |
|
163 |
```bash
|
164 |
$ cd ragflow/docker
|
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.10.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.10.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?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
24 |
</a>
|
|
|
66 |
|
67 |
## 🔥 Latest Updates
|
68 |
|
69 |
+
- 2024-08-22 Support text to SQL statements through RAG.
|
70 |
+
|
71 |
- 2024-08-02 Supports GraphRAG inspired by [graphrag](https://github.com/microsoft/graphrag) and mind map.
|
72 |
|
73 |
- 2024-07-23 Supports audio file parsing.
|
|
|
160 |
|
161 |
3. Build the pre-built Docker images and start up the server:
|
162 |
|
163 |
+
> 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.10.0`, before running the following commands.
|
164 |
|
165 |
```bash
|
166 |
$ cd ragflow/docker
|
README_ja.md
CHANGED
@@ -18,8 +18,8 @@
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
22 |
-
alt="docker pull infiniflow/ragflow:v0.
|
23 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
24 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
25 |
</a>
|
@@ -48,6 +48,7 @@
|
|
48 |
|
49 |
## 🔥 最新情報
|
50 |
|
|
|
51 |
- 2024-08-02 [graphrag](https://github.com/microsoft/graphrag) からインスピレーションを得た GraphRAG とマインド マップをサポートします。
|
52 |
- 2024-07-23 音声ファイルの解析をサポートしました。
|
53 |
- 2024-07-21 より多くの LLM サプライヤー (LocalAI/OpenRouter/StepFun/Nvidia) をサポートします。
|
@@ -142,7 +143,7 @@
|
|
142 |
$ docker compose up -d
|
143 |
```
|
144 |
|
145 |
-
> 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.
|
146 |
|
147 |
> コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
|
148 |
|
@@ -204,7 +205,7 @@
|
|
204 |
```bash
|
205 |
$ git clone https://github.com/infiniflow/ragflow.git
|
206 |
$ cd ragflow/
|
207 |
-
$ docker build -t infiniflow/ragflow:v0.
|
208 |
$ cd ragflow/docker
|
209 |
$ chmod +x ./entrypoint.sh
|
210 |
$ docker compose up -d
|
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.10.0-brightgreen"
|
22 |
+
alt="docker pull infiniflow/ragflow:v0.10.0"></a>
|
23 |
<a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
|
24 |
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
25 |
</a>
|
|
|
48 |
|
49 |
## 🔥 最新情報
|
50 |
|
51 |
+
- 2024-08-22 RAG を介して SQL ステートメントへのテキストをサポートします。
|
52 |
- 2024-08-02 [graphrag](https://github.com/microsoft/graphrag) からインスピレーションを得た GraphRAG とマインド マップをサポートします。
|
53 |
- 2024-07-23 音声ファイルの解析をサポートしました。
|
54 |
- 2024-07-21 より多くの LLM サプライヤー (LocalAI/OpenRouter/StepFun/Nvidia) をサポートします。
|
|
|
143 |
$ docker compose up -d
|
144 |
```
|
145 |
|
146 |
+
> 上記のコマンドを実行すると、RAGFlowの開発版dockerイメージが自動的にダウンロードされます。 特定のバージョンのDockerイメージをダウンロードして実行したい場合は、docker/.envファイルのRAGFLOW_VERSION変数を見つけて、対応するバージョンに変更してください。 例えば、RAGFLOW_VERSION=v0.10.0として、上記のコマンドを実行してください。
|
147 |
|
148 |
> コアイメージのサイズは約 9 GB で、ロードに時間がかかる場合があります。
|
149 |
|
|
|
205 |
```bash
|
206 |
$ git clone https://github.com/infiniflow/ragflow.git
|
207 |
$ cd ragflow/
|
208 |
+
$ docker build -t infiniflow/ragflow:v0.10.0 .
|
209 |
$ cd ragflow/docker
|
210 |
$ chmod +x ./entrypoint.sh
|
211 |
$ docker compose up -d
|
README_ko.md
CHANGED
@@ -18,7 +18,7 @@
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
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?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
24 |
</a>
|
@@ -49,6 +49,8 @@
|
|
49 |
|
50 |
## 🔥 업데이트
|
51 |
|
|
|
|
|
52 |
- 2024-08-02: [graphrag](https://github.com/microsoft/graphrag)와 마인드맵에서 영감을 받은 GraphRAG를 지원합니다.
|
53 |
|
54 |
- 2024-07-23: 오디오 파일 분석을 지원합니다.
|
@@ -145,7 +147,7 @@
|
|
145 |
|
146 |
3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
|
147 |
|
148 |
-
> 다음 명령어를 실행하면 *dev* 버전의 RAGFlow Docker 이미지가 자동으로 다운로드됩니다. 특정 Docker 버전을 다운로드하고 실행하려면, **docker/.env** 파일에서 `RAGFLOW_VERSION`을 원하는 버전으로 업데이트한 후, 예를 들어 `RAGFLOW_VERSION=v0.
|
149 |
```bash
|
150 |
$ cd ragflow/docker
|
151 |
$ chmod +x ./entrypoint.sh
|
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.10.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.10.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?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
24 |
</a>
|
|
|
49 |
|
50 |
## 🔥 업데이트
|
51 |
|
52 |
+
- 2024-08-22 RAG를 통해 SQL 문에 텍스트를 지원합니다.
|
53 |
+
|
54 |
- 2024-08-02: [graphrag](https://github.com/microsoft/graphrag)와 마인드맵에서 영감을 받은 GraphRAG를 지원합니다.
|
55 |
|
56 |
- 2024-07-23: 오디오 파일 분석을 지원합니다.
|
|
|
147 |
|
148 |
3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
|
149 |
|
150 |
+
> 다음 명령어를 실행하면 *dev* 버전의 RAGFlow Docker 이미지가 자동으로 다운로드됩니다. 특정 Docker 버전을 다운로드하고 실행하려면, **docker/.env** 파일에서 `RAGFLOW_VERSION`을 원하는 버전으로 업데이트한 후, 예를 들어 `RAGFLOW_VERSION=v0.10.0`로 업데이트 한 뒤, 다음 명령어를 실행하세요.
|
151 |
```bash
|
152 |
$ cd ragflow/docker
|
153 |
$ chmod +x ./entrypoint.sh
|
README_zh.md
CHANGED
@@ -18,7 +18,7 @@
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
-
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.
|
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?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
24 |
</a>
|
@@ -47,6 +47,7 @@
|
|
47 |
|
48 |
## 🔥 近期更新
|
49 |
|
|
|
50 |
- 2024-08-02 支持 GraphRAG 启发于 [graphrag](https://github.com/microsoft/graphrag) 和思维导图。
|
51 |
- 2024-07-23 支持解析音频文件。
|
52 |
- 2024-07-21 支持更多的大模型供应商(LocalAI/OpenRouter/StepFun/Nvidia)。
|
@@ -141,7 +142,7 @@
|
|
141 |
$ docker compose -f docker-compose-CN.yml up -d
|
142 |
```
|
143 |
|
144 |
-
> 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.
|
145 |
|
146 |
> 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
|
147 |
|
@@ -203,7 +204,7 @@
|
|
203 |
```bash
|
204 |
$ git clone https://github.com/infiniflow/ragflow.git
|
205 |
$ cd ragflow/
|
206 |
-
$ docker build -t infiniflow/ragflow:v0.
|
207 |
$ cd ragflow/docker
|
208 |
$ chmod +x ./entrypoint.sh
|
209 |
$ docker compose up -d
|
|
|
18 |
<a href="https://demo.ragflow.io" target="_blank">
|
19 |
<img alt="Static Badge" src="https://img.shields.io/badge/Online-Demo-4e6b99"></a>
|
20 |
<a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
|
21 |
+
<img src="https://img.shields.io/badge/docker_pull-ragflow:v0.10.0-brightgreen" alt="docker pull infiniflow/ragflow:v0.10.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?labelColor=d4eaf7&color=2e6cc4" alt="license">
|
24 |
</a>
|
|
|
47 |
|
48 |
## 🔥 近期更新
|
49 |
|
50 |
+
- 2024-08-22 支持用RAG技术实现从自然语言到SQL语句的转换。
|
51 |
- 2024-08-02 支持 GraphRAG 启发于 [graphrag](https://github.com/microsoft/graphrag) 和思维导图。
|
52 |
- 2024-07-23 支持解析音频文件。
|
53 |
- 2024-07-21 支持更多的大模型供应商(LocalAI/OpenRouter/StepFun/Nvidia)。
|
|
|
142 |
$ docker compose -f docker-compose-CN.yml up -d
|
143 |
```
|
144 |
|
145 |
+
> 请注意,运行上述命令会自动下载 RAGFlow 的开发版本 docker 镜像。如果你想下载并运行特定版本的 docker 镜像,请在 docker/.env 文件中找到 RAGFLOW_VERSION 变量,将其改为对应版本。例如 RAGFLOW_VERSION=v0.10.0,然后运行上述命令。
|
146 |
|
147 |
> 核心镜像文件大约 9 GB,可能需要一定时间拉取。请耐心等待。
|
148 |
|
|
|
204 |
```bash
|
205 |
$ git clone https://github.com/infiniflow/ragflow.git
|
206 |
$ cd ragflow/
|
207 |
+
$ docker build -t infiniflow/ragflow:v0.10.0 .
|
208 |
$ cd ragflow/docker
|
209 |
$ chmod +x ./entrypoint.sh
|
210 |
$ docker compose up -d
|
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.
|
132 |
|
133 |

|
134 |
|
|
|
128 |
|
129 |
## Search for knowledge base
|
130 |
|
131 |
+
As of RAGFlow v0.10.0, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
|
132 |
|
133 |

|
134 |
|
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 a specific folder
|
47 |
|
48 |
-
|
49 |
|
50 |
## Search files or folders
|
51 |
|
52 |
-
As of RAGFlow v0.
|
53 |
|
54 |

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

|
83 |
|
84 |
-
> As of RAGFlow v0.
|
|
|
45 |
|
46 |
## Move file to a specific folder
|
47 |
|
48 |
+

|
49 |
|
50 |
## Search files or folders
|
51 |
|
52 |
+
As of RAGFlow v0.10.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 |

|
55 |
|
|
|
81 |
|
82 |

|
83 |
|
84 |
+
> As of RAGFlow v0.10.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.
|
38 |
|
39 |
<Tabs
|
40 |
defaultValue="linux"
|
@@ -177,7 +177,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
|
|
177 |
|
178 |
3. Build the pre-built Docker images and start up the server:
|
179 |
|
180 |
-
> 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.
|
181 |
|
182 |
```bash
|
183 |
$ cd ragflow/docker
|
|
|
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.10.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"
|
|
|
177 |
|
178 |
3. Build the pre-built Docker images and start up the server:
|
179 |
|
180 |
+
> 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.10.0`, before running the following commands.
|
181 |
|
182 |
```bash
|
183 |
$ cd ragflow/docker
|