From 7ae8828e616b794f6725cae9d0fd02f36d4c543d Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Thu, 28 Nov 2024 14:57:50 +0800 Subject: [PATCH] Added release notes v0.12.0 (#3711) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docs/guides/upgrade_ragflow.mdx | 6 ++++- docs/release_notes.md | 45 ++++++++++++++++++++++++++++++--- 2 files changed, 46 insertions(+), 5 deletions(-) diff --git a/docs/guides/upgrade_ragflow.mdx b/docs/guides/upgrade_ragflow.mdx index bdb5218ad..31d19d91d 100644 --- a/docs/guides/upgrade_ragflow.mdx +++ b/docs/guides/upgrade_ragflow.mdx @@ -11,7 +11,9 @@ Upgrade RAGFlow to `dev-slim`/`dev` or the latest, published release. ## Upgrade RAGFlow to `dev-slim`/`dev`, the most recent, tested Docker image -`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 **docker/.env**. +`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). + +To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker image: 1. Clone the repo @@ -52,6 +54,8 @@ RAGFLOW_IMAGE=infiniflow/ragflow:dev ## Upgrade RAGFlow to the most recent, officially published release +To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker image: + 1. Clone the repo ```bash diff --git a/docs/release_notes.md b/docs/release_notes.md index 8b489a353..a05515c72 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -24,14 +24,14 @@ Released on November 26, 2024. - Replaces Redis with Valkey. - Adds three new UI languages (*contributed by the community*): Indonesian, Spanish, and Vietnamese. -### Compatability changes +### Compatibility changes 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) This approach eliminates the need to manually update **service_config.yaml** after making changes to **.env**, facilitating dynamic environment configurations. -:::danger -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. +:::danger IMPORTANT +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. ::: ### Related APIs @@ -56,6 +56,10 @@ Ensure that you [upgrade both your code and Docker image to this release](https: ## v0.13.0 +Released on October 31, 2024. + +### New features + - Adds the team management functionality for all users. - Updates the Agent UI to improve usability. - Adds support for Markdown chunking in the **General** chunk method. @@ -78,4 +82,37 @@ pip install ragflow-sdk==0.13.0 - [Acquire a RAGFlow API key](https://ragflow.io/docs/dev/acquire_ragflow_api_key) - [HTTP API Reference](https://ragflow.io/docs/dev/http_api_reference) -- [Python API Reference](https://ragflow.io/docs/dev/python_api_reference) \ No newline at end of file +- [Python API Reference](https://ragflow.io/docs/dev/python_api_reference) + +## v0.12.0 + +Released on September 30, 2024. + +### New features + +- Offers slim editions of RAGFlow's Docker images, which do not include built-in BGE/BCE embedding or reranking models. +- Improves the results of multi-round dialogues. +- Enables users to remove added LLM vendors. +- Adds support for OpenTTS and SparkTTS models. +- 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. +- Adds agent tools **YahooFance** and **Jin10**. +- Adds a template for an investment advisor agent. + +### Compatibility changes + +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. + +The default Docker image edition is `dev-slim`. The following list clarifies the differences between various editions: + +- `dev-slim`: The slim edition of the most recent tested Docker image. +- `v0.12.0-slim`: The slim edition of the most recent **officially released** Docker image. +- `dev`: The full edition of the most recent tested Docker image. +- `v0.12.0`: The full edition of the most recent **officially released** Docker image. + +See [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow) for instructions on upgrading. + +### Documentation + +#### Added documents + +- [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow) \ No newline at end of file