Synchronize documentation. (#291)

Co-authored-by: RAGFlow Curator <infinitydocs.curator@users.noreply.github.com>

Author: infinityCurator

website/docs/faq.mdx

@@ -443,13 +443,26 @@ See [Upgrade RAGFlow](./guides/upgrade_ragflow.mdx) for more information.
 
 To switch your document engine from Elasticsearch to [Infinity](https://github.com/infiniflow/infinity):
 
-1. In **docker/.env**, set `DOC_ENGINE=${DOC_ENGINE:-infinity}`
-2. Restart your Docker image: 
+1. Stop all running containers:  
 
-```bash
-$ docker compose -f docker-compose.yml up -d
-```
+   ```bash
+   $ docker compose -f docker/docker-compose.yml down -v
+   ```
+:::caution WARNING
+`-v` will delete all Docker container volumes, and the existing data will be cleared.
+:::
+
+2. In **docker/.env**, set `DOC_ENGINE=${DOC_ENGINE:-infinity}`
+3. Restart your Docker image: 
+
+   ```bash
+   $ docker compose -f docker-compose.yml up -d
+   ```
+
+---
 
 ### Where are my uploaded files stored in RAGFlow's image?
 
 All uploaded files are stored in Minio, RAGFlow's object storage solution. For instance, if you upload your file directly to a knowledge base, it is located at `<knowledgebase_id>/filename`.
+
+---

website/docs/guides/agent/agent_component_reference/begin.mdx

@@ -48,8 +48,8 @@ You can set global variables within the **Begin** component, which can be either
 
 :::tip NOTE
 To pass in parameters from a client, call:
-- HTTP method [Converse with agent](../../references/http_api_reference.md#converse-with-agent), or
-- Python method [Converse with agent](../../referencespython_api_reference.md#converse-with-agent).
+- HTTP method [Converse with agent](../../../references/http_api_reference.md#converse-with-agent), or
+- Python method [Converse with agent](../../../referencespython_api_reference.md#converse-with-agent).
 :::
 
 :::danger IMPORTANT

website/docs/guides/chat/accelerate_question_answering.mdx

@@ -20,7 +20,7 @@ Please note that some of your settings may consume a significant amount of time.
 Please note that rerank models are essential in certain scenarios. There is always a trade-off between speed and performance; you must weigh the pros against cons for your specific case.
 :::
 
-- In the **Assistant Setting** tab of your **Chat Configuration** dialogue, disabling **Keyword analysis** will reduce the time to receive an answer from the LLM.
+- In the **Assistant settings** tab of your **Chat Configuration** dialogue, disabling **Keyword analysis** will reduce the time to receive an answer from the LLM.
 - When chatting with your chat assistant, click the light bulb icon above the *current* dialogue and scroll down the popup window to view the time taken for each task:  
    ![enlighten](https://github.com/user-attachments/assets/fedfa2ee-21a7-451b-be66-20125619923c)  
 

website/docs/guides/chat/implement_deep_research.md

@@ -15,11 +15,11 @@ From v0.17.0 onward, RAGFlow supports integrating agentic reasoning in an AI cha
 
 To activate this feature:
 
-1. Enable the **Reasoning** toggle under the **Prompt Engine** tab of your chat assistant dialogue.
+1. Enable the **Reasoning** toggle under the **Prompt engine** tab of your chat assistant dialogue.
 
 ![Image](https://github.com/user-attachments/assets/4a1968d0-0128-4371-879f-77f3a70197f5)
 
-2. Enter the correct Tavily API key under the **Assistant Setting** tab of your chat assistant dialogue to leverage Tavily-based web search
+2. Enter the correct Tavily API key under the **Assistant settings** tab of your chat assistant dialogue to leverage Tavily-based web search
 
 ![Image](https://github.com/user-attachments/assets/e8787532-7e72-49ef-8951-169ae544512f)
 

website/docs/guides/chat/set_chat_variables.md

@@ -0,0 +1,112 @@
+---
+sidebar_position: 4
+slug: /set_chat_variables
+---
+
+# Set variables
+
+Set variables to be used together with the system prompt for your LLM.
+
+---
+
+When configuring the system prompt for a chat model, variables play an important role in enhancing flexibility and reusability. With variables, you can dynamically adjust the system prompt to be sent to your model. In the context of RAGFlow, if you have defined variables in the **Chat Configuration** dialogue, except for the system's reserved variable `{knowledge}`, you are required to pass in values for them from RAGFlow's [HTTP API](../../references/http_api_reference.md#converse-with-chat-assistant) or through its [Python SDK](../../references/python_api_reference.md#converse-with-chat-assistant).
+
+:::danger IMPORTANT
+In RAGFlow, variables are closely linked with the system prompt. When you add a variable in the **Variable** section, include it in the system prompt. Conversely, when deleting a variable, ensure it is removed from the system prompt; otherwise, an error would occur.
+:::
+
+## Where to set variables
+
+Hover your mouse over your chat assistant, click **Edit** to open its **Chat Configuration** dialogue, then click the **Prompt Engine** tab. Here, you can work on your variables in the **System prompt** field and the **Variable** section:
+
+![set_variables](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/prompt_engine.jpg)
+
+## 1. Manage variables
+
+In the **Variable** section, you add, remove, or update variables.
+
+### `{knowledge}` - a reserved variable
+
+`{knowledge}` is the system's reserved variable, representing the chunks retrieved from the knowledge base(s) specified by **Knowledge bases** under the **Assistant settings** tab. If your chat assistant is associated with certain knowledge bases, you can keep it as is.
+
+:::info NOTE
+It does not currently make a difference whether you set `{knowledge}` to optional or mandatory, but note that this design will be updated at a later point.
+:::
+
+From v0.17.0 onward, you can start an AI chat without specifying knowledge bases. In this case, we recommend removing the `{knowledge}` variable to prevent unnecessary references and keeping the **Empty response** field empty to avoid errors.
+
+### Custom variables
+
+Besides `{knowledge}`, you can also define your own variables to pair with the system prompt. To use these custom variables, you must pass in their values through RAGFlow's official APIs. The **Optional** toggle determines whether these variables are required in the corresponding APIs:
+
+- **Disabled** (Default): The variable is mandatory and must be provided.
+- **Enabled**: The variable is optional and can be omitted if not needed.
+
+
+
+## 2. Update system prompt
+
+After you add or remove variables in the **Variable** section, ensure your changes are reflected in the system prompt to avoid inconsistencies and errors. Here's an example:
+
+```
+You are an intelligent assistant. Please answer the question by summarizing chunks from the specified knowledge base(s)...
+
+Your answers should follow a professional and {style} style.
+
+Here is the knowledge base:
+{knowledge}
+The above is the knowledge base.
+```
+
+:::tip NOTE
+If you have removed `{knowledge}`, ensure that you thoroughly review and update the entire system prompt to achieve optimal results.
+:::
+
+## APIs
+
+The *only* way to pass in values for the custom variables defined in the **Chat Configuration** dialogue is to call RAGFlow's [HTTP API](../../references/http_api_reference.md#converse-with-chat-assistant) or through its [Python SDK](../../references/python_api_reference.md#converse-with-chat-assistant).
+
+### HTTP API
+
+See [Converse with chat assistant](../../references/http_api_reference.md#converse-with-chat-assistant). Here's an example:
+
+```json {9}
+curl --request POST \
+     --url http://{address}/api/v1/chats/{chat_id}/completions \
+     --header 'Content-Type: application/json' \
+     --header 'Authorization: Bearer <YOUR_API_KEY>' \
+     --data-binary '
+     {
+          "question": "xxxxxxxxx",
+          "stream": true,
+          "style":"hilarious"
+     }'
+```
+
+### Python API
+
+See [Converse with chat assistant](../../references/python_api_reference.md#converse-with-chat-assistant). Here's an example:
+
+```python {18}
+from ragflow_sdk import RAGFlow
+
+rag_object = RAGFlow(api_key="<YOUR_API_KEY>", base_url="http://<YOUR_BASE_URL>:9380")
+assistant = rag_object.list_chats(name="Miss R")
+assistant = assistant[0]
+session = assistant.create_session()    
+
+print("\n==================== Miss R =====================\n")
+print("Hello. What can I do for you?")
+
+while True:
+    question = input("\n==================== User =====================\n> ")
+    style = input("Please enter your preferred style (e.g., formal, informal, hilarious): ")
+    
+    print("\n==================== Miss R =====================\n")
+    
+    cont = ""
+    for ans in session.ask(question, stream=True, style=style):
+        print(ans.content[len(cont):], end='', flush=True)
+        cont = ans.content
+```
+

website/docs/guides/chat/start_chat.md

@@ -19,7 +19,7 @@ You start an AI conversation by creating an assistant.
 
    > RAGFlow offers you the flexibility of choosing a different chat model for each dialogue, while allowing you to set the default models in **System Model Settings**.
 
-2. Update **Assistant Setting**:
+2. Update **Assistant Settings**:
 
    - **Assistant name** is the name of your chat assistant. Each assistant corresponds to a dialogue with a unique combination of knowledge bases, prompts, hybrid search configurations, and large model settings.
    - **Empty response**:

website/docs/guides/dataset/construct_knowledge_graph.md

@@ -70,7 +70,7 @@ In a knowledge graph, a community is a cluster of entities linked by relationshi
 3. Click **Knowledge graph** to view the details of the generated graph.
 4. To use the created knowledge graph, do either of the following:
 
-   - In your **Chat Configuration** dialogue, click the **Assistant Setting** tab to add the corresponding knowledge base(s) and click the **Prompt Engine** tab to switch on the **Use knowledge graph** toggle.
+   - In your **Chat Configuration** dialogue, click the **Assistant settings** tab to add the corresponding knowledge base(s) and click the **Prompt engine** tab to switch on the **Use knowledge graph** toggle.
    - If you are using an agent, click the **Retrieval** agent component to specify the knowledge base(s) and switch on the **Use knowledge graph** toggle.
 
 ## Frequently asked questions

website/docs/guides/dataset/use_tag_sets.md

@@ -11,15 +11,15 @@ Use a tag set to tag chunks in your datasets.
 
 Retrieval accuracy is the touchstone for a production-ready RAG framework. In addition to retrieval-enhancing approaches like auto-keyword, auto-question, and knowledge graph, RAGFlow introduces an auto-tagging feature to address semantic gaps. The auto-tagging feature automatically maps tags in the user-defined tag sets to relevant chunks within your knowledge base based on similarity with each chunk. This automation mechanism allows you to apply an additional "layer" of domain-specific knowledge to existing datasets, which is particularly useful when dealing with a large number of chunks.
 
-To use this feature, ensure you have at least one properly configured tag set, specify the tag set(s) on the **Configuration** page of your knowledge base (dataset), and then re-parse your documents to initiate the auto-tag process. During this process, each chunk in your dataset is compared with every entry in the specified tag set(s), and tags are automatically applied based on similarity.
+To use this feature, ensure you have at least one properly configured tag set, specify the tag set(s) on the **Configuration** page of your knowledge base (dataset), and then re-parse your documents to initiate the auto-tagging process. During this process, each chunk in your dataset is compared with every entry in the specified tag set(s), and tags are automatically applied based on similarity.
 
 :::caution NOTE
 The auto-tagging feature is *unavailable* on the [Infinity](https://github.com/infiniflow/infinity) document engine.
 :::
 
 ## Scenarios
 
-Auto-tagging applies in situations where chunks are so similar to each other that the intended chunks cannot be distinguished from the rest. For example, when you have a few chunks about iPhone and a majority about iPhone case or iPhone accessaries, it becomes difficult to retrieve the iPhone-specific chunks without additional information.
+Auto-tagging applies in situations where chunks are so similar to each other that the intended chunks cannot be distinguished from the rest. For example, when you have a few chunks about iPhone and a majority about iPhone case or iPhone accessaries, it becomes difficult to retrieve those chunks about iPhone without additional information.
 
 ## Create tag set
 

website/docs/guides/manage_files.md

@@ -7,7 +7,7 @@ slug: /manage_files
 
 Knowledge base, hallucination-free chat, and file management are the three pillars of RAGFlow. RAGFlow's file management allows you to upload files individually or in bulk. You can then link an uploaded file to multiple target knowledge bases. This guide showcases some basic usages of the file management feature.
 
-:::danger IMPORTANT
+:::info IMPORTANT
 Compared to uploading files directly to various knowledge bases, uploading them to RAGFlow's file management and then linking them to different knowledge bases is *not* an unnecessary step, particularly when you want to delete some parsed files or an entire knowledge base but retain the original files.
 :::
 
@@ -17,7 +17,9 @@ RAGFlow's file management allows you to establish your file system with nested f
 
 ![create new folder](https://github.com/infiniflow/ragflow/assets/93570324/3a37a5f4-43a6-426d-a62a-e5cd2ff7a533)
 
-> Each knowledge base in RAGFlow has a corresponding folder under the **root/.knowledgebase** directory. You are not allowed to create a subfolder within it.
+:::caution NOTE
+Each knowledge base in RAGFlow has a corresponding folder under the **root/.knowledgebase** directory. You are not allowed to create a subfolder within it.
+:::
 
 ## Upload file
 

website/docs/guides/team/join_or_leave_team.md

@@ -39,4 +39,4 @@ _After accepting the team invite, you should be able to view and update the team
 
 ## Leave a joined team
 
-![leave_team](https://github.com/user-attachments/assets/16f31462-27e5-4a13-b9dc-dd7f1bcc43f0)
+![leave_team](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/quit.jpg)