writinwaters
commited on
Commit
·
f6ddf72
1
Parent(s):
e23293e
Added release notes v0.12.0 (#3711)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
- docs/guides/upgrade_ragflow.mdx +5 -1
- docs/release_notes.md +41 -4
docs/guides/upgrade_ragflow.mdx
CHANGED
@@ -11,7 +11,9 @@ Upgrade RAGFlow to `dev-slim`/`dev` or the latest, published release.
|
|
11 |
|
12 |
## Upgrade RAGFlow to `dev-slim`/`dev`, the most recent, tested Docker image
|
13 |
|
14 |
-
`dev-slim` refers to the RAGFlow Docker image *without* embedding models, while `dev` refers to the RAGFlow Docker image with embedding models. For details on their differences, see
|
|
|
|
|
15 |
|
16 |
1. Clone the repo
|
17 |
|
@@ -52,6 +54,8 @@ RAGFLOW_IMAGE=infiniflow/ragflow:dev
|
|
52 |
|
53 |
## Upgrade RAGFlow to the most recent, officially published release
|
54 |
|
|
|
|
|
55 |
1. Clone the repo
|
56 |
|
57 |
```bash
|
|
|
11 |
|
12 |
## Upgrade RAGFlow to `dev-slim`/`dev`, the most recent, tested Docker image
|
13 |
|
14 |
+
`dev-slim` refers to the RAGFlow Docker image *without* embedding models, while `dev` refers to the RAGFlow Docker image with embedding models. For details on their differences, see [ragflow/docker/.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env).
|
15 |
+
|
16 |
+
To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker image:
|
17 |
|
18 |
1. Clone the repo
|
19 |
|
|
|
54 |
|
55 |
## Upgrade RAGFlow to the most recent, officially published release
|
56 |
|
57 |
+
To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker image:
|
58 |
+
|
59 |
1. Clone the repo
|
60 |
|
61 |
```bash
|
docs/release_notes.md
CHANGED
@@ -24,14 +24,14 @@ Released on November 26, 2024.
|
|
24 |
- Replaces Redis with Valkey.
|
25 |
- Adds three new UI languages (*contributed by the community*): Indonesian, Spanish, and Vietnamese.
|
26 |
|
27 |
-
###
|
28 |
|
29 |
As of this release, **service_config.yaml.template** replaces **service_config.yaml** for configuring backend services. Upon Docker container startup, the environment variables defined in this template file are automatically populated and a **service_config.yaml** is auto-generated from it. [#3341](https://github.com/infiniflow/ragflow/pull/3341)
|
30 |
|
31 |
This approach eliminates the need to manually update **service_config.yaml** after making changes to **.env**, facilitating dynamic environment configurations.
|
32 |
|
33 |
-
:::danger
|
34 |
-
Ensure that you [upgrade both your code and Docker image to this release](https://ragflow.io/docs/dev/upgrade_ragflow#upgrade-ragflow-to-the-most-recent-officially-published-release) before trying this new approach.
|
35 |
:::
|
36 |
|
37 |
### Related APIs
|
@@ -56,6 +56,10 @@ Ensure that you [upgrade both your code and Docker image to this release](https:
|
|
56 |
|
57 |
## v0.13.0
|
58 |
|
|
|
|
|
|
|
|
|
59 |
- Adds the team management functionality for all users.
|
60 |
- Updates the Agent UI to improve usability.
|
61 |
- Adds support for Markdown chunking in the **General** chunk method.
|
@@ -78,4 +82,37 @@ pip install ragflow-sdk==0.13.0
|
|
78 |
|
79 |
- [Acquire a RAGFlow API key](https://ragflow.io/docs/dev/acquire_ragflow_api_key)
|
80 |
- [HTTP API Reference](https://ragflow.io/docs/dev/http_api_reference)
|
81 |
-
- [Python API Reference](https://ragflow.io/docs/dev/python_api_reference)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
24 |
- Replaces Redis with Valkey.
|
25 |
- Adds three new UI languages (*contributed by the community*): Indonesian, Spanish, and Vietnamese.
|
26 |
|
27 |
+
### Compatibility changes
|
28 |
|
29 |
As of this release, **service_config.yaml.template** replaces **service_config.yaml** for configuring backend services. Upon Docker container startup, the environment variables defined in this template file are automatically populated and a **service_config.yaml** is auto-generated from it. [#3341](https://github.com/infiniflow/ragflow/pull/3341)
|
30 |
|
31 |
This approach eliminates the need to manually update **service_config.yaml** after making changes to **.env**, facilitating dynamic environment configurations.
|
32 |
|
33 |
+
:::danger IMPORTANT
|
34 |
+
Ensure that you [upgrade **both** your code **and** Docker image to this release](https://ragflow.io/docs/dev/upgrade_ragflow#upgrade-ragflow-to-the-most-recent-officially-published-release) before trying this new approach.
|
35 |
:::
|
36 |
|
37 |
### Related APIs
|
|
|
56 |
|
57 |
## v0.13.0
|
58 |
|
59 |
+
Released on October 31, 2024.
|
60 |
+
|
61 |
+
### New features
|
62 |
+
|
63 |
- Adds the team management functionality for all users.
|
64 |
- Updates the Agent UI to improve usability.
|
65 |
- Adds support for Markdown chunking in the **General** chunk method.
|
|
|
82 |
|
83 |
- [Acquire a RAGFlow API key](https://ragflow.io/docs/dev/acquire_ragflow_api_key)
|
84 |
- [HTTP API Reference](https://ragflow.io/docs/dev/http_api_reference)
|
85 |
+
- [Python API Reference](https://ragflow.io/docs/dev/python_api_reference)
|
86 |
+
|
87 |
+
## v0.12.0
|
88 |
+
|
89 |
+
Released on September 30, 2024.
|
90 |
+
|
91 |
+
### New features
|
92 |
+
|
93 |
+
- Offers slim editions of RAGFlow's Docker images, which do not include built-in BGE/BCE embedding or reranking models.
|
94 |
+
- Improves the results of multi-round dialogues.
|
95 |
+
- Enables users to remove added LLM vendors.
|
96 |
+
- Adds support for OpenTTS and SparkTTS models.
|
97 |
+
- Implements an **Excel to HTML** toggle in the **General** chunk method, allowing users to parse an spreadsheet into either an HTML table or key-value pairs by row.
|
98 |
+
- Adds agent tools **YahooFance** and **Jin10**.
|
99 |
+
- Adds a template for an investment advisor agent.
|
100 |
+
|
101 |
+
### Compatibility changes
|
102 |
+
|
103 |
+
As of this release, RAGFlow offers slim editions of its Docker images to improve the experience for users with limited Internet access. A slim edition of RAGFlow's Docker image does not include built-in BGE/BCE embedding models and has a size of about 1GB; a full edition of RAGFlow is approximately 9GB and includes both built-in embedding models and embedding models that will be downloaded once you select them in the RAGFlow UI.
|
104 |
+
|
105 |
+
The default Docker image edition is `dev-slim`. The following list clarifies the differences between various editions:
|
106 |
+
|
107 |
+
- `dev-slim`: The slim edition of the most recent tested Docker image.
|
108 |
+
- `v0.12.0-slim`: The slim edition of the most recent **officially released** Docker image.
|
109 |
+
- `dev`: The full edition of the most recent tested Docker image.
|
110 |
+
- `v0.12.0`: The full edition of the most recent **officially released** Docker image.
|
111 |
+
|
112 |
+
See [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow) for instructions on upgrading.
|
113 |
+
|
114 |
+
### Documentation
|
115 |
+
|
116 |
+
#### Added documents
|
117 |
+
|
118 |
+
- [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow)
|