Skip to content

Commit

Permalink
UI updates + RAGFlow image description (#3995)
Browse files Browse the repository at this point in the history 
### What problem does this PR solve?



### Type of change

- [x] Documentation Update
  • Loading branch information
@writinwaters
writinwaters authored Dec 12, 2024
1 parent 6d19294 commit bb8f97c
Show file tree
Hide file tree
Showing 11 changed files with 76 additions and 77 deletions.
17 changes: 8 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,15 +175,14 @@ releases! 🌟
$ docker compose -f docker/docker-compose.yml up -d
```
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
| v0.14.1 | ~9 GB | YES | stable release |
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
4. Check the server status after having the server up and running:
Expand Down
18 changes: 8 additions & 10 deletions README_id.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,16 +168,14 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
$ docker compose -f docker/docker-compose.yml up -d
```

| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
| v0.14.1 | ~9 GB | YES | stable release |
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |


| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ≈2 | ❌ | *Unstable* nightly build |

4. Periksa status server setelah server aktif dan berjalan:

Expand Down
17 changes: 8 additions & 9 deletions README_ja.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,15 +148,14 @@
$ docker compose -f docker/docker-compose.yml up -d
```

| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
| v0.14.1 | ~9 GB | YES | stable release |
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |

| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ≈2 | ❌ | *Unstable* nightly build |

4. サーバーを立ち上げた後、サーバーの状態を確認する:

Expand Down
20 changes: 8 additions & 12 deletions README_ko.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,19 +151,15 @@
$ cd ragflow
$ docker compose -f docker/docker-compose.yml up -d
```


| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
| v0.14.1 | ~9 GB | YES | stable release |
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |



| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ≈2 | ❌ | *Unstable* nightly build |

4. 서버가 시작된 후 서버 상태를 확인하세요:

Expand Down
17 changes: 8 additions & 9 deletions README_zh.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,15 +149,14 @@
$ docker compose -f docker/docker-compose.yml up -d
```

| RAGFLOW_IMAGE tag in docker/.env | 尺寸 | 内置 embedding 模型和相关 Python 库? | 描述 |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
| v0.14.1 | ~9 GB | YES | stable release |
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |

| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ≈2 | ❌ | *Unstable* nightly build |

4. 服务器启动成功后再次确认服务器状态：

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/agentic_rag/general_purpose_chatbot.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ RAGFlow's no-code editor spares you the trouble of coding, making agent developm
Here’s a breakdown of each component and its role and requirements in the chatbot template:

- **Begin**
- Function: Sets the opening greeting for the user.
- Function: Sets an opening greeting for users.
- Purpose: Establishes a welcoming atmosphere and prepares the user for interaction.

- **Interact**
Expand Down
28 changes: 18 additions & 10 deletions docs/quickstart.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ slug: /
# Quick start
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import APITable from '@site/src/components/APITable';

RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. When integrated with LLMs, it is capable of providing truthful question-answering capabilities, backed by well-founded citations from various complex formatted data.

Expand All @@ -19,7 +20,7 @@ This quick start guide describes a general process from:
:::danger IMPORTANT
We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM.

If you are on an ARM platform, following [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image.
If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image.
:::

## Prerequisites
Expand Down Expand Up @@ -189,15 +190,22 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
$ docker compose -f docker/docker-compose.yml up -d
```

| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- |
| v0.14.1 | ~9 GB | YES | stable release |
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |

```mdx-code-block
<APITable>
```

| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | &approx;2 | ❌ | Stable release |
| v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
| nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |

```mdx-code-block
</APITable>
```

:::tip NOTE
A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.
Expand Down
4 changes: 2 additions & 2 deletions docs/references/http_api_reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -887,7 +887,7 @@ Failure:

---

## Add chunks
## Add chunk

**POST** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks`

Expand All @@ -913,7 +913,7 @@ curl --request POST \
--header 'Authorization: Bearer <YOUR_API_KEY>' \
--data '
{
"content": "<SOME_CHUNK_CONTENT_HERE>"
"content": "<CHUNK_CONTENT_HERE>"
}'
```

Expand Down
2 changes: 1 addition & 1 deletion docs/release_notes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ Released on May 31, 2024.
:::danger IMPORTANT
While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM.

If you are on an ARM platform, following [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image.
If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image.
:::

### Related APIs
Expand Down
Loading

0 comments on commit bb8f97c

Please sign in to comment.