From c10eeb003ccafcea361c38d8a53f27766ea37fb5 Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 31 Oct 2024 16:27:33 +0800 Subject: [PATCH 1/3] Moved the Upgrade Manuel out of FAQ --- docs/guides/upgrade_ragflow.md | 43 +++++++++++++++++++++++++ docs/quickstart.mdx | 14 +++++--- docs/references/http_api_reference.md | 6 ++-- docs/references/python_api_reference.md | 2 +- 4 files changed, 56 insertions(+), 9 deletions(-) create mode 100644 docs/guides/upgrade_ragflow.md diff --git a/docs/guides/upgrade_ragflow.md b/docs/guides/upgrade_ragflow.md new file mode 100644 index 00000000000..1eb23ea4029 --- /dev/null +++ b/docs/guides/upgrade_ragflow.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 7 +slug: /upgrade_ragflow +--- + +# Upgrade RAGFlow + +You can upgrade RAGFlow to dev version or the latest version: + +- Dev versions are for developers and contributors. They are published on a nightly basis and may crash because they are not fully tested. We cannot guarantee their validity and you are at your own risk trying out latest, untested features. +- The latest version refers to the most recent, officially published release. It is stable and works best with regular users. + +To upgrade RAGFlow to the dev version: + +Update the RAGFlow image and restart RAGFlow: + +1. Update **ragflow/docker/.env** as follows: + + ```bash + RAGFLOW_IMAGE=infiniflow/ragflow:dev + ``` + +2. Update ragflow image and restart ragflow: + + ```bash + docker compose -f docker/docker-compose.yml pull + docker compose -f docker/docker-compose.yml up -d + ``` + +To upgrade RAGFlow to the latest version: + +1. Update **ragflow/docker/.env** as follows: + + ```bash + RAGFLOW_IMAGE=infiniflow/ragflow:latest + ``` + +2. Update the RAGFlow image and restart RAGFlow: + + ```bash + docker compose -f docker/docker-compose.yml pull + docker compose -f docker/docker-compose.yml up -d + ``` diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 62f53165c8d..8d5c3bdc300 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -351,13 +351,17 @@ Conversations in RAGFlow are based on a particular knowledge base or multiple kn 4. Update **Model Setting**. -5. RAGFlow also offers conversation APIs. Hover over your dialogue **>** **Chat Bot API** to integrate RAGFlow's chat capabilities into your applications: - - ![chatbot api](https://github.com/infiniflow/ragflow/assets/93570324/fec23715-f9af-4ac2-81e5-942c5035c5e6) - -6. Now, let's start the show: +5. Now, let's start the show: ![question1](https://github.com/infiniflow/ragflow/assets/93570324/bb72dd67-b35e-4b2a-87e9-4e4edbd6e677) ![question2](https://github.com/infiniflow/ragflow/assets/93570324/7cc585ae-88d0-4aa2-817d-0370b2ad7230) + +:::tip NOTE +RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's RAG and AI-powered chat capabilities into your applications. Read the following documents for more information: + +- [Acquire a RAGFlow API key](./guides/develop/acquire_ragflow_api_key.md) +- [HTTP API reference](./references/http_api_reference.md) +- [Python API reference](./references/python_api_reference.md) +::: diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index ab4b8442bc8..7ee0314e136 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -5,7 +5,7 @@ slug: /http_api_reference # HTTP API Reference -This document provides a complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md). +A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md). --- @@ -1135,8 +1135,8 @@ Updates content or configurations for a specified chunk. - `'Authorization: Bearer '` - Body: - `"content"`: `string` - - `"important_keywords"`: `string` - - `"available"`: `integer` + - `"important_keywords"`: `list[string]` + - `"available"`: `boolean` #### Request example diff --git a/docs/references/python_api_reference.md b/docs/references/python_api_reference.md index 569c912b06a..3a1b7093b4e 100644 --- a/docs/references/python_api_reference.md +++ b/docs/references/python_api_reference.md @@ -5,7 +5,7 @@ slug: /python_api_reference # Python API Reference -This document offers a complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md). +A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../guides/develop/acquire_ragflow_api_key.md). --- From 01cd6e59a1b1b19fd1a4727c41a93d7cb13707fa Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 31 Oct 2024 16:33:28 +0800 Subject: [PATCH 2/3] minor --- docs/guides/upgrade_ragflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/upgrade_ragflow.md b/docs/guides/upgrade_ragflow.md index 1eb23ea4029..46ad6d2407b 100644 --- a/docs/guides/upgrade_ragflow.md +++ b/docs/guides/upgrade_ragflow.md @@ -20,7 +20,7 @@ Update the RAGFlow image and restart RAGFlow: RAGFLOW_IMAGE=infiniflow/ragflow:dev ``` -2. Update ragflow image and restart ragflow: +2. Update RAGFlow image and restart RAGFlow: ```bash docker compose -f docker/docker-compose.yml pull From fd97f6ba43a4903c35e2f8c27845326b92342fb5 Mon Sep 17 00:00:00 2001 From: writinwaters Date: Thu, 31 Oct 2024 16:34:44 +0800 Subject: [PATCH 3/3] minor --- docs/quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 8d5c3bdc300..dde11864e62 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -359,7 +359,7 @@ Conversations in RAGFlow are based on a particular knowledge base or multiple kn :::tip NOTE -RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's RAG and AI-powered chat capabilities into your applications. Read the following documents for more information: +RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's capabilities into your applications. Read the following documents for more information: - [Acquire a RAGFlow API key](./guides/develop/acquire_ragflow_api_key.md) - [HTTP API reference](./references/http_api_reference.md)