Skip to content

[Cron] Sync and update documentation #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/docs/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ RAGFlow utilizes MinIO as its object storage solution, leveraging its scalabilit
- `RAGFLOW-IMAGE`
The Docker image edition. Available editions:

- `infiniflow/ragflow:v0.17.2-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.17.2`: The RAGFlow Docker image with embedding models including:
- `infiniflow/ragflow:v0.18.0-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.18.0`: The RAGFlow Docker image with embedding models including:
- Built-in embedding models:
- `BAAI/bge-large-zh-v1.5`
- `maidalun1020/bce-embedding-base_v1`
Expand Down
2 changes: 1 addition & 1 deletion website/docs/develop/build_docker_image.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ After building the infiniflow/ragflow:nightly-slim image, you are ready to launc

1. Edit Docker Compose Configuration

Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.17.2-slim` to `infiniflow/ragflow:nightly-slim` to use the pre-built image.
Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.18.0-slim` to `infiniflow/ragflow:nightly-slim` to use the pre-built image.


2. Launch the Service
Expand Down
4 changes: 2 additions & 2 deletions website/docs/develop/mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ ragflow-server | / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
ragflow-server | /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
ragflow-server |
ragflow-server |
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 RAGFlow version: v0.17.2-285-gb2c299fa full
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 RAGFlow version: v0.18.0-285-gb2c299fa full
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 project base: /ragflow
ragflow-server | 2025-04-18 15:41:29,088 INFO 27 Current configs, from /ragflow/conf/service_conf.yaml:
ragflow-server | ragflow: {'host': '0.0.0.0', 'http_port': 9380}
Expand All @@ -130,7 +130,7 @@ ragflow-server | / / / __ `/ ___/ //_/ / __/ | |/_/ _ \/ ___/ / / / __/ __ \
ragflow-server | / / / /_/ (__ ) ,< / /____> </ __/ /__/ /_/ / /_/ /_/ / /
ragflow-server | /_/ \__,_/____/_/|_| /_____/_/|_|\___/\___/\__,_/\__/\____/_/
ragflow-server |
ragflow-server | 2025-04-18 15:41:34,501 INFO 32 TaskExecutor: RAGFlow version: v0.17.2-285-gb2c299fa full
ragflow-server | 2025-04-18 15:41:34,501 INFO 32 TaskExecutor: RAGFlow version: v0.18.0-285-gb2c299fa full
ragflow-server | 2025-04-18 15:41:34,501 INFO 32 Use Elasticsearch http://es01:9200 as the doc engine.
...
```
Expand Down
6 changes: 3 additions & 3 deletions website/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM6

### Which embedding models can be deployed locally?

RAGFlow offers two Docker image editions, `v0.17.2-slim` and `v0.17.2`:
RAGFlow offers two Docker image editions, `v0.18.0-slim` and `v0.18.0`:

- `infiniflow/ragflow:v0.17.2-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.17.2`: The RAGFlow Docker image with embedding models including:
- `infiniflow/ragflow:v0.18.0-slim` (default): The RAGFlow Docker image without embedding models.
- `infiniflow/ragflow:v0.18.0`: The RAGFlow Docker image with embedding models including:
- Built-in embedding models:
- `BAAI/bge-large-zh-v1.5`
- `BAAI/bge-reranker-v2-m3`
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/chat/start_chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You start an AI conversation by creating an assistant.
- If **Rerank model** is selected, the hybrid score system uses keyword similarity and reranker score, and the default weight assigned to the reranker score is 1-0.7=0.3.
- **Variable** refers to the variables (keys) to be used in the system prompt. `{knowledge}` is a reserved variable. Click **Add** to add more variables for the system prompt.
- If you are uncertain about the logic behind **Variable**, leave it *as-is*.
- As of v0.17.2, if you add custom variables here, the only way you can pass in their values is to call:
- As of v0.18.0, if you add custom variables here, the only way you can pass in their values is to call:
- HTTP method [Converse with chat assistant](../../references/http_api_reference.md#converse-with-chat-assistant), or
- Python method [Converse with chat assistant](../../references/python_api_reference.md#converse-with-chat-assistant).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/dataset/configure_knowledge_base.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ See [Run retrieval test](./run_retrieval_test.md) for details.

## Search for knowledge base

As of RAGFlow v0.17.2, the search feature is still in a rudimentary form, supporting only knowledge base search by name.
As of RAGFlow v0.18.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)

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/manage_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,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.17.2, bulk download is not supported, nor can you download an entire folder.
> As of RAGFlow v0.18.0, bulk download is not supported, nor can you download an entire folder.
10 changes: 5 additions & 5 deletions website/docs/guides/upgrade_ragflow.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,16 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
git clone https://github.com/infiniflow/ragflow.git
```

2. Switch to the latest, officially published release, e.g., `v0.17.2`:
2. Switch to the latest, officially published release, e.g., `v0.18.0`:

```bash
git checkout -f v0.17.2
git checkout -f v0.18.0
```

3. Update **ragflow/docker/.env** as follows:

```bash
RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.2
RAGFLOW_IMAGE=infiniflow/ragflow:v0.18.0
```

4. Update the RAGFlow image and restart RAGFlow:
Expand All @@ -92,10 +92,10 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag
1. From an environment with Internet access, pull the required Docker image.
2. Save the Docker image to a **.tar** file.
```bash
docker save -o ragflow.v0.17.2.tar infiniflow/ragflow:v0.17.2
docker save -o ragflow.v0.18.0.tar infiniflow/ragflow:v0.18.0
```
3. Copy the **.tar** file to the target server.
4. Load the **.tar** file into Docker:
```bash
docker load -i ragflow.v0.17.2.tar
docker load -i ragflow.v0.18.0.tar
```
10 changes: 5 additions & 5 deletions website/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If

`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 abnormal behaviors, and the system will throw out-of-memory errors when a process reaches the limitation.

RAGFlow v0.17.2 uses Elasticsearch or [Infinity](https://github.com/infiniflow/infinity) for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.
RAGFlow v0.18.0 uses Elasticsearch or [Infinity](https://github.com/infiniflow/infinity) for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.

<Tabs
defaultValue="linux"
Expand Down Expand Up @@ -179,13 +179,13 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
```bash
$ git clone https://github.com/infiniflow/ragflow.git
$ cd ragflow/docker
$ git checkout -f v0.17.2
$ git checkout -f v0.18.0
```

3. Use the pre-built Docker images and start up the server:

:::tip NOTE
The command below downloads the `v0.17.2-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.17.2-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.17.2` for the full edition `v0.17.2`.
The command below downloads the `v0.18.0-slim` edition of the RAGFlow Docker image. Refer to the following table for descriptions of different RAGFlow editions. To download a RAGFlow edition different from `v0.18.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.18.0` for the full edition `v0.18.0`.
:::

```bash
Expand All @@ -202,8 +202,8 @@ This section provides instructions on setting up the RAGFlow server on Linux. If

| RAGFlow image tag | Image size (GB) | Has embedding models and Python packages? | Stable? |
| ------------------- | --------------- | ----------------------------------------- | ------------------------ |
| `v0.17.2` | &approx;9 | :heavy_check_mark: | Stable release |
| `v0.17.2-slim` | &approx;2 | ❌ | Stable release |
| `v0.18.0` | &approx;9 | :heavy_check_mark: | Stable release |
| `v0.18.0-slim` | &approx;2 | ❌ | Stable release |
| `nightly` | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
| `nightly-slim` | &approx;2 | ❌ | *Unstable* nightly build |

Expand Down
13 changes: 1 addition & 12 deletions website/docs/references/http_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,6 @@ curl --request POST \
- `"presentation"`: Presentation
- `"picture"`: Picture
- `"one"`: One
- `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
- `"email"`: Email

Expand All @@ -409,10 +408,6 @@ curl --request POST \
- If `"chunk_method"` is `"qa"`, `"manuel"`, `"paper"`, `"book"`, `"laws"`, or `"presentation"`, the `"parser_config"` object contains the following attribute:
- `"raptor"`: Raptor-specific settings. Defaults to: `{"use_raptor": false}`.
- If `"chunk_method"` is `"table"`, `"picture"`, `"one"`, or `"email"`, `"parser_config"` is an empty JSON object.
- If `"chunk_method"` is `"knowledge_graph"`, the `"parser_config"` object contains the following attributes:
- `"chunk_token_count"`: Defaults to `128`.
- `"delimiter"`: Defaults to `"\n"`.
- `"entity_types"`: Defaults to `["organization","person","location","event","time"]`

#### Response

Expand Down Expand Up @@ -573,8 +568,6 @@ curl --request PUT \
- `"picture"`: Picture
- `"one"`:One
- `"email"`: Email
- `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!

#### Response

Expand Down Expand Up @@ -655,7 +648,7 @@ Success:
"id": "6e211ee0723611efa10a0242ac120007",
"language": "English",
"name": "mysql",
"chunk_method": "knowledge_graph",
"chunk_method": "naive",
"parser_config": {
"chunk_token_num": 8192,
"delimiter": "\\n",
Expand Down Expand Up @@ -841,10 +834,6 @@ curl --request PUT \
- If `"chunk_method"` is `"qa"`, `"manuel"`, `"paper"`, `"book"`, `"laws"`, or `"presentation"`, the `"parser_config"` object contains the following attribute:
- `"raptor"`: Raptor-specific settings. Defaults to: `{"use_raptor": false}`.
- If `"chunk_method"` is `"table"`, `"picture"`, `"one"`, or `"email"`, `"parser_config"` is an empty JSON object.
- If `"chunk_method"` is `"knowledge_graph"`, the `"parser_config"` object contains the following attributes:
- `"chunk_token_count"`: Defaults to `128`.
- `"delimiter"`: Defaults to `"\n"`.
- `"entity_types"`: Defaults to `["organization","person","location","event","time"]`

#### Response

Expand Down
4 changes: 0 additions & 4 deletions website/docs/references/python_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,6 @@ The chunking method of the dataset to create. Available options:
- `"presentation"`: Presentation
- `"picture"`: Picture
- `"one"`: One
- `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
- `"email"`: Email

##### parser_config
Expand Down Expand Up @@ -398,8 +396,6 @@ A dictionary representing the attributes to update, with the following keys:
- `"presentation"`: Presentation
- `"picture"`: Picture
- `"one"`: One
- `"knowledge_graph"`: Knowledge Graph
Ensure your LLM is properly configured on the **Settings** page before selecting this. Please also note that Knowledge Graph consumes a large number of Tokens!
- `"email"`: Email
- `"parser_config"`: `dict[str, Any]` The parsing configuration for the document. Its attributes vary based on the selected `"chunk_method"`:
- `"chunk_method"`=`"naive"`:
Expand Down
8 changes: 8 additions & 0 deletions website/versioned_docs/version-v0.18.0/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Get Started",
"position": 1,
"link": {
"type": "generated-index",
"description": "RAGFlow Quick Start"
}
}
Loading