revert white-space changes in docs (#12557)

### What problem does this PR solve?

Trailing white-spaces in commit 6814ace1aa
got automatically trimmed by code editor may causes documentation
typesetting broken.

Mostly for double spaces for soft line breaks.  

### Type of change

- [x] Documentation Update
This commit is contained in:
Jimmy Ben Klieve
2026-01-13 09:41:02 +08:00
committed by GitHub
parent fd0a1fde6b
commit 867ec94258
71 changed files with 660 additions and 731 deletions

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
sidebarIcon: LucideCog sidebarIcon: LucideCog
} }
--- ---
# Configuration # Configuration
Configurations for deploying RAGFlow via Docker. Configurations for deploying RAGFlow via Docker.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideBookA categoryIcon: LucideBookA
} }
--- ---
# Contribution guidelines # Contribution guidelines
General guidelines for RAGFlow's community contributors. General guidelines for RAGFlow's community contributors.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideKey categoryIcon: LucideKey
} }
--- ---
# Acquire RAGFlow API key # Acquire RAGFlow API key
An API key is required for the RAGFlow server to authenticate your HTTP/Python or MCP requests. This documents provides instructions on obtaining a RAGFlow API key. An API key is required for the RAGFlow server to authenticate your HTTP/Python or MCP requests. This documents provides instructions on obtaining a RAGFlow API key.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucidePackage categoryIcon: LucidePackage
} }
--- ---
# Build RAGFlow Docker image # Build RAGFlow Docker image
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideMonitorPlay categoryIcon: LucideMonitorPlay
} }
--- ---
# Launch service from source # Launch service from source
A guide explaining how to set up a RAGFlow service from its source code. By following this guide, you'll be able to debug using the source code. A guide explaining how to set up a RAGFlow service from its source code. By following this guide, you'll be able to debug using the source code.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideTvMinimalPlay categoryIcon: LucideTvMinimalPlay
} }
--- ---
# Launch RAGFlow MCP server # Launch RAGFlow MCP server
Launch an MCP server from source or via Docker. Launch an MCP server from source or via Docker.

View File

@ -6,7 +6,6 @@ sidebar_custom_props: {
} }
--- ---
# RAGFlow MCP client examples # RAGFlow MCP client examples
Python and curl MCP client examples. Python and curl MCP client examples.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideToolCase categoryIcon: LucideToolCase
} }
--- ---
# RAGFlow MCP tools # RAGFlow MCP tools
The MCP server currently offers a specialized tool to assist users in searching for relevant information powered by RAGFlow DeepDoc technology: The MCP server currently offers a specialized tool to assist users in searching for relevant information powered by RAGFlow DeepDoc technology:

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideShuffle categoryIcon: LucideShuffle
} }
--- ---
# Switch document engine # Switch document engine
Switch your doc engine from Elasticsearch to Infinity. Switch your doc engine from Elasticsearch to Infinity.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
sidebarIcon: LucideCircleQuestionMark sidebarIcon: LucideCircleQuestionMark
} }
--- ---
# FAQs # FAQs
Answers to questions about general features, troubleshooting, usage, and more. Answers to questions about general features, troubleshooting, usage, and more.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideSquareTerminal categoryIcon: LucideSquareTerminal
} }
--- ---
# Admin CLI # Admin CLI
The RAGFlow Admin CLI is a command-line-based system administration tool that offers administrators an efficient and flexible method for system interaction and control. Operating on a client-server architecture, it communicates in real-time with the Admin Service, receiving administrator commands and dynamically returning execution results. The RAGFlow Admin CLI is a command-line-based system administration tool that offers administrators an efficient and flexible method for system interaction and control. Operating on a client-server architecture, it communicates in real-time with the Admin Service, receiving administrator commands and dynamically returning execution results.

View File

@ -5,8 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideActivity categoryIcon: LucideActivity
} }
--- ---
# Admin Service # Admin Service
The Admin Service is the core backend management service of the RAGFlow system, providing comprehensive system administration capabilities through centralized API interfaces for managing and controlling the entire platform. Adopting a client-server architecture, it supports access and operations via both a Web UI and an Admin CLI, ensuring flexible and efficient execution of administrative tasks. The Admin Service is the core backend management service of the RAGFlow system, providing comprehensive system administration capabilities through centralized API interfaces for managing and controlling the entire platform. Adopting a client-server architecture, it supports access and operations via both a Web UI and an Admin CLI, ensuring flexible and efficient execution of administrative tasks.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucidePalette categoryIcon: LucidePalette
} }
--- ---
# Admin UI # Admin UI
The RAGFlow Admin UI is a web-based interface that provides comprehensive system status monitoring and user management capabilities. The RAGFlow Admin UI is a web-based interface that provides comprehensive system status monitoring and user management capabilities.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: RagAiAgent categoryIcon: RagAiAgent
} }
--- ---
# Agent component # Agent component
The component equipped with reasoning, tool usage, and multi-agent collaboration capabilities. The component equipped with reasoning, tool usage, and multi-agent collaboration capabilities.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideMessageSquareDot categoryIcon: LucideMessageSquareDot
} }
--- ---
# Await response component # Await response component
A component that halts the workflow and awaits user input. A component that halts the workflow and awaits user input.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideHome categoryIcon: LucideHome
} }
--- ---
# Begin component # Begin component
The starting component in a workflow. The starting component in a workflow.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideSwatchBook categoryIcon: LucideSwatchBook
} }
--- ---
# Categorize component # Categorize component
A component that classifies user inputs and applies strategies accordingly. A component that classifies user inputs and applies strategies accordingly.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideBlocks categoryIcon: LucideBlocks
} }
--- ---
# Title chunker component # Title chunker component
A component that splits texts into chunks by heading level. A component that splits texts into chunks by heading level.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideBlocks categoryIcon: LucideBlocks
} }
--- ---
# Token chunker component # Token chunker component
A component that splits texts into chunks, respecting a maximum token limit and using delimiters to find optimal breakpoints. A component that splits texts into chunks, respecting a maximum token limit and using delimiters to find optimal breakpoints.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideCodeXml categoryIcon: LucideCodeXml
} }
--- ---
# Code component # Code component
A component that enables users to integrate Python or JavaScript codes into their Agent for dynamic data processing. A component that enables users to integrate Python or JavaScript codes into their Agent for dynamic data processing.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: RagSql categoryIcon: RagSql
} }
--- ---
# Execute SQL tool # Execute SQL tool
A tool that execute SQL queries on a specified relational database. A tool that execute SQL queries on a specified relational database.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: RagHTTP categoryIcon: RagHTTP
} }
--- ---
# HTTP request component # HTTP request component
A component that calls remote services. A component that calls remote services.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideListPlus categoryIcon: LucideListPlus
} }
--- ---
# Indexer component # Indexer component
A component that defines how chunks are indexed. A component that defines how chunks are indexed.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideRepeat2 categoryIcon: LucideRepeat2
} }
--- ---
# Iteration component # Iteration component
A component that splits text input into text segments and iterates a predefined workflow for each one. A component that splits text input into text segments and iterates a predefined workflow for each one.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideMessageSquareReply categoryIcon: LucideMessageSquareReply
} }
--- ---
# Message component # Message component
A component that sends out a static or dynamic message. A component that sends out a static or dynamic message.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideFilePlay categoryIcon: LucideFilePlay
} }
--- ---
# Parser component # Parser component
A component that sets the parsing rules for your dataset. A component that sets the parsing rules for your dataset.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideFolderSearch categoryIcon: LucideFolderSearch
} }
--- ---
# Retrieval component # Retrieval component
A component that retrieves information from specified datasets. A component that retrieves information from specified datasets.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideSplit categoryIcon: LucideSplit
} }
--- ---
# Switch component # Switch component
A component that evaluates whether specified conditions are met and directs the follow of execution accordingly. A component that evaluates whether specified conditions are met and directs the follow of execution accordingly.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideType categoryIcon: LucideType
} }
--- ---
# Text processing component # Text processing component
A component that merges or splits texts. A component that merges or splits texts.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideFileStack categoryIcon: LucideFileStack
} }
--- ---
# Transformer component # Transformer component
A component that uses an LLM to extract insights from the chunks. A component that uses an LLM to extract insights from the chunks.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideBookOpenText categoryIcon: LucideBookOpenText
} }
--- ---
# Introduction to agents # Introduction to agents
Key concepts, basic operations, a quick view of the agent editor. Key concepts, basic operations, a quick view of the agent editor.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideMonitorDot categoryIcon: LucideMonitorDot
} }
--- ---
# Embed agent into webpage # Embed agent into webpage
You can use iframe to embed an agent into a third-party webpage. You can use iframe to embed an agent into a third-party webpage.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideCodesandbox categoryIcon: LucideCodesandbox
} }
--- ---
# Sandbox quickstart # Sandbox quickstart
A secure, pluggable code execution backend designed for RAGFlow and other applications requiring isolated code execution environments. A secure, pluggable code execution backend designed for RAGFlow and other applications requiring isolated code execution environments.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideSearch categoryIcon: LucideSearch
} }
--- ---
# Search # Search
Conduct an AI search. Conduct an AI search.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideScanSearch categoryIcon: LucideScanSearch
} }
--- ---
# Implement deep research # Implement deep research
Implements deep research for agentic reasoning. Implements deep research for agentic reasoning.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideVariable categoryIcon: LucideVariable
} }
--- ---
# Set variables # Set variables
Set variables to be used together with the system prompt for your LLM. Set variables to be used together with the system prompt for your LLM.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideBot categoryIcon: LucideBot
} }
--- ---
# Start AI chat # Start AI chat
Initiate an AI-powered chat with a configured chat assistant. Initiate an AI-powered chat with a configured chat assistant.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: SiGoogledrive categoryIcon: SiGoogledrive
} }
--- ---
# Add Google Drive # Add Google Drive
## 1. Create a Google Cloud Project ## 1. Create a Google Cloud Project

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideFileCodeCorner categoryIcon: LucideFileCodeCorner
} }
--- ---
# Auto-extract metadata # Auto-extract metadata
Automatically extract metadata from uploaded files. Automatically extract metadata from uploaded files.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideSlidersHorizontal categoryIcon: LucideSlidersHorizontal
} }
--- ---
# Auto-keyword Auto-question # Auto-keyword Auto-question
import APITable from '@site/src/components/APITable'; import APITable from '@site/src/components/APITable';

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideGroup categoryIcon: LucideGroup
} }
--- ---
# Configure child chunking strategy # Configure child chunking strategy
Set parent-child chunking strategy to improve retrieval. Set parent-child chunking strategy to improve retrieval.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideCog categoryIcon: LucideCog
} }
--- ---
# Configure dataset # Configure dataset
Most of RAGFlow's chat assistants and Agents are based on datasets. Each of RAGFlow's datasets serves as a knowledge source, *parsing* files uploaded from your local machine and file references generated in RAGFlow's File system into the real 'knowledge' for future AI chats. This guide demonstrates some basic usages of the dataset feature, covering the following topics: Most of RAGFlow's chat assistants and Agents are based on datasets. Each of RAGFlow's datasets serves as a knowledge source, *parsing* files uploaded from your local machine and file references generated in RAGFlow's File system into the real 'knowledge' for future AI chats. This guide demonstrates some basic usages of the dataset feature, covering the following topics:

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideWandSparkles categoryIcon: LucideWandSparkles
} }
--- ---
# Construct knowledge graph # Construct knowledge graph
Generate a knowledge graph for your dataset. Generate a knowledge graph for your dataset.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideToggleRight categoryIcon: LucideToggleRight
} }
--- ---
# Enable Excel2HTML # Enable Excel2HTML
Convert complex Excel spreadsheets into HTML tables. Convert complex Excel spreadsheets into HTML tables.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideNetwork categoryIcon: LucideNetwork
} }
--- ---
# Enable RAPTOR # Enable RAPTOR
A recursive abstractive method used in long-context knowledge retrieval and summarization, balancing broad semantic understanding with fine details. A recursive abstractive method used in long-context knowledge retrieval and summarization, balancing broad semantic understanding with fine details.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideTableOfContents categoryIcon: LucideTableOfContents
} }
--- ---
# Extract table of contents # Extract table of contents
Extract table of contents (TOC) from documents to provide long context RAG and improve retrieval. Extract table of contents (TOC) from documents to provide long context RAG and improve retrieval.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideCode categoryIcon: LucideCode
} }
--- ---
# Manage metadata # Manage metadata
Manage metadata for your dataset and for your individual documents. Manage metadata for your dataset and for your individual documents.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideTextSearch categoryIcon: LucideTextSearch
} }
--- ---
# Run retrieval test # Run retrieval test
Conduct a retrieval test on your dataset to check whether the intended chunks can be retrieved. Conduct a retrieval test on your dataset to check whether the intended chunks can be retrieved.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideFileText categoryIcon: LucideFileText
} }
--- ---
# Select PDF parser # Select PDF parser
Select a visual model for parsing your PDFs. Select a visual model for parsing your PDFs.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideListChevronsUpDown categoryIcon: LucideListChevronsUpDown
} }
--- ---
# Set context window size # Set context window size
Set context window size for images and tables to improve long-context RAG performances. Set context window size for images and tables to improve long-context RAG performances.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideCode categoryIcon: LucideCode
} }
--- ---
# Set metadata # Set metadata
Manually add metadata to an uploaded file Manually add metadata to an uploaded file

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideStickyNote categoryIcon: LucideStickyNote
} }
--- ---
# Set page rank # Set page rank
Create a step-retrieval strategy using page rank. Create a step-retrieval strategy using page rank.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideTags categoryIcon: LucideTags
} }
--- ---
# Use tag set # Use tag set
Use a tag set to auto-tag chunks in your datasets. Use a tag set to auto-tag chunks in your datasets.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideFolderDot categoryIcon: LucideFolderDot
} }
--- ---
# Files # Files
RAGFlow's file management allows you to upload files individually or in bulk. You can then link an uploaded file to multiple target datasets. This guide showcases some basic usages of the file management feature. RAGFlow's file management allows you to upload files individually or in bulk. You can then link an uploaded file to multiple target datasets. This guide showcases some basic usages of the file management feature.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideMonitorCog categoryIcon: LucideMonitorCog
} }
--- ---
# Deploy local models # Deploy local models
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideKey categoryIcon: LucideKey
} }
--- ---
# Configure model API key # Configure model API key
An API key is required for RAGFlow to interact with an online AI model. This guide provides information about setting your model API key in RAGFlow. An API key is required for RAGFlow to interact with an online AI model. This guide provides information about setting your model API key in RAGFlow.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideLogOut categoryIcon: LucideLogOut
} }
--- ---
# Join or leave a team # Join or leave a team
Accept an invitation to join a team, decline an invitation, or leave a team. Accept an invitation to join a team, decline an invitation, or leave a team.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideUserCog categoryIcon: LucideUserCog
} }
--- ---
# Manage team members # Manage team members
Invite or remove team members. Invite or remove team members.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideShare2 categoryIcon: LucideShare2
} }
--- ---
# Share Agent # Share Agent
Share an Agent with your team members. Share an Agent with your team members.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideShare2 categoryIcon: LucideShare2
} }
--- ---
# Share chat assistant # Share chat assistant
Sharing chat assistant is currently exclusive to RAGFlow Enterprise, but will be made available in due course. Sharing chat assistant is currently exclusive to RAGFlow Enterprise, but will be made available in due course.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideShare2 categoryIcon: LucideShare2
} }
--- ---
# Share dataset # Share dataset
Share a dataset with team members. Share a dataset with team members.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideShare2 categoryIcon: LucideShare2
} }
--- ---
# Share models # Share models
Sharing models is currently exclusive to RAGFlow Enterprise. Sharing models is currently exclusive to RAGFlow Enterprise.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideLocateFixed categoryIcon: LucideLocateFixed
} }
--- ---
# Tracing # Tracing
Observability & Tracing with Langfuse. Observability & Tracing with Langfuse.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideArrowBigUpDash categoryIcon: LucideArrowBigUpDash
} }
--- ---
# Upgrading # Upgrading
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
sidebarIcon: LucideRocket sidebarIcon: LucideRocket
} }
--- ---
# Get started # Get started
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideCaseUpper categoryIcon: LucideCaseUpper
} }
--- ---
# Glossary # Glossary
Definitions of key terms and basic concepts related to RAGFlow. Definitions of key terms and basic concepts related to RAGFlow.

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideGlobe categoryIcon: LucideGlobe
} }
--- ---
# HTTP API # HTTP API
A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key). A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key).

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: SiPython categoryIcon: SiPython
} }
--- ---
# Python API # Python API
A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key). A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key).

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
categoryIcon: LucideBox categoryIcon: LucideBox
} }
--- ---
# Supported models # Supported models
import APITable from '@site/src/components/APITable'; import APITable from '@site/src/components/APITable';

View File

@ -5,7 +5,6 @@ sidebar_custom_props: {
sidebarIcon: LucideClipboardPenLine sidebarIcon: LucideClipboardPenLine
} }
--- ---
# Releases # Releases
Key features, improvements and bug fixes in the latest releases. Key features, improvements and bug fixes in the latest releases.