diff --git a/docker/README.md b/docker/README.md index bb37a8ef6..bab35dbe9 100644 --- a/docker/README.md +++ b/docker/README.md @@ -14,7 +14,7 @@ - **docker-compose.yml** Sets up environment for RAGFlow and its dependencies. - **docker-compose-base.yml** - Sets up environment for RAGFlow's dependencies: Elasticsearch, MySQL, MinIO, and Redis. + Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis. ## 🐬 Docker environment variables diff --git a/docs/configurations.md b/docs/configurations.md index 286e695ca..e94f846b5 100644 --- a/docs/configurations.md +++ b/docs/configurations.md @@ -32,7 +32,7 @@ docker compose -f docker/docker-compose.yml up -d - **docker-compose.yml** Sets up environment for RAGFlow and its dependencies. - **docker-compose-base.yml** - Sets up environment for RAGFlow's dependencies: Elasticsearch, MySQL, MinIO, and Redis. + Sets up environment for RAGFlow's dependencies: Elasticsearch/[Infinity](https://github.com/infiniflow/infinity), MySQL, MinIO, and Redis. ## Docker environment variables diff --git a/docs/guides/_category_.json b/docs/guides/_category_.json index 3512565ea..895506b00 100644 --- a/docs/guides/_category_.json +++ b/docs/guides/_category_.json @@ -1,6 +1,6 @@ { "label": "Guides", - "position": 2, + "position": 3, "link": { "type": "generated-index", "description": "Guides for RAGFlow users and developers." diff --git a/docs/references/_category_.json b/docs/references/_category_.json index 75d4e0eff..fec533560 100644 --- a/docs/references/_category_.json +++ b/docs/references/_category_.json @@ -1,6 +1,6 @@ { "label": "References", - "position": 4, + "position": 6, "link": { "type": "generated-index", "description": "Miscellaneous References" diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index 381b32aa2..a904e14c2 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -2120,7 +2120,7 @@ Failure: --- -## Create session with an agent +## Create session with agent **POST** `/api/v1/agents/{agent_id}/sessions` diff --git a/docs/release_notes.md b/docs/release_notes.md index bad8b6bcd..8b489a353 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -13,7 +13,7 @@ Released on November 26, 2024. ### New features -- Supports [Infinity](https://github.com/infiniflow/infinity) or Elasticsearch (default) as document engine for vector storage and full-text indexing. +- 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) - Enhances user experience by adding more variables to the Agent and implementing auto-saving. - Adds a three-step translation agent template, inspired by [Andrew Ng's translation agent](https://github.com/andrewyng/translation-agent). - Adds an SEO-optimized blog writing agent template. @@ -22,16 +22,60 @@ Released on November 26, 2024. - Optimizes term weight calculations, reducing the retrieval time by 50%. - Improves task executor monitoring with additional performance indicators. - Replaces Redis with Valkey. -- Adds three new UI languages (contributed by community): Indonesian, Spanish, and Vietnamese. +- Adds three new UI languages (*contributed by the community*): Indonesian, Spanish, and Vietnamese. + +### Compatability 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. +::: ### Related APIs #### HTTP APIs -- [Create session with agent](https://ragflow.io/docs/dev/http_api_reference#create-session-with-an-agent) +- [Create session with agent](https://ragflow.io/docs/dev/http_api_reference#create-session-with-agent) - [Converse with agent](https://ragflow.io/docs/dev/http_api_reference#converse-with-agent) #### Python APIs - [Create session with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent) -- [Converse with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent) \ No newline at end of file +- [Converse with agent](https://ragflow.io/docs/dev/python_api_reference#create-session-with-agent) + +### Documentation + +#### Added documents + +- [Configurations](https://ragflow.io/docs/dev/configurations) +- [Manage team members](https://ragflow.io/docs/dev/manage_team_members) +- [Run health check on RAGFlow's dependencies](https://ragflow.io/docs/dev/run_health_check) + +## v0.13.0 + +- 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. +- Introduces an **invoke** tool within the Agent UI. +- Integrates support for Dify's knowledge base API. +- Adds support for GLM4-9B and Yi-Lightning models. +- Introduces HTTP and Python APIs for dataset management, file management within dataset, and chat assistant management. + +:::tip NOTE +To download RAGFlow's Python SDK: + +```bash +pip install ragflow-sdk==0.13.0 +``` +::: + +### Documentation + +#### Added documents + +- [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