Kevin Hu commited on
Commit
dba367b
·
1 Parent(s): 75c7829

Corrections. (#4127)

Browse files

### What problem does this PR solve?


### Type of change

- [x] Documentation Update

README.md CHANGED
@@ -168,7 +168,7 @@ releases! 🌟
168
 
169
  3. Start up the server using the pre-built Docker images:
170
 
171
- > 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`.
172
 
173
  ```bash
174
  $ cd ragflow
 
168
 
169
  3. Start up the server using the pre-built Docker images:
170
 
171
+ > 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.15.0-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.15.0` for the full edition `v0.15.0`.
172
 
173
  ```bash
174
  $ cd ragflow
README_id.md CHANGED
@@ -161,7 +161,7 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
161
 
162
  3. Bangun image Docker pre-built dan jalankan server:
163
 
164
- > 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.
165
 
166
  ```bash
167
  $ cd ragflow
 
161
 
162
  3. Bangun image Docker pre-built dan jalankan server:
163
 
164
+ > 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.15.0-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0 untuk edisi lengkap v0.15.0.
165
 
166
  ```bash
167
  $ cd ragflow
README_ja.md CHANGED
@@ -142,7 +142,7 @@
142
 
143
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
144
 
145
- > 以下のコマンドは、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 と設定します。
146
 
147
  ```bash
148
  $ cd ragflow
 
142
 
143
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:
144
 
145
+ > 以下のコマンドは、RAGFlow Dockerイメージの v0.15.0-slim エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.15.0-slim とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。例えば、完全版 v0.15.0 をダウンロードするには、RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0 と設定します。
146
 
147
  ```bash
148
  $ cd ragflow
README_ko.md CHANGED
@@ -147,7 +147,7 @@
147
 
148
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
149
 
150
- > 아래 명령어는 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로 설정합니다.
151
 
152
  ```bash
153
  $ cd ragflow
 
147
 
148
  3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요:
149
 
150
+ > 아래 명령어는 RAGFlow Docker 이미지의 v0.15.0-slim 버전을 다운로드합니다. 다양한 RAGFlow 버전에 대한 설명은 다음 표를 참조하십시오. v0.15.0-slim과 다른 RAGFlow 버전을 다운로드하려면, docker/.env 파일에서 RAGFLOW_IMAGE 변수를 적절히 업데이트한 후 docker compose를 사용하여 서버를 시작하십시오. 예를 들어, 전체 버전인 v0.15.0을 다운로드하려면 RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0로 설정합니다.
151
 
152
  ```bash
153
  $ cd ragflow
README_zh.md CHANGED
@@ -143,7 +143,7 @@
143
 
144
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
145
 
146
- > 运行以下命令会自动下载 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` 完整发行版。
147
 
148
  ```bash
149
  $ cd ragflow
 
143
 
144
  3. 进入 **docker** 文件夹,利用提前编译好的 Docker 镜像启动服务器:
145
 
146
+ > 运行以下命令会自动下载 RAGFlow slim Docker 镜像 `v0.15.0-slim`。请参考下表查看不同 Docker 发行版的描述。如需下载不同于 `v0.15.0-slim` 的 Docker 镜像,请在运行 `docker compose` 启动服务之前先更新 **docker/.env** 文件内的 `RAGFLOW_IMAGE` 变量。比如,你可以通过设置 `RAGFLOW_IMAGE=infiniflow/ragflow:v0.15.0` 来下载 RAGFlow 镜像的 `v0.15.0` 完整发行版。
147
 
148
  ```bash
149
  $ cd ragflow
docs/quickstart.mdx CHANGED
@@ -185,7 +185,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
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
 
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.15.0-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.15.0` for the full edition `v0.15.0`.
189
  :::
190
 
191
  ```bash
docs/references/http_api_reference.md CHANGED
@@ -2175,7 +2175,7 @@ curl --request POST \
2175
  ##### Request parameters
2176
 
2177
  - `agent_id`: (*Path parameter*)
2178
- The ID of the associated agent assistant.
2179
 
2180
  #### Response
2181
 
@@ -2364,7 +2364,7 @@ curl --request POST \
2364
  ##### Request Parameters
2365
 
2366
  - `agent_id`: (*Path parameter*), `string`
2367
- The ID of the associated agent assistant.
2368
  - `"question"`: (*Body Parameter*), `string`, *Required*
2369
  The question to start an AI-powered conversation.
2370
  - `"stream"`: (*Body Parameter*), `boolean`
 
2175
  ##### Request parameters
2176
 
2177
  - `agent_id`: (*Path parameter*)
2178
+ The ID of the associated agent.
2179
 
2180
  #### Response
2181
 
 
2364
  ##### Request Parameters
2365
 
2366
  - `agent_id`: (*Path parameter*), `string`
2367
+ The ID of the associated agent.
2368
  - `"question"`: (*Body Parameter*), `string`, *Required*
2369
  The question to start an AI-powered conversation.
2370
  - `"stream"`: (*Body Parameter*), `boolean`
docs/references/python_api_reference.md CHANGED
@@ -1412,7 +1412,7 @@ Creates a session with the current agent.
1412
  - Success: A `Session` object containing the following attributes:
1413
  - `id`: `str` The auto-generated unique identifier of the created session.
1414
  - `message`: `list[Message]` The messages of the created session assistant. Default: `[{"role": "assistant", "content": "Hi! I am your assistant,can I help you?"}]`
1415
- - `agent_id`: `str` The ID of the associated agent assistant.
1416
  - Failure: `Exception`
1417
 
1418
  #### Examples
 
1412
  - Success: A `Session` object containing the following attributes:
1413
  - `id`: `str` The auto-generated unique identifier of the created session.
1414
  - `message`: `list[Message]` The messages of the created session assistant. Default: `[{"role": "assistant", "content": "Hi! I am your assistant,can I help you?"}]`
1415
+ - `agent_id`: `str` The ID of the associated agent.
1416
  - Failure: `Exception`
1417
 
1418
  #### Examples