writinwaters commited on
Commit
2d88b84
·
1 Parent(s): 75d5476

Moved the Upgrade Manuel out of FAQ (#3131)

Browse files

### What problem does this PR solve?


### Type of change


- [x] Documentation Update

docs/guides/upgrade_ragflow.md ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ sidebar_position: 7
3
+ slug: /upgrade_ragflow
4
+ ---
5
+
6
+ # Upgrade RAGFlow
7
+
8
+ You can upgrade RAGFlow to dev version or the latest version:
9
+
10
+ - 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.
11
+ - The latest version refers to the most recent, officially published release. It is stable and works best with regular users.
12
+
13
+ To upgrade RAGFlow to the dev version:
14
+
15
+ Update the RAGFlow image and restart RAGFlow:
16
+
17
+ 1. Update **ragflow/docker/.env** as follows:
18
+
19
+ ```bash
20
+ RAGFLOW_IMAGE=infiniflow/ragflow:dev
21
+ ```
22
+
23
+ 2. Update RAGFlow image and restart RAGFlow:
24
+
25
+ ```bash
26
+ docker compose -f docker/docker-compose.yml pull
27
+ docker compose -f docker/docker-compose.yml up -d
28
+ ```
29
+
30
+ To upgrade RAGFlow to the latest version:
31
+
32
+ 1. Update **ragflow/docker/.env** as follows:
33
+
34
+ ```bash
35
+ RAGFLOW_IMAGE=infiniflow/ragflow:latest
36
+ ```
37
+
38
+ 2. Update the RAGFlow image and restart RAGFlow:
39
+
40
+ ```bash
41
+ docker compose -f docker/docker-compose.yml pull
42
+ docker compose -f docker/docker-compose.yml up -d
43
+ ```
docs/quickstart.mdx CHANGED
@@ -351,13 +351,17 @@ Conversations in RAGFlow are based on a particular knowledge base or multiple kn
351
 
352
  4. Update **Model Setting**.
353
 
354
- 5. RAGFlow also offers conversation APIs. Hover over your dialogue **>** **Chat Bot API** to integrate RAGFlow's chat capabilities into your applications:
355
-
356
- ![chatbot api](https://github.com/infiniflow/ragflow/assets/93570324/fec23715-f9af-4ac2-81e5-942c5035c5e6)
357
-
358
- 6. Now, let's start the show:
359
 
360
  ![question1](https://github.com/infiniflow/ragflow/assets/93570324/bb72dd67-b35e-4b2a-87e9-4e4edbd6e677)
361
 
362
  ![question2](https://github.com/infiniflow/ragflow/assets/93570324/7cc585ae-88d0-4aa2-817d-0370b2ad7230)
363
 
 
 
 
 
 
 
 
 
 
351
 
352
  4. Update **Model Setting**.
353
 
354
+ 5. Now, let's start the show:
 
 
 
 
355
 
356
  ![question1](https://github.com/infiniflow/ragflow/assets/93570324/bb72dd67-b35e-4b2a-87e9-4e4edbd6e677)
357
 
358
  ![question2](https://github.com/infiniflow/ragflow/assets/93570324/7cc585ae-88d0-4aa2-817d-0370b2ad7230)
359
 
360
+
361
+ :::tip NOTE
362
+ RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's capabilities into your applications. Read the following documents for more information:
363
+
364
+ - [Acquire a RAGFlow API key](./guides/develop/acquire_ragflow_api_key.md)
365
+ - [HTTP API reference](./references/http_api_reference.md)
366
+ - [Python API reference](./references/python_api_reference.md)
367
+ :::
docs/references/http_api_reference.md CHANGED
@@ -5,7 +5,7 @@ slug: /http_api_reference
5
 
6
  # HTTP API Reference
7
 
8
- 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).
9
 
10
  ---
11
 
@@ -1135,8 +1135,8 @@ Updates content or configurations for a specified chunk.
1135
  - `'Authorization: Bearer <YOUR_API_KEY>'`
1136
  - Body:
1137
  - `"content"`: `string`
1138
- - `"important_keywords"`: `string`
1139
- - `"available"`: `integer`
1140
 
1141
  #### Request example
1142
 
 
5
 
6
  # HTTP API Reference
7
 
8
+ 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).
9
 
10
  ---
11
 
 
1135
  - `'Authorization: Bearer <YOUR_API_KEY>'`
1136
  - Body:
1137
  - `"content"`: `string`
1138
+ - `"important_keywords"`: `list[string]`
1139
+ - `"available"`: `boolean`
1140
 
1141
  #### Request example
1142
 
docs/references/python_api_reference.md CHANGED
@@ -5,7 +5,7 @@ slug: /python_api_reference
5
 
6
  # Python API Reference
7
 
8
- 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).
9
 
10
  ---
11
 
 
5
 
6
  # Python API Reference
7
 
8
+ 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).
9
 
10
  ---
11