Restructured guides (#5555)

### What problem does this PR solve?


### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters 2025-03-03 17:13:37 +08:00 committed by GitHub
parent 131f272e69
commit b67697b6f2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 44 additions and 27 deletions

View File

@ -1,6 +1,6 @@
{ {
"label": "Develop", "label": "Developer guides",
"position": 10, "position": 4,
"link": { "link": {
"type": "generated-index", "type": "generated-index",
"description": "Guides for Hardcore Developers" "description": "Guides for Hardcore Developers"

View File

@ -3,7 +3,7 @@ sidebar_position: 10
slug: /faq slug: /faq
--- ---
# Frequently asked questions # FAQ
Queries regarding general features, troubleshooting, usage, and more. Queries regarding general features, troubleshooting, usage, and more.
@ -65,7 +65,7 @@ RAGFlow has a number of built-in models for document structure parsing, which ac
### Which architectures or devices does RAGFlow support? ### Which architectures or devices does RAGFlow support?
We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image.
--- ---
@ -130,7 +130,7 @@ Yes, we support enhancing user queries based on existing context of an ongoing c
#### How to build the RAGFlow image from scratch? #### How to build the RAGFlow image from scratch?
See [Build a RAGFlow Docker image](https://ragflow.io/docs/dev/build_docker_image). See [Build a RAGFlow Docker image](./develop/build_docker_image).
--- ---
@ -453,7 +453,7 @@ This error occurs because there are too many chunks matching your search criteri
### How to get an API key for integration with third-party applications? ### How to get an API key for integration with third-party applications?
See [Acquire a RAGFlow API key](../guides/develop/acquire_ragflow_api_key.md). See [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md).
--- ---

View File

@ -0,0 +1,8 @@
{
"label": "Chat",
"position": 1,
"link": {
"type": "generated-index",
"description": "Chat-specific guides."
}
}

View File

@ -1,25 +1,16 @@
--- ---
sidebar_position: 2 sidebar_position: 2
slug: /accelerate_doc_indexing_and_question_answering slug: /accelerate_question_answering
--- ---
# Accelerate document indexing and question answering # Accelerate question answering
import APITable from '@site/src/components/APITable'; import APITable from '@site/src/components/APITable';
A checklist to speed up document parsing and question answering. A checklist to speed up document parsing and question answering.
--- ---
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: Please note that some of your settings may consume a significant amount of time. If you often find that your question answering is time-consuming, here is a checklist to consider:
## 1. Accelerate document indexing
- Use GPU to reduce embedding time.
- On the configuration page of your knowledge base, switch off **Use RAPTOR to enhance retrieval**.
- Extracting knowledge graph (GraphRAG) is time-consuming.
- Disable **Auto-keyword** and **Auto-question** on the configuration page of yor knowledge base, as both depend on the LLM.
## 2. Accelerate question answering
- 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. - 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.
- In the **Prompt Engine** tab of your **Chat Configuration** dialogue, leaving the **Rerank model** field empty will significantly decrease retrieval time. - In the **Prompt Engine** tab of your **Chat Configuration** dialogue, leaving the **Rerank model** field empty will significantly decrease retrieval time.

View File

@ -0,0 +1,18 @@
---
sidebar_position: 9
slug: /accelerate_doc_indexing
---
# Accelerate document indexing
import APITable from '@site/src/components/APITable';
A checklist to speed up document parsing.
---
Please note that some of your settings may consume a significant amount of time. If you often find that document parsing is time-consuming, here is a checklist to consider:
- Use GPU to reduce embedding time.
- On the configuration page of your knowledge base, switch off **Use RAPTOR to enhance retrieval**.
- Extracting knowledge graph (GraphRAG) is time-consuming.
- Disable **Auto-keyword** and **Auto-question** on the configuration page of yor knowledge base, as both depend on the LLM.

View File

@ -3,7 +3,7 @@ sidebar_position: 4
slug: /manage_team_members slug: /manage_team_members
--- ---
# Manage team members # Team
Invite or remove team members, join or leave a team. Invite or remove team members, join or leave a team.

View File

@ -25,7 +25,7 @@ This user guide does not intend to cover much of the installation or configurati
:::note :::note
- For information about downloading Ollama, see [here](https://github.com/ollama/ollama?tab=readme-ov-file#ollama). - For information about downloading Ollama, see [here](https://github.com/ollama/ollama?tab=readme-ov-file#ollama).
- For information about configuring Ollama server, see [here](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server). - For information about configuring Ollama server, see [here](../../faq.md#how-do-i-configure-ollama-server).
- For a complete list of supported models and variants, see the [Ollama model library](https://ollama.com/library). - For a complete list of supported models and variants, see the [Ollama model library](https://ollama.com/library).
::: :::

View File

@ -3,7 +3,7 @@ sidebar_position: 11
slug: /upgrade_ragflow slug: /upgrade_ragflow
--- ---
# Upgrade RAGFlow # Upgrade
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';

View File

@ -20,7 +20,7 @@ This quick start guide describes a general process from:
:::danger IMPORTANT :::danger IMPORTANT
We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM.
If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image.
::: :::
## Prerequisites ## Prerequisites
@ -356,7 +356,7 @@ Conversations in RAGFlow are based on a particular knowledge base or multiple kn
:::tip NOTE :::tip NOTE
RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's 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) - [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md)
- [HTTP API reference](./references/http_api_reference.md) - [HTTP API reference](./references/http_api_reference.md)
- [Python API reference](./references/python_api_reference.md) - [Python API reference](./references/python_api_reference.md)
::: :::

View File

@ -205,9 +205,9 @@ pip install ragflow-sdk==0.13.0
#### Added documents #### Added documents
- [Acquire a RAGFlow API key](https://ragflow.io/docs/dev/acquire_ragflow_api_key) - [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md)
- [HTTP API Reference](https://ragflow.io/docs/dev/http_api_reference) - [HTTP API Reference](./references/http_api_reference.md)
- [Python API Reference](https://ragflow.io/docs/dev/python_api_reference) - [Python API Reference](./references/python_api_reference.md)
## v0.12.0 ## v0.12.0
@ -315,7 +315,7 @@ Released on May 31, 2024.
:::danger IMPORTANT :::danger IMPORTANT
While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM.
If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image.
::: :::
### Related APIs ### Related APIs