writinwaters
commited on
Commit
·
dc442d8
1
Parent(s):
c9d78b3
Added release notes for v0.13.0 (#3691)
Browse files### What problem does this PR solve?
### Type of change
- [x] Documentation Update
- docker/README.md +1 -1
- docs/configurations.md +1 -1
- docs/guides/_category_.json +1 -1
- docs/references/_category_.json +1 -1
- docs/references/http_api_reference.md +1 -1
- docs/release_notes.md +48 -4
docker/README.md
CHANGED
@@ -14,7 +14,7 @@
|
|
14 |
- **docker-compose.yml**
|
15 |
Sets up environment for RAGFlow and its dependencies.
|
16 |
- **docker-compose-base.yml**
|
17 |
-
Sets up environment for RAGFlow's dependencies: Elasticsearch, MySQL, MinIO, and Redis.
|
18 |
|
19 |
## 🐬 Docker environment variables
|
20 |
|
|
|
14 |
- **docker-compose.yml**
|
15 |
Sets up environment for RAGFlow and its dependencies.
|
16 |
- **docker-compose-base.yml**
|
17 |
+
Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
|
18 |
|
19 |
## 🐬 Docker environment variables
|
20 |
|
docs/configurations.md
CHANGED
@@ -32,7 +32,7 @@ docker compose -f docker/docker-compose.yml up -d
|
|
32 |
- **docker-compose.yml**
|
33 |
Sets up environment for RAGFlow and its dependencies.
|
34 |
- **docker-compose-base.yml**
|
35 |
-
Sets up environment for RAGFlow's dependencies: Elasticsearch, MySQL, MinIO, and Redis.
|
36 |
|
37 |
## Docker environment variables
|
38 |
|
|
|
32 |
- **docker-compose.yml**
|
33 |
Sets up environment for RAGFlow and its dependencies.
|
34 |
- **docker-compose-base.yml**
|
35 |
+
Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis.
|
36 |
|
37 |
## Docker environment variables
|
38 |
|
docs/guides/_category_.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1 |
{
|
2 |
"label": "Guides",
|
3 |
-
"position":
|
4 |
"link": {
|
5 |
"type": "generated-index",
|
6 |
"description": "Guides for RAGFlow users and developers."
|
|
|
1 |
{
|
2 |
"label": "Guides",
|
3 |
+
"position": 3,
|
4 |
"link": {
|
5 |
"type": "generated-index",
|
6 |
"description": "Guides for RAGFlow users and developers."
|
docs/references/_category_.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1 |
{
|
2 |
"label": "References",
|
3 |
-
"position":
|
4 |
"link": {
|
5 |
"type": "generated-index",
|
6 |
"description": "Miscellaneous References"
|
|
|
1 |
{
|
2 |
"label": "References",
|
3 |
+
"position": 6,
|
4 |
"link": {
|
5 |
"type": "generated-index",
|
6 |
"description": "Miscellaneous References"
|
docs/references/http_api_reference.md
CHANGED
@@ -2120,7 +2120,7 @@ Failure:
|
|
2120 |
|
2121 |
---
|
2122 |
|
2123 |
-
## Create session with
|
2124 |
|
2125 |
**POST** `/api/v1/agents/{agent_id}/sessions`
|
2126 |
|
|
|
2120 |
|
2121 |
---
|
2122 |
|
2123 |
+
## Create session with agent
|
2124 |
|
2125 |
**POST** `/api/v1/agents/{agent_id}/sessions`
|
2126 |
|
docs/release_notes.md
CHANGED
@@ -13,7 +13,7 @@ Released on November 26, 2024.
|
|
13 |
|
14 |
### New features
|
15 |
|
16 |
-
- Supports [Infinity](https://github.com/infiniflow/infinity) or Elasticsearch (default) as document engine for vector storage and full-text indexing.
|
17 |
- Enhances user experience by adding more variables to the Agent and implementing auto-saving.
|
18 |
- Adds a three-step translation agent template, inspired by [Andrew Ng's translation agent](https://github.com/andrewyng/translation-agent).
|
19 |
- Adds an SEO-optimized blog writing agent template.
|
@@ -22,16 +22,60 @@ Released on November 26, 2024.
|
|
22 |
- Optimizes term weight calculations, reducing the retrieval time by 50%.
|
23 |
- Improves task executor monitoring with additional performance indicators.
|
24 |
- Replaces Redis with Valkey.
|
25 |
-
- Adds three new UI languages (contributed by community): Indonesian, Spanish, and Vietnamese.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
26 |
|
27 |
### Related APIs
|
28 |
|
29 |
#### HTTP APIs
|
30 |
|
31 |
-
- [Create session with agent](https://ragflow.io/docs/dev/http_api_reference#create-session-with-
|
32 |
- [Converse with agent](https://ragflow.io/docs/dev/http_api_reference#converse-with-agent)
|
33 |
|
34 |
#### Python APIs
|
35 |
|
36 |
- [Create session with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent)
|
37 |
-
- [Converse with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
13 |
|
14 |
### New features
|
15 |
|
16 |
+
- 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)
|
17 |
- Enhances user experience by adding more variables to the Agent and implementing auto-saving.
|
18 |
- Adds a three-step translation agent template, inspired by [Andrew Ng's translation agent](https://github.com/andrewyng/translation-agent).
|
19 |
- Adds an SEO-optimized blog writing agent template.
|
|
|
22 |
- Optimizes term weight calculations, reducing the retrieval time by 50%.
|
23 |
- Improves task executor monitoring with additional performance indicators.
|
24 |
- Replaces Redis with Valkey.
|
25 |
+
- Adds three new UI languages (*contributed by the community*): Indonesian, Spanish, and Vietnamese.
|
26 |
+
|
27 |
+
### Compatability 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
|
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
|
38 |
|
39 |
#### HTTP APIs
|
40 |
|
41 |
+
- [Create session with agent](https://ragflow.io/docs/dev/http_api_reference#create-session-with-agent)
|
42 |
- [Converse with agent](https://ragflow.io/docs/dev/http_api_reference#converse-with-agent)
|
43 |
|
44 |
#### Python APIs
|
45 |
|
46 |
- [Create session with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent)
|
47 |
+
- [Converse with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent)
|
48 |
+
|
49 |
+
### Documentation
|
50 |
+
|
51 |
+
#### Added documents
|
52 |
+
|
53 |
+
- [Configurations](https://ragflow.io/docs/dev/configurations)
|
54 |
+
- [Manage team members](https://ragflow.io/docs/dev/manage_team_members)
|
55 |
+
- [Run health check on RAGFlow's dependencies](https://ragflow.io/docs/dev/run_health_check)
|
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.
|
62 |
+
- Introduces an **invoke** tool within the Agent UI.
|
63 |
+
- Integrates support for Dify's knowledge base API.
|
64 |
+
- Adds support for GLM4-9B and Yi-Lightning models.
|
65 |
+
- Introduces HTTP and Python APIs for dataset management, file management within dataset, and chat assistant management.
|
66 |
+
|
67 |
+
:::tip NOTE
|
68 |
+
To download RAGFlow's Python SDK:
|
69 |
+
|
70 |
+
```bash
|
71 |
+
pip install ragflow-sdk==0.13.0
|
72 |
+
```
|
73 |
+
:::
|
74 |
+
|
75 |
+
### Documentation
|
76 |
+
|
77 |
+
#### Added documents
|
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)
|