From b51d2f5f8234d96b7ebe8700fbea2a7527c33e2d Mon Sep 17 00:00:00 2001 From: Kevin Hu Date: Thu, 19 Dec 2024 18:18:55 +0800 Subject: [PATCH] Corrections. --- README.md | 2 +- README_id.md | 2 +- README_ja.md | 2 +- README_ko.md | 2 +- README_zh.md | 2 +- docs/quickstart.mdx | 2 +- docs/references/http_api_reference.md | 4 ++-- docs/references/python_api_reference.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6676c3c144c..791208c8ed9 100644 --- a/README.md +++ b/README.md @@ -168,7 +168,7 @@ releases! 🌟 3. Start up the server using the pre-built Docker images: - > 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`. + > 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`. ```bash $ cd ragflow diff --git a/README_id.md b/README_id.md index 8131d379db9..0aa81f518d1 100644 --- a/README_id.md +++ b/README_id.md @@ -161,7 +161,7 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io). 3. Bangun image Docker pre-built dan jalankan server: - > 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. + > 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. ```bash $ cd ragflow diff --git a/README_ja.md b/README_ja.md index 1bc03d62884..f01c2cd800c 100644 --- a/README_ja.md +++ b/README_ja.md @@ -142,7 +142,7 @@ 3. ビルド済みの Docker イメージをビルドし、サーバーを起動する: - > 以下のコマンドは、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 と設定します。 + > 以下のコマンドは、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 と設定します。 ```bash $ cd ragflow diff --git a/README_ko.md b/README_ko.md index 9fcd26b88cf..88ba88b2865 100644 --- a/README_ko.md +++ b/README_ko.md @@ -147,7 +147,7 @@ 3. 미리 빌드된 Docker 이미지를 생성하고 서버를 시작하세요: - > 아래 명령어는 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로 설정합니다. + > 아래 명령어는 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로 설정합니다. ```bash $ cd ragflow diff --git a/README_zh.md b/README_zh.md index 70c062c8859..9284a67caf1 100644 --- a/README_zh.md +++ b/README_zh.md @@ -143,7 +143,7 @@ 3. 进入 **docker** 文件夹，利用提前编译好的 Docker 镜像启动服务器： - > 运行以下命令会自动下载 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` 完整发行版。 + > 运行以下命令会自动下载 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` 完整发行版。 ```bash $ cd ragflow diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 4543d703295..9c74ae73bc5 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -185,7 +185,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If 3. Use the pre-built Docker images and start up the server: :::tip NOTE - 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`. + 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`. ::: ```bash diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index 57f7c1826bc..7fcc3432719 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -2175,7 +2175,7 @@ curl --request POST \ ##### Request parameters - `agent_id`: (*Path parameter*) - The ID of the associated agent assistant. + The ID of the associated agent. #### Response @@ -2364,7 +2364,7 @@ curl --request POST \ ##### Request Parameters - `agent_id`: (*Path parameter*), `string` - The ID of the associated agent assistant. + The ID of the associated agent. - `"question"`: (*Body Parameter*), `string`, *Required* The question to start an AI-powered conversation. - `"stream"`: (*Body Parameter*), `boolean` diff --git a/docs/references/python_api_reference.md b/docs/references/python_api_reference.md index 7ba2b5ca8a9..5b16f19980d 100644 --- a/docs/references/python_api_reference.md +++ b/docs/references/python_api_reference.md @@ -1412,7 +1412,7 @@ Creates a session with the current agent. - Success: A `Session` object containing the following attributes: - `id`: `str` The auto-generated unique identifier of the created session. - `message`: `list[Message]` The messages of the created session assistant. Default: `[{"role": "assistant", "content": "Hi! I am your assistant，can I help you?"}]` - - `agent_id`: `str` The ID of the associated agent assistant. + - `agent_id`: `str` The ID of the associated agent. - Failure: `Exception` #### Examples