Publish RAGFlow's HTTP and Python API references (#3116)

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

docs/guides/develop/acquire_ragflow_api_key.md

@@ -0,0 +1,18 @@
+---
+sidebar_position: 3
+slug: /acquire_ragflow_api_key
+---
+
+# Acquire a RAGFlow API key
+
+A key is required for the RAGFlow server to authenticate your requests via HTTP or a Python API. This documents provides instructions on obtaining a RAGFlow API key.
+
+1. Click your avatar on the top right corner of the RAGFlow UI to access the configuration page.
+2. Click **API** to switch to the **API** page.
+3. Obtain a RAGFlow API key:
+
+![ragflow_api_key](https://github.com/user-attachments/assets/f461ed61-04c6-4faf-b3d8-6b5fa56be4e7)
+
+:::tip NOTE
+See the [RAGFlow HTTP API reference](../../references/http_api_reference.md) or the [RAGFlow Python API reference](../../references/python_api_reference.md) for a complete reference of RAGFlow's HTTP or Python APIs.
+:::

docs/guides/llm_api_key_setup.md

@@ -29,7 +29,7 @@ For now, RAGFlow supports the following online LLMs. Click the corresponding lin
 - [StepFun](https://platform.stepfun.com/)
 
 :::note
-If you find your online LLM is not on the list, don't feel disheartened. The list is expanding, and you can [file a feature request](https://github.com/infiniflow/ragflow/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml&title=%5BFeature+Request%5D%3A+) with us! Alternatively, if you have customized or locally-deployed models, you can [bind them to RAGFlow using Ollama, Xinferenc, or LocalAI](./deploy_local_llm.mdx).
+If you find your online LLM is not on the list, don't feel disheartened. The list is expanding, and you can [file a feature request](https://github.com/infiniflow/ragflow/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml&title=%5BFeature+Request%5D%3A+) with us! Alternatively, if you have customized or locally-deployed models, you can [bind them to RAGFlow using Ollama, Xinference, or LocalAI](./deploy_local_llm.mdx).
 :::
 
 ## Configure model API key

docs/references/api.md

@@ -1,553 +0,0 @@
----
-sidebar_position: 1
-slug: /api
----
-
-# API reference
-
-RAGFlow offers RESTful APIs for you to integrate its capabilities into third-party applications. 
-
-## Base URL
-```
-https://demo.ragflow.io/v1/
-```
-
-## Authorization
-
-All of RAGFlow's RESTful APIs use API key for authorization, so keep it safe and do not expose it to the front end. 
-Put your API key in the request header. 
-
-```buildoutcfg
-Authorization: Bearer {API_KEY}
-```
-
-:::note
-In the current design, the RESTful API key you get from RAGFlow does not expire.
-:::
-
-To get your Chat API key or Agent API key:
-
-For Chat API key:
-   1. In RAGFlow, click **Chat** tab in the middle top of the page.
-   2. Hover over the corresponding dialogue **>** **Chat Bot API** to show the chatbot API configuration page.
-   3. Click **API Key** **>** **Create new key** to create your API key.
-   4. Copy and keep your API key safe. 
-
-For Agent API key:
-   1. In RAGFlow, click **Agent** tab in the middle top of the page.
-   2. Click your agent **>** ** Chat Bot API** to show the chatbot API configuration page.
-   3. Click **API Key** **>** **Create new key** to create your API key.
-   4. Copy and keep your API key safe. 
-
-## Create conversation
-
-This method creates (news) a conversation for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| GET      | `/api/new_conversation`                                     |
-
-:::note
-You are *required* to save the `data.id` value returned in the response data, which is the session ID for all upcoming conversations.
-:::
-
-#### Request parameter
-
-| Name     |  Type  | Required |        Description                                          |
-|----------|--------|----------|-------------------------------------------------------------|
-| `user_id`| string |   Yes    | The unique identifier assigned to each user. `user_id` must be less than 32 characters and cannot be empty. The following character sets are supported: <br />- 26 lowercase English letters (a-z)<br />- 26 uppercase English letters (A-Z)<br />- 10 digits (0-9)<br />- "_", "-", "." |
-
-### Response 
-
-```json
-{
-    "data": {
-        "create_date": "Fri, 12 Apr 2024 17:26:21 GMT",
-        "create_time": 1712913981857,
-        "dialog_id": "4f0a2e4cb9af11ee9ba20aef05f5e94f",
-        "duration": 0.0,
-        "id": "b9b2e098f8ae11ee9f45fa163e197198",
-        "message": [
-            {
-                "content": "Hi, I'm your assistant, what can I do for you?",
-                "role": "assistant"
-            }
-        ],
-        "reference": [],
-        "tokens": 0,
-        "update_date": "Fri, 12 Apr 2024 17:26:21 GMT",
-        "update_time": 1712913981857,
-        "user_id": "<USER_ID_SET_BY_THE_CALLER>"
-    },
-    "retcode": 0,
-    "retmsg": "success"
-}
-```
-
-## Get conversation history
-
-This method retrieves the history of a specified conversation session. 
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| GET      | `/api/conversation/<id>`                                    |
-
-#### Request parameter
-
-| Name     |  Type  | Required |        Description                                          |
-|----------|--------|----------|-------------------------------------------------------------|
-| `id`     | string |   Yes    | The unique identifier assigned to a conversation session. `id` must be less than 32 characters and cannot be empty. The following character sets are supported: <br />- 26 lowercase English letters (a-z)<br />- 26 uppercase English letters (A-Z)<br />- 10 digits (0-9)<br />- "_", "-", "." |
-
-### Response 
-
-#### Response parameter
-
-- `message`: All conversations in the specified conversation session.
-    - `role`: `"user"` or `"assistant"`.
-    - `content`: The text content of user or assistant. The citations are in a format like `##0$$`. The number in the middle, 0 in this case, indicates which part in data.reference.chunks it refers to.
-    
-- `user_id`: This is set by the caller.
-- `reference`: Each reference corresponds to one of the assistant's answers in `data.message`.
-    - `chunks`
-        - `content_with_weight`: Content of the chunk.
-        - `doc_name`: Name of the *hit* document.
-        - `img_id`: The image ID of the chunk. It is an optional field only for PDF, PPTX, and images. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the image.
-        - `positions`: [page_number, [upleft corner(x, y)], [right bottom(x, y)]], the chunk position, only for PDF.
-        - `similarity`: The hybrid similarity.
-        - `term_similarity`: The keyword simimlarity.
-        - `vector_similarity`: The embedding similarity.
-    - `doc_aggs`:
-        - `doc_id`: ID of the *hit* document. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the document.
-        - `doc_name`: Name of the *hit* document.
-        - `count`: The number of *hit* chunks in this document.
-
-```json
-{
-    "data": {
-        "create_date": "Mon, 01 Apr 2024 09:28:42 GMT",
-        "create_time": 1711934922220,
-        "dialog_id": "df4a4916d7bd11eeaa650242ac180006",
-        "id": "2cae30fcefc711ee94140242ac180006",
-        "message": [
-            {
-                "content": "Hi! I'm your assistant, what can I do for you?",
-                "role": "assistant"
-            },
-            {
-                "content": "What's the vit score for GPT-4?",
-                "role": "user"
-            },
-            {
-                "content": "The ViT Score for GPT-4 in the zero-shot scenario is 0.5058, and in the few-shot scenario, it is 0.6480. ##0$$",
-                "role": "assistant"
-            }
-        ],
-        "user_id": "<USER_ID_SET_BY_THE_CALLER>",
-        "reference": [
-            {
-                "chunks": [
-                    {
-                        "chunk_id": "d0bc7892c3ec4aeac071544fd56730a8",
-                        "content_ltks": "tabl 1:openagi task-solv perform under differ set for three closed-sourc llm . boldfac denot the highest score under each learn schema . metric gpt-3.5-turbo claude-2 gpt-4 zero few zero few zero few clip score 0.0 0.0 0.0 0.2543 0.0 0.3055 bert score 0.1914 0.3820 0.2111 0.5038 0.2076 0.6307 vit score 0.2437 0.7497 0.4082 0.5416 0.5058 0.6480 overal 0.1450 0.3772 0.2064 0.4332 0.2378 0.5281",
-                        "content_with_weight": "<table><caption>Table 1: OpenAGI task-solving performances under different settings for three closed-source LLMs. Boldface denotes the highest score under each learning schema.</caption>\n<tr><th  rowspan=2 >Metrics</th><th  >GPT-3.5-turbo</th><th></th><th  >Claude-2</th><th  >GPT-4</th></tr>\n<tr><th  >Zero</th><th  >Few</th><th  >Zero Few</th><th  >Zero Few</th></tr>\n<tr><td  >CLIP Score</td><td  >0.0</td><td  >0.0</td><td  >0.0 0.2543</td><td  >0.0 0.3055</td></tr>\n<tr><td  >BERT Score</td><td  >0.1914</td><td  >0.3820</td><td  >0.2111 0.5038</td><td  >0.2076 0.6307</td></tr>\n<tr><td  >ViT Score</td><td  >0.2437</td><td  >0.7497</td><td  >0.4082 0.5416</td><td  >0.5058 0.6480</td></tr>\n<tr><td  >Overall</td><td  >0.1450</td><td  >0.3772</td><td  >0.2064 0.4332</td><td  >0.2378 0.5281</td></tr>\n</table>",
-                        "doc_id": "c790da40ea8911ee928e0242ac180005",
-                        "doc_name": "OpenAGI When LLM Meets Domain Experts.pdf",
-                        "img_id": "afab9fdad6e511eebdb20242ac180006-d0bc7892c3ec4aeac071544fd56730a8",
-                        "important_kwd": [],
-                        "kb_id": "afab9fdad6e511eebdb20242ac180006",
-                        "positions": [
-                            [
-                                9.0,
-                                159.9383341471354,
-                                472.1773274739583,
-                                223.58013916015625,
-                                307.86692301432294
-                            ]
-                        ],
-                        "similarity": 0.7310340654129031,
-                        "term_similarity": 0.7671974387781668,
-                        "vector_similarity": 0.40556370512552886
-                    },
-                    {
-                        "chunk_id": "7e2345d440383b756670e1b0f43a7007",
-                        "content_ltks": "5.5 experiment analysi the main experiment result are tabul in tab . 1 and 2 , showcas the result for closed-sourc and open-sourc llm , respect . the overal perform is calcul a the averag of cllp 8 bert and vit score . ",
-                        "content_with_weight": "5.5 Experimental Analysis\nThe main experimental results are tabulated in Tab. 1 and 2, showcasing the results for closed-source and open-source LLMs, respectively. The overall performance is calculated as the average of CLlP\n8\nBERT and ViT scores.",
-                        "doc_id": "c790da40ea8911ee928e0242ac180005",
-                        "doc_name": "OpenAGI When LLM Meets Domain Experts.pdf",
-                        "img_id": "afab9fdad6e511eebdb20242ac180006-7e2345d440383b756670e1b0f43a7007",
-                        "important_kwd": [],
-                        "kb_id": "afab9fdad6e511eebdb20242ac180006",
-                        "positions": [
-                            [
-                                8.0,
-                                107.3,
-                                508.90000000000003,
-                                686.3,
-                                697.0
-                            ],
-                        ],
-                        "similarity": 0.6691508616357027,
-                        "term_similarity": 0.6999011754270821,
-                        "vector_similarity": 0.39239803751328806
-                    },
-                ],
-                "doc_aggs": [
-                    {
-                        "count": 8,
-                        "doc_id": "c790da40ea8911ee928e0242ac180005",
-                        "doc_name": "OpenAGI When LLM Meets Domain Experts.pdf"
-                    }
-                ],
-                "total": 8
-            },
-        ],
-        "update_date": "Tue, 02 Apr 2024 09:07:49 GMT",
-        "update_time": 1712020069421
-    },
-    "retcode": 0,
-    "retmsg": "success"
-}
-```
-    
-## Get answer
-
-This method retrieves from RAGFlow Chat or RAGFlow Agent the answer to the user's latest question.
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| POST     | `/api/completion`                                           |
-
-#### Request parameter
-
-|   Name           |  Type  | Required | Description   |
-|------------------|--------|----------|---------------|
-| `conversation_id`| string | Yes      | The ID of the conversation session. Call ['GET' /new_conversation](#create-conversation) to retrieve the ID.|
-| `messages`       |  json  | Yes      | The latest question in a JSON form, such as `[{"role": "user", "content": "How are you doing!"}]`|
-| `quote`          |  bool  |  No      | Default: false|
-| `stream`         |  bool  |  No      | Default: true |
-| `doc_ids`        | string |  No      | Document IDs delimited by comma, like `c790da40ea8911ee928e0242ac180005,23dsf34ree928e0242ac180005`. The retrieved contents will be confined to these documents. |
-
-### Response 
-
-- `answer`: The answer to the user's latest question.
-- `reference`: 
-    - `chunks`: The retrieved chunks that contribute to the answer.  
-        - `content_with_weight`: Content of the chunk.
-        - `doc_name`: Name of the *hit* document.
-        - `img_id`: The image ID of the chunk. It is an optional field only for PDF, PPTX, and images. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the image.
-        - `positions`: [page_number, [upleft corner(x, y)], [right bottom(x, y)]], the chunk position, only for PDF.
-        - `similarity`: The hybrid similarity.
-        - `term_similarity`: The keyword simimlarity.
-        - `vector_similarity`: The embedding similarity.
-    - `doc_aggs`:
-        - `doc_id`: ID of the *hit* document. Call ['GET' /document/get/\<id\>](#get-document-content) to retrieve the document.
-        - `doc_name`: Name of the *hit* document. 
-        - `count`: The number of *hit* chunks in this document.
-
-```json
-{
-    "data": {
-      "answer": "The ViT Score for GPT-4 in the zero-shot scenario is 0.5058, and in the few-shot scenario, it is 0.6480. ##0$$",
-      "reference": {
-        "chunks": [
-          {
-            "chunk_id": "d0bc7892c3ec4aeac071544fd56730a8",
-            "content_ltks": "tabl 1:openagi task-solv perform under differ set for three closed-sourc llm . boldfac denot the highest score under each learn schema . metric gpt-3.5-turbo claude-2 gpt-4 zero few zero few zero few clip score 0.0 0.0 0.0 0.2543 0.0 0.3055 bert score 0.1914 0.3820 0.2111 0.5038 0.2076 0.6307 vit score 0.2437 0.7497 0.4082 0.5416 0.5058 0.6480 overal 0.1450 0.3772 0.2064 0.4332 0.2378 0.5281",
-            "content_with_weight": "<table><caption>Table 1: OpenAGI task-solving performances under different settings for three closed-source LLMs. Boldface denotes the highest score under each learning schema.</caption>\n<tr><th  rowspan=2 >Metrics</th><th  >GPT-3.5-turbo</th><th></th><th  >Claude-2</th><th  >GPT-4</th></tr>\n<tr><th  >Zero</th><th  >Few</th><th  >Zero Few</th><th  >Zero Few</th></tr>\n<tr><td  >CLIP Score</td><td  >0.0</td><td  >0.0</td><td  >0.0 0.2543</td><td  >0.0 0.3055</td></tr>\n<tr><td  >BERT Score</td><td  >0.1914</td><td  >0.3820</td><td  >0.2111 0.5038</td><td  >0.2076 0.6307</td></tr>\n<tr><td  >ViT Score</td><td  >0.2437</td><td  >0.7497</td><td  >0.4082 0.5416</td><td  >0.5058 0.6480</td></tr>\n<tr><td  >Overall</td><td  >0.1450</td><td  >0.3772</td><td  >0.2064 0.4332</td><td  >0.2378 0.5281</td></tr>\n</table>",
-            "doc_id": "c790da40ea8911ee928e0242ac180005",
-            "doc_name": "OpenAGI When LLM Meets Domain Experts.pdf",
-            "img_id": "afab9fdad6e511eebdb20242ac180006-d0bc7892c3ec4aeac071544fd56730a8",
-            "important_kwd": [],
-            "kb_id": "afab9fdad6e511eebdb20242ac180006",
-            "positions": [
-              [
-                9.0,
-                159.9383341471354,
-                472.1773274739583,
-                223.58013916015625,
-                307.86692301432294
-              ]
-            ],
-            "similarity": 0.7310340654129031,
-            "term_similarity": 0.7671974387781668,
-            "vector_similarity": 0.40556370512552886
-          },
-          {
-            "chunk_id": "7e2345d440383b756670e1b0f43a7007",
-            "content_ltks": "5.5 experiment analysi the main experiment result are tabul in tab . 1 and 2 , showcas the result for closed-sourc and open-sourc llm , respect . the overal perform is calcul a the averag of cllp 8 bert and vit score . here , onli the task descript of the benchmark task are fed into llm(addit inform , such a the input prompt and llm\u2019output , is provid in fig . a.4 and a.5 in supplementari). broadli speak , closed-sourc llm demonstr superior perform on openagi task , with gpt-4 lead the pack under both zero-and few-shot scenario . in the open-sourc categori , llama-2-13b take the lead , consist post top result across variou learn schema--the perform possibl influenc by it larger model size . notabl , open-sourc llm significantli benefit from the tune method , particularli fine-tun and\u2019rltf . these method mark notic enhanc for flan-t5-larg , vicuna-7b , and llama-2-13b when compar with zero-shot and few-shot learn schema . in fact , each of these open-sourc model hit it pinnacl under the rltf approach . conclus , with rltf tune , the perform of llama-2-13b approach that of gpt-3.5 , illustr it potenti .",
-            "content_with_weight": "5.5 Experimental Analysis\nThe main experimental results are tabulated in Tab. 1 and 2, showcasing the results for closed-source and open-source LLMs, respectively. The overall performance is calculated as the average of CLlP\n8\nBERT and ViT scores. Here, only the task descriptions of the benchmark tasks are fed into LLMs (additional information, such as the input prompt and LLMs\u2019 outputs, is provided in Fig. A.4 and A.5 in supplementary). Broadly speaking, closed-source LLMs demonstrate superior performance on OpenAGI tasks, with GPT-4 leading the pack under both zero- and few-shot scenarios. In the open-source category, LLaMA-2-13B takes the lead, consistently posting top results across various learning schema--the performance possibly influenced by its larger model size. Notably, open-source LLMs significantly benefit from the tuning methods, particularly Fine-tuning and\u2019 RLTF. These methods mark noticeable enhancements for Flan-T5-Large, Vicuna-7B, and LLaMA-2-13B when compared with zero-shot and few-shot learning schema. In fact, each of these open-source models hits its pinnacle under the RLTF approach. Conclusively, with RLTF tuning, the performance of LLaMA-2-13B approaches that of GPT-3.5, illustrating its potential.",
-            "doc_id": "c790da40ea8911ee928e0242ac180005",
-            "doc_name": "OpenAGI When LLM Meets Domain Experts.pdf",
-            "img_id": "afab9fdad6e511eebdb20242ac180006-7e2345d440383b756670e1b0f43a7007",
-            "important_kwd": [],
-            "kb_id": "afab9fdad6e511eebdb20242ac180006",
-            "positions": [
-              [
-                8.0,
-                107.3,
-                508.90000000000003,
-                686.3,
-                697.0
-              ]
-            ],
-            "similarity": 0.6691508616357027,
-            "term_similarity": 0.6999011754270821,
-            "vector_similarity": 0.39239803751328806
-          }
-        ],
-        "doc_aggs": {
-          "OpenAGI When LLM Meets Domain Experts.pdf": 4
-        },
-        "total": 8
-      }
-    },
-    "retcode": 0,
-    "retmsg": "success"
-}
-```  
-
-## Get document content
-
-This method retrieves the content of a document.
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| GET      | `/document/get/<id>`                                        |
-
-### Response
-
-A binary file. 
-
-## Upload file
-
-This method uploads a specific file to a specified knowledge base.
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| POST     | `/api/document/upload`                                      |
-
-#### Response parameter
-
-|   Name      | Type   | Required | Description                                             |
-|-------------|--------|----------|---------------------------------------------------------|
-| `file`      | file   | Yes      | The file to upload.                                     |
-| `kb_name`   | string | Yes      | The name of the knowledge base to upload the file to.   |
-| `parser_id` | string |  No      | The parsing method (chunk template) to use. <br />- "naive": General;<br />- "qa": Q&A;<br />- "manual": Manual;<br />- "table": Table;<br />- "paper": Paper;<br />- "laws": Laws;<br />- "presentation": Presentation;<br />- "picture": Picture;<br />- "one": One. |
-| `run`       | string |  No      | 1: Automatically start file parsing. If `parser_id` is not set, RAGFlow uses the general template by default. |
-
-
-### Response 
-
-```json
-{
-    "data": {
-        "chunk_num": 0,
-        "create_date": "Thu, 25 Apr 2024 14:30:06 GMT",
-        "create_time": 1714026606921,
-        "created_by": "553ec818fd5711ee8ea63043d7ed348e",
-        "id": "41e9324602cd11ef9f5f3043d7ed348e",
-        "kb_id": "06802686c0a311ee85d6246e9694c130",
-        "location": "readme.txt",
-        "name": "readme.txt",
-        "parser_config": {
-            "field_map": {
-            },
-            "pages": [
-                [
-                    0,
-                    1000000
-                ]
-            ]
-        },
-        "parser_id": "general",
-        "process_begin_at": null,
-        "process_duation": 0.0,
-        "progress": 0.0,
-        "progress_msg": "",
-        "run": "0",
-        "size": 929,
-        "source_type": "local",
-        "status": "1",
-        "thumbnail": null,
-        "token_num": 0,
-        "type": "doc",
-        "update_date": "Thu, 25 Apr 2024 14:30:06 GMT",
-        "update_time": 1714026606921
-    },
-    "retcode": 0,
-    "retmsg": "success"
-}
-```
-### Demo for Upload File(Python) 
-
-```python
-# upload_to_kb.py  
-import requests
-
-
-def upload_file_to_kb(file_path, kb_name, token='ragflow-xxxxxxxxxxxxx', parser_id='naive'):
-    """  
-    Uploads a file to a knowledge base.  
-
-    Args:  
-    - file_path: Path to the file to upload.  
-    - kb_name: Name of the target knowledge base.  
-    - parser_id: ID of the chosen file parser (defaults to 'naive').  
-    - token: API token for authentication.  
-    """
-    url = 'http://127.0.0.1/v1/api/document/upload'  # Replace with your actual API URL  
-    files = {'file': open(file_path, 'rb')}  # The file to upload  
-    data = {'kb_name': kb_name, 'parser_id': parser_id, 'run': '1'}  # Additional form data  
-    headers = {'Authorization': f'Bearer {token}'}  # Replace with your actual Bearer token  
-
-    response = requests.post(url, files=files, data=data, headers=headers)
-
-    if response.status_code == 200:
-        print("File uploaded successfully:", response.json())
-    else:
-        print("Failed to upload file:", response.status_code, response.text)
-
-file_to_upload = './ai_intro.pdf'  # For example: './documents/report.pdf'  
-knowledge_base_name = 'AI_knowledge_base'
-# Assume you have already obtained your token and set it here  
-token = 'ragflow-xxxxxxxxxxxxx'
-
-# Call the function to upload the file  
-upload_file_to_kb(file_to_upload, knowledge_base_name, token=token)
-```
-## Get document chunks
-
-This method retrieves the chunks of a specific document by `doc_name` or `doc_id`.
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| GET      | `/api/list_chunks`                                          |
-
-#### Request parameter
-
-|   Name     | Type   | Required |                        Description                                                          |
-|------------|--------|----------|---------------------------------------------------------------------------------------------|
-| `doc_name` | string |  No      | The name of the document in the knowledge base. It must not be empty if `doc_id` is not set.|
-| `doc_id`   | string |  No      | The ID of the document in the knowledge base. It must not be empty if `doc_name` is not set.|
-
-
-### Response
-
-```json
-{
-    "data": [
-        {
-            "content": "Figure 14: Per-request neural-net processingof RL-Cache.\n103\n(sn)\nCPU\n 102\nGPU\n8101\n100\n8\n16 64 256 1K\n4K",
-            "doc_name": "RL-Cache.pdf",
-            "img_id": "0335167613f011ef91240242ac120006-b46c3524952f82dbe061ce9b123f2211"
-        },
-        {
-            "content": "4.3 ProcessingOverheadof RL-CacheACKNOWLEDGMENTSThis section evaluates how effectively our RL-Cache implemen-tation leverages modern multi-core CPUs and GPUs to keep the per-request neural-net processing overhead low. Figure 14 depictsThis researchwas supported inpart by the Regional Government of Madrid (grant P2018/TCS-4499, EdgeData-CM)andU.S. National Science Foundation (grants CNS-1763617 andCNS-1717179).REFERENCES",
-            "doc_name": "RL-Cache.pdf",
-            "img_id": "0335167613f011ef91240242ac120006-d4c12c43938eb55d2d8278eea0d7e6d7"
-        }
-    ],
-    "retcode": 0,
-    "retmsg": "success"
-}
-```
-
-## Get document list
-
-This method retrieves a list of documents from a specified knowledge base.
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| POST     | `/api/list_kb_docs`                                         |
-
-#### Request parameter
-
-| Name        | Type   | Required |  Description                                                          |
-|-------------|--------|----------|-----------------------------------------------------------------------|
-| `kb_name`   | string | Yes      | The name of the knowledge base, from which you get the document list. |
-| `page`      | int    |  No      | The number of pages, default:1.                                       |
-| `page_size` | int    |  No      | The number of docs for each page, default:15.                         |
-| `orderby`   | string |  No      | `chunk_num`, `create_time`, or `size`, default:`create_time`          |
-| `desc`      | bool   |  No      | Default:True.                                                         |
-| `keywords`  | string |  No      | Keyword of the document name.                                         |
-
-
-### Response 
-
-```json
-{
-    "data": {
-        "docs": [
-            {
-                "doc_id": "bad89a84168c11ef9ce40242ac120006",
-                "doc_name": "test.xlsx"
-            },
-            {
-                "doc_id": "641a9b4013f111efb53f0242ac120006",
-                "doc_name": "1111.pdf"
-            }
-        ],
-        "total": 2
-    },
-    "retcode": 0,
-    "retmsg": "success"
-}
-```
-
-## Delete documents 
-
-This method deletes documents by document ID or name.
-
-### Request
-
-#### Request URI
-
-| Method   |        Request URI                                          |
-|----------|-------------------------------------------------------------|
-| DELETE   | `/api/document`                                             |
-
-#### Request parameter
-
-| Name        | Type   | Required | Description                |
-|-------------|--------|----------|----------------------------|
-| `doc_names` | List   |  No      | A list of document names. It must not be empty if `doc_ids` is not set.  |
-| `doc_ids`   | List   |  No      | A list of document IDs. It must not be empty if `doc_names` is not set.  |
-
-
-### Response
-
-```json
-{
-    "data": true,
-    "retcode": 0,
-    "retmsg": "success"
-}
-```

docs/references/faq.md

@@ -49,7 +49,7 @@ Currently, we only support x86 CPU and Nvidia GPU.
 
 ### 2. Do you offer an API for integration with third-party applications?
 
-The corresponding APIs are now available. See the [RAGFlow API Reference](./api.md) for more information.
+The corresponding APIs are now available. See the [RAGFlow HTTP API Reference](./http_api_reference.md) or the [RAGFlow Python API Reference](./python_api_reference.md) for more information.
 
 ### 3. Do you support stream output?
 

{api → docs/references}/http_api_reference.md

@@ -1,7 +1,11 @@
+---
+sidebar_position: 0
+slug: /http_api_reference
+---
 
-# DRAFT! HTTP API Reference
+# HTTP API Reference
 
-**THE API REFERENCES BELOW ARE STILL UNDER DEVELOPMENT.**
+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).
 
 ---
 

{api → docs/references}/python_api_reference.md

@@ -1,10 +1,15 @@
-# DRAFT Python API Reference
+---
+sidebar_position: 1
+slug: /python_api_reference
+---
 
-**THE API REFERENCES BELOW ARE STILL UNDER DEVELOPMENT.**
+# 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).
 
 ---
 
-:::tip NOTE
+:::tip API GROUPING
 Dataset Management
 :::
 

docs/references/ragflow_api.md

@@ -1,881 +0,0 @@
----
-sidebar_class_name: hidden
----
-
-# API reference
-
-RAGFlow offers RESTful APIs for you to integrate its capabilities into third-party applications. 
-
-## Base URL
-```
-http://<host_address>/v1/api/
-```
-
-## Dataset URL
-```
-http://<host_address>/api/v1/dataset
-```
-
-## Authorization
-
-All of RAGFlow's RESTFul APIs use API key for authorization, so keep it safe and do not expose it to the front end. 
-Put your API key in the request header. 
-
-```buildoutcfg
-Authorization: Bearer {API_KEY}
-```
-
-To get your API key:
-
-1. In RAGFlow, click **Chat** tab in the middle top of the page.
-2. Hover over the corresponding dialogue **>** **Chat Bot API** to show the chatbot API configuration page.
-3. Click **API Key** **>** **Create new key** to create your API key.
-4. Copy and keep your API key safe. 
-
-## Create dataset
-
-This method creates (news) a dataset for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI |
-|--------|-------------|
-| POST   | `/dataset`  |
-
-:::note
-You are *required* to save the `data.dataset_id` value returned in the response data, which is the session ID for all upcoming conversations.
-:::
-
-#### Request parameter
-
-| Name           |  Type  | Required | Description                                                                                                                                                                                                                                                                                                         |
-|----------------|--------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `dataset_name` | string |   Yes    | The unique identifier assigned to each newly created dataset. `dataset_name` must be less than 2 ** 10 characters and cannot be empty. The following character sets are supported: <br />- 26 lowercase English letters (a-z)<br />- 26 uppercase English letters (A-Z)<br />- 10 digits (0-9)<br />- "_", "-", "." |
-
-### Response 
-
-```json
-{
-  "code": 0, 
-  "data": {
-    "dataset_name": "kb1",
-    "dataset_id": "375e8ada2d3c11ef98f93043d7ee537e"
-  }, 
-  "message": "success"
-}
-```
-
-## Get dataset list
-
-This method lists the created datasets for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method   | Request URI |
-|----------|-------------|
-| GET      | `/dataset`  |
-
-### Response 
-
-#### Response parameter
-
-```json
-{
-    "code": 0,
-    "data": [
-        {
-            "avatar": null,
-            "chunk_num": 0,
-            "create_date": "Mon, 17 Jun 2024 16:00:05 GMT",
-            "create_time": 1718611205876,
-            "created_by": "b48110a0286411ef994a3043d7ee537e",
-            "description": null,
-            "doc_num": 0,
-            "embd_id": "BAAI/bge-large-zh-v1.5",
-            "id": "9bd6424a2c7f11ef81b83043d7ee537e",
-            "language": "Chinese",
-            "name": "dataset3(23)",
-            "parser_config": {
-                "pages": [
-                    [
-                        1,
-                        1000000
-                    ]
-                ]
-            },
-            "parser_id": "naive",
-            "permission": "me",
-            "similarity_threshold": 0.2,
-            "status": "1",
-            "tenant_id": "b48110a0286411ef994a3043d7ee537e",
-            "token_num": 0,
-            "update_date": "Mon, 17 Jun 2024 16:00:05 GMT",
-            "update_time": 1718611205876,
-            "vector_similarity_weight": 0.3
-        }
-    ],
-    "message": "List datasets successfully!"
-}
-```
-
-## Delete dataset
-
-This method deletes a dataset for a specific user.
-
-### Request
-
-#### Request URI
-
-| Method | Request URI             |
-|--------|-------------------------|
-| DELETE | `/dataset/{dataset_id}` |
-
-#### Request parameter
-
-| Name         |  Type  | Required | Description                                                                                                                                                      |
-|--------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `dataset_id` | string | Yes      | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.                                                                                |
-
-### Response 
-
-```json
-{
-  "code": 0,
-  "message": "Remove dataset: 9cefaefc2e2611ef916b3043d7ee537e successfully"
-}
-```  
-
-### Get the details of the specific dataset
-
-This method gets the details of the specific dataset. 
-
-### Request
-
-#### Request URI
-
-| Method   | Request URI             |
-|----------|-------------------------|
-| GET      | `/dataset/{dataset_id}` |
-
-#### Request parameter
-
-| Name         |  Type  | Required | Description                                                                                                                                                      |
-|--------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `dataset_id` | string | Yes      | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.                                                                                |
-
-### Response 
-
-```json
-{
-    "code": 0,
-    "data": {
-        "avatar": null,
-        "chunk_num": 0, 
-        "description": null,
-        "doc_num": 0,
-        "embd_id": "BAAI/bge-large-zh-v1.5",
-        "id": "060323022e3511efa8263043d7ee537e", 
-        "language": "Chinese", 
-        "name": "test(1)", 
-        "parser_config": 
-        {
-            "pages": [[1, 1000000]]
-        }, 
-        "parser_id": "naive", 
-        "permission": "me", 
-        "token_num": 0
-  }, 
-    "message": "success"
-}
-```
-
-### Update the details of the specific dataset
-
-This method updates the details of the specific dataset. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI             |
-|--------|-------------------------|
-| PUT    | `/dataset/{dataset_id}` |
-
-#### Request parameter
-
-You are required to input at least one parameter.
-
-| Name                 | Type   | Required | Description                                                           |
-|----------------------|--------|----------|-----------------------------------------------------------------------|
-| `name`               | string | No       | The name of the knowledge base, from which you get the document list. |
-| `description`        | string | No       | The description of the knowledge base.                                |
-| `permission`         | string | No       | The permission for the knowledge base, default:me.                    |
-| `language`           | string | No       | The language of the knowledge base.                                   |
-| `chunk_method`       | string | No       | The chunk method of the knowledge base.                               |
-| `embedding_model_id` | string | No       | The embedding model id of the knowledge base.                         |
-| `photo`              | string | No       | The photo of the knowledge base.                                      |
-| `layout_recognize`   | bool   | No       | The layout recognize of the knowledge base.                           |
-| `token_num`          | int    | No       | The token number of the knowledge base.                               |
-| `id`                 | string | No       | The id of the knowledge base.                                         |
-
-### Response 
-
-### Successful response
-
-```json
-{
-    "code": 0,
-    "data": {
-        "avatar": null,
-        "chunk_num": 0,
-        "create_date": "Wed, 19 Jun 2024 20:33:34 GMT",
-        "create_time": 1718800414518, 
-        "created_by": "b48110a0286411ef994a3043d7ee537e", 
-        "description": "new_description1", 
-        "doc_num": 0, 
-        "embd_id": "BAAI/bge-large-zh-v1.5", 
-        "id": "24f9f17a2e3811ef820e3043d7ee537e", 
-        "language": "English", 
-        "name": "new_name", 
-        "parser_config": 
-        {
-            "pages": [[1, 1000000]]
-        },
-        "parser_id": "naive", 
-        "permission": "me", 
-        "similarity_threshold": 0.2, 
-        "status": "1", 
-        "tenant_id": "b48110a0286411ef994a3043d7ee537e", 
-        "token_num": 0, 
-        "update_date": "Wed, 19 Jun 2024 20:33:34 GMT", 
-        "update_time": 1718800414529, 
-        "vector_similarity_weight": 0.3
-  }, 
-    "message": "success"
-}
-```
-
-### Response for the operating error
-
-```json
-{
-    "code": 103, 
-    "message": "Only the owner of knowledgebase is authorized for this operation!"
-}
-```
-
-### Response for no parameter
-```json
-{ 
-    "code": 102, 
-    "message": "Please input at least one parameter that you want to update!"
-}
-```
-
-------------------------------------------------------------------------------------------------------------------------------
-
-## Upload documents
-
-This method uploads documents for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                       |
-|--------|-----------------------------------|
-| POST   | `/dataset/{dataset_id}/documents` |
-
-
-#### Request parameter
-
-| Name         |  Type  | Required |        Description                                         |
-|--------------|--------|----------|------------------------------------------------------------|
-| `dataset_id` | string |   Yes    | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID. |
-
-### Response 
-
-### Successful response
-
-```json
-{
-      "code": 0,
-      "data": [
-        {
-          "created_by": "b48110a0286411ef994a3043d7ee537e",
-          "id": "859584a0379211efb1a23043d7ee537e",
-          "kb_id": "8591349a379211ef92213043d7ee537e",
-          "location": "test.txt",
-          "name": "test.txt",
-          "parser_config": {
-            "pages": [
-              [1, 1000000]
-            ]
-          },
-          "parser_id": "naive",
-          "size": 0,
-          "thumbnail": null,
-          "type": "doc"
-        },
-        {
-          "created_by": "b48110a0286411ef994a3043d7ee537e",
-          "id": "8596f18c379211efb1a23043d7ee537e",
-          "kb_id": "8591349a379211ef92213043d7ee537e",
-          "location": "test1.txt",
-          "name": "test1.txt",
-          "parser_config": {
-            "pages": [
-              [1, 1000000]
-            ]
-          },
-          "parser_id": "naive",
-          "size": 0,
-          "thumbnail": null,
-          "type": "doc"
-        }
-      ],
-      "message": "success"
-}
-```
-
-### Response for nonexistent files
-
-```json
-{
-      "code": "RetCode.DATA_ERROR",
-      "message": "The file test_data/imagination.txt does not exist"
-}
-```
-
-### Response for nonexistent dataset
-
-```json
-{
-      "code": 102,
-      "message": "Can't find this dataset"
-}
-```
-
-### Response for the number of files exceeding the limit
-
-```json
-{
-      "code": 102,
-      "message": "You try to upload 512 files, which exceeds the maximum number of uploading files: 256"
-}
-```
-### Response for uploading without files.
-
-```json
-{
-    "code": 101,
-    "message": "None is not string."
-}
-```
-
-## Delete documents
-
-This method deletes documents for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                       |
-|--------|-----------------------------------|
-| DELETE | `/dataset/{dataset_id}/documents/{document_id}` |
-
-
-#### Request parameter
-
-| Name          |  Type  | Required | Description                                                                         |
-|---------------|--------|----------|-------------------------------------------------------------------------------------|
-| `dataset_id`  | string |   Yes    | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.   |
-| `document_id` | string |   Yes    | The ID of the document. Call ['GET' /document](#list-documents) to retrieve the ID. |
-
-### Response 
-
-### Successful response
-
-```json
-{
-      "code": 0,
-      "data": true,
-      "message": "success"
-}
-```
-
-### Response for deleting a document that does not exist
-
-```json
-{
-      "code": 102,
-      "message": "Document 111 not found!"
-}
-```
-### Response for deleting documents from a non-existent dataset
-
-```json
-{
-      "code": 101,
-      "message": "The document f7aba1ec379b11ef8e853043d7ee537e is not in the dataset: 000, but in the dataset: f7a7ccf2379b11ef83223043d7ee537e."
-}
-```
-
-## List documents
-
-This method lists documents for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                       |
-|--------|-----------------------------------|
-| GET    | `/dataset/{dataset_id}/documents` |
-
-
-#### Request parameter
-
-| Name         | Type   | Required | Description                                                                                                |
-|--------------|--------|----------|------------------------------------------------------------------------------------------------------------|
-| `dataset_id` | string | Yes      | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.                          |
-| `offset`     | int    | No       | The start of the listed documents. Default: 0                                                              |
-| `count`      | int    | No       | The total count of the listed documents. Default: -1, meaning all the later part of documents from the start. |
-| `order_by`   | string | No       | Default: `create_time`                                                                                     |
-| `descend`    | bool   | No       | The order of listing documents. Default: True                                                              |
-| `keywords`   | string | No       | The searching keywords of listing documents. Default: ""                                                   |
-
-### Response 
-
-### Successful Response 
-
-```json
-{
-      "code": 0,
-      "data": {
-        "docs": [
-          {
-            "chunk_num": 0,
-            "create_date": "Mon, 01 Jul 2024 19:24:10 GMT",
-            "create_time": 1719833050046,
-            "created_by": "b48110a0286411ef994a3043d7ee537e",
-            "id": "6fb6f588379c11ef87023043d7ee537e",
-            "kb_id": "6fb1c9e6379c11efa3523043d7ee537e",
-            "location": "empty.txt",
-            "name": "empty.txt",
-            "parser_config": {
-              "pages": [
-                [1, 1000000]
-              ]
-            },
-            "parser_id": "naive",
-            "process_begin_at": null,
-            "process_duation": 0.0,
-            "progress": 0.0,
-            "progress_msg": "",
-            "run": "0",
-            "size": 0,
-            "source_type": "local",
-            "status": "1",
-            "thumbnail": null,
-            "token_num": 0,
-            "type": "doc",
-            "update_date": "Mon, 01 Jul 2024 19:24:10 GMT",
-            "update_time": 1719833050046
-          },
-          {
-            "chunk_num": 0,
-            "create_date": "Mon, 01 Jul 2024 19:24:10 GMT",
-            "create_time": 1719833050037,
-            "created_by": "b48110a0286411ef994a3043d7ee537e",
-            "id": "6fb59c60379c11ef87023043d7ee537e",
-            "kb_id": "6fb1c9e6379c11efa3523043d7ee537e",
-            "location": "test.txt",
-            "name": "test.txt",
-            "parser_config": {
-              "pages": [
-                [1, 1000000]
-              ]
-            },
-            "parser_id": "naive",
-            "process_begin_at": null,
-            "process_duation": 0.0,
-            "progress": 0.0,
-            "progress_msg": "",
-            "run": "0",
-            "size": 0,
-            "source_type": "local",
-            "status": "1",
-            "thumbnail": null,
-            "token_num": 0,
-            "type": "doc",
-            "update_date": "Mon, 01 Jul 2024 19:24:10 GMT",
-            "update_time": 1719833050037
-          }
-        ],
-        "total": 2
-      },
-      "message": "success"
-}
-```
-
-### Response for listing documents with IndexError
-
-```json
-{
-      "code": 100,
-      "message": "IndexError('Offset is out of the valid range.')"
-}
-```
-## Update the details of the document
-
-This method updates the details, including the name, enable and template type of a specific document for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                                     |
-|--------|-------------------------------------------------|
-| PUT    | `/dataset/{dataset_id}/documents/{document_id}` |
-
-
-#### Request parameter
-
-| Name         | Type   | Required | Description                                                                                                |
-|--------------|--------|----------|------------------------------------------------------------------------------------------------------------|
-| `dataset_id`  | string |   Yes    | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.   |
-| `document_id` | string |   Yes    | The ID of the document. Call ['GET' /document](#list-documents) to retrieve the ID. |
-
-### Response 
-
-### Successful Response 
-
-```json
-{
-      "code": 0,
-      "data": {
-        "chunk_num": 0,
-        "create_date": "Mon, 15 Jul 2024 16:55:03 GMT",
-        "create_time": 1721033703914,
-        "created_by": "b48110a0286411ef994a3043d7ee537e",
-        "id": "ed30167a428711efab193043d7ee537e",
-        "kb_id": "ed2d8770428711efaf583043d7ee537e",
-        "location": "test.txt",
-        "name": "new_name.txt",
-        "parser_config": {
-          "pages": [
-            [1, 1000000]
-          ]
-        },
-        "parser_id": "naive",
-        "process_begin_at": null,
-        "process_duration": 0.0,
-        "progress": 0.0,
-        "progress_msg": "",
-        "run": "0",
-        "size": 14,
-        "source_type": "local",
-        "status": "1",
-        "thumbnail": null,
-        "token_num": 0,
-        "type": "doc",
-        "update_date": "Mon, 15 Jul 2024 16:55:03 GMT",
-        "update_time": 1721033703934
-      },
-      "message": "Success"
-}
-```
-
-### Response for updating a document which does not exist.
-
-```json
-{
-      "code": 101,
-      "message": "This document weird_doc_id cannot be found!"
-}
-```
-
-### Response for updating a document without giving parameters.
-```json
-{
-      "code": 102,
-      "message": "Please input at least one parameter that you want to update!"
-}
-```
-
-### Response for updating a document in the nonexistent dataset.
-```json
-{
-      "code": 102,
-      "message": "This dataset fake_dataset_id cannot be found!"
-}
-```
-
-### Response for updating a document with an extension name that differs from its original.
-```json
-{
-      "code": 101,
-      "data": false,
-      "message": "The extension of file cannot be changed"
-}
-```
-
-### Response for updating a document with a duplicate name.
-```json
-{
-      "code": 101,
-      "message": "Duplicated document name in the same dataset."
-}
-```
-
-### Response for updating a document's illegal parameter.
-```json
-{
-      "code": 101,
-      "message": "illegal_parameter is an illegal parameter."
-}
-```
-
-### Response for updating a document's name without its name value.
-```json
-{
-      "code": 102,
-      "message": "There is no new name."
-}
-```
-
-### Response for updating a document's with giving illegal enable's value.
-```json
-{
-      "code": 102,
-      "message": "Illegal value '?' for 'enable' field."
-}
-```
-
-## Download the document
-
-This method downloads a specific document for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                                     |
-|--------|-------------------------------------------------|
-| GET    | `/dataset/{dataset_id}/documents/{document_id}` |
-
-
-#### Request parameter
-
-| Name         | Type   | Required | Description                                                                                                |
-|--------------|--------|----------|------------------------------------------------------------------------------------------------------------|
-| `dataset_id`  | string |   Yes    | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.   |
-| `document_id` | string |   Yes    | The ID of the document. Call ['GET' /document](#list-documents) to retrieve the ID. |
-
-### Response 
-
-### Successful Response 
-
-```json
-{
-      "code": "0",
-      "data": "b'test\\ntest\\ntest'"
-}
-```
-
-### Response for downloading a document which does not exist.
-
-```json
-{
-      "code": 101,
-      "message": "This document 'imagination.txt' cannot be found!"
-}
-```
-
-### Response for downloading a document in the nonexistent dataset.
-```json
-{
-      "code": 102,
-      "message": "This dataset 'imagination' cannot be found!"
-}
-```
-
-### Response for downloading an empty document.
-```json
-{
-      "code": 102,
-      "message": "This file is empty."
-}
-```
-
-## Start parsing a document
-
-This method enables a specific document to start parsing for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                                            |
-|--------|--------------------------------------------------------|
-| POST   | `/dataset/{dataset_id}/documents/{document_id}/status` |
-
-
-#### Request parameter
-
-| Name         | Type   | Required | Description                                                                                                |
-|--------------|--------|----------|------------------------------------------------------------------------------------------------------------|
-| `dataset_id`  | string |   Yes    | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.   |
-| `document_id` | string |   Yes    | The ID of the document. Call ['GET' /document](#list-documents) to retrieve the ID. |
-
-### Response 
-
-### Successful Response 
-
-```json
-{
-      "code": 0,
-      "message": ""
-}
-```
-
-### Response for parsing a document which does not exist.
-
-```json
-{
-      "code": 101,
-      "message": "This document 'imagination.txt' cannot be found!"
-}
-```
-
-### Response for parsing a document in the nonexistent dataset.
-```json
-{
-      "code": 102,
-      "message": "This dataset 'imagination' cannot be found!"
-}
-```
-
-### Response for parsing an empty document.
-```json
-{
-      "code": 0,
-      "message": "Empty data in the document: empty.txt;"
-}
-```
-
-## Start parsing multiple documents
-
-This method enables multiple documents, including all documents in the specific dataset or specified documents, to start parsing for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                                           |
-|--------|-------------------------------------------------------|
-| POST   | `/dataset/{dataset_id}/documents/status` |
-
-
-#### Request parameter
-
-| Name         | Type   | Required | Description                                                                                                                       |
-|--------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------|
-| `dataset_id`  | string |   Yes    | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.                                                 |
-| `document_id` | string |   Yes    | The ID of the document. Call ['GET' /document](#list-documents) to retrieve the ID.                                               |
-| `doc_ids` | list | No | The document IDs of the documents that the user would like to parse. Default: None, means all documents in the specified dataset. |
-### Response 
-
-### Successful Response 
-
-```json
-{
-      "code": 0,
-      "data": true,
-      "message": ""
-}
-```
-
-### Response for parsing documents which does not exist.
-
-```json
-{
-      "code": 101,
-      "message": "This document 'imagination.txt' cannot be found!"
-}
-```
-
-### Response for parsing documents in the nonexistent dataset.
-```json
-{
-      "code": 102,
-      "message": "This dataset 'imagination' cannot be found!"
-}
-```
-
-### Response for parsing documents, one of which is empty.
-```json
-{
-      "code": 0,
-      "data": true,
-      "message": "Empty data in the document: empty.txt; "
-}
-```
-
-## Show the parsing status of the document
-
-This method shows the parsing status of the document for a specific user. 
-
-### Request
-
-#### Request URI
-
-| Method | Request URI                                           |
-|--------|-------------------------------------------------------|
-| GET    | `/dataset/{dataset_id}/documents/status` |
-
-
-#### Request parameter
-
-| Name         | Type   | Required | Description                                                                                                                       |
-|--------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------|
-| `dataset_id`  | string |   Yes    | The ID of the dataset. Call ['GET' /dataset](#create-dataset) to retrieve the ID.                                                 |
-| `document_id` | string |   Yes    | The ID of the document. Call ['GET' /document](#list-documents) to retrieve the ID.                                               |
-
-### Response 
-
-### Successful Response 
-
-```json
-{
-      "code": 0,
-      "data": {
-            "progress": 0.0,
-            "status": "RUNNING"
-      },
-      "message": "success"
-}
-```
-
-### Response for showing the parsing status of a document which does not exist.
-
-```json
-{
-      "code": 102,
-      "message": "This document: 'imagination.txt' is not a valid document."
-}
-```
-
-### Response for showing the parsing status of a document in the nonexistent dataset.
-```json
-{
-      "code": 102,
-      "message": "This dataset 'imagination' cannot be found!"
-}
-```

web/src/components/api-service/chat-overview-modal/api-content.tsx

@@ -1,8 +1,8 @@
 import HightLightMarkdown from '@/components/highlight-markdown';
 import { useSetModalState, useTranslate } from '@/hooks/common-hooks';
 import { Button, Card, Flex, Space } from 'antd';
-// import apiDoc from '../../../../../api/http_api_reference.md';
-import apiDoc from '@parent/api/http_api_reference.md';
+// import apiDoc from '../../../../../docs/references/http_api_reference.md';
+import apiDoc from '@parent/docs/references/http_api_reference.md';
 import ChatApiKeyModal from '../chat-api-key-modal';
 import EmbedModal from '../embed-modal';
 import { usePreviewChat, useShowEmbedModal } from '../hooks';