You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

release_notes.md 17KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. ---
  2. sidebar_position: 2
  3. slug: /release_notes
  4. ---
  5. # Releases
  6. Key features, improvements and bug fixes in the latest releases.
  7. ## v0.17.1
  8. Released on March 3, 2025.
  9. ### New features
  10. - AI chat: Implements Deep Research for agentic reasoning. To activate this, enable the **Reasoning** toggle under the **Prompt Engine** tab of your chat assistant dialogue.
  11. - AI chat: Leverages Tavily-based web search to enhance contexts in agentic reasoning. To activate this, enter the correct Tavily API key under the **Assistant Setting** tab of your chat assistant dialogue.
  12. - AI chat: Supports starting a chat without specifying knowledge bases.
  13. - AI chat: HTML files can also be previewed and referenced, in addition to PDF files.
  14. - Dataset: Adds a **Document parser** dropdown menu to dataset configurations. This includes a DeepDoc model option, which is time-consuming, a much faster **naive** option (plain text), which skips DLA (Document Layout Analysis), OCR (Optical Character Recognition), and TSR (Table Structure Recognition) tasks, and several currently *experimental* large model options.
  15. - Agent component: **(x)** or a forward slash `/` can be used to insert available keys (variables) in the system prompt field of the **Generate** or **Template** component.
  16. - Object storage: Supports using Aliyun OSS (Object Storage Service) as a file storage option.
  17. - Models: Updates the supported model list for Tongyi-Qianwen, adding DeepSeek-specific models; adds ModelScope as a model provider.
  18. - APIs: Document metadata can be updated through an API.
  19. The following diagram illustrates the workflow of RAGFlow's Deep Research:
  20. ![Image](https://github.com/user-attachments/assets/f65d4759-4f09-4d9d-9549-c0e1fe907525)
  21. The following is a screenshot of a conversation that integrates Deep Research:
  22. ![Image](https://github.com/user-attachments/assets/165b88ff-1f5d-4fb8-90e2-c836b25e32e9)
  23. ### Related APIs
  24. #### HTTP APIs
  25. Adds a body parameter `"meta_fields"` to the [Update document](./references/http_api_reference.md#update-document) method.
  26. #### Python APIs
  27. Adds a key option `"meta_fields"` to the [Update document](./references/python_api_reference.md#update-document) method.
  28. ### Documentation
  29. #### Added documents
  30. [Run retrieval test](./guides/dataset/run_retrieval_test.md)
  31. ## v0.16.0
  32. Released on February 6, 2025.
  33. ### New features
  34. - Supports DeepSeek R1 and DeepSeek V3.
  35. - GraphRAG refactor: Knowledge graph is dynamically built on an entire knowledge base (dataset) rather than on an individual file, and automatically updated when a newly uploaded file starts parsing. See [here](https://ragflow.io/docs/dev/construct_knowledge_graph).
  36. - Adds an **Iteration** agent component and a **Research report generator** agent template. See [here](./guides/agent/agent_component_reference/iteration.mdx).
  37. - New UI language: Portuguese.
  38. - Allows setting metadata for a specific file in a knowledge base to enhance AI-powered chats. See [here](./guides/dataset/set_metadata.md).
  39. - Upgrades RAGFlow's document engine [Infinity](https://github.com/infiniflow/infinity) to v0.6.0.dev3.
  40. - Supports GPU acceleration for DeepDoc (see [docker-compose-gpu.yml](https://github.com/infiniflow/ragflow/blob/main/docker/docker-compose-gpu.yml)).
  41. - Supports creating and referencing a **Tag** knowledge base as a key milestone towards bridging the semantic gap between query and response.
  42. :::danger IMPORTANT
  43. The **Tag knowledge base** feature is *unavailable* on the [Infinity](https://github.com/infiniflow/infinity) document engine.
  44. :::
  45. ### Documentation
  46. #### Added documents
  47. - [Construct knowledge graph](./guides/dataset/construct_knowledge_graph.md)
  48. - [Set metadata](./guides/dataset/set_metadata.md)
  49. - [Begin component](./guides/agent/agent_component_reference/begin.mdx)
  50. - [Generate component](./guides/agent/agent_component_reference/generate.mdx)
  51. - [Interact component](./guides/agent/agent_component_reference/interact.mdx)
  52. - [Retrieval component](./guides/agent/agent_component_reference/retrieval.mdx)
  53. - [Categorize component](./guides/agent/agent_component_reference/categorize.mdx)
  54. - [Keyword component](./guides/agent/agent_component_reference/keyword.mdx)
  55. - [Message component](./guides/agent/agent_component_reference/message.mdx)
  56. - [Rewrite component](./guides/agent/agent_component_reference/rewrite.mdx)
  57. - [Switch component](./guides/agent/agent_component_reference/switch.mdx)
  58. - [Concentrator component](./guides/agent/agent_component_reference/concentrator.mdx)
  59. - [Template component](./guides/agent/agent_component_reference/template.mdx)
  60. - [Iteration component](./guides/agent/agent_component_reference/iteration.mdx)
  61. - [Note component](./guides/agent/agent_component_reference/note.mdx)
  62. ## v0.15.1
  63. Released on December 25, 2024.
  64. ### Upgrades
  65. - Upgrades RAGFlow's document engine [Infinity](https://github.com/infiniflow/infinity) to v0.5.2.
  66. - Enhances the log display of document parsing status.
  67. ### Fixed issues
  68. This release fixes the following issues:
  69. - The `SCORE not found` and `position_int` errors returned by [Infinity](https://github.com/infiniflow/infinity).
  70. - Once an embedding model in a specific knowledge base is changed, embedding models in other knowledge bases can no longer be changed.
  71. - Slow response in question-answering and AI search due to repetitive loading of the embedding model.
  72. - Fails to parse documents with RAPTOR.
  73. - Using the **Table** parsing method results in information loss.
  74. - Miscellaneous API issues.
  75. ### Related APIs
  76. #### HTTP APIs
  77. Adds an optional parameter `"user_id"` to the following APIs:
  78. - [Create session with chat assistant](https://ragflow.io/docs/dev/http_api_reference#create-session-with-chat-assistant)
  79. - [Update chat assistant's session](https://ragflow.io/docs/dev/http_api_reference#update-chat-assistants-session)
  80. - [List chat assistant's sessions](https://ragflow.io/docs/dev/http_api_reference#list-chat-assistants-sessions)
  81. - [Create session with agent](https://ragflow.io/docs/dev/http_api_reference#create-session-with-agent)
  82. - [Converse with chat assistant](https://ragflow.io/docs/dev/http_api_reference#converse-with-chat-assistant)
  83. - [Converse with agent](https://ragflow.io/docs/dev/http_api_reference#converse-with-agent)
  84. - [List agent sessions](https://ragflow.io/docs/dev/http_api_reference#list-agent-sessions)
  85. ## v0.15.0
  86. Released on December 18, 2024.
  87. ### New features
  88. - Introduces additional Agent-specific APIs.
  89. - Supports using page rank score to improve retrieval performance when searching across multiple knowledge bases.
  90. - Offers an iframe in Chat and Agent to facilitate the integration of RAGFlow into your webpage.
  91. - Adds a Helm chart for deploying RAGFlow on Kubernetes.
  92. - Supports importing or exporting an agent in JSON format.
  93. - Supports step run for Agent components/tools.
  94. - Adds a new UI language: Japanese.
  95. - Supports resuming GraphRAG and RAPTOR from a failure, enhancing task management resilience.
  96. - Adds more Mistral models.
  97. - Adds a dark mode to the UI, allowing users to toggle between light and dark themes.
  98. ### Improvements
  99. - Upgrades the Document Layout Analysis model in DeepDoc.
  100. - Significantly enhances the retrieval performance when using [Infinity](https://github.com/infiniflow/infinity) as document engine.
  101. ### Related APIs
  102. #### HTTP APIs
  103. - [List agent sessions](https://ragflow.io/docs/dev/http_api_reference#list-agent-sessions)
  104. - [List agents](https://ragflow.io/docs/dev/http_api_reference#list-agents)
  105. #### Python APIs
  106. - [List agent sessions](https://ragflow.io/docs/dev/python_api_reference#list-agent-sessions)
  107. - [List agents](https://ragflow.io/docs/dev/python_api_reference#list-agents)
  108. ## v0.14.1
  109. Released on November 29, 2024.
  110. ### Improvements
  111. Adds [Infinity's configuration file](https://github.com/infiniflow/ragflow/blob/main/docker/infinity_conf.toml) to facilitate integration and customization of [Infinity](https://github.com/infiniflow/infinity) as a document engine. From this release onwards, updates to Infinity's configuration can be made directly within RAGFlow and will take effect immediately after restarting RAGFlow using `docker compose`. [#3715](https://github.com/infiniflow/ragflow/pull/3715)
  112. ### Fixed issues
  113. This release fixes the following issues:
  114. - Unable to display or edit content of a chunk after clicking it.
  115. - A `'Not found'` error in Elasticsearch.
  116. - Chinese text becoming garbled during parsing.
  117. - A compatibility issue with Polars.
  118. - A compatibility issue between Infinity and GraphRAG.
  119. ## v0.14.0
  120. Released on November 26, 2024.
  121. ### New features
  122. - Supports [Infinity](https://github.com/infiniflow/infinity) or Elasticsearch (default) as document engine for vector storage and full-text indexing. [#2894](https://github.com/infiniflow/ragflow/pull/2894)
  123. - Enhances user experience by adding more variables to the Agent and implementing auto-saving.
  124. - Adds a three-step translation agent template, inspired by [Andrew Ng's translation agent](https://github.com/andrewyng/translation-agent).
  125. - Adds an SEO-optimized blog writing agent template.
  126. - Provides HTTP and Python APIs for conversing with an agent.
  127. - Supports the use of English synonyms during retrieval processes.
  128. - Optimizes term weight calculations, reducing the retrieval time by 50%.
  129. - Improves task executor monitoring with additional performance indicators.
  130. - Replaces Redis with Valkey.
  131. - Adds three new UI languages (*contributed by the community*): Indonesian, Spanish, and Vietnamese.
  132. ### Compatibility changes
  133. 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)
  134. This approach eliminates the need to manually update **service_config.yaml** after making changes to **.env**, facilitating dynamic environment configurations.
  135. :::danger IMPORTANT
  136. 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.
  137. :::
  138. ### Related APIs
  139. #### HTTP APIs
  140. - [Create session with agent](https://ragflow.io/docs/dev/http_api_reference#create-session-with-agent)
  141. - [Converse with agent](https://ragflow.io/docs/dev/http_api_reference#converse-with-agent)
  142. #### Python APIs
  143. - [Create session with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent)
  144. - [Converse with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent)
  145. ### Documentation
  146. #### Added documents
  147. - [Configurations](https://ragflow.io/docs/dev/configurations)
  148. - [Manage team members](https://ragflow.io/docs/dev/manage_team_members)
  149. - [Run health check on RAGFlow's dependencies](https://ragflow.io/docs/dev/run_health_check)
  150. ## v0.13.0
  151. Released on October 31, 2024.
  152. ### New features
  153. - Adds the team management functionality for all users.
  154. - Updates the Agent UI to improve usability.
  155. - Adds support for Markdown chunking in the **General** chunk method.
  156. - Introduces an **invoke** tool within the Agent UI.
  157. - Integrates support for Dify's knowledge base API.
  158. - Adds support for GLM4-9B and Yi-Lightning models.
  159. - Introduces HTTP and Python APIs for dataset management, file management within dataset, and chat assistant management.
  160. :::tip NOTE
  161. To download RAGFlow's Python SDK:
  162. ```bash
  163. pip install ragflow-sdk==0.13.0
  164. ```
  165. :::
  166. ### Documentation
  167. #### Added documents
  168. - [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md)
  169. - [HTTP API Reference](./references/http_api_reference.md)
  170. - [Python API Reference](./references/python_api_reference.md)
  171. ## v0.12.0
  172. Released on September 30, 2024.
  173. ### New features
  174. - Offers slim editions of RAGFlow's Docker images, which do not include built-in BGE/BCE embedding or reranking models.
  175. - Improves the results of multi-round dialogues.
  176. - Enables users to remove added LLM vendors.
  177. - Adds support for **OpenTTS** and **SparkTTS** models.
  178. - Implements an **Excel to HTML** toggle in the **General** chunk method, allowing users to parse a spreadsheet into either HTML tables or key-value pairs by row.
  179. - Adds agent tools **YahooFinance** and **Jin10**.
  180. - Adds an investment advisor agent template.
  181. ### Compatibility changes
  182. 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.
  183. The default Docker image edition is `nightly-slim`. The following list clarifies the differences between various editions:
  184. - `nightly-slim`: The slim edition of the most recent tested Docker image.
  185. - `v0.12.0-slim`: The slim edition of the most recent **officially released** Docker image.
  186. - `nightly`: The full edition of the most recent tested Docker image.
  187. - `v0.12.0`: The full edition of the most recent **officially released** Docker image.
  188. See [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow) for instructions on upgrading.
  189. ### Documentation
  190. #### Added documents
  191. - [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow)
  192. ## v0.11.0
  193. Released on September 14, 2024.
  194. ### New features
  195. - Introduces an AI search interface within the RAGFlow UI.
  196. - Supports audio output via **FishAudio** or **Tongyi Qwen TTS**.
  197. - Allows the use of Postgres for metadata storage, in addition to MySQL.
  198. - Supports object storage options with S3 or Azure Blob.
  199. - Supports model vendors: **Anthropic**, **Voyage AI**, and **Google Cloud**.
  200. - Supports the use of **Tencent Cloud ASR** for audio content recognition.
  201. - Adds finance-specific agent components: **WenCai**, **AkShare**, **YahooFinance**, and **TuShare**.
  202. - Adds a medical consultant agent template.
  203. - Supports running retrieval benchmarking on the following datasets:
  204. - [ms_marco_v1.1](https://huggingface.co/datasets/microsoft/ms_marco)
  205. - [trivia_qa](https://huggingface.co/datasets/mandarjoshi/trivia_qa)
  206. - [miracl](https://huggingface.co/datasets/miracl/miracl)
  207. ## v0.10.0
  208. Released on August 26, 2024.
  209. ### New features
  210. - Introduces a text-to-SQL template in the Agent UI.
  211. - Implements Agent APIs.
  212. - Incorporates monitoring for the task executor.
  213. - Introduces Agent tools **GitHub**, **DeepL**, **BaiduFanyi**, **QWeather**, and **GoogleScholar**.
  214. - Supports chunking of EML files.
  215. - Supports more LLMs or model services: **GPT-4o-mini**, **PerfXCloud**, **TogetherAI**, **Upstage**, **Novita.AI**, **01.AI**, **SiliconFlow**, **PPIO**, **XunFei Spark**, **Baidu Yiyan**, and **Tencent Hunyuan**.
  216. ## v0.9.0
  217. Released on August 6, 2024.
  218. ### New features
  219. - Supports GraphRAG as a chunk method.
  220. - Introduces Agent component **Keyword** and search tools, including **Baidu**, **DuckDuckGo**, **PubMed**, **Wikipedia**, **Bing**, and **Google**.
  221. - Supports speech-to-text recognition for audio files.
  222. - Supports model vendors **Gemini** and **Groq**.
  223. - Supports inference frameworks, engines, and services including **LM studio**, **OpenRouter**, **LocalAI**, and **Nvidia API**.
  224. - Supports using reranker models in Xinference.
  225. ## v0.8.0
  226. Released on July 8, 2024.
  227. ### New features
  228. - Supports Agentic RAG, enabling graph-based workflow construction for RAG and agents.
  229. - Supports model vendors **Mistral**, **MiniMax**, **Bedrock**, and **Azure OpenAI**.
  230. - Supports DOCX files in the MANUAL chunk method.
  231. - Supports DOCX, MD, and PDF files in the Q&A chunk method.
  232. ## v0.7.0
  233. Released on May 31, 2024.
  234. ### New features
  235. - Supports the use of reranker models.
  236. - Integrates reranker and embedding models: [BCE](https://github.com/netease-youdao/BCEmbedding), [BGE](https://github.com/FlagOpen/FlagEmbedding), and [Jina](https://jina.ai/embeddings/).
  237. - Supports LLMs Baichuan and VolcanoArk.
  238. - Implements [RAPTOR](https://arxiv.org/html/2401.18059v1) for improved text retrieval.
  239. - Supports HTML files in the GENERAL chunk method.
  240. - Provides HTTP and Python APIs for deleting documents by ID.
  241. - Supports ARM64 platforms.
  242. :::danger IMPORTANT
  243. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM.
  244. If you are on an ARM platform, follow [this guide](./develop/build_docker_image.mdx) to build a RAGFlow Docker image.
  245. :::
  246. ### Related APIs
  247. #### HTTP API
  248. - [Delete documents](https://ragflow.io/docs/dev/http_api_reference#delete-documents)
  249. #### Python API
  250. - [Delete documents](https://ragflow.io/docs/dev/python_api_reference#delete-documents)
  251. ## v0.6.0
  252. Released on May 21, 2024.
  253. ### New features
  254. - Supports streaming output.
  255. - Provides HTTP and Python APIs for retrieving document chunks.
  256. - Supports monitoring of system components, including Elasticsearch, MySQL, Redis, and MinIO.
  257. - Supports disabling **Layout Recognition** in the GENERAL chunk method to reduce file chunking time.
  258. ### Related APIs
  259. #### HTTP API
  260. - [Retrieve chunks](https://ragflow.io/docs/dev/http_api_reference#retrieve-chunks)
  261. #### Python API
  262. - [Retrieve chunks](https://ragflow.io/docs/dev/python_api_reference#retrieve-chunks)
  263. ## v0.5.0
  264. Released on May 8, 2024.
  265. ### New features
  266. - Supports LLM DeepSeek.