writinwaters commited on
Commit
0d43cf3
·
1 Parent(s): ae761d0

Added document: Accelerate document indexing and retrieval (#4600)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

docs/guides/accelerate_question_answering.mdx ADDED
@@ -0,0 +1,50 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ sidebar_position: 2
3
+ slug: /accelerate_doc_indexing_and_question_answering
4
+ ---
5
+
6
+ # Accelerate document indexing and question answering
7
+ import APITable from '@site/src/components/APITable';
8
+
9
+ A checklist to speed up document parsing and question answering.
10
+
11
+ ---
12
+
13
+ Please note that some of your settings may consume a significant amount of time. If you often find that document parsing and question answering are time-consuming, here is a checklist to consider:
14
+
15
+ ## 1. Accelerate document indexing
16
+
17
+ - Use GPU to reduce embedding time.
18
+ - On the configuration page of your knowledge base, toggle off **Use RAPTOR to enhance retrieval**.
19
+ - The **Knowledge Graph** chunk method (GraphRAG) is time-consuming.
20
+ - Disable **Auto-keyword** and **Auto-question** on the configuration page of yor knowledge base, as both depend on the LLM.
21
+
22
+ ## 2. Accelerate question answering
23
+
24
+ - In the **Prompt Engine** tab of your **Chat Configuration** dialogue, disabling **Multi-turn optimization** will reduce the time required to get an answer from the LLM.
25
+ - In the **Prompt Engine** tab of your **Chat Configuration** dialogue, leaving the **Rerank model** field empty will significantly decrease retrieval time.
26
+ - In the **Assistant Setting** tab of your **Chat Configuration** dialogue, disabling **Keyword analysis** will reduce the time to get get an answer from the LLM.
27
+ - 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:
28
+ ![enlighten](https://github.com/user-attachments/assets/fedfa2ee-21a7-451b-be66-20125619923c)
29
+
30
+
31
+ ```mdx-code-block
32
+ <APITable>
33
+ ```
34
+
35
+ | Item name | Description |
36
+ | ----------------- | ------------------------------------------------------------ |
37
+ | Total | Total time spent on this conversation round, including chunk retrieval and answer generation. |
38
+ | Check LLM | Time to validate the specified LLM. |
39
+ | Create retriever | Time to create a chunk retriever. |
40
+ | Bind embedding | Time to initialize an embedding model instance. |
41
+ | Bind LLM | Time to intialize an LLM instance. |
42
+ | Tune question | Time to optimize the user query using the context of the mult-turn conversation. |
43
+ | Bind reranker | Time to initialize an reranker model instance for chunk retrieval. |
44
+ | Generate keywords | Time to extract keywords from the user query. |
45
+ | Retrieval | Time to retrieve the chunks. |
46
+ | Generate answer | Time to generate the answer. |
47
+
48
+ ```mdx-code-block
49
+ </APITable>
50
+ ```
docs/guides/configure_knowledge_base.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- sidebar_position: 1
3
  slug: /configure_knowledge_base
4
  ---
5
 
 
1
  ---
2
+ sidebar_position: 0
3
  slug: /configure_knowledge_base
4
  ---
5
 
docs/guides/develop/build_docker_image.mdx CHANGED
@@ -12,6 +12,7 @@ A guide explaining how to build a RAGFlow Docker image from its source code. By
12
  ## Target Audience
13
 
14
  - Developers who have added new features or modified the existing code and require a Docker image to view and debug their changes.
 
15
  - Testers looking to explore the latest features of RAGFlow in a Docker image.
16
 
17
  ## Prerequisites
 
12
  ## Target Audience
13
 
14
  - Developers who have added new features or modified the existing code and require a Docker image to view and debug their changes.
15
+ - Developers looking to build a RAGFlow Docker image for an ARM64 platform.
16
  - Testers looking to explore the latest features of RAGFlow in a Docker image.
17
 
18
  ## Prerequisites
docs/guides/start_chat.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- sidebar_position: 2
3
  slug: /start_chat
4
  ---
5
 
@@ -57,11 +57,11 @@ You start an AI conversation by creating an assistant.
57
 
58
  :::tip NOTE
59
 
60
- 1. Click the light bubble icon above the answer to view the expanded system prompt:
61
 
62
  ![](https://github.com/user-attachments/assets/515ab187-94e8-412a-82f2-aba52cd79e09)
63
 
64
- *The light bubble icon is available only for the current dialogue.*
65
 
66
  2. Scroll down the expanded prompt to view the time consumed for each task:
67
 
 
1
  ---
2
+ sidebar_position: 1
3
  slug: /start_chat
4
  ---
5
 
 
57
 
58
  :::tip NOTE
59
 
60
+ 1. Click the light bulb icon above the answer to view the expanded system prompt:
61
 
62
  ![](https://github.com/user-attachments/assets/515ab187-94e8-412a-82f2-aba52cd79e09)
63
 
64
+ *The light bulb icon is available only for the current dialogue.*
65
 
66
  2. Scroll down the expanded prompt to view the time consumed for each task:
67